gulp-scsslint

0.0.5 verified Fri May 01 auth: no javascript abandoned

Gulp plugin wrapping the SCSS-Lint Ruby gem for linting SCSS/Sass files. Latest version is 0.0.5, last published in 2014. No active development since, effectively abandoned. Requires Ruby and the scss-lint gem installed separately. Provides gulp-compatible streaming with configurable reporters. Alternatives include stylelint with scss plugin (more modern, no Ruby dependency).

Common errors

error Error: spawn scss-lint ENOENT ↓

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

fix

Install Ruby and run 'gem install scss-lint'

error TypeError: scsslint is not a function ↓

cause Using ES module import syntax with a CommonJS module.

fix

Use 'const scsslint = require('gulp-scsslint');'

error Error: Cannot find module 'gulp-scsslint' ↓

cause Package not installed or missing from node_modules.

fix

Run 'npm install gulp-scsslint --save-dev'

Warnings

gotcha Requires Ruby and scss-lint gem installed separately. Not installed via npm. ↓

fix Install Ruby and run 'gem install scss-lint'

gotcha No active development since 2014. Consider using stylelint or sass-lint instead. ↓

fix Migrate to stylelint with stylelint-scss plugin

gotcha scss-lint binary may not be found if not in PATH. Use options.bin to specify path. ↓

fix Set options.bin like 'bundle exec scss-lint' or full path

gotcha Passing --exclude via args may cause errors if all files are excluded. ↓

fix Avoid using --exclude; use gulp-filter instead

Install

npm install gulp-scsslint

yarn add gulp-scsslint

pnpm add gulp-scsslint

Imports

gulpScsslint

wrong

import scsslint from 'gulp-scsslint';

correct

const scsslint = require('gulp-scsslint');

CommonJS only; no ES module support.

scsslint()
```
.pipe(scsslint())
```
Call as a function, not as a constructor. Options can be passed as an object or a string path.
scsslint.reporter()
wrong
```
.pipe(scsslint.reporter);
```
correct
```
.pipe(scsslint.reporter());
```
Reporter is a method that returns a transform stream.

Quickstart

Basic gulp task that lints all .scss files using scss-lint and reports results.

const gulp = require('gulp');
const scsslint = require('gulp-scsslint');

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