Sign Up for Free

RunKit +

Try any Node.js package right in your browser

This is a playground to test code. It runs a full Node.js environment and already has all of npm’s 400,000 packages pre-installed, including gulp-coffeelint-cjsx with all npm packages installed. Try it out:

gulp-coffeelint-cjsx lists no main file and has no index.js, so it can't be directly required. If this is a mistake, please let us know. It may however contain internal files that you can require manually:

// require("gulp-coffeelint-cjsx/[??]")

This service is provided by RunKit and is not affiliated with npm, Inc or the package authors.

gulp-coffeelint-cjsx v0.0.3

Lint your CoffeeScript/CJSX using gulp and CoffeeLint

gulp-coffeelint Build Status Coverage Status NPM version

Dependency Status devDependency Status Pretty Stylish

CoffeeLint plugin for gulp 3.


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 () {


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 files will be treated as Literate CoffeeScript.


Type: String

Absolute path of a json file containing options for coffeelint.


Type: Object

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


Type: Boolean

Are we dealing with Literate CoffeeScript?


Type: Array[Function] Default: []

Add custom rules to coffeelint.


Type: Boolean

Should we use coffeelint-cjsx instead of coffeelint?


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
file.coffeelint.opt = {}; // the options used by `coffeelint`
file.coffeelint.literate = false; // you guessed it



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.


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.



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.


MIT License © Jan Raasch


RunKit is a free, in-browser JavaScript dev environment for prototyping Node.js code, with every npm package installed. Sign up to share your code.
Sign Up for Free