stylelint-webpack-plugin v 2.1.0
webpack 的 styleline 插件。
安装
npm install stylelint-webpack-plugin --save-dev
1
当然您还是需要安装stylelint的,如果没有的话:
npm install stylelint --save-dev
1
使用
在您的 webpack 配置中:
const StylelintPlugin = require('stylelint-webpack-plugin');
module.exports = {
// ...
plugins: [new StylelintPlugin(options)],
// ...
};
1
2
3
4
5
6
7
2
3
4
5
6
7
配置项
您可以参见stylelint配置来获取完整的配置。下面这些配置是直接传入stylelint的。
| options属性 | 类型 | 默认值 | 描述 |
|---|---|---|---|
| configFile | String | undefined | 指定stylelint要使用的配置文件位置。默认是由stylelint处理。 |
| context | String | compiler.context | 指定文件根目录的字符串。 |
| files | String|Array[String] | '**/*.s?(a|c)ss' | 指定查找文件的通配符。必须相对于options.context。 |
| fix | Boolean | false | 如果设置为true,stylelint将尽可能修复更多错误。修复是对实际的源文件进行修复。参见自动修复文档 |
| formatter | String|Function | string | 需要格式化时用到的格式,参见格式化配置项。 |
| lintDirtyModulesOnly | Boolean | false | 仅改变文件,并在开始时跳过。 |
| stylelintPath | String | stylelint | 用于检索的stylelint实例路径。 |
报错和警告
默认情况下,插件会根据stylelint错误/警告数目自动调整错误报告。您仍然可以通过使用emitError或emitWarning配置项强制执行抛出错误和警告:
| options属性 | 类型 | 默认值 | 描述 |
|---|---|---|---|
| emitError | Boolean | false | 如果为true的话则总是返回错误。 |
| emitWarning | Boolean | false | 如果为true的话则总是返回警告。 |
| failOnError | Boolean | false | 如果设置为true的话,那么当触发任何错误的时候,将导致构建失败。 |
| failOnWarning | Boolean | false | 如果设置为true的话,那么有任何警告的时候,将导致构建失败。 |
| quiet | Boolean | false | 如果设置为true,将仅处理和报告错误并忽略警告。 |