# 命令行接口

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

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

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

如：

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

# Run on multiple files
npx eslint lib/**

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

npx eslint "lib/**"

**注意：**您还可以使用替代包管理器（例如 Yarn 或 pnpm）来运行 ESLint。请参阅您的包管理器的文档以了解正确的语法。

# 选项

命令行实用程序有几个选项。您可以通过运行 npx eslint -h 查看选项。

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

Basic configuration:
  --no-eslintrc                   Disable use of configuration from .eslintrc.*
  -c, --config path::String       Use this configuration, overriding .eslintrc.* config options if present
  --env [String]                  Specify environments
  --ext [String]                  Specify JavaScript file extensions
  --global [String]               Define global variables
  --parser String                 Specify the parser to be used
  --parser-options Object         Specify parser options
  --resolve-plugins-relative-to path::String  A folder where plugins should be resolved from, CWD by default

Specifying rules and plugins:
  --plugin [String]               Specify plugins
  --rule Object                   Specify rules
  --rulesdir [path::String]       Load additional rules from this directory. Deprecated: Use rules from plugins

Fixing 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)

Ignoring files:
  --ignore-path path::String      Specify path of ignore file
  --no-ignore                     Disable use of ignore files and patterns
  --ignore-pattern [String]       Pattern of files to ignore (in addition to those in .eslintignore)

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

Handling 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 directives

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
  --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

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

例子：

npx eslint --ext .jsx --ext .js lib/

npx eslint --ext .jsx,.js lib/

# 基本配置

# --no-eslintrc

禁止使用来自 .eslintrc.* 和 package.json 文件的配置。

例子：

npx eslint --no-eslintrc file.js

# -c、--config

这个选项允许你为 ESLint 指定一个额外的配置文件（更多信息参见 配置 ESLint）。

例子：

npx eslint -c ~/my-eslint.json file.js

本例使用 ~/my-eslint.json 的配置文件。

如果 .eslintrc.* 和/或 package.json 文件也用于配置（即未指定 --no-eslintrc），则配置将被合并。此配置文件中的选项优先于 .eslintrc.* 和 package.json 文件中的选项。

# --env

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

例子：

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

# --ext

此选项允许您指定 ESLint 在您指定的目录中搜索目标文件时将使用哪些文件扩展名。默认情况下，ESLint 会检查 *.js 文件以及与配置中的 overrides 条目匹配的文件。

例子：

# 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

注意：--ext 仅在参数是目录时使用。如果您使用 glob 模式或文件名，则 --ext 将被忽略。

例如，npx eslint lib/* --ext .js 将匹配 lib/ 目录中的所有文件，而不考虑扩展名。

# --global

此选项定义全局变量，以便它们不会被 no-undef 规则标记为未定义。默认情况下，假定任何指定的全局变量都是只读的，但将 :true 附加到变量名可确保 no-undef 也允许写入。要指定多个全局变量，请使用逗号分隔它们，或多次使用该选项。

例子：

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

# --parser

此选项允许您指定 ESLint 使用的解析器。默认情况下，将使用 espree。

# --parser-options

此选项允许您指定 ESLint 使用的解析器选项。请注意，可用的解析器选项由正在使用的解析器决定。

例子：

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

# --resolve-plugins-relative-to

更改解析插件的文件夹。默认情况下，插件是从当前工作目录解析的。当插件由最终用户以外的人安装时，应使用此选项。它应该设置为依赖于必要插件的项目的项目目录。例如：

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

# 指定规则和插件

# --plugin

此选项指定要加载的插件。您可以省略插件名称中的前缀 eslint-plugin-。

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

例子：

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

# --rule

此选项指定要使用的规则。这些规则将与配置文件指定的任何规则合并。（您可以使用 --no-eslintrc 更改该行为。）要定义多个规则，请使用逗号分隔它们，或多次使用该选项。levn 格式用于指定规则。

如果规则是在插件中定义的，则必须在规则 ID 前加上插件名称和 /。

例子：

npx eslint --rule 'quotes: [error, double]'
npx eslint --rule 'guard-for-in: error' --rule 'brace-style: [error, 1tbs]'
npx eslint --rule 'jquery/dollar-sign: error'

# --rulesdir

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

此选项允许您指定另一个目录来加载规则文件。这允许您在运行时动态加载新规则。当您有不适合与 ESLint 捆绑的自定义规则时，这很有用。

例子：

npx eslint --rulesdir my-rules/ file.js

自定义规则目录中的规则必须遵循与捆绑规则相同的格式才能正常工作。您还可以通过包含多个 --rulesdir 选项为自定义规则指定多个位置：

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

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

# 解决问题

# --fix

此选项指示 ESLint 尝试修复尽可能多的问题。对实际文件本身进行了修复，仅输出剩余的未修复问题。并非所有问题都可以使用此选项解决，并且该选项在以下情况下不起作用：

如果您想修复来自 stdin 的代码，或者想要获得修复而不实际将它们写入文件，请使用 --fix-dry-run 选项。

# --fix-dry-run

此选项与 --fix 具有相同的效果，但有一个区别：修复不会保存到文件系统中。这使得修复来自 stdin 的代码成为可能（当与 --stdin 标志一起使用时）。

因为默认格式化程序不输出固定代码，所以您必须使用另一个（例如 json）来获取修复程序。这是此模式的示例：

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

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

# --fix-type

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

您可以在命令行上指定一种或多种修复类型。这里有些例子：

npx eslint --fix --fix-type suggestion .
npx eslint --fix --fix-type suggestion --fix-type problem .
npx eslint --fix --fix-type suggestion,layout .

如果您使用另一个程序来格式化您的代码，但您仍然希望 ESLint 应用其他类型的修复，此选项很有帮助。

# 忽略文件

# --ignore-path

**注意：**使用平面配置 (eslint.config.js) 时不支持 --ignore-path。

此选项允许您指定要用作 .eslintignore 的文件。默认情况下，ESLint 在当前工作目录中查找 .eslintignore。您可以通过提供不同文件的路径来覆盖此行为。

例子：

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

# --no-ignore

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

例子：

npx eslint --no-ignore file.js

# --ignore-pattern

此选项允许您指定要忽略的文件模式（除了 .eslintignore 中的那些）。您可以重复该选项以提供多种模式。支持的语法与 .eslintignore 文件 相同，它们使用与 .gitignore 规范 相同的模式。您应该引用您的模式以避免对 glob 模式的 shell 解释。

例子：

npx eslint --ignore-pattern '/lib/' --ignore-pattern '/src/vendor/*' .

# 使用标准输入

# --stdin

这个选项告诉 ESLint 从 STDIN 而不是从文件中读取和检查源代码。您可以使用它将代码通过管道传输到 ESLint。

例子：

cat myfile.js | npx eslint --stdin

# --stdin-filename

此选项允许您指定一个文件名来处理 STDIN。这在处理来自 STDIN 的文件并且您有依赖于文件名的规则时很有用。

例子

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

# 处理警告

# --quiet

此选项允许您禁用警告报告。如果启用此选项，则 ESLint 仅报告错误。

例子：

npx eslint --quiet file.js

# --max-warnings

此选项允许您指定警告阈值，如果您的项目中有太多警告级别的规则违规，可用于强制 ESLint 以错误状态退出。

通常，如果 ESLint 运行并且没有发现错误（只有警告），它将以成功退出状态退出。但是，如果指定了 --max-warnings 并且总警告计数大于指定的阈值，则 ESLint 将以错误状态退出。指定阈值 -1 或省略此选项将阻止此行为。

例子：

npx eslint --max-warnings 10 file.js

# 输出

# -o、--output-file

允许将报告写入文件。

例子：

npx eslint -o ./test/test.html

指定时，将给定格式输出到提供的文件名中。

# -f、--format

此选项指定控制台的输出格式。可能的格式有：

checkstyle
compact
html
jslint-xml
json
junit
stylish（默认）
tap
unix
visualstudio

例子：

npx eslint -f compact file.js

您还可以通过指定自定义格式化程序文件的路径，从命令行使用自定义格式化程序。

例子：

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

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

例子：

npm install eslint-formatter-pretty

npx eslint -f pretty file.js

// equivalent:
npx eslint -f eslint-formatter-pretty file.js

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

npx eslint -f compact file.js > results.txt

这会将输出保存到 results.txt 文件中。

# --color、--no-color

此选项强制启用/禁用彩色输出。您可以使用它来覆盖默认行为，即启用彩色输出，除非未检测到 TTY，例如在管道 eslint 到 cat 或 less 时。

例子：

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

# 内联配置注释

# --no-inline-config

此选项可防止 /*eslint-disable*/ 或 /*global foo*/ 等内联注释产生任何影响。这允许您设置 ESLint 配置，而无需文件修改它。所有内联配置注释都被忽略，例如：

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

