JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 995
  • Score
    100M100P100Q106545F
  • License MIT

Lint your CoffeeScript using gulp and CoffeeLint

Package Exports

  • gulp-coffeelint

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (gulp-coffeelint) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

gulp-coffeelint Build Status NPM version

Dependency Status devDependency Status

CoffeeLint plugin for gulp

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

Options coffeelint(opt, literate, rules)

opt

Type: String or Object Default: null

By default it 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). You may also pass in options you wish to send to coffeelint (see http://www.coffeelint.org/#options) directly or you may enter the absolute path of a .json file containing such a configuration object.

literate

Type: Boolean Default: false

Are we dealing with literate CoffeeScript here?

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 returns by `coffeelint`
file.coffeelint.results = []; // `coffeelint` results, see http://www.coffeelint.org/#api
file.coffeelint.opt = {}; // The options you passed to `coffeelint`
file.coffeelint.literate = false; // Again, this is your doing...

License

MIT License © Jan Raasch