https://github.com/mmorga/grunt-raml-cop
Grunt plugin for raml-cop
https://github.com/mmorga/grunt-raml-cop
Last synced: 4 months ago
JSON representation
Grunt plugin for raml-cop
- Host: GitHub
- URL: https://github.com/mmorga/grunt-raml-cop
- Owner: mmorga
- License: apache-2.0
- Created: 2015-07-31T19:35:51.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2017-03-20T18:16:12.000Z (about 9 years ago)
- Last Synced: 2025-10-02T04:25:16.680Z (9 months ago)
- Language: JavaScript
- Size: 11.7 KB
- Stars: 0
- Watchers: 1
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE-Apache-2.0
Awesome Lists containing this project
README
# grunt-raml-cop
> Grunt plugin for RAML Cop.
## Getting Started
This plugin requires Grunt `~0.4.5`
If you haven't used [Grunt](http://gruntjs.com/) before, be sure to check out
the [Getting Started](http://gruntjs.com/getting-started) guide, as it explains
how to create a [Gruntfile](http://gruntjs.com/sample-gruntfile) as well as
install and use Grunt plugins. Once you're familiar with that process, you may
install this plugin with this command:
```shell
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:
```js
grunt.loadNpmTasks('grunt-raml-cop');
```
Alternatively, you can use the
[load-grunt-tasks](https://www.npmjs.com/package/load-grunt-tasks)
npm module to automatically load tasks like so:
```js
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()`.
```js
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:
```js
'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](http://gruntjs.com/).