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, that are both used via yaml-validator.

Getting Started

This plugin requires Grunt ~1.1 and Node.js minimum of 14.15.0, which is the active Long Term Support (LTS) version.

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

All options are false by default which disables their use.

options.log

Type: string

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.

options.structure

Type: object

Default value: false

The most complex style of checking validity.

options.yaml

Type: object

Default value: false

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.

options.writeJson

Type: boolean

Default: false

Write the given Yaml file as pretty printed JSON in the same path, just by changing the file extension to json.

Please note that any existing JSON files will be cruelly overwritten.

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: {
      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: {
    logged: {
      options: {
        log: 'yaml-validator.log'
      },
      src: ['configuration/*.yml', 'other/important/*_stuff.yml']
    }
  }
});

Structure validation options

In case an array is found, all its members are assumed to have the given structure. This can be seen in the classRooms property, which according to the configuration below, should be an array, for which all items are objects, which all should have a name and id properties, with the given types.

The teachers array is made of strings, thus all items in that array must be a string.

grunt.initConfig({
  yaml_validator: {
    custom: {
      options: {
        structure: {
          school: {
            description: 'string',
            code: 'number',
            principal: {
              name: 'string'
            },
            classRooms: [
              {
                name: 'string',
                id: 'number'
              }
            ],
            teachers: [
              'string'
            ]
          }
        }
      },
      src: ['configuration/*.yml', 'other/important/*_stuff.yml']
    }
  }
});

Warning callback in Yaml parsing options

Using the options.yaml.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']
    }
  }
});

Write a JSON file option

It is possible to use the options.writeJson to have all the files processed, to be saved in JSON format, in the same file path as the original Yaml files.

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

Contributing

"A Beginner's Guide to Open Source: The Best Advice for Making your First Contribution".

Also there is a blog post about "45 Github Issues Dos and Don’ts".

Linting is done with ESLint and can be executed with npm run lint. There should be no errors appearing after any JavaScript file changes.

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

Release History

Changes happening across different versions and upcoming changes are tracked in the CHANGELOG.md file.

License

Copyright (c) Juga Paazmaya [e-mail]

Licensed under the MIT license.

Changelog

v3.0.0 (2023-06-06)

• Migrated to version 2 of Semaphore CI
• Minimum supported Node.js version lifted from 10.13.0 to 14.15.0