命令行界面参考

ESLint 命令行界面 (CLI) 允许您从终端执行代码检查。CLI 具有各种选项，您可以传递这些选项来配置 ESLint。

运行 CLI

ESLint 需要 Node.js 进行安装。请按照入门指南中的说明安装 ESLint。

大多数用户使用npx在命令行上运行 ESLint，如下所示

npx eslint [options] [file|dir|glob]*
1

例如

# Run on two files
npx eslint file1.js file2.js

# Run on multiple files
npx eslint lib/**
1
2
3
4
5

请注意，当将 glob 作为参数传递时，它会由您的 shell 展开。展开的结果可能因您的 shell 及其配置而异。如果您想使用 node glob 语法，则必须引用您的参数（如果您需要在 Windows 中运行，请使用双引号），如下所示

npx eslint "lib/**"
1

如果您使用的是扁平化配置文件（eslint.config.js），您还可以省略文件参数，ESLint 将使用 .。例如，这两行执行相同的操作

npx eslint .
npx eslint
1
2

如果您未使用扁平化配置文件，则在不带文件参数的情况下运行 ESLint 会导致错误。

注意：您还可以使用其他包管理器（例如Yarn或pnpm）来运行 ESLint。对于 pnpm，使用 pnpm dlx eslint；对于 Yarn，使用 yarn dlx eslint。

向选项传递多个值

接受多个值的选项可以通过重复选项或使用逗号分隔的列表来指定（除了--ignore-pattern，它不允许使用第二种样式）。

接受多个值的选项示例

npx eslint --global describe --global it tests/
# OR
npx eslint --global describe,it tests/
1
2
3

选项

您可以通过运行 npx eslint -h 查看所有 CLI 选项。

eslint [options] file.js [file.js] [dir]

Basic configuration:
  --no-config-lookup              Disable look up for eslint.config.js
  -c, --config path::String       Use this configuration instead of eslint.config.js, eslint.config.mjs, or
                                  eslint.config.cjs
  --inspect-config                Open the config inspector with the current configuration
  --global [String]               Define global variables
  --parser String                 Specify the parser to be used
  --parser-options Object         Specify parser options

Specify Rules and Plugins:
  --plugin [String]               Specify plugins
  --rule Object                   Specify rules

Fix Problems:
  --fix                           Automatically fix problems
  --fix-dry-run                   Automatically fix problems without saving the changes to the file system
  --fix-type Array                Specify the types of fixes to apply (directive, problem, suggestion, layout)

Ignore Files:
  --no-ignore                     Disable use of ignore files and patterns
  --ignore-pattern [String]       Patterns of files to ignore

Use stdin:
  --stdin                         Lint code provided on <STDIN> - default: false
  --stdin-filename String         Specify filename to process STDIN as

Handle Warnings:
  --quiet                         Report errors only - default: false
  --max-warnings Int              Number of warnings to trigger nonzero exit code - default: -1

Output:
  -o, --output-file path::String  Specify file to write report to
  -f, --format String             Use a specific output format - default: stylish
  --color, --no-color             Force enabling/disabling of color

Inline configuration comments:
  --no-inline-config              Prevent comments from changing config or rules
  --report-unused-disable-directives  Adds reported errors for unused eslint-disable and eslint-enable directives
  --report-unused-disable-directives-severity String  Chooses severity level for reporting unused eslint-disable and
                                                      eslint-enable directives - either: off, warn, error, 0, 1, or 2

Caching:
  --cache                         Only check changed files - default: false
  --cache-file path::String       Path to the cache file. Deprecated: use --cache-location - default: .eslintcache
  --cache-location path::String   Path to the cache file or directory
  --cache-strategy String         Strategy to use for detecting changed files in the cache - either: metadata or
                                  content - default: metadata

Miscellaneous:
  --init                          Run config initialization wizard - default: false
  --env-info                      Output execution environment information - default: false
  --no-error-on-unmatched-pattern  Prevent errors when pattern is unmatched
  --exit-on-fatal-error           Exit with exit code 2 in case of fatal error - default: false
  --no-warn-ignored               Suppress warnings when the file list includes ignored files
  --pass-on-no-patterns           Exit with exit code 0 in case no file patterns are passed
  --debug                         Output debugging information
  -h, --help                      Show help
  -v, --version                   Output the version number
  --print-config path::String     Print the configuration for the given file
  --stats                         Add statistics to the lint report - default: false
  --flag [String]                 Enable a feature flag
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63

基本配置

--no-eslintrc

仅限 .eslintrc 模式。禁用从 .eslintrc.* 和 package.json 文件中使用配置。对于扁平化配置模式，请改用 --no-config-lookup。

• 参数类型：无参数。

--no-eslintrc 示例

npx eslint --no-eslintrc file.js
1

-c, --config

此选项允许您为 ESLint 指定一个额外的配置文件（有关详细信息，请参阅配置 ESLint）。

• 参数类型：字符串。文件路径。
• 多个参数：否

-c, --config 示例

npx eslint -c ~/my.eslint.config.js file.js
1

此示例使用 ~/my.eslint.config.js 中的配置文件，该文件将用于代替搜索 eslint.config.js 文件。

--inspect-config

仅限扁平化配置模式。此选项运行 npx @eslint/config-inspector@latest 以启动配置检查器。您可以使用配置检查器更好地了解您的配置正在执行的操作以及它适用于哪些文件。当您使用此标志时，CLI 不会执行代码检查。

• 参数类型：无参数。

--inspect-config 示例

npx eslint --inspect-config
1

--env

仅限 .eslintrc 模式。此选项启用特定的环境。

• 参数类型：字符串。可用的环境之一。
• 多个参数：是

每个环境定义的全局变量的详细信息可在指定环境文档中找到。此选项仅启用环境。它不会禁用在其他配置文件中设置的环境。要指定多个环境，请使用逗号分隔它们，或多次使用该选项。

--env 示例

npx eslint --env browser,node file.js
npx eslint --env browser --env node file.js
1
2

--ext

仅限 .eslintrc 模式。如果您使用的是扁平化配置 (eslint.config.js)，请参阅迁移指南。

此选项允许您指定 ESLint 在搜索您指定的目录中的目标文件时使用的文件扩展名。

• 参数类型：字符串。文件扩展名。
• 多个参数：是
• 默认值：.js 和与您配置的 overrides 条目匹配的文件。

--ext 仅在要检查的模式是目录时使用。如果您使用 glob 模式或文件名，则 --ext 将被忽略。例如，npx eslint "lib/*" --ext .js 匹配 lib/ 目录中的所有文件，无论扩展名如何。

--ext 示例

# Use only .ts extension
npx eslint . --ext .ts

# Use both .js and .ts
npx eslint . --ext .js --ext .ts

# Also use both .js and .ts
npx eslint . --ext .js,.ts
1
2
3
4
5
6
7
8

--global

此选项定义全局变量，以便no-undef规则不会将其标记为未定义。

• 参数类型：字符串。全局变量的名称。默认情况下，任何指定的全局变量都被假定为只读，但将 :true 附加到变量的名称可确保 no-undef 也允许写入。
• 多个参数：是

--global 示例

npx eslint --global require,exports:true file.js
npx eslint --global require --global exports:true
1
2

--parser

此选项允许您指定 ESLint 要使用的解析器。

• 参数类型：字符串。ESLint 要使用的解析器。
• 多个参数：否
• 默认值：espree

--parser 示例

# Use TypeScript ESLint parser
npx eslint --parser @typescript-eslint/parser file.ts
1
2

--parser-options

此选项允许您指定 ESLint 要使用的解析器选项。可用的解析器选项由正在使用的解析器确定。

• 参数类型：用冒号 (:) 分隔的键/值对。
• 多个参数：是

--parser-options 示例

echo '3 ** 4' | npx eslint --stdin --parser-options ecmaVersion:6 # fails with a parsing error
echo '3 ** 4' | npx eslint --stdin --parser-options ecmaVersion:7 # succeeds, yay!
1
2

--resolve-plugins-relative-to

仅限 .eslintrc 模式。更改从其解析插件的目录。

• 参数类型：字符串。目录路径。
• 多个参数：否
• 默认值：默认情况下，插件从找到配置文件的目录中解析。

此选项应在插件由最终用户以外的人安装时使用。它应设置为依赖于必要插件的项目的项目目录。

例如

• 当使用位于当前项目外部的配置文件（使用 --config 标志）时，如果该配置使用本地安装到自身的插件，则应将 --resolve-plugins-relative-to 设置为包含配置文件的目录。
• 如果某个集成依赖于 ESLint 和一组插件，并且该工具代表用户调用 ESLint 并使用预设配置，则该工具应将 --resolve-plugins-relative-to 设置为该工具的顶级目录。

--resolve-plugins-relative-to 示例

npx eslint --config ~/personal-eslintrc.js \
--resolve-plugins-relative-to /usr/local/lib/
1
2

指定规则和插件

--plugin

此选项指定要加载的插件。

• 参数类型：字符串。插件名称。您可以选择省略插件名称的前缀 eslint-plugin-。
• 多个参数：是

在使用插件之前，您必须使用 npm 安装它。

--plugin 示例

npx eslint --plugin jquery file.js
npx eslint --plugin eslint-plugin-mocha file.js
1
2

--rule

此选项指定要使用的规则。

• 参数类型：使用levn格式指定的规则及其配置。
• 多个参数：是

这些规则与使用配置文件指定的任何规则合并。如果规则在插件中定义，则必须在规则 ID 前添加插件名称和 /。

要忽略 .eslintrc 配置文件中的规则，并且仅运行命令行中指定的规则，请将 --rule 标志与--no-eslintrc标志结合使用。

--rule 示例

# Apply single rule
npx eslint --rule 'quotes: [error, double]'
# Apply multiple rules
npx eslint --rule 'guard-for-in: error' --rule 'brace-style: [error, 1tbs]'
# Apply rule from jquery plugin
npx eslint --rule 'jquery/dollar-sign: error'
# Only apply rule from the command line
npx eslint --rule 'quotes: [error, double]' --no-eslintrc
1
2
3
4
5
6
7
8

--rulesdir

已弃用：改用插件中的规则。

仅限 .eslintrc 模式。此选项允许您指定另一个目录，从中加载规则文件。这允许您在运行时动态加载新规则。当您有自定义规则不适合与 ESLint 捆绑在一起时，这很有用。

• 参数类型：字符串。目录路径。自定义规则目录中的规则必须遵循与捆绑规则相同的格式才能正常工作。
• 多个参数：是。

请注意，与核心规则和插件规则一样，您仍然需要在配置中或通过 --rule CLI 选项启用规则，才能在代码检查期间实际运行这些规则。使用 --rulesdir 指定规则目录不会自动启用该目录中的规则。

--rulesdir 示例

npx eslint --rulesdir my-rules/ file.js
npx eslint --rulesdir my-rules/ --rulesdir my-other-rules/ file.js
1
2

修复问题

--fix

此选项指示 ESLint 尝试修复尽可能多的问题。修复将直接应用于实际的文件，并且只会输出剩余的未修复问题。

• 参数类型：无参数。

并非所有问题都可使用此选项修复，并且在以下情况下此选项不起作用

1. 当代码通过管道传输到 ESLint 时，此选项会抛出错误。
2. 此选项对使用处理器的代码没有影响，除非处理器选择允许自动修复。

如果您想修复来自 stdin 的代码或以其他方式希望获得修复而不将其实际写入文件，请使用--fix-dry-run选项。

--fix 示例

npx eslint --fix file.js
1

--fix-dry-run

此选项与 --fix 的效果相同，区别在于修复不会保存到文件系统。因为默认的格式化程序不会输出修复后的代码，所以您必须使用其他格式化程序（例如 --format json）来获取修复。

• 参数类型：无参数。

当与 --stdin 标志一起使用时，这使得可以修复来自 stdin 的代码成为可能。

此标志对于需要从命令行自动修复文本而无需将其保存到文件系统的集成（例如编辑器插件）很有用。

--fix-dry-run 示例

getSomeText | npx eslint --stdin --fix-dry-run --format json
1

--fix-type

此选项允许您在使用--fix或--fix-dry-run时指定要应用的修复类型。

• 参数类型：字符串。以下修复类型之一
  1. problem - 修复代码中潜在的错误
  2. suggestion - 应用改进代码的修复
  3. layout - 应用不会更改程序结构（AST）的修复
  4. directive - 应用对内联指令（如// eslint-disable）的修复
• 多个参数：是

如果您正在使用其他程序来格式化代码，但仍希望 ESLint 应用其他类型的修复，则此选项很有用。

--fix-type 示例

npx eslint --fix --fix-type suggestion .
npx eslint --fix --fix-type suggestion --fix-type problem .
npx eslint --fix --fix-type suggestion,layout .
1
2
3

忽略文件

--ignore-path

仅限 eslintrc 模式。此选项允许您指定用作.eslintignore的文件。

• 参数类型：字符串。文件路径。
• 多个参数：否
• 默认值：默认情况下，ESLint 在当前工作目录中查找.eslintignore。

注意：--ignore-path仅在使用已弃用的配置时受支持。如果要将.gitignore文件中的模式包含在eslint.config.js文件中，请参阅包含.gitignore文件。

--ignore-path 示例

npx eslint --ignore-path tmp/.eslintignore file.js
npx eslint --ignore-path .gitignore file.js
1
2

--no-ignore

禁用从.eslintignore文件、--ignore-path标志、--ignore-pattern标志以及配置文件中的ignorePatterns属性排除文件。

• 参数类型：无参数。

--no-ignore 示例

npx eslint --no-ignore file.js
1

--ignore-pattern

此选项允许您指定要忽略的文件模式。在 eslintrc 模式下，这些模式是除了.eslintignore之外的。

• 参数类型：字符串。支持的语法与.eslintignore文件相同，后者使用与.gitignore规范相同的模式。您应该引用模式以避免 shell 对 glob 模式进行解释。
• 多个参数：是

--ignore-pattern 示例

npx eslint --ignore-pattern "/lib/" --ignore-pattern "/src/vendor/*" .
1

使用标准输入

--stdin

此选项指示 ESLint 从 STDIN 读取和 lint 源代码，而不是从文件读取。您可以使用此选项将代码管道传输到 ESLint。

• 参数类型：无参数。

--stdin 示例

cat myfile.js | npx eslint --stdin
1

--stdin-filename

此选项允许您指定要处理 STDIN 的文件名。

• 参数类型：字符串。文件路径。
• 多个参数：否

在处理来自 STDIN 的文件并且您有依赖于文件名的规则时，这很有用。

--stdin-filename 示例

cat myfile.js | npx eslint --stdin --stdin-filename myfile.js
1

处理警告

--quiet

此选项允许您禁用对警告的报告以及设置为警告的规则的运行。如果您启用此选项，ESLint 仅报告错误，并且仅运行设置为错误的规则。

• 参数类型：无参数。

--quiet 示例

npx eslint --quiet file.js
1

--max-warnings

此选项允许您指定警告阈值，该阈值可用于强制 ESLint 在项目中存在过多警告级规则违规时退出并显示错误状态。

• 参数类型：整数。允许的最大警告数。要防止此行为，请不要使用此选项或将-1指定为参数。
• 多个参数：否

通常，如果 ESLint 运行并发现没有错误（只有警告），它将退出并显示成功退出状态。但是，如果指定了--max-warnings并且总警告计数大于指定的阈值，则 ESLint 将退出并显示错误状态。

--max-warnings 示例

npx eslint --max-warnings 10 file.js
1

输出

-o, --output-file

将 lint 结果的输出写入指定的文件。

• 参数类型：字符串。文件路径。
• 多个参数：否

-o, --output-file 示例

npx eslint -o ./test/test.html
1

-f, --format

此选项指定控制台的输出格式。

• 参数类型：字符串。内置格式化程序或自定义格式化程序之一。
• 多个参数：否
• 默认值：stylish

如果您使用在本地文件中定义的自定义格式化程序，则可以指定自定义格式化程序文件的路径。

使用 npm 安装的格式化程序将使用或不使用eslint-formatter-前缀进行解析。

指定后，给定的格式将输出到控制台。如果您想将该输出保存到文件中，则可以在命令行中执行以下操作

# Saves the output into the `results.json` file.
npx eslint -f json file.js > results.json
1
2

-f, --format 示例

使用内置的json格式化程序

npx eslint --format json file.js
1

使用本地自定义格式化程序

npx eslint -f ./customformat.js file.js
1

使用 npm 安装的格式化程序

npm install eslint-formatter-pretty

# Then run one of the following commands
npx eslint -f pretty file.js
# or alternatively
npx eslint -f eslint-formatter-pretty file.js
1
2
3
4
5
6

--color 和 --no-color

这些选项强制启用/禁用彩色输出。

• 参数类型：无参数。

您可以使用这些选项覆盖默认行为，即启用彩色输出，除非未检测到 TTY，例如当通过cat或less管道传输eslint时。

--color 和 --no-color 示例

npx eslint --color file.js | cat
npx eslint --no-color file.js
1
2

内联配置注释

--no-inline-config

此选项可防止内联注释（如/*eslint-disable*/或/*global foo*/）产生任何影响。

