版本

调试你的配置

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 来启动配置检查器。然后,你可以输入要检查的文件名,以查看哪些配置对象将被应用。

Config inspector screenshot showing which config objects match index.js

配置检查器还会显示你使用哪些过时的规则、你使用了多少个可用的规则等等。

更改语言