grunt-raml-cop

Grunt plugin for RAML Cop.

Getting Started

This plugin requires Grunt ~0.4.5

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-raml-cop --save-dev

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

grunt.loadNpmTasks('grunt-raml-cop');

Alternatively, you can use the load-grunt-tasks npm module to automatically load tasks like so:

require('load-grunt-tasks')(grunt, { scope: 'devDependencies' });

The "raml_cop" task

Overview

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

grunt.initConfig({
  'raml_cop': {
    options: {
      // Task-specific options go here.
    },
    your_target: {
      // Target-specific file lists and/or options go here.
    },
  },
});

Options

raml_cop only has one option, and that is the list of files to validate. It can be specified globally, or per target and behaves similarly to how most files are specified to grunt tasks:

'raml_cop': {
	test: {
		files: [{
			expand: true,
			src: ['src/api.raml']
		}]
	}
}

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.