调试您的配置
ESLint 基于您的配置文件和命令行选项为每个要检查的文件创建配置。配置文件越大,确定文件为何未按预期进行检查就越困难。为了帮助调试您的配置,ESLint 提供了一些工具。
在调试模式下运行 CLI
使用场景:您不确定是否正在读取正确的配置文件。如果您在同一个项目中有多个配置文件,则可能会发生这种情况。
操作方法:使用--debug
命令行标志运行 ESLint 并传递要检查的文件,如下所示
npx eslint --debug file.js
这会将 ESLint 的所有调试信息输出到控制台。您应该将此输出复制到一个文件,然后搜索eslint.config.js
以查看加载了哪个文件。以下是一些示例输出
eslint:eslint Using file patterns: bin/eslint.js +0ms
eslint:eslint Searching for eslint.config.js +0ms
eslint:eslint Loading config from C:\Users\nzakas\projects\eslint\eslint\eslint.config.js +5ms
eslint:eslint Config file URL is file:///C:/Users/nzakas/projects/eslint/eslint/eslint.config.js +0ms
打印文件的计算配置
使用场景:您不确定为什么代码检查没有产生预期的结果,可能是因为您的规则配置似乎没有被应用,或者使用了错误的语言选项。
操作方法:使用--print-config
命令行标志运行 ESLint 并传递要检查的文件,如下所示
npx eslint --print-config file.js
这会输出文件的计算配置的 JSON 表示形式,例如
{
"linterOptions": {
"reportUnusedDisableDirectives": 1
},
"language": "@/js",
"languageOptions": {
"sourceType": "module",
"ecmaVersion": "latest"
},
"plugins": [
"@"
],
"rules": {
"prefer-const": 2
}
}
使用配置检查器
使用场景:您不确定配置文件中的某些配置对象是否与给定的文件名匹配。
操作方法:使用--inspect-config
命令行标志运行 ESLint 并传递要检查的文件,如下所示
npx eslint --inspect-config
这会通过安装和启动@eslint/config-inspector
来启动配置检查器。然后,您可以输入相关文件名以查看将应用哪些配置对象。
配置检查器还会显示何时弃用规则、您使用了多少个可用规则等等。