stylelint-prettier

What is stylelint-prettier?

The stylelint-prettier package integrates Prettier with Stylelint, allowing you to use Prettier as a Stylelint rule. This ensures that your styles are formatted according to Prettier's rules while also being linted by Stylelint.

What are stylelint-prettier's main functionalities?

Integrate Prettier with Stylelint

This configuration in your .stylelintrc file extends the recommended settings for integrating Prettier with Stylelint. It ensures that your styles are formatted according to Prettier's rules and also linted by Stylelint.

{
  "extends": [
    "stylelint-prettier/recommended"
  ]
}

Run Prettier as a Stylelint rule

This configuration in your .stylelintrc file sets up Prettier as a Stylelint rule. You can customize Prettier's options, such as using single quotes and adding trailing commas, directly within your Stylelint configuration.

{
  "rules": {
    "prettier/prettier": [
      true,
      {
        "singleQuote": true,
        "trailingComma": "all"
      }
    ]
  }
}

Other packages similar to stylelint-prettier

eslint-plugin-prettier

eslint-plugin-prettier integrates Prettier with ESLint, allowing you to use Prettier as an ESLint rule. This package is similar to stylelint-prettier but is used for JavaScript and other languages supported by ESLint instead of CSS.

stylelint-config-prettier

stylelint-config-prettier is a configuration package that turns off all Stylelint rules that are unnecessary or might conflict with Prettier. Unlike stylelint-prettier, it does not run Prettier as a Stylelint rule but ensures that the two tools do not conflict.

README

stylelint-prettier

Runs Prettier as a Stylelint rule and reports differences as individual Stylelint issues.

Sample

Given the input file style.css:

.insert {
  display: block
}

.alter:after {color: red; content: 'example'}

.delete {
  display: block;;
}

Running ./node_modules/.bin/stylelint style.css shall output:

style.css
 2:17  ✖  Insert ";"                                          prettier/prettier
 5:15  ✖  Replace "color:·red;·content:·'example'" with       prettier/prettier
          "⏎··color:·red;⏎··content:·"example";⏎"
 8:17  ✖  Delete ";"                                          prettier/prettier

Installation

npm install --save-dev stylelint-prettier prettier

stylelint-prettier does not install Prettier or Stylelint for you. You must install these yourself.

Then, in your .stylelintrc:

{
  "plugins": ["stylelint-prettier"],
  "rules": {
    "prettier/prettier": true
  }
}

Alternatively you can extend from the stylelint-prettier/recommended config, which does the same thing:

{
  "extends": ["stylelint-prettier/recommended"]
}

Disabling rules that may conflict with Prettier

As of Stylelint v15, Stylelint deprecated all stylistic rules that conflict with prettier, and removed these rules in Stylelint v16. If you are using Stylelint v15 or above and are not using any of these deprecated rules then you do not need to do anything extra; this section does not apply to you.

If you are using Stylelint's stylistic rules, then many of them shall conflict with Prettier. This plugin works best if you disable all other Stylelint rules relating to stylistic opinions. If another active Stylelint rule disagrees with prettier about how code should be formatted, it will be impossible to avoid lint errors. You should use stylelint-config-prettier to disable all stylistic Stylelint rules.

To integrate this plugin with stylelint-config-prettier:

1. In addition to the above installation instructions, install stylelint-config-prettier:

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

2. Then add stylelint-config-prettier to the list of extended configs in your .stylelintrc that you added in the prior section. stylelint-config-prettier should go last in the array so that it will override other configs:

   {
     "extends": [
       "stylelint-prettier/recommended"
       "stylelint-config-prettier"
     ]
   }
   

You can then set Prettier's own options inside a .prettierrc file.

Options

stylelint-prettier will honor your .prettierrc file by default. You only need this section if you wish to override those settings.

Note: While it is possible to pass options to Prettier via your Stylelint configuration file, it is not recommended because editor extensions such as prettier-atom and prettier-vscode will read .prettierrc, but won't read settings from Stylelint, which can lead to an inconsistent experience.

Objects are passed directly to Prettier as options. Example:

{
  "rules": {
    "prettier/prettier": [true, {"singleQuote": true, "tabWidth": 4}]
  }
}

NB: This option will merge and override any config set with .prettierrc files (for Prettier < 1.7.0, config files are ignored)

---

Contributing

See CONTRIBUTING.md

Inspiration

The layout for this codebase and base configuration of prettier was taken from https://github.com/prettier/eslint-plugin-prettier

Changelog

5.0.0 (2023-12-10)

Increase the minimum required versions of stylelintand node. Stylelint v16 has converted its codebase to esm and has deprecated its commonjs apis. We've followed their suggested migration guide and stylelint-prettier is now an esm-only package. This has required dropping support for v15 at the same time.

• Minimum stylelint version is now v16 (drop support for v15.x)
• Minimum node requirements is now >=18.12.0 (drop support for v14.x and v16.x)