This version ofstylelint-webpack-plugin only works with webpack 5. For webpack 4, see the2.x branch.

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

Getting Started

To begin, you'll need to installstylelint-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 installstylelint >= 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:[newStylelintPlugin(options)],// ...};

Options

Seestylelint's options for the complete list of available options . These options are passed directly tostylelint.

cache

• Type:

typecache=boolean;

• Default:true

The cache is enabled by default to decrease execution time.

cacheLocation

• Type:

typecacheLocation=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:

typecontext=string;

• Default:undefined

Specify the config file location to be used bystylelint.

Note:

By default this ishandled bystylelint.

context

• Type:

typecontext=string;

• Default:compiler.context

A string indicating the root of your files.

exclude

• Type:

typeexclude=string|string[];

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

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

extensions

• Type:

typeextensions=string|string[];

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

Specify the extensions that should be checked.

files

• Type:

typefiles=string|string[];

• Default:null

Specify directories, files, or globs. Must be relative tooptions.context. Directories are traversed recursively, looking for files matchingoptions.extensions. File and glob patterns ignoreoptions.extensions.

fix

• Type:

typefix=boolean;

• Default:false

Iftrue,stylelint will fix as many errors as possible. The fixes are made to the actual source files. All unfixed errors will be reported. SeeAutofixing errors docs.

formatter

• Type:

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

• Default:'string'

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

lintDirtyModulesOnly

• Type:

typelintDirtyModulesOnly=boolean;

• Default:false

Lint only changed files; skip linting on start.

stylelintPath

• Type:

typestylelintPath=string;

• Default:stylelint

Path tostylelint instance that will be used for linting.

threads

• Type:

typethreads=boolean|number;

• Default:false

Set totrue 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 tofalse, 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 theemitErrororemitWarning options:

emitError

• Type:

typeemitError=boolean;

• Default:true

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

emitWarning

• Type:

typeemitWarning=boolean;

• Default:true

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

failOnError

• Type:

typefailOnError=boolean;

• Default:true

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

failOnWarning

• Type:

typefailOnWarning=boolean;

• Default:false

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

quiet

• Type:

typequiet=boolean;

• Default:false

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

outputReport

• Type:

typeoutputReport=|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, ajson file for use for reporting.

ThefilePath 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