grunt-yaml-validator

grunt-yaml-validator

Validate Yaml files and enforce a given structure

Yaml files are parsed via js-yaml and the structure defined via task configuration is enforced with check-type.

Getting Started

This plugin requires Grunt ~0.4 and Node.js 0.10.0.

If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:

npm install grunt-yaml-validator --save-dev

Once the plugin has been installed, it may be enabled inside your Gruntfile.js with this line of JavaScript:

grunt.loadNpmTasks('grunt-yaml-validator');

In case you are using an automated loader, such as jit-grunt, the above line is not needed.

The "yaml_validator" task

Please note that this project is a multi task plugin, so pay special attention for configuring it.

Files to be checked with this plugin, should be defined via src property.

Overview

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

grunt.initConfig({
  yaml_validator: {
    options: {
      // Task-specific options go here.
    },
    your_target: {
      options: {
        // Multi task specific options go here.
      }
      // Target-specific file lists and/or options go here.
      src: []
    },
  },
});

Options

options.log

Type: string|boolean Default value: 'false'

In case the value is not false, the given string will be used as log file where all the task output is written.

Please note that running Grunt with -v (verbose) mode does make a difference in the resulting output.

options.structure

Type: Array Default value: '[]'

An array to list the property structure which the Yaml files should contain.

options.yaml

Type: Object Default value: null

Options passed to safeload method of js-yaml.

Please note that the onWarning callback is being used by this plugin and any method written for it, will be run after the one implemented in this plugin. The callback get called with two parameters, of which the first is the error in question, while the second is the file path of the given Yaml file.

Usage Examples

Default Options

By using the default option values, only the validity of the configured Yaml files are checked.

grunt.initConfig({
  yaml_validator: {
    defaults: {
      options: {
        log: false,
        structure: [],
        yaml: null
      },
      src: ['configuration/*.yml', 'other/important/*_stuff.yml']
    }
  }
});

Logging options

All output is written in the log file as well as to the standard output.

grunt.initConfig({
  yaml_validator: {
    custom: {
      options: {
        log: 'yaml-validator.log'
      },
      src: ['configuration/*.yml', 'other/important/*_stuff.yml']
    }
  }
});

Structure definition options

The given structure validation requirements are passed to the has() method of the check-type plugin.

grunt.initConfig({
  yaml_validator: {
    custom: {
      options: {
        structure: [
         'school',
         'school.description',
         'school.title',
         'school.language'
        ]
      },
      src: ['configuration/*.yml', 'other/important/*_stuff.yml']
    }
  }
});

Warning callback in Yaml parsing options

Using the onWarning callback, the possible parsing errors can be retrieved.

grunt.initConfig({
  yaml_validator: {
    custom: {
      options: {
        yaml: {
          onWarning: function (error, filepath) {
            console.log(filepath + ' has error: ' + error);
          }
        }
      },
      src: ['configuration/*.yml', 'other/important/*_stuff.yml']
    }
  }
});

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 with ESLint and test your code using unit tests.

Please note that any features or changed will not be merged without working unit tests.

Release History

• v0.1.0 (2014-10-27) Initial release to the World
• v0.1.1 (2014-10-27) Fix structure type and update documentation
• v0.2.0 (2014-10-27) Log file option
• v0.2.1 (2014-10-27) Remove unused dependency
• v0.2.2 (2014-10-28) Log total number as last in the output string

License

Copyright (c) Juga Paazmaya, under the MIT license