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 wil 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; // or false
file.csslint.errorCount = 0; // number of errors returned by CSSLint
file.csslint.results = []; // CSSLint errors
file.csslint.opt = {}; // The options you passed to CSSLint

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));
});

Custom Rules

The plugin exposes the csslint addRule method which allows you to define custom rules that are run in addition to the included rules. Creating your own rules works exactly like when using csslint directly.

var csslint = require(‘gulp-csslint’);

csslint.addRule({
	// rule object
});

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()) // Display errors
    .pipe(csslint.failReporter()); // Fail on error
});