例子：

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

# --report-unused-disable-directives

此选项会导致 ESLint 报告指令注释，如 // eslint-disable-line 无论如何不会在该行上报告错误。通过清理不再适用的旧 eslint-disable 注释，这有助于防止未来的错误被意外抑制。

警告：使用此选项时，可能会在升级 ESLint 或自定义规则时开始报告新错误。例如，假设某条规则存在导致其报告误报的错误，并添加了 eslint-disable 注释以禁止错误报告。如果在 ESLint 的补丁版本中修复了该错误，则 eslint-disable 注释将不再使用，因为 ESLint 不再生成不正确的报告。如果使用 report-unused-disable-directives 选项，这将导致未使用指令的新报告错误。

例子：

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

# 缓存

# --cache

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

**注意：**如果你用 --cache 运行 ESLint，然后在没有 --cache 的情况下运行 ESLint，.eslintcache 文件将被删除。这是必要的，因为 lint 的结果可能会更改并使 .eslintcache 无效。如果要控制何时删除缓存文件，请使用 --cache-location 指定缓存文件的备用位置。

**注意：**自动修复的文件不会放在缓存中。不触发自动修复的后续 linting 会将其放入缓存中。

# --cache-file

缓存文件的路径。如果没有指定 .eslintcache 将被使用。该文件将在执行 eslint 命令的目录中创建。已弃用：请改用 --cache-location。

