gulp-sass-lint

library1.4.0jsnpmunverified

Gulp plugin for Sass Lint that lints SCSS/SASS files during a Gulp build. Current stable version is 1.4.0, with last release in 2017. It wraps sass-lint and provides Gulp-compatible streaming, formatting, and fail-on-error functionality. Key differentiators: integrates directly into Gulp pipelines, supports custom config files, inline rule disabling via source comments. Compared to stylelint or gulp-stylelint, it is specific to Sass (not PostCSS) and relies on the older sass-lint, which is no longer maintained. Release cadence: low/inactive.

devops

npm install gulp-sass-lint

github ↗package ↗

INSTALL

IMPORT

SIG · GULP-SASS-LINT

gulp-sass-lint

devopsjavascriptv1.4.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.

sassLint

✓ import sassLint from 'gulp-sass-lint'

✗ const sassLint = require('gulp-sass-lint').default;

Default export is the plugin function. In CommonJS, simply require('gulp-sass-lint').

sassLint.format

✓ sassLint.format()

✗ sassLint.format(writable)

format optionally accepts a writable stream; no argument uses stdout.

sassLint.failOnError

✓ sassLint.failOnError()

Fail the task if any linting error is found.

Sets up a Gulp task to lint all SCSS files, format output, and fail on lint errors.

import gulp from 'gulp'; import sassLint from 'gulp-sass-lint'; export default function lint() { return gulp.src('sass/**/*.scss') .pipe(sassLint()) .pipe(sassLint.format()) .pipe(sassLint.failOnError()); }

Debug

Known issues

deprecatedsass-lint is deprecated in favor of stylelint with scss plugin.

fix

Migrate to stylelint + @stylistic/stylelint-scss or sass-lint-auto-fix.

affects: >=1.4.0

gotchaOptions object nesting: rules must be inside top-level 'rules', not under 'options.rules'.

fix

Pass rules at top level: sassLint({ rules: { 'no-ids': 1 } })

affects: >=1.3.0

gotchaConfig file format: .sass-lint.yml is expected, not .sasslintrc or JSON.

fix

Create a .sass-lint.yml file in project root or specify configFile path.

affects: >=1.0.0

breakingNode.js version support: dropped support for Node <4 in v1.3.0.

fix

Use Node.js >=4 or stick to v1.2.x.

affects: >=1.3.0

Errors

Common errors & fixes

TypeError: gulpSassLint is not a function

Using ES import incorrectly expecting named export.

fix

Use default import: import sassLint from 'gulp-sass-lint'

Cannot find module 'sass-lint'

Missing peer dependency sass-lint.

fix

npm install sass-lint --save-dev

Error: Invalid config file format

Config file is not valid YAML or missing required keys.

fix

Ensure .sass-lint.yml is valid and follows sass-lint config spec.

Upgrade

Version history

1.4.0latest on npm

Audit

Dependencies

sass-lintrequiredCore linting engine for SCSS/SASS

gulprequiredPeer dependency required for Gulp plugin interface

Agent activity

4 hits · last 30 days

node

Resources

githubhttps://github.com/sasstools/gulp-sass-lint ↗

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