• 参数类型：无参数。

这允许您设置 ESLint 配置而无需文件修改它。所有内联配置注释都将被忽略，例如

• /*eslint-disable*/
• /*eslint-enable*/
• /*global*/
• /*eslint*/
• /*eslint-env*/
• // eslint-disable-line
• // eslint-disable-next-line

--no-inline-config 示例

npx eslint --no-inline-config file.js
1

--report-unused-disable-directives

此选项导致 ESLint 在无论如何都不会在该行报告错误时报告指令注释（如// eslint-disable-line）。

• 参数类型：无参数。

这有助于防止将来意外地抑制错误，方法是清理不再适用的旧eslint-disable和eslint-enable注释。

--report-unused-disable-directives 示例

npx eslint --report-unused-disable-directives file.js
1

--report-unused-disable-directives-severity

与--report-unused-disable-directives相同，但允许您指定报告的错误的严重级别（error、warn、off）。一次只能使用这两个选项之一。

• 参数类型：字符串。以下值之一
  1. off（或0）
  2. warn（或1）
  3. error（或2）
• 多个参数：否
• 默认值：默认情况下，使用linterOptions.reportUnusedDisableDirectives配置设置（默认为"warn"）。

--report-unused-disable-directives-severity 示例

npx eslint --report-unused-disable-directives-severity warn file.js
1