# --cache-location

缓存位置的路径。可以是文件或目录。如果没有指定位置，将使用 .eslintcache。在这种情况下，该文件将在执行 eslint 命令的目录中创建。

如果指定了目录，则将在指定文件夹内创建缓存文件。文件的名称将基于当前工作目录 (CWD) 的哈希值。例如：.cache_hashOfCWD

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

例子：

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

# --cache-strategy

用于检测更改文件的缓存策略。可以是 metadata 或 content。如果未指定策略，将使用 metadata。

content 策略在文件的修改时间发生变化的情况下很有用，即使它们的内容没有变化。例如，这可能发生在 git clone 之类的 git 操作期间，因为 git 不跟踪文件修改时间。

例子：

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

# 其他

# --init

此选项将运行 npm init @eslint/config 以启动配置初始化向导。它旨在通过回答几个问题、选择流行的样式指南来帮助新用户快速创建 .eslintrc 文件。

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

# --env-info

此选项输出有关执行环境的信息，包括 Node、npm 的版本以及 ESLint 的本地和全局安装。ESLint 团队可能会要求提供此信息以帮助解决错误。

# --no-error-on-unmatched-pattern

当引用的 glob 模式或 --ext 不匹配时，此选项可防止错误。当您的 shell 无法匹配 glob 时，这不会防止错误。

# --exit-on-fatal-error

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

# --debug

此选项将调试信息输出到控制台。当您发现问题并难以确定问题时，此信息很有用。ESLint 团队可能会要求提供此调试信息以帮助解决错误。将此标志添加到 ESLint 命令行调用中，以便在命令运行时获得额外的调试信息（例如，npx eslint --debug test.js 和 npx eslint test.js --debug 是等效的）

# -h、--help

此选项输出帮助菜单，显示所有可用选项。当它存在时，所有其他选项都将被忽略。

# -v、--version

此选项将当前 ESLint 版本输出到控制台。当它存在时，所有其他选项都将被忽略。

# --print-config

此选项输出用于传递的文件的配置。如果存在，则不会执行检查，并且只有与配置相关的选项有效。

例子：

npx eslint --print-config file.js

# 从 linting 中忽略文件

当 ESLint 对目录进行操作时，ESLint 支持 .eslintignore 文件从 linting 过程中排除文件。作为单个 CLI 参数给出的文件将免于排除。.eslintignore 文件是一个纯文本文件，每行包含一个模式。它可以位于目标目录的任何祖先中；它将影响其包含目录以及所有子目录中的文件。下面是一个 .eslintignore 文件的简单示例：

temp.js
**/vendor/*.js

可以在 忽略代码 中找到 ESLint 默认忽略的受支持模式和目录的更详细细分。

# 退出代码

当 linting 文件时，ESLint 会以下列退出代码之一退出：

0：Linting 成功并且没有 linting 错误。如果 --max-warnings 标志设置为 n，则 linting 警告的数量最多为 n。
1：linting 成功并且至少存在一个 linting 错误，或者 linting 警告多于 --max-warnings 选项所允许的数量。
2：由于配置问题或内部错误，检查不成功。

← 忽略代码 array-callback-return →