README.md

stylelint-config-scss

Shareable Stylelint configuration for SCSS syntax Sass files.

Installation

npm install --save-dev @cargosense/stylelint-config-scss

Usage

Stylelint supports a variety of configuration file formats.

Tip

We recommend using a configuration file named stylelint.config.js using either ECMAScript module (ESM) or CommonJS module syntax.

YAML

In a file named .stylelintrc or .stylelintrc.yml:

---
extends: "@cargosense/stylelint-config-scss"
---

JSON

In a file named .stylelintrc or .stylelintrc.json:

{
  "extends": "@cargosense/stylelint-config-scss"
}

JavaScript

In a JavaScript file using ESM syntax:

// stylelint.config.mjs
export { default } from "@cargosense/stylelint-config-scss";

// or…
import config from "@cargosense/stylelint-config-scss";

export default {
  extends: [config]
};

In a JavaScript file using CommonJS module syntax:

// stylelint.config.cjs
module.exports = {
  extends: ["@cargosense/stylelint-config-scss"]
}

License

stylelint-config-scss is freely available under the MIT License.