Extension to allow custom rules for CSSLint to be defined and loaded
npm install grunt-csslint-plus>= 0.4.0`
- 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-contrib-csslint --save-dev
npm install grunt-csslint-plus --save-dev
`
Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:
`javascript
grunt.loadNpmTasks('grunt-contrib-csslint');
grunt.loadNpmTasks('grunt-csslint-plus');
`
__N.B.__ since grunt-csslint-plus is an extension of grunt-contrib-css, _both_ packages _must_ be installed for it to work!Options
To include your own custom rules for csslinting, you must provide an array of directories containing rules in the following way:`javascript
csslint_plus: {
rules: [
'node_modules/grunt-csslint-plus/examples/*.js'
]
}
`
Two example rules are provided in the node moduleCsslint Setup
Since this package is an _extension_ of Grunt CSSLint, this package needs to be set up as well. You can find installation instructions here.Or, add the following to your
gruntfile.js`javascript
csslint: {
strict: {
options: {
import: 2
},
src: ['.../*/.css']
}
},
`Csslint Plus Task
Run this task with grunt csslint_plus command$3
To define your own custom css rules, you must provide rules in the following example format:
`javascript
var rule = {
id: "example_id",
name: "example_rule_name",
desc: "description of rule",
init: function(parser, reporter) {
var rule = this;
parser.addListener("startRule", function(evt) { ... } ), # example listeners
parser.addListener("endRule", function(evt) { ... } ) # another example listener
}
}exports.Rule = rule
``Probably the best way to get documentation is to look through the rules available in csslint as there are a lot more listeners.