gulp-csslint
CSSLint plugin for gulp 3
Usage
First, install gulp-csslint
as a development dependency:
npm install --save-dev gulp-csslint
Then, add it to your gulpfile.js
:
var csslint = require('gulp-csslint');
gulp.task('css', function() {
gulp.src('client/css/*.css')
.pipe(csslint())
.pipe(csslint.reporter());
});
API
csslint(ruleConfiguration)
ruleConfiguration
Type: Object
If you pass lookup: false
, the local .csslintrc is not looked up automatically.
You can pass rule configuration as an object. See the list of rules by ID on the CSSLint wiki for valid rule IDs.
Any properties passed will be in addition to (or overwriting) the ones in .csslintrc (unless lookup: false
is passed).
gulp.src('client/css/*.css')
.pipe(csslint({
'shorthand': false
}))
.pipe(csslint.reporter());
csslint(csslintrc)
csslintrc
Type: String
You can also pass the path to your csslintrc file instead of a rule configuration object.
gulp.src('client/css/*.css')
.pipe(csslint('csslintrc.json'))
.pipe(csslint.reporter());
Results
Adds the following properties to the file object:
file.csslint.success = true;
file.csslint.errorCount = 0;
file.csslint.results = [];
file.csslint.opt = {};
Using reporters
Several reporters come built-in to css-lint. To use one of these reporters, pass the name to csslint.reporter
.
For a list of all reporters supported by csslint
, see the csslint wiki.
gulp.task('lint', function() {
gulp.files('lib/*.css')
.pipe(csslint())
.pipe(csslint.reporter('junit-xml'));
Custom reporters
Custom reporter functions can be passed as csslint.reporter(reporterFunc)
. The reporter function will be called for each linted file and passed the file object as described above.
var csslint = require('gulp-csslint');
var gutil = require('gulp-util');
var customReporter = function(file) {
gutil.log(gutil.colors.cyan(file.csslint.errorCount)+' errors in '+gutil.colors.magenta(file.path));
file.csslint.results.forEach(function(result) {
gutil.log(result.error.message+' on line '+result.error.line);
});
};
gulp.task('lint', function() {
gulp.files('lib/*.css')
.pipe(csslint())
.pipe(csslint.reporter(customReporter));
});
Reporter options
You can also pass options to the built-in formatter, by passing a second option to reporter
.
gulp.task('lint', function() {
gulp.files('lib/*.css')
.pipe(csslint())
.pipe(csslint.reporter('junit-xml', options));
});
See the documentation for the formatters regarding what options they support.
This plugin supports one option outside of that, called logger
, allowing you to specify how to log out the report.
Default is using process.stdout.write
, but you can use e.g. console.log
, or gutil.log
.
gulp.task('lint', function() {
gulp.files('lib/*.css')
.pipe(csslint())
.pipe(csslint.reporter('junit-xml', {logger: console.log.bind(console)}));
});
gulp.task('lint', function() {
gulp.files('lib/*.css')
.pipe(csslint())
.pipe(csslint.reporter('junit-xml', {logger: gutil.log.bind(null, 'gulp-csslint:')}));
});
logger
is called once for the starting format of the reporter, then once for each file containing violations, then
lastly once for the ending format. Instead of writing to stdout
, you can write to file using this option.
gulp.task('lint', function(cb) {
var fs = require('fs');
var output = '';
gulp.files('lib/*.css')
.pipe(csslint())
.pipe(csslint.reporter('junit-xml', {logger: function(str) { output += str; }}));
fs.writeFile('some/path/junit.xml', output, cb);
});
This functionality is only available when not using custom reporters.
Custom rules
Use the csslint.addRule(rule)
method to define custom rules that run in addition to the rules defined in the csslintrc file. See Working with Rules for details.
var csslint = require('gulp-csslint');
csslint.addRule({
});
gulp.task('lint', function() {
gulp.files('lib/*.css')
.pipe(csslint())
.pipe(csslint.reporter())
});
Fail on errors
Pipe the file stream to csslint.failReporter()
to fail on errors.
var csslint = require('gulp-csslint');
gulp.task('lint', function() {
gulp.files('lib/*.css')
.pipe(csslint())
.pipe(csslint.reporter())
.pipe(csslint.reporter('fail'));
});