grunt-jscs
A grunt task for running js-codesniffer validator
Getting Started
This plugin requires Grunt ~0.4.1
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-jscs --save-dev
Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:
grunt.loadNpmTasks( "grunt-contrib-jscs" );
The "jscs" task
Overview
In your project's Gruntfile, add a section named jscs
to the data object passed into grunt.initConfig()
.
grunt.initConfig({
jscs: {
all: {
options: {
// Task-specific options go here.
},
files: {
src: [ "" ] // Target-specific file/directory goes here.
}
}
}
})
Options
options.standard
Type: String
Default Idiomatic
- apply specified standard (Idiomatic, Jquery)
options.report
Type: String
Default 'Undefined'
xml for printing an XML report checkstyle for printing Jenkins-friendly checkstyle report
options.report-file
Type: String
Default 'Undefined'
- write the report to the specified file path
Usage Examples
Default Options
grunt.initConfig({
jscs: {
all: {
options: {
"standard": "Jquery"
},
files: {
src: [ "tasks" ]
}
}
}
});
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.