grunt-matter

Add, extend, sort or strip YAML front matter. Also has options for populating randomized mock data. This plugin is especially useful for creating test or example templates.

npm install grunt-matter
15 downloads in the last day
46 downloads in the last week
98 downloads in the last month

grunt-matter NPM version Build Status

Add, extend, sort or strip YAML front matter. Also has options for populating randomized mock data. This plugin is especially useful for creating test or example templates.

This plugin is useful for adding or extending YAML front matter in general, but it was created to make it easier to create and update templates for tests and boilerplates.

Getting Started

Overview

In your project's Gruntfile, add a section named matter to the data object passed into grunt.initConfig().

grunt.initConfig({
  matter: {
    options: {
      // Task-specific options go here.
    },
    target: {
      // Target-specific file lists and/or options go here.
    }
  }
})

Options

props

Type: Object Default value: undefined

Extend YAML front matter with given properties. Example:

mock

Type: Object Default value: undefined

Extend YAML front matter with generated random data, based on a defined template model. See datafixture.js for the full list of options.

sort

Type: Boolean Default value: false

Alphabetically sort the properties in the specified YAML front matter.

strip

Type: Boolean Default value: false

Strip all YAML front matter from the given pages.

Usage Examples

props

Extend YAML front matter in the given pages with any number of custom properties.

grunt.initConfig({
  matter: {
    options: {
      props: {
        foo: 'One',
        bar: 'Two',
        someObj: {
          baz: 'Lorem'
        }
      }
    },
    files: {}
  }
});

mock data

grunt.initConfig({
  matter: {
    options: {
      mock: {
        "lorem": "lorem"
        values: "0...100:2", 
        names: ["Ian",2, 10.4, true, "Andros"], 
        complex: {
          PO:"20000...30000",
          country: ["Mexico", "Canada", "US"]
        }
      }
    },
    files: {}
  }
});

Author

License

Copyright (c) 2013 Jon Schlinkert, contributors. Released under the MIT license


This file was generated on Mon Sep 02 2013 09:44:51.

npm loves you