StylelintWebpackPlugin
[![npm][npm]][npm-url] [![node][node]][node-url] [![deps][deps]][deps-url] [![tests][tests]][tests-url] [![coverage][cover]][cover-url] [![chat][chat]][chat-url] [![size][size]][size-url]
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
You can pass stylelint options.
context
- Type:
String - Default:
compiler.context
A string indicating the root of your files.
files
- Type:
String|Array[String] - Default:
'**/*.s?(a|c)ss'
Specify the glob pattern for finding files. Must be relative to options.context.
formatter
- Type:
Function - Default:
require('stylelint').formatters.string
Specify the formatter that you would like to use to format your results.
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.