缓存

--cache

存储有关已处理文件的信息，以便仅对已更改的文件进行操作。启用此选项可以通过确保仅 lint 已更改的文件来极大地提高 ESLint 的运行时性能。缓存默认存储在.eslintcache中。

• 参数类型：无参数。

如果您使用--cache运行 ESLint，然后在不使用--cache的情况下运行 ESLint，则.eslintcache文件将被删除。这是必要的，因为 lint 的结果可能会发生变化并使.eslintcache无效。如果要控制何时删除缓存文件，则使用--cache-location指定缓存文件的备用位置。

自动修复的文件不会放入缓存中。随后不触发自动修复的 lint 将将其放入缓存中。

--cache 示例

npx eslint --cache file.js
1

--cache-file

已弃用：请改用--cache-location。

缓存文件的路径。如果没有指定，则使用.eslintcache。该文件在执行eslint命令的目录中创建。

--cache-location

指定缓存位置的路径。可以是文件或目录。

• 参数类型：字符串。文件或目录的路径。如果指定了目录，则在指定的文件夹内创建缓存文件。文件名称基于当前工作目录的哈希值，例如：.cache_hashOfCWD。
• 多个参数：否
• 默认值：如果未指定位置，则使用.eslintcache。该文件在执行eslint命令的目录中创建。

