Stylelint

Make sure you have Node.js on your computer.

Make sure a local Node.js interpreter is configured in your project: open the Settings dialog (Ctrl+Alt+S) and go to Languages & Frameworks | Node.js. The Node interpreter field shows the default project Node.js interpreter.

Learn more from Configuring a local Node.js interpreter.

To activate Stylelint, open the Settings dialog (Ctrl+Alt+S), go to Languages & Frameworks | Style Sheets | Stylelint, and select the Enable checkbox. After that the controls in the dialog become available.

In the Stylelint Package field, specify the location of the stylelint package installed globally or in the current project. If you followed the standard installation procedure, PyCharm detects the package automaticaly.

In the Run for files field, specify the pattern that defines the set of files to be linted. By default, StyleLint processes only plain CSS files therefore the default pattern is {**/*,*}.{css}.

To lint files of other types or files stored in specific folders, use glob patterns to update the default pattern. To lint files of other types also use custom configs as described in Lint stylesheets different from CSS below.

note

The Process JS files checkbox is no longer on the page. However, if you selected it in previous versions of PyCharm, this setting is reflected in the default pattern as follows:

{**/*,*}.{css,js}

• For example, to lint HTML, Vue, SCSS, Styled Components, JavaScript, TypeScript, JSX, and TSX as well, update the default pattern as follows:

  {**/*,*}.{html,vue,css,scss,js,ts,jsx,tsx}

• To lint files from a specific folder, replace {**/*,*} with <path to the folder>*.

  Suppose, you have a project with the following structure:

  

  To lint CSS and SCSS files only in the styles folder, update the pattern as follows:

  styles/*.{css,scss}

  As a result, the files styles.css and lint_scss.scss will be linted while no_lint_scss.scss will not.

Optionally:

In the Configuration file field, specify the location of your configuration file.

By default, the field is empty and PyCharm uses the Stylelint native mechanism to detect configurations automatically. With this auto-detection mode, Stylelint goes up the folder structure and looks for configurations defined in one of the following ways:

• Through a stylelint property in a package.json file.

• In a .stylelintrc.json, .stylelintrc.yaml, .stylelintrc.yml, or .stylelintrc.js file.

• In a stylelint.config.js file that exports a JavaScript object.

• In a stylelint.config.cjs file that exports a JavaScript object. When running Stylelint in JavaScript, packages with the "type":"module" property in their package.json.

Learn more from the Stylelint official website.

To use a custom configuration file, click in the Configuration file field and select the path to the required configuration file in the dialog that opens.

Install stylelint together with the appropriate shared config depending on the stylesheet you want to lint, for example, SCSS:

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

Learn more about available shared configs from the Stylelint official website.

Open your Stylelint configuration file and add an extends field with the following contents:

{
    "extends": "<shared config>"
}

For example:

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