Registry / devops / gulp-coffeelint

gulp-coffeelint

library0.6.0jsnpmunverified

Gulp plugin for CoffeeLint, version 0.6.0. It lints CoffeeScript files within a gulp pipeline, supporting custom rule files, inline options, literate CoffeeScript, and custom rules. It integrates with CoffeeLint's built-in and external reporters, and includes 'fail' and 'failOnWarning' reporters for task failure. Commonly used in legacy CoffeeScript projects, but no longer actively maintained. Key differentiators: seamless gulp integration, auto-discovery of coffeelint.json config, and per-file result properties.

devops testing

npm install gulp-coffeelint

github ↗package ↗

INSTALL

IMPORT

SIG · GULP-COFFEELINT

gulp-coffeelint

devopsjavascriptv0.6.0

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

gulp-coffeelint

✓ const coffeelint = require('gulp-coffeelint');

✗ import coffeelint from 'gulp-coffeelint';

CommonJS module; ESM not supported.

Sets up a gulp task that lints CoffeeScript files, uses stylish reporter, and fails on error.

const gulp = require('gulp'); const coffeelint = require('gulp-coffeelint'); gulp.task('lint', function() { return gulp.src('./src/*.coffee') .pipe(coffeelint()) .pipe(coffeelint.reporter('coffeelint-stylish')) .pipe(coffeelint.reporter('fail')); });

Debug

Known issues

deprecatedCoffeeScript and CoffeeLint are largely obsolete; consider migrating to JavaScript/TypeScript with ESLint.

fix

Migrate to ESLint or similar.

affects: >=0.1.0

gotchaWhen using 'fail' reporter, ensure the stream is returned from the task, otherwise gulp may not detect failure.

fix

Always return the stream from the gulp task (e.g., 'return gulp.src(...).pipe(...)').

affects: >=0.1.0

gotchaCustom reporters must follow CoffeeLint's reporter interface (constructor and publish method).

fix

Implement a constructor accepting an errorReport and a publish method.

affects: >=0.1.0

Errors

Common errors & fixes

Error: Cannot find module 'coffeelint-stylish'

The default reporter is not installed as a dependency.

fix

Install coffeelint-stylish: npm install --save-dev coffeelint-stylish

TypeError: coffeelint.reporter is not a function

Forgetting to call coffeelint() before .reporter().

fix

Use .pipe(coffeelint().reporter(...)) or .pipe(coffeelint()).pipe(coffeelint.reporter(...))

Error: Failed to load coffeelint config file coffeelint.json

Missing or incorrect config file path.

fix

Create a valid coffeelint.json in your project root or pass optFile option.

Upgrade

Version history

0.6.0latest on npm

Audit

Dependencies

coffeelintrequiredpeer dependency: requires CoffeeLint to be installed

coffeelint-stylishoptionaldefault reporter when none specified

Agent activity

4 hits · last 30 days

node

Resources

githubhttps://github.com/janraasch/gulp-coffeelint ↗

packagehttps://www.npmjs.com/package/gulp-coffeelint ↗