[![npm][npm]][npm-url] [![node][node]][node-url] [![deps][deps]][deps-url] [![tests][tests]][tests-url] [![chat][chat]][chat-url]
A Stylelint plugin for webpack
This module requires a minimum of Node v6.9.0 and webpack v4.0.0.
Both stylelint-loader and this module have their uses. stylelint-loader lints the files you require (or the ones you define as an entry in your webpack config). However, @imports in files are not followed, meaning only the main file for each require/entry is linted.
stylelint-webpack-plugin allows defining a glob pattern) matching the configuration and use of stylelint.
To begin, you'll need to install stylelint-webpack-plugin:
$ npm install stylelint-webpack-plugin --save-dev
Then add the plugin to your webpack config. For example:
file.ext
import file from 'file.ext';
// webpack.config.js
const StyleLintPlugin = require('stylelint-webpack-plugin');
module.exports = {
// ...
plugins: [
new StyleLintPlugin(options),
],
// ...
}
And run webpack via your preferred method.
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 via cosmiconfig.
context Type: String Default: compiler.context
A String indicating the root of your SCSS files.
emitErrors Type: Boolean Default: true
If true, pipes stylelint error severity messages to the webpack compiler's error message handler.
Note: When this property is disabled all stylelint messages are piped to the webpack compiler's warning message handler.
failOnError Type: Boolean Default: false
If true, throws a fatal error in the global build process. This will end the build process on any stylelint error.
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: Object Default: require('stylelint').formatters.string
Specify a custom formatter to format errors printed to the console.
lintDirtyModulesOnly Type: Boolean Default: false
Lint only changed files, skip lint on start.
syntax Type: String Default: undefined
See the styelint user guide for more info. e.g. use 'scss' to lint .scss files.
By default the plugin will dump full reporting of errors. Set failOnError to true if you want webpack build process breaking with any stylelint error. You can use the quiet option to avoid error output to the console.
This project was inspired by, and is a heavily modified version of sasslint-webpack-plugin.
Thanks to Javier (@vieron) for authoring this plugin.
© JS Foundation and other contributors
Licensed under the Creative Commons Attribution License 4.0.
https://webpack.js.org/plugins/stylelint-webpack-plugin