StylelintWebpackPlugin

npm node deps tests coverage chat size

stylelint-webpack-plugin 3.0 仅支持 webpack 5。对于 webpack 4,请查看 2.x 分支

该插件使用 stylelint 帮助你在样式代码中避免错误并强制规范。

Getting Started

首先,你需要安装 stylelint-webpack-plugin

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

注意:如果你还没有安装 stylelint >= 13,请先用 npm 进行安装:

npm install stylelint --save-dev

然后添加该插件到你的 webpack 配置中。例如:

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

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

选项

有关可用选项的完整列表请参阅 styleint 的配置项,这些选项直接传递给 stylelint

configFile

  • 类型:String
  • 默认值:undefined

指定 stylelint 配置文件的位置。

注意: 默认情况下由 stylelint 处理

context

  • 类型:String
  • 默认值:compiler.context

指定文件根目录的字符串。

exclude

  • 类型:String|Array[String]
  • 默认值:['node_modules', compiler.options.output.path]

指定要忽略的文件或目录。必须相对于 options.context

extensions

  • 类型:String|Array[String]
  • 默认值:['css', 'scss', 'sass']

指定要检查的扩展名。

files

  • 类型:String|Array[String]
  • 默认值:'**/*.(s(c|a)ss|css)'

可指定为目录,文件名或 globs。目录会递归地寻找与 options.extensions 相匹配的文件。文件名和 glob 模式将忽略 options.extensions

fix

  • 类型:Boolean
  • 默认值:false

如果值为 truestylelint 将修复尽可能多的 error。修复真实的源文件。报告所有未修复的 errors。请参阅 自动修复错误 文档。

formatter

  • 类型:String|Function
  • 默认值:'string'

指定要用于格式化结果的 formatter。请参阅 formatter 选项

lintDirtyModulesOnly

  • 类型:Boolean
  • 默认值:false

仅检查有变化的文件,启动时跳过检查。

stylelintPath

  • 类型:String
  • 默认值:stylelint

将要用来做检查的 stylelint 实例的路径。

threads

  • 类型:Boolean | Number
  • 默认值:false

设置为 true 时,会根据 cpu 的数量自动决定池子的大小。设置为大于 1 的数字时,可以确定池子的大小。设置为 false、1 或更小时,会禁用池子,并只在主线程运行。

Errors 和 Warning

默认情况下,插件将根据 stylelint 错误/警告数量自动调整错误报告。 你仍然可以使用 emitError emitWarning 选项来强制改变这种默认行为。

emitError

  • 类型:Boolean
  • 默认值:true

如遇到错误将会被直接输出,如需禁用,请设置为 false

emitWarning

  • 类型:Boolean
  • 默认值:true

如遇到警告将会被直接输出,如需禁用,请设置为 false

failOnError

  • 类型:Boolean
  • 默认值:true

如果有任何错误,都将导致模块构建失败,如需禁用,请设置为 false

failOnWarning

  • 类型:Boolean
  • 默认值:false

如果设置为 true,出现任何 warnings 都将会导致模块构建失败。

quiet

  • 类型:Boolean
  • 默认值:false

如果设置为 true,则仅处理和报告 errors,并忽略 warnings。

outputReport

  • 类型:Boolean|Object
  • 默认值:false

将输出的错误写入文件,例如,用于上报的 json 文件。 其 filePath 会相对于 webpack 配置中的:output.path. 你可以为输出文件设置不同的 formatter,如果未设置,则将使用默认 formatter

{
  'path/to/file';
  'json';
}

Changelog

Changelog

License

MIT

译者