StylelintWebpackPlugin

A Stylelint plugin for webpack

Install

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

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

npm install stylelint --save-dev

Usage

In your webpack configuration:

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

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

Options

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

configFile

• Type: String
• Default: undefined

Specify the config file location to be used by stylelint.

Note: By default this is handled by stylelint.

context

• Type: String
• Default: compiler.context

A string indicating the root of your files.

files

• Type: String|Array[String]
• Default: '**/*.(s(c|a)ss|css)'

Specify the glob pattern for finding files. Must be relative to options.context.

fix

• Type: 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: String|Function
• Default: 'string'

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

lintDirtyModulesOnly

• Type: Boolean
• Default: false

Lint only changed files, skip lint on start.

stylelintPath

• Type: String
• Default: stylelint

Path to stylelint instance that will be used for linting.

Errors and Warning

By default the plugin will auto adjust error reporting depending on stylelint errors/warnings counts. You can still force this behavior by using emitError or emitWarning options:

emitError

• Type: Boolean
• Default: false

Will always return errors, if set to true.

emitWarning

• Type: Boolean
• Default: false

Will always return warnings, if set to true.

failOnError

• Type: Boolean
• Default: false

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

failOnWarning

• Type: Boolean
• Default: false

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

quiet

• Type: Boolean
• Default: false

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

Changelog

Changelog

License

MIT