Front Matter Manipulator

Table of Contents

• Convert
  • exports
• Drop
  • exports
• Values
  • exports
• Update
  • exports
  • replacementCallback - Function to run to rename the field
• Fields
  • exports
• Rename
  • exports
  • replacementCallback - Function to run to rename the field

Convert

exports

Converts the given field to an array, unless it is already an array

Parameters

• patterns string A file path or glob pattern to search for files to modify
• field string The field you want to convert
• options Object Configuration options
  • options.ignore string A file path or glob pattern to search for files not to modify. Defaults to “node_modules”.

Examples

var fmp = require("front-matter-manipulator")
 
fmp.convert("_posts/example-post.md", "categories")

var fmp = require("front-matter-manipulator")
var options = {
    ignore: "_posts/subdirectory/*.md"
}
 
fmp.convert("_posts/**‏/*.md", "categories", options)

Drop

exports

Deletes the given fields from the front matter

Parameters

• patterns string A file path or glob pattern to search for files to modify
• fields string A space delimited list of fields you wish to drop
• options Object Configuration options
  • options.ignore string A file path or glob pattern to search for files not to modify. Defaults to “node_modules”.
  • options.exclude string Exclude files that have a certain values. Formatted as a comma delimited list of key value pairs.
  • options.include string Only include files that have a certain values. Formatted as a comma delimited list of key value pairs.

Examples

var fmp = require("front-matter-manipulator")
 
fmp.drop("_posts/example-post.md", "categories tags")

var fmp = require("front-matter-manipulator")
var options = {
    ignore: "_posts/subdirectory/*.md",
    include: "layout=post",
    exclude: "featured=true"
}
 
fmp.drop("**‏/*.md", "categories tags", options)

Values

exports

Retrieves all fields for one or more files

Parameters

• patterns string A file path or glob pattern to search for files
• fields string A space delimited list of fields to get values for
• options Object Configuration options
  • options.ignore string A file path or glob pattern to search for files not to modify. Defaults to “node_modules”.
  • options.outputFile string path to a file where output should be saved

Examples

var fmp = require("front-matter-manipulator")
 
fmp.values("_posts/example-post.md", "categories tags")

var fmp = require("front-matter-manipulator")
var options = {
    ignore: "_posts/subdirectory/*.md"
}
 
fmp.values("**‏/*.md", "categories tags", options)

Returns Object values

Update

exports

Updates the given key value pair’s value

Parameters

• patterns string A file path or glob pattern to search for files to modify
• field string The name of the field you wish to update

• replacement **(string

  replacementCallback)** The new value of the field

• options Object Configuration options
  • options.ignore string A file path or glob pattern to search for files not to modify. Defaults to “node_modules”.
  • options.exclude string Exclude files that have a certain values. Formatted as a comma delimited list of key value pairs.
  • options.include string Only include files that have a certain values. Formatted as a comma delimited list of key value pairs.

Examples

var fmp = require("front-matter-manipulator")
 
fmp.update("_posts/example-post.md", "draft", "true")

var fmp = require("front-matter-manipulator")
var options = {
    ignore: "_posts/subdirectory/*.md",
    include: "layout=post",
    exclude: "featured=true"
}
 
fmp.rename("**‏/*.md", "draft", "true", options)

replacementCallback - Function to run to rename the field

Optional replacement function to be run for each match

Type: Function

Parameters

• value string The field’s current value
• field string The current field permutation
• filePath string The current file’s path

Examples

var fmp = require("front-matter-manipulator")
function replacement(field, filePath) {
    if (field.indexOf(0) > -1) { // Update if array index 0
       replacement = "newKey"
    }
}    

fmp.rename("**‏/*.md", "categories", replacement, options)

Returns string replacement - The replacement value

Fields

exports

Retrieves all fields for one or more files

Parameters

• patterns string A file path or glob pattern to search for files
• options Object Configuration options
  • options.ignore string A file path or glob pattern to search for files not to modify. Defaults to “node_modules”.
  • options.exclude string Exclude files that have a certain values. Formatted as a comma delimited list of key value pairs.
  • options.include string Only include files that have a certain values. Formatted as a comma delimited list of key value pairs.
  • options.outputFile string path to a file where output should be saved
  • options.outputstring string output values as a space delimited string instead of JSON

Examples

var fmp = require("front-matter-manipulator")
 
fmp.fields("_posts/example-post.md")

var fmp = require("front-matter-manipulator")
var options = {
    ignore: "_posts/subdirectory/*.md",
    include: "layout=post",
    exclude: "featured=true"
}
 
fmp.fields("**‏/*.md", options)

Returns Object fields

Rename

exports

Renames the given field

Parameters

• patterns string A file path or glob pattern to search for files to modify
• key

• replacement **(string

  replacementCallback)** The replacement name for the field.

• options Object Configuration options
  • options.ignore string A file path or glob pattern to search for files not to modify. Defaults to “node_modules”.
  • options.exclude string Exclude files that have a certain values. Formatted as a comma delimited list of key value pairs.
  • options.include string Only include files that have a certain values. Formatted as a comma delimited list of key value pairs.
• field string The name of the field you wish to rename

Examples

var fmp = require("front-matter-manipulator")
 
fmp.rename("_posts/example-post.md", "categories", "tags")

var fmp = require("front-matter-manipulator")
var options = {
    ignore: "_posts/subdirectory/*.md",
    include: "layout=post",
    exclude: "featured=true"
}
 
fmp.rename("**‏/*.md", "categories", "tags", options)

replacementCallback - Function to run to rename the field

Optional replacement function to be run for each match

Type: Function

Parameters

• field string The current field permutation
• filePath string The current file’s path

Examples

var fmp = require("front-matter-manipulator")
function replacement(field, filePath) {
    if (field.indexOf(0) > -1) { // Update if array index 0
       replacement = "newKey"
    }
}    

fmp.rename("**‏/*.md", "categories", replacement, options)

Returns string replacement - The replacement field name