ember-cli-scss-lint

2.4.1 verified Fri May 01 auth: no javascript maintenance

Ember CLI addon that integrates sass-lint into the build pipeline, automatically linting SCSS files during ember serve, test, or build. Version 2.4.1 is the latest stable release; this package is in maintenance mode and relies on the deprecated sass-lint package (last released in 2018). It requires Ember.js v2.18+, Ember CLI v2.13+, and Node >=10. Differentiates from alternative Ember SCSS linting addons by using the Node.js-based sass-lint (not the Ruby scss-lint) and by being a straightforward drop-in that reads configuration from .sass-lint.yml or ember-cli-build.js.

Common errors

error Cannot find module 'sass-lint' ↓

cause The sass-lint package is missing from node_modules.

fix

Run 'npm install' (or 'yarn') to ensure sass-lint is installed as a transitive dependency.

error No valid configuration file found ↓

cause Missing or misnamed .sass-lint.yml file.

fix

Create a .sass-lint.yml file in the root of your Ember project with proper rules.

error The addon 'ember-cli-scss-lint' requires the ember-cli-babel addon to be installed ↓

cause Missing ember-cli-babel dependency.

fix

Run 'ember install ember-cli-babel' then reinstall this addon.

Warnings

deprecated This addon depends on sass-lint, which is deprecated and no longer maintained (last release 2018). Newer Ember projects should consider using sass-lint's successor, stylelint with stylelint-scss. ↓

fix Migrate to stylelint with stylelint-scss (or use ember-cli-stylelint).

deprecated Node.js 10 is the minimum required; Node 6 and 8 are no longer supported by the addon (engines field says >=10). ↓

fix Ensure your Node.js version is 10 or higher (preferably LTS).

gotcha The sass-lint package (not this addon) has been deprecated in favor of stylelint. This means no new rules or bug fixes will come from the underlying linter. ↓

fix Consider moving to stylelint for SCSS linting; install ember-cli-stylelint and configure accordingly.

deprecated Ember CLI versions before 2.13 are not supported (compatibility says v2.13+). ↓

fix Upgrade your Ember CLI version to at least 2.13.

Install

npm install ember-cli-scss-lint

yarn add ember-cli-scss-lint

pnpm add ember-cli-scss-lint

Imports

ember-cli-scss-lint
wrong
```
npm install --save-dev ember-cli-scss-lint
```
correct
```
ember install ember-cli-scss-lint
```
You must use 'ember install' to ensure the addon is properly registered in the consuming app.

scssLintOptions

wrong

let app = new EmberApp(defaults, { scssLint: { ... } });

correct

let app = new EmberApp(defaults, { scssLintOptions: { ... } });

The configuration key in ember-cli-build.js must be 'scssLintOptions', not 'scssLint'.

.sass-lint.yml

wrong

Create .scss-lint.yml (for Ruby scss-lint) or .eslintrc (this is for JS).

correct

Create a .sass-lint.yml file in the project root.

The configuration file must be named .sass-lint.yml and placed in the root of the Ember project.

Quickstart

Installs the addon, adds a minimal .sass-lint.yml config, and triggers linting during an Ember build.

// Step 1: Install the addon
ember install ember-cli-scss-lint

// Step 2: Create .sass-lint.yml in project root with sample rules:
// files:
//   include: '**/*.scss'
// options:
//   formatter: stylish
//   merge-default-rules: false
// rules:
//   border-zero:
//     - 1
//     - convention: zero

// Step 3: Run ember server – linting will happen automatically on build.
ember serve