Adorade Stylelint Config

An opinionated Stylelint config used by Adorade across our projects.

Installation

npm install @adorade/stylelint-config --save-dev
# Or with yarn:
yarn add @adorade/stylelint-config --dev

Usage

We provide a single config that covers both CSS and SCSS. It will automatically apply SCSS rules to files ending in .scss.

You simply have to extend this config in your stylelint.config.js:

/** @type {import('stylelint').Config} */
export default {
  extends: [ '@adorade/stylelint-config' ]
  rules: { 
    // stylelint rules
    // stylelistic rules
  },
  overrides: [
    {
      files: "**/*.scss",
      rules: { 
        // scss plugin rules
      }
    }
  ]
}

Documentation

This config extends the shared config:

• stylelint-config-standard-scss: The standard shareable SCSS config for Stylelint.
  • stylelint-config-standard: The standard shareable config for Stylelint.
  • stylelint-config-recommended-scss: The recommended shareable SCSS config for Stylelint.
    • stylelint-config-recommended: The recommended shareable config for Stylelint.
    • bundles the stylelint-scss plugin pack: A collection of SCSS specific linting rules for stylelint.
    • bundles the postcss-scss custom syntax: A SCSS parser for PostCSS.
• stylelint-codeguide: The stylistic shareable config for Stylelint.
• stylelint-order: Order-related linting rules for stylelint. Properties must be sorted according to this list.

To see the rules that this config uses, please read the config itself.

License

Released under the MIT License.