stylelint-config-superology-scss

Shared Stylelint & Prettier config for SCSS based projects at Superology.

Extends stylelint-config-recommended and stylelint-config-recommended-scss.

Turns on additional rules to enforce common conventions found in the specifications and in a handful of CSS styleguides, including: The Idiomatic CSS Principles, Google's CSS Style Guide, Airbnb's Styleguide, and @mdo's Code Guide.

It favours flexibility over strictness for things like multi-line lists and single-line rulesets.

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

Usage

Install the configuration

npm install stylelint-config-superology-scss --save-dev

Also make sure you have peer dependencies installed:

npm install stylelint prettier --save-dev

Add to Stylelint configuration

{
  "extends": "stylelint-config-superology-scss"
}

Using .stylelintrc file

or

module.exports = {
  extends: "stylelint-config-superology-scss",
};

if using .stylelintrc.js file

Suggestions?

Create a discussion on GitHub or learn how to make a contribution.