/stylelint-config

Avenga's stylelint rules and config

Primary LanguageJavaScriptMIT LicenseMIT

Avenga's Stylelint Config

npm version contributions welcome Downloads per month

This config extends the stylelint-config-standard-scss shared config and configures its own rules.

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

Installation

Install stylelint and @avenga/stylelint-config:

npm install --save-dev stylelint @avenga/stylelint-config

Usage

stylelint expects a configuration object. If your project already has one, just reference @avenga/stylelint-config with extends.

{
  "extends": "@avenga/stylelint-config"
}

If you need to add a stylelint configuration object to your project, there are different approaches. One popular approach is to add a .stylelintrc.js file to the root of your project.

// .stylelintrc.js

module.exports = {
  extends: '@avenga/stylelint-config',
};

It is possible to overwrite rules to meet your project specific needs.

Stylelint Editor Plugins