readme.md

stylelint-config-prettier

Note
As of Stylelint v15 all style-related rules have been deprecated. If you are using v15 or higher and are not making use of these deprecated rules, this plugin is no longer necessary.

Turns off all rules that are unnecessary or might conflict with Prettier. This lets you use your favorite shareable config without letting its stylistic choices get in the way when using Prettier.

Installation

Install stylelint-config-prettier:

npm install --save-dev stylelint-config-prettier

Then, append stylelint-config-prettier to the extends array in your .stylelintrc.* file. Make sure to put it last, so it will override other configs.

{
  "extends": [
    // other configs ...
    "stylelint-config-prettier"
  ]
}

CLI helper tool

stylelint-config-prettier is shipped with a little CLI tool to help you check if your configuration contains any rules that are in conflict with Prettier.

In order to execute the CLI tool, first add a script for it to package.json:

{
  "scripts": {
    "stylelint-check": "stylelint-config-prettier-check"
  }
}

Then run npm run stylelint-check.

Attribution

• Inspired by eslint-config-prettier.
• CLI helper inspired by tslint-config-prettier.
• Original disabled ruleset copied from prettier-stylelint.

---

MIT