@nuxtjs/stylelint-module
@nuxtjs/stylelint-module
Nuxt 的 Stylelint 模块。一个强大而现代的代码检查工具，帮助你避免错误并在你的样式中强制执行约定。
@nuxtjs/stylelint-module
适用于 Nuxt.js 的 Stylelint 模块
注意：此分支适用于与 Nuxt 3 或 Nuxt Bridge 兼容的模块。查看 nuxt2 分支 以获取 Nuxt 2 支持。
需求
你需要确保已安装 stylelint
使用 pnpm
pnpm add -D stylelint
或者，使用 yarn
yarn add -D stylelint
或者，使用 npm
npm install -D stylelint
注意：目前，此模块仅在使用 vite 时与 stylelint 的最新版本 16 兼容，尚未实现对 webpack 的支持（请参阅 https://github.com/webpack-contrib/stylelint-webpack-plugin/issues/342）。
设置
- 将
@nuxtjs/stylelint-module依赖项添加到你的项目中
使用 pnpm
pnpm add -D @nuxtjs/stylelint-module
或者，使用 yarn
yarn add -D @nuxtjs/stylelint-module
或者，使用 npm
npm install -D @nuxtjs/stylelint-module
- 将
@nuxtjs/stylelint-module添加到nuxt.config.js文件的modules部分
export default {
modules: [
// Simple usage
'@nuxtjs/stylelint-module',
// With options
['@nuxtjs/stylelint-module', { /* module options */ }]
]
}
使用顶级选项
export default {
modules: [
'@nuxtjs/stylelint-module'
],
stylelint: {
/* module options */
}
}
选项
请参阅 stylelint 的选项 以获取可用选项的完整列表。这些选项将直接传递给 stylelint。
缓存
- 类型：
Boolean - 默认值：
true
注意：默认情况下启用缓存以减少执行时间。
包含
- 类型：
String|Array[String] - 默认值：
[nuxt.options.srcDir.'/**/*.{css,scss,sass,less,styl,vue}']
指定目录、文件或通配符。
排除
- 类型：
Array[String] - 默认值：
['**/node_modules/**', 'virtual:', nuxt.options.buildDir]
指定要排除的文件和/或目录。
stylelintPath
- 类型：
String - 默认值：
stylelint
将用于代码检查的 stylelint 实例的路径。
格式化程序
- 类型：
Function - 默认值：
'string'
指定要用于格式化结果的格式化程序。
lintOnStart
- 类型：
Boolean - 默认值：
true
在项目启动时检查所有匹配的文件，速度太慢，谨慎开启。
lintDirtyOnly
- 类型：
Boolean - 默认值：
true
运行 Stylelint 时仅检查已更改的文件，除了 buildStart 钩子，禁用时将检查 include 选项中指定的所有文件。
emitWarning
- 类型：
Boolean - 默认值：
true
将打印找到的警告。
emitError
- 类型：
Boolean - 默认值：
true
将打印找到的错误。
failOnWarning
- 类型：
Boolean - 默认值：
false
如果存在任何警告，则会导致模块构建失败，基于 emitWarning。
failOnError
- 类型：
Boolean - 默认值：
true
如果存在任何错误，则会导致模块构建失败，基于 emitError。
贡献
你可以在线使用 CodeSandBox 为此模块做出贡献
或本地
- 克隆此存储库
- 使用
pnpm install安装依赖项 - 使用
pnpm dev:prepare准备开发服务器 - 使用
pnpm build构建模块 - 使用
pnpm dev启动游乐场
许可证
版权所有 (c) Nuxt 模块