如果缓存的目录不存在，请确保在 *nix 系统上添加尾随/或在 Windows 上添加\。否则，路径将被假定为文件。

--cache-location 示例

npx eslint "src/**/*.js" --cache --cache-location "/Users/user/.eslintcache/"
1

--cache-strategy

用于检测已更改文件的缓存策略。

• 参数类型：字符串。以下值之一
  1. metadata
  2. content
• 多个参数：否
• 默认值：metadata

在您的文件修改时间即使内容未更改时也会发生变化的情况下，content策略可能很有用。例如，这可能在像git clone这样的 git 操作期间发生，因为 git 不会跟踪文件修改时间。

--cache-strategy 示例

npx eslint "src/**/*.js" --cache --cache-strategy content
1

其他

--init

此选项运行npm init @eslint/config以启动配置初始化向导。它旨在通过回答一些问题来帮助新用户快速创建.eslintrc文件。当您使用此标志时，CLI 不会执行 lint。

• 参数类型：无参数。

生成的配置文件将在当前目录中创建。

--init 示例

npx eslint --init
1

--env-info

此选项输出有关执行环境的信息，包括 Node.js、npm 以及 ESLint 的本地和全局安装的版本。

• 参数类型：无参数。

ESLint 团队可能会要求提供此信息以帮助解决错误。当您使用此标志时，CLI 不会执行 lint。

