stylelint-config-recommended

stylelint-config-recommended

The recommended shareable config for Stylelint.

It turns on most of the Stylelint rules that help you avoid errors.

You can use this as a foundation for your own config, but we suggest most people use our standard config instead which extends this config and adds a few more rules to enforce common conventions.

Installation

npm install stylelint-config-recommended --save-dev

Usage

Set your stylelint config to:

{
  "extends": "stylelint-config-recommended"
}

Extending the config

Add a "rules" key to your config, then add your overrides and additions there.

For example, to change the at-rule-no-unknown rule to use its ignoreAtRules option, turn off the block-no-empty rule, and add the unit-allowed-list rule:

{
  "extends": "stylelint-config-recommended",
  "rules": {
    "at-rule-no-unknown": [
      true,
      {
        "ignoreAtRules": ["extends"]
      }
    ],
    "block-no-empty": null,
    "unit-allowed-list": ["em", "rem", "s"]
  }
}

Changelog

License

Similar packages

Other packages similar to stylelint-config-recommended

stylelint-config-standard

The stylelint-config-standard package provides a more comprehensive set of rules compared to stylelint-config-recommended. It includes additional rules for stylistic issues and best practices, making it suitable for projects that require stricter code quality enforcement.

stylelint-config-sass-guidelines

The stylelint-config-sass-guidelines package is tailored for Sass projects and follows the guidelines set by Sass Guidelines. It includes rules specific to Sass syntax and best practices, making it a good choice for projects that use Sass.

stylelint-config-prettier

The stylelint-config-prettier package turns off all rules that are unnecessary or might conflict with Prettier, a code formatter. This package is useful if you want to use Stylelint for catching errors and Prettier for formatting.