@nuxtjs/eslint-module
用于 Nuxt 的 ESLint 模块
注意： 此分支适用于Nuxt 3 或 Nuxt Bridge 兼容模块。查看 nuxt2 分支 以获取 Nuxt 2 支持。
要求
你需要确保已安装 eslint >= 7
使用 pnpm
pnpm add -D eslint
或者，使用 yarn
yarn add -D eslint
或者，使用 npm
npm install -D eslint
安装
- 添加
@nuxtjs/eslint-module依赖到你的项目
使用 pnpm
pnpm add -D @nuxtjs/eslint-module
或者，使用 yarn
yarn add -D @nuxtjs/eslint-module
或者，使用 npm
npm install -D @nuxtjs/eslint-module
- 添加
@nuxtjs/eslint-module到nuxt.config.ts的modules部分
export default defineNuxtConfig({
modules: [
// Simple usage
'@nuxtjs/eslint-module',
// With options
['@nuxtjs/eslint-module', { /* module options */ }]
]
})
使用顶层选项
export default defineNuxtConfig({
modules: [
'@nuxtjs/eslint-module'
],
eslint: {
/* module options */
}
})
选项
你可以传递 eslint 选项。
请注意，你提供的 config 选项将传递给 ESLint 类。这与你在 package.json 或 .eslintrc 中指定的选项集不同。有关更多详细信息，请参阅 eslint 文档。
cache
- 类型：
Boolean - 默认值：
true
注意：默认情况下启用缓存以减少执行时间。
include
- 类型：
String|Array[String] - 默认值：
[nuxt.options.srcDir.'/**/*.{js,jsx,ts,tsx,vue}']
指定目录、文件或 glob 模式。
exclude
- 类型：
Array[String] - 默认值：
['**/node_modules/**', nuxt.options.buildDir]
指定要排除的文件和/或目录。
eslintPath
- 类型：
String - 默认值：
eslint
将用于 linting 的 eslint 实例的路径。
formatter
- 类型：
String|Function - 默认值：
'stylish'
接受一个函数，该函数将有一个参数：eslint 消息数组（对象）。该函数必须将输出作为字符串返回。你可以使用官方 eslint 格式化程序。
lintOnStart
- 类型：
Boolean - 默认值：
true
也在项目启动时检查所有匹配的文件，速度较慢，请谨慎开启。
emitWarning
- 类型：
Boolean - 默认值：
true
将打印找到的警告。
emitError
- 类型：
Boolean - 默认值：
true
将打印找到的错误。
failOnWarning
- 类型：
Boolean - 默认值：
false
如果存在任何警告（基于 emitWarning），将导致模块构建失败。
failOnError
- 类型：
Boolean - 默认值：
false
如果存在任何错误（基于 emitError），将导致模块构建失败。
贡献
你可以使用 CodeSandBox 在线为此模块做贡献
或本地贡献
- 克隆此仓库
- 使用
pnpm install安装依赖 - 使用
pnpm dev:prepare准备开发服务器 - 使用
pnpm build构建模块 - 使用
pnpm dev启动 playground
许可证
版权所有 (c) Nuxt Community