--env-info 示例

npx eslint --env-info
1

--no-error-on-unmatched-pattern

此选项可防止在不匹配的带引号的 glob 模式或--ext时出现错误。这不会防止 shell 无法匹配 glob 时出现的错误。

• 参数类型：无参数。

--no-error-on-unmatched-pattern 示例

npx eslint --no-error-on-unmatched-pattern --ext .ts "lib/*"
1

--exit-on-fatal-error

如果发生一个或多个致命解析错误，此选项会导致 ESLint 退出并显示退出代码 2。在没有此选项的情况下，ESLint 会将致命解析错误报告为规则违规。

• 参数类型：无参数。

--exit-on-fatal-error 示例

npx eslint --exit-on-fatal-error file.js
1

--no-warn-ignored

仅限平面配置模式。当显式传递忽略的文件名时，此选项会抑制File ignored by default和File ignored because of a matching ignore pattern警告。当与--max-warnings 0配对使用时，它很有用，因为它可以防止由于上述警告导致退出代码 1。

• 参数类型：无参数。

--no-warn-ignored 示例

npx eslint --no-warn-ignored --max-warnings 0 ignored-file.js
1

--pass-on-no-patterns

此选项允许 ESLint 在没有传递文件或目录模式时退出并显示代码 0。在没有此选项的情况下，ESLint 假设您要使用.作为模式。（在旧版 eslintrc 模式下运行时，ESLint 将退出并显示代码 1。）

