gulp-scss-lint

library1.0.0jsnpmunverified

Gulp plugin to validate .scss files using the Ruby-based scss-lint tool, wrapping it into a Gulp pipeline for linting SCSS stylesheets. Version 1.0.0, last updated 2016, with no recent releases. Works with Node >= 0.10 and requires Ruby and scss_lint gem installed separately. Offers options for config file, bundle exec, reporter output, maxBuffer, and endless mode for watch. Deprecated in favor of sass-lint or stylelint, as scss-lint is no longer maintained by its original authors. Release cadence: single stable release. Key differentiator vs JavaScript-based linters: leverages Ruby scss-lint's rule set.

testing

npm install gulp-scss-lint

github ↗package ↗

INSTALL

IMPORT

SIG · GULP-SCSS-LINT

gulp-scss-lint

testingjavascriptv1.0.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.

default

✓ import scsslint from 'gulp-scss-lint'

✗ const scsslint = require('gulp-scss-lint')

ESM import style – but the package is CommonJS, require() also works; no named exports.

scsslint

✓ const scsslint = require('gulp-scss-lint');

✗ import { scsslint } from 'gulp-scss-lint';

CommonJS require is the only supported pattern. Named import will fail.

gulp.task

✓ gulp.task('lint', function() { return gulp.src('*.scss').pipe(scsslint()); });

✗ gulp.task('lint', () => gulp.src('*.scss').pipe(scsslint()));

Must return the stream for Gulp to handle async correctly; arrow functions work but the stream must be returned.

Creates a Gulp task that lints all .scss files in src/, using a custom config file and outputting a JSON report.

const gulp = require('gulp'); const scsslint = require('gulp-scss-lint'); gulp.task('scss-lint', function() { return gulp.src('src/**/*.scss') .pipe(scsslint({ config: '.scss-lint.yml', bundleExec: false, reporterOutput: 'scssReport.json', maxBuffer: 307200 })); }); gulp.task('default', gulp.series('scss-lint'));

Debug

Known issues

deprecatedscss-lint (Ruby gem) is deprecated; its official repository archived in 2019. gulp-scss-lint is no longer maintained.

fix

Migrate to a JavaScript-based linter like stylelint with scss plugin or sass-lint.

affects: >=1.0.0

gotchaRequires Ruby and the scss_lint gem installed globally. Missing dependency leads to silent failures or 'command not found' errors.

fix

Install Ruby and run `gem install scss_lint` before using this plugin.

affects: >=0.0.1

gotchaThe plugin does not support Node.js versions above 0.10 officially; may break on modern Node (>=12).

fix

Use a child_process polyfill or update plugin; consider migrating to sass-lint.

affects: >=1.0.0

gotchamaxBuffer default is 300*1024 bytes; if you hit 'maxBuffer exceeded', the error is not descriptive.

fix

Increase maxBuffer option (e.g., 307200) in scsslint() config.

affects: >=1.0.0

Errors

Common errors & fixes

Error: spawn scss-lint ENOENT

scss-lint Ruby gem not installed or not found in PATH.

fix

Install scss-lint: `gem install scss_lint` and ensure Ruby is in PATH.

throw new Error('scss-lint output buffer exceeded')

Default maxBuffer (300*1024) insufficient for large lint output.

fix

Add `maxBuffer: 307200` to the scsslint() options (or higher).

TypeError: scsslint is not a function

Using ES6 import syntax with named import instead of default import or require.

fix

Use `const scsslint = require('gulp-scss-lint');` or `import scsslint from 'gulp-scss-lint';`

Upgrade

Version history

1.0.0latest on npm

Audit

Dependencies

gulpoptionalPeer dependency – requires Gulp to be installed as a plugin

Agent activity

4 hits · last 30 days

node

Resources

githubhttps://github.com/juanfran/gulp-scss-lint ↗

packagehttps://www.npmjs.com/package/gulp-scss-lint ↗