Noisy Pillaging Monster

    gulp-coffeelint-cjsx

    0.0.3 • Public • Published

    gulp-coffeelint Build Status Coverage Status NPM version

    Dependency Status devDependency Status Pretty Stylish

    CoffeeLint plugin for gulp 3.

    Usage

    First, install gulp-coffeelint-cjsx as a development dependency:

    npm install --save-dev gulp-coffeelint-cjsx

    Then, add it to your gulpfile.js:

    var gulp = require('gulp');
    var coffeelint = require('gulp-coffeelint-cjsx');
     
    gulp.task('lint', function () {
        gulp.src('./src/*.coffee')
            .pipe(coffeelint())
            .pipe(coffeelint.reporter())
    });

    API

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

    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.

    cjsx

    Type: Boolean

    Should we use coffeelint-cjsx instead of coffeelint?

    Results

    Adds the following properties to the file object:

    file.coffeelint.success = true; // if no errors were found, false otherwise
    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 used by `coffeelint`
    file.coffeelint.literate = false; // you guessed it

    Reporters

    coffeelint.reporter(name)

    Assuming you would like to make use of those pretty results we have after piping through coffeelint() there are some bundled reporters at your service.

    name

    Type: String Default: 'default' Possible Values: 'default', 'fail', 'failOnWarning'

    • The 'default' reporter uses coffeelint-stylish to output a pretty report to the console. See usage example above.

    • If you would like your stream to emit an error (e.g. to fail the build on a CI server) when errors are found, use the 'fail' reporter.

    • If you want it to throw an error on both warnings and errors, use the 'failOnWarning' reporter

    This example will log errors and warnings using the coffeelint-stylish reporter, then fail if coffeelint was not a success.

      .pipe(coffeelint())
      .pipe(coffeelint.reporter())
      .pipe(coffeelint.reporter('fail'))
    

    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

    Install

    npm i gulp-coffeelint-cjsx

    DownloadsWeekly Downloads

    1

    Version

    0.0.3

    License

    MIT

    Last publish

    Collaborators

    • darryl-snow