stylelint-webpack-plugin

This version of stylelint-webpack-plugin only works with webpack 5. For webpack 4, see the 2.x branch.

This plugin uses stylelint, which helps you avoid errors and enforce conventions in your styles.

Getting Started

To begin, you'll need to install stylelint-webpack-plugin:

npm install stylelint-webpack-plugin --save-dev

or

yarn add -D stylelint-webpack-plugin

or

pnpm add -D stylelint-webpack-plugin

Note

You also need to install stylelint >= 13 from npm, if you haven't already:

npm install stylelint --save-dev

or

yarn add -D stylelint

or

pnpm add -D stylelint

Note

If you are using Stylelint 13 rather than 14+, you might also need to install @types/stylelint as a dev dependency if you encounter Stylelint-related type errors.

Then add the plugin to your webpack configuration. For example:

const StylelintPlugin = require("stylelint-webpack-plugin");

module.exports = {
  // ...
  plugins: [new StylelintPlugin(options)],
  // ...
};

Options

See stylelint's options for the complete list of available options . These options are passed directly to stylelint.

cache

• Type:

type cache = boolean;

• Default: true

The cache is enabled by default to decrease execution time.

cacheLocation

• Type:

type cacheLocation = string;

• Default: node_modules/.cache/stylelint-webpack-plugin/.stylelintcache

Specify the path to the cache location. This can be a file or a directory.

configFile

• Type:

type context = string;

• Default: undefined

Specify the config file location to be used by stylelint.

Note:

By default this is handled by stylelint.

context

• Type:

type context = string;

• Default: compiler.context

A string indicating the root of your files.

exclude

• Type:

type exclude = string | string[];

• Default: ['node_modules', compiler.options.output.path]

Specify the files and/or directories to exclude. Must be relative to options.context.

extensions

• Type:

type extensions = string | string[];

• Default: ['css', 'scss', 'sass']

Specify the extensions that should be checked.

files

• Type:

type files = string | string[];

• Default: null

Specify directories, files, or globs. Must be relative to options.context. Directories are traversed recursively, looking for files matching options.extensions. File and glob patterns ignore options.extensions.

fix

• Type:

type fix = boolean;

• Default: false

If true, stylelint will fix as many errors as possible. The fixes are made to the actual source files. All unfixed errors will be reported. See Autofixing errors docs.

formatter

• Type:

type formatter =
  | string
  | ((results: import("stylelint").LintResult[]) => string);

• Default: 'string'

Specify the formatter you would like to use to format your results. See the formatter option.

lintDirtyModulesOnly

• Type:

type lintDirtyModulesOnly = boolean;

• Default: false

Lint only changed files; skip linting on start.

stylelintPath

• Type:

type stylelintPath = string;

• Default: stylelint

Path to stylelint instance that will be used for linting.

threads

• Type:

type threads = boolean | number;

• Default: false

Set to true for an auto-selected pool size based on number of CPUs. Set to a number greater than 1 to set an explicit pool size.

Set to false, 1, or less to disable and run only in main process.

Errors and Warning

By default, the plugin will automatically adjust error reporting depending on the number of Stylelint errors/warnings.

You can still force this behavior by using the emitError or emitWarning options:

emitError

• Type:

type emitError = boolean;

• Default: true

The errors found will always be emitted. To disable, set to false.

emitWarning

• Type:

type emitWarning = boolean;

• Default: true

The warnings found will always be emitted. To disable, set to false.

failOnError

• Type:

type failOnError = boolean;

• Default: true

Will cause the module build to fail if there are any errors. To disable, set to false.

failOnWarning

• Type:

type failOnWarning = boolean;

• Default: false

Will cause the module build to fail if there are any warnings, when set to true.

quiet

• Type:

type quiet = boolean;

• Default: false

Will process and report errors only, and ignore warnings, when set to true.

outputReport

• Type:

type outputReport =
  | boolean
  | {
      filePath?: string | undefined;
      formatter?:
        | (string | ((results: import("stylelint").LintResult[]) => string))
        | undefined;
    };

• Default: false

Writes the output of the errors to a file - for example, a json file for use for reporting.

The filePath is relative to the webpack config: output.path.

You can pass in a different formatter for the output file. If none is passed in the default/configured formatter will be used.

const outputReport = {
  filePath: "path/to/file",
  formatter: "json",
};

Changelog

Changelog

Contributing

We welcome all contributions! If you're new here, please take a moment to review our contributing guidelines before submitting issues or pull requests.

CONTRIBUTING

License

MIT