• 参数类型：无参数。

--pass-on-no-patterns 示例

npx eslint --pass-on-no-patterns
1

--debug

此选项将调试信息输出到控制台。将此标志添加到 ESLint 命令行调用中，以便在命令运行时获取额外的调试信息。

• 参数类型：无参数。

当您遇到问题并且难以查明问题时，此信息很有用。ESLint 团队可能会要求提供此调试信息以帮助解决错误。

--debug 示例

npx eslint --debug test.js
1

-h, --help

此选项输出帮助菜单，显示所有可用选项。当此选项存在时，所有其他选项都将被忽略。当您使用此标志时，CLI 不会执行 lint。

• 参数类型：无参数。

-h, --help 示例

npx eslint --help
1

-v, --version

此选项将当前 ESLint 版本输出到控制台。当此选项存在时，所有其他选项都将被忽略。使用此标志时，CLI 不会执行代码风格检查。

• 参数类型：无参数。

-v, --version 示例

npx eslint --version
1

--print-config

此选项输出将用于传递的文件的配置。如果存在，则不会执行代码风格检查，并且只有与配置相关的选项有效。使用此标志时，CLI 不会执行代码风格检查。

• 参数类型：字符串。文件路径。
• 多个参数：否

--print-config 示例

npx eslint --print-config file.js
1

--stats

此选项添加一系列详细的性能统计信息（请参阅 统计信息类型），例如解析、修复和代码风格检查时间（每个规则的时间），到传递给格式化程序的 result 对象（请参阅 统计信息 CLI 用法）。

• 参数类型：无参数。

此选项旨在与显示统计信息的自定义格式化程序一起使用。它也可以与内置的 json 格式化程序一起使用。

--stats 示例

npx eslint --stats --format json file.js
1

--flag

此选项启用 ESLint 的一个或多个功能标志。

• 参数类型：字符串。一个功能标识符。
• 多个参数：是

--flag 示例

npx eslint --flag x_feature file.js
1

退出代码

在检查文件时，ESLint 将退出以下退出代码之一

• 0：代码风格检查成功，并且没有代码风格检查错误。如果 --max-warnings 标志设置为 n，则代码风格检查警告的数量最多为 n。
• 1：代码风格检查成功，并且至少存在一个代码风格检查错误，或者代码风格检查警告的数量超过了 --max-warnings 选项允许的数量。
• 2：由于配置问题或内部错误导致代码风格检查失败。