gulp-coffeelint

gulp-coffeelint

CoffeeLint plugin for gulp 3.

Usage

First, install gulp-coffeelint as a development dependency:

npm install --save-dev gulp-coffeelint

Then, add it to your gulpfile.js:

var gulp = require('gulp');
var coffeelint = require('gulp-coffeelint');

gulp.task('lint', function () {
    gulp.src('./src/*.coffee')
        .pipe(coffeelint())
        .pipe(coffeelint.reporter()) // Using `coffeelint-stylish` reporter https://npmjs.org/package/coffeelint-stylish
});

API

coffeelint([optFile,] [opt,] [literate,] [rules])

All arguments are optional. By default gulp-coffeelint will walk up the directory tree looking for a coffeelint.json (per file, i.e. dirname) or a package.json that has a coffeelintConfig object (as the cli does). Also, .litcoffee and .coffee.md files will be treated as Literate CoffeeScript.

optFile

Type: String

Absolute path of a json file containing options for coffeelint.

opt

Type: Object

Options you wish to send to coffeelint. If optFile is given, this will be ignored.

literate

Type: Boolean

Are we dealing with Literate CoffeeScript?

rules

Type: Array[Function] Default: []

Add custom rules to coffeelint.

Results

Adds the following properties to the file object:

file.coffeelint.success = true; // or false
file.coffeelint.errorCount = 0; // number of errors returned by `coffeelint`
file.coffeelint.warningCount = 0; // number of warnings returned by `coffeelint`
file.coffeelint.results = []; // `coffeelint` results, see http://www.coffeelint.org/#api
file.coffeelint.opt = {}; // the options use by `coffeelint`
file.coffeelint.literate = false; // you guessed it

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 gulp and npm-test. Plus, make sure to adhere to these commit message conventions.

License

MIT License © Jan Raasch

Changelog

0.2.1 (2014-02-09)

Maintenance

• update dependencies