grunt-yaml

grunt-yaml

Compiles YAML to JSON.

Getting Started

If you haven't used grunt before, be sure to check out the Getting Started guide. And, This task would work on grunt version ~0.4.0rc7 only.

From the same directory as your project's Gruntfile and package.json, install this plugin with the following command:

npm install grunt-yaml --save-dev

Once that's done, add this line to your project's Gruntfile:

grunt.loadNpmTasks('grunt-yaml');

If the plugin has been installed correctly, running grunt --help at the command line should list the newly-installed plugin's task or tasks. In addition, the plugin should be listed in package.json as a devDependency, which ensures that it will be installed whenever the npm install command is run.

The "yaml" task

Overview

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

grunt.initConfig({
  yaml: {
    your_target: {
      options: {
        ignored: /^_/,
        space: 4,
        constructors: {
          '!include': function (node, yaml) {
            var data = require('fs').readFileSync(node.value, 'utf-8');
            return yaml.load(data);
          }
        }
      },
      dest: 'output_directory',
      src: 'yaml_directory/**/*.yml'
    },
  },
})

Options

options.ignored

Type: RegExp or String Default value: null

A value that specify file pattern for not compile.

options.space

Type: Number Default value: 2

A value that is given to JSON.stringify for pretty-printing.

options.constructors

Type: Object Default value: {}

A Object for add custom constructor to js-yaml.

Usage Examples

See my repository.

Contributing

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using grunt.

Release History

• 2012-02-09   v0.1.1   Support for grunt 0.4.0rc7.
• 2012-12-22   v0.1.0   First release.

License

Copyright (c) 2012 Shogo Iwano Licensed under the MIT license.