命令行界面参考

ESLint 命令行界面 (CLI) 允许您从终端执行 linting。CLI 有多种选项，您可以传递这些选项来配置 ESLint。

运行 CLI

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

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

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

yarn dlx eslint [options] [file|dir|glob]* 
1

pnpm dlx eslint [options] [file|dir|glob]* 
1

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

例如

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

# Run on two files
yarn dlx eslint file1.js file2.js 
1
2

# Run on two files
pnpm dlx eslint file1.js file2.js 
1
2

# Run on two files
bunx eslint file1.js file2.js 
1
2

或

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

# Run on multiple files
yarn dlx eslint lib/** 
1
2

# Run on multiple files
pnpm dlx eslint lib/** 
1
2

# Run on multiple files
bunx eslint lib/** 
1
2

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

npx eslint "lib/**" 
1

yarn dlx eslint "lib/**" 
1

pnpm dlx eslint "lib/**" 
1

bunx eslint "lib/**" 
1

如果您正在使用扁平配置文件 (eslint.config.js)，您也可以省略文件参数，ESLint 将使用 .。例如，以下两行执行相同的操作

npx eslint . 
1

yarn dlx eslint . 
1

pnpm dlx eslint . 
1

bunx eslint . 
1

npx eslint 
1

yarn dlx eslint 
1

pnpm dlx eslint 
1

bunx eslint 
1

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

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

将多个值传递给选项

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

接受多个值的选项示例

npx eslint --global describe --global it tests/ 
1

yarn dlx eslint --global describe --global it tests/ 
1

pnpm dlx eslint --global describe --global it tests/ 
1

bunx eslint --global describe --global it tests/ 
1

或

npx eslint --global describe,it tests/ 
1

yarn dlx eslint --global describe,it tests/ 
1

pnpm dlx eslint --global describe,it tests/ 
1

bunx eslint --global describe,it tests/ 
1

选项

您可以通过运行 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
  --ext [String]                  Specify additional file extensions to lint
  --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
  --report-unused-inline-configs String  Adds reported errors for unused eslint inline config comments - 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
64
65

基本配置

--no-eslintrc

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

• 参数类型：无参数。

--no-eslintrc 示例

npx eslint --no-eslintrc file.js 
1

yarn dlx eslint --no-eslintrc file.js 
1

pnpm dlx eslint --no-eslintrc file.js 
1

bunx eslint --no-eslintrc file.js 
1

-c, --config

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

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

-c, --config 示例

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

yarn dlx eslint -c ~/my.eslint.config.js file.js 
1

pnpm dlx eslint -c ~/my.eslint.config.js file.js 
1

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

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

--inspect-config

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

• 参数类型：无参数。

--inspect-config 示例

npx eslint --inspect-config 
1

yarn dlx eslint --inspect-config 
1

pnpm dlx eslint --inspect-config 
1

bunx eslint --inspect-config 
1

--env

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

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

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

--env 示例

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

yarn dlx eslint --env browser,node file.js 
1

pnpm dlx eslint --env browser,node file.js 
1

bunx eslint --env browser,node file.js 
1

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

yarn dlx eslint --env browser --env node file.js 
1

pnpm dlx eslint --env browser --env node file.js 
1

bunx eslint --env browser --env node file.js 
1

--ext

此选项允许您指定要 lint 的其他文件扩展名。

• 参数类型：字符串。文件扩展名。
• 多个参数：是
• 默认值：默认情况下，ESLint lint 扩展名为 .js、.mjs、.cjs 的文件以及配置文件中指定的其他扩展名。

此选项主要用于与 --no-config-lookup 选项结合使用，因为在这种情况下，没有配置文件可以在其中指定其他扩展名。

--ext 示例

# Include .ts files
npx eslint . --ext .ts 
1
2

# Include .ts files
yarn dlx eslint . --ext .ts 
1
2

# Include .ts files
pnpm dlx eslint . --ext .ts 
1
2

# Include .ts files
bunx eslint . --ext .ts 
1
2

# Include .ts and .tsx files
npx eslint . --ext .ts --ext .tsx 
1
2

# Include .ts and .tsx files
yarn dlx eslint . --ext .ts --ext .tsx 
1
2

# Include .ts and .tsx files
pnpm dlx eslint . --ext .ts --ext .tsx 
1
2

# Include .ts and .tsx files
bunx eslint . --ext .ts --ext .tsx 
1
2

# Also include .ts and .tsx files
npx eslint . --ext .ts,.tsx 
1
2

# Also include .ts and .tsx files
yarn dlx eslint . --ext .ts,.tsx 
1
2

# Also include .ts and .tsx files
pnpm dlx eslint . --ext .ts,.tsx 
1
2

# Also include .ts and .tsx files
bunx eslint . --ext .ts,.tsx 
1
2

--global

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

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

--global 示例

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

yarn dlx eslint --global require,exports:true file.js 
1

pnpm dlx eslint --global require,exports:true file.js 
1

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

npx eslint --global require --global exports:true 
1

yarn dlx eslint --global require --global exports:true 
1

pnpm dlx eslint --global require --global exports:true 
1

bunx eslint --global require --global exports:true 
1

--parser

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

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

--parser 示例

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

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

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

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

--parser-options

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

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

--parser-options 示例

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

# fails with a parsing error
echo '3 ** 4' | yarn dlx eslint --stdin --parser-options ecmaVersion:6 
1
2

# fails with a parsing error
echo '3 ** 4' | pnpm dlx eslint --stdin --parser-options ecmaVersion:6 
1
2

# fails with a parsing error
echo '3 ** 4' | bunx eslint --stdin --parser-options ecmaVersion:6 
1
2

# succeds, yay!
echo '3 ** 4' | npx eslint --stdin --parser-options ecmaVersion:7 
1
2

# succeds, yay!
echo '3 ** 4' | yarn dlx eslint --stdin --parser-options ecmaVersion:7 
1
2

# succeds, yay!
echo '3 ** 4' | pnpm dlx eslint --stdin --parser-options ecmaVersion:7 
1
2

# succeds, yay!
echo '3 ** 4' | bunx eslint --stdin --parser-options ecmaVersion:7 
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

yarn dlx eslint --config ~/personal-eslintrc.js --resolve-plugins-relative-to /usr/local/lib/ 
1

pnpm dlx eslint --config ~/personal-eslintrc.js --resolve-plugins-relative-to /usr/local/lib/ 
1

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

指定规则和插件

--plugin

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

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

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

--plugin 示例

npx eslint --plugin jquery file.js 
1

yarn dlx eslint --plugin jquery file.js 
1

pnpm dlx eslint --plugin jquery file.js 
1

bunx eslint --plugin jquery file.js 
1

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

yarn dlx eslint --plugin eslint-plugin-mocha file.js 
1

pnpm dlx eslint --plugin eslint-plugin-mocha file.js 
1

bunx eslint --plugin eslint-plugin-mocha file.js 
1

--rule

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

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

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

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

--rule 示例

# Apply single rule
npx eslint --rule 'quotes: [error, double]' 
1
2

# Apply single rule
yarn dlx eslint --rule 'quotes: [error, double]' 
1
2

# Apply single rule
pnpm dlx eslint --rule 'quotes: [error, double]' 
1
2

# Apply single rule
bunx eslint --rule 'quotes: [error, double]' 
1
2

# Apply multiple rules
npx eslint --rule 'guard-for-in: error' --rule 'brace-style: [error, 1tbs]' 
1
2

# Apply multiple rules
yarn dlx eslint --rule 'guard-for-in: error' --rule 'brace-style: [error, 1tbs]' 
1
2

# Apply multiple rules
pnpm dlx eslint --rule 'guard-for-in: error' --rule 'brace-style: [error, 1tbs]' 
1
2

# Apply multiple rules
bunx eslint --rule 'guard-for-in: error' --rule 'brace-style: [error, 1tbs]' 
1
2

# Apply rule from jquery plugin
npx eslint --rule 'jquery/dollar-sign: error' 
1
2

# Apply rule from jquery plugin
yarn dlx eslint --rule 'jquery/dollar-sign: error' 
1
2

# Apply rule from jquery plugin
pnpm dlx eslint --rule 'jquery/dollar-sign: error' 
1
2

# Apply rule from jquery plugin
bunx eslint --rule 'jquery/dollar-sign: error' 
1
2

# Only apply rule from the command line
npx eslint --rule 'quotes: [error, double]' --no-eslintrc 
1
2

# Only apply rule from the command line
yarn dlx eslint --rule 'quotes: [error, double]' --no-eslintrc 
1
2

# Only apply rule from the command line
pnpm dlx eslint --rule 'quotes: [error, double]' --no-eslintrc 
1
2

# Only apply rule from the command line
bunx eslint --rule 'quotes: [error, double]' --no-eslintrc 
1
2

--rulesdir

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

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

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

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

--rulesdir 示例

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

yarn dlx eslint --rulesdir my-rules/ file.js 
1

pnpm dlx eslint --rulesdir my-rules/ file.js 
1

bunx eslint --rulesdir my-rules/ file.js 
1

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

yarn dlx eslint --rulesdir my-rules/ --rulesdir my-other-rules/ file.js 
1

pnpm dlx eslint --rulesdir my-rules/ --rulesdir my-other-rules/ file.js 
1

bunx eslint --rulesdir my-rules/ --rulesdir my-other-rules/ file.js 
1

修复问题

--fix

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

• 参数类型：无参数。

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

1. 当代码通过管道传递给 ESLint 时，此选项会引发错误。
2. 此选项对使用处理器的代码无效，除非处理器选择允许自动修复。

如果您想从 stdin 修复代码，或者希望在不实际将其写入文件的情况下获取修复，请使用--fix-dry-run 选项。

--fix 示例

npx eslint --fix file.js 
1

yarn dlx eslint --fix file.js 
1

pnpm dlx eslint --fix file.js 
1

bunx 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

getSomeText | yarn dlx eslint --stdin --fix-dry-run --format json 
1

getSomeText | pnpm dlx eslint --stdin --fix-dry-run --format json 
1

getSomeText | bunx 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 . 
1

yarn dlx eslint --fix --fix-type suggestion . 
1

pnpm dlx eslint --fix --fix-type suggestion . 
1

bunx eslint --fix --fix-type suggestion . 
1

npx eslint --fix --fix-type suggestion --fix-type problem . 
1

yarn dlx eslint --fix --fix-type suggestion --fix-type problem . 
1

pnpm dlx eslint --fix --fix-type suggestion --fix-type problem . 
1

bunx eslint --fix --fix-type suggestion --fix-type problem . 
1

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

yarn dlx eslint --fix --fix-type suggestion,layout . 
1

pnpm dlx eslint --fix --fix-type suggestion,layout . 
1

bunx eslint --fix --fix-type suggestion,layout . 
1

忽略文件

--ignore-path

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

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

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

--ignore-path 示例

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

yarn dlx eslint --ignore-path tmp/.eslintignore file.js 
1

pnpm dlx eslint --ignore-path tmp/.eslintignore file.js 
1

bunx eslint --ignore-path tmp/.eslintignore file.js 
1

npx eslint --ignore-path .gitignore file.js 
1

yarn dlx eslint --ignore-path .gitignore file.js 
1

pnpm dlx eslint --ignore-path .gitignore file.js 
1

bunx eslint --ignore-path .gitignore file.js 
1

--no-ignore

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

• 参数类型：无参数。

--no-ignore 示例

npx eslint --no-ignore file.js 
1

yarn dlx eslint --no-ignore file.js 
1

pnpm dlx eslint --no-ignore file.js 
1

bunx 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

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

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

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

使用 stdin

--stdin

此选项告诉 ESLint 从 STDIN 读取和 lint 源代码，而不是从文件中读取。您可以使用它将代码通过管道传递给 ESLint。

• 参数类型：无参数。

--stdin 示例

cat myFile.js | npx eslint --stdin 
1

cat myFile.js | yarn dlx eslint --stdin 
1

cat myFile.js | pnpm dlx eslint --stdin 
1

cat myFile.js | bunx eslint --stdin 
1

--stdin-filename

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

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

当从 STDIN 处理文件并且您的规则依赖于文件名时，这非常有用。

--stdin-filename 示例

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

cat myFile.js | yarn dlx eslint --stdin --stdin-filename myfile.js 
1

cat myFile.js | pnpm dlx eslint --stdin --stdin-filename myfile.js 
1

cat myFile.js | bunx eslint --stdin --stdin-filename myfile.js 
1

处理警告

--quiet

此选项允许您禁用关于警告的报告和设置为警告的规则的运行。如果您启用此选项，则 ESLint 只会报告错误，并且只会运行设置为错误的规则。

• 参数类型：无参数。

--quiet 示例

npx eslint --quiet file.js 
1

yarn dlx eslint --quiet file.js 
1

pnpm dlx eslint --quiet file.js 
1

bunx eslint --quiet file.js 
1

--max-warnings

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

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

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

--max-warnings 示例

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

yarn dlx eslint --max-warnings 10 file.js 
1

pnpm dlx eslint --max-warnings 10 file.js 
1

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

输出

-o, --output-file

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

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

-o, --output-file 示例

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

yarn dlx eslint -o ./test/test.html 
1

pnpm dlx eslint -o ./test/test.html 
1

bunx 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

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

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

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

-f, --format 示例

使用内置的 json 格式化器

npx eslint --format json file.js 
1

yarn dlx eslint --format json file.js 
1

pnpm dlx eslint --format json file.js 
1

bunx eslint --format json file.js 
1

使用本地自定义格式化器

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

yarn dlx eslint -f ./customformat.js file.js 
1

pnpm dlx eslint -f ./customformat.js file.js 
1

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

使用 npm 安装的格式化器

npm install eslint-formatter-pretty
1

yarn add eslint-formatter-pretty
1

pnpm add eslint-formatter-pretty
1

bun add eslint-formatter-pretty
1

然后运行以下命令之一

npx eslint -f pretty file.js 
1

yarn dlx eslint -f pretty file.js 
1

pnpm dlx eslint -f pretty file.js 
1

bunx eslint -f pretty file.js 
1

或替代地

npx eslint -f eslint-formatter-pretty file.js 
1

yarn dlx eslint -f eslint-formatter-pretty file.js 
1

pnpm dlx eslint -f eslint-formatter-pretty file.js 
1

bunx eslint -f eslint-formatter-pretty file.js 
1

--color 和 --no-color

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

• 参数类型：无参数。

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

--color 和 --no-color 示例

npx eslint --color file.js | cat 
1

yarn dlx eslint --color file.js | cat 
1

pnpm dlx eslint --color file.js | cat 
1

bunx eslint --color file.js | cat 
1

npx eslint --no-color file.js 
1

yarn dlx eslint --no-color file.js 
1

pnpm dlx eslint --no-color file.js 
1

bunx eslint --no-color file.js 
1

内联配置注释

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

yarn dlx eslint --no-inline-config file.js 
1

pnpm dlx eslint --no-inline-config file.js 
1

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

--report-unused-disable-directives

当在没有报告错误的行上报告指令注释（如 // eslint-disable-line）时，此选项会使 ESLint 报告它们。

• 参数类型：无参数。

通过清理不再适用的旧 eslint-disable 和 eslint-enable 注释，这对于防止将来意外抑制错误非常有用。

--report-unused-disable-directives 示例

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

yarn dlx eslint --report-unused-disable-directives file.js 
1

pnpm dlx eslint --report-unused-disable-directives file.js 
1

bunx 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

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

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

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

--report-unused-inline-configs

此选项使 ESLint 报告内联配置注释（如 /* eslint rule-name: "error" */），其规则严重性和任何选项与已配置的内容匹配。

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

这对于保持文件清洁且没有误导性的混乱非常有用。内联配置注释旨在以某种方式更改 ESLint 的行为：如果它们不更改任何内容，则没有理由将它们留在其中。

--report-unused-inline-configs 示例

npx eslint --report-unused-inline-configs error file.js
1

缓存

--cache

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

• 参数类型：无参数。

如果您使用 --cache 运行 ESLint，然后不使用 --cache 运行 ESLint，则 .eslintcache 文件将被删除。这是必要的，因为 lint 的结果可能会更改并使 .eslintcache 无效。如果您想控制何时删除缓存文件，请使用 --cache-location 来指定缓存文件的备用位置。

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

--cache 示例

npx eslint --cache file.js 
1

yarn dlx eslint --cache file.js 
1

pnpm dlx eslint --cache file.js 
1

bunx 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

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

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

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

--cache-strategy

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

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

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

--cache-strategy 示例

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

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

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

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

杂项

--init

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

• 参数类型：无参数。

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

--init 示例

npx eslint --init 
1

yarn dlx eslint --init 
1

pnpm dlx eslint --init 
1

bunx eslint --init 
1

--env-info

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

• 参数类型：无参数。

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

--env-info 示例

npx eslint --env-info 
1

yarn dlx eslint --env-info 
1

pnpm dlx eslint --env-info 
1

bunx 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

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

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

bunx 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

yarn dlx eslint --exit-on-fatal-error file.js 
1

pnpm dlx eslint --exit-on-fatal-error file.js 
1

bunx 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

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

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

bunx 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

yarn dlx eslint --pass-on-no-patterns 
1

pnpm dlx eslint --pass-on-no-patterns 
1

bunx eslint --pass-on-no-patterns 
1

--debug

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

• 参数类型：无参数。

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

--debug 示例

npx eslint --debug test.js 
1

yarn dlx eslint --debug test.js 
1

pnpm dlx eslint --debug test.js 
1

bunx eslint --debug test.js 
1

-h, --help

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

• 参数类型：无参数。

-h, --help 示例

npx eslint --help 
1

yarn dlx eslint --help 
1

pnpm dlx eslint --help 
1

bunx eslint --help 
1

-v, --version

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

• 参数类型：无参数。

-v, --version 示例

npx eslint --version 
1

yarn dlx eslint --version 
1

pnpm dlx eslint --version 
1

bunx eslint --version 
1

--print-config

此选项输出要用于传递文件的配置。存在此选项时，不会执行 linting，并且只有与配置相关的选项有效。当您使用此标志时，CLI 不会执行 linting。

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

--print-config 示例

npx eslint --print-config file.js 
1

yarn dlx eslint --print-config file.js 
1

pnpm dlx eslint --print-config file.js 
1

bunx eslint --print-config file.js 
1

--stats

此选项添加了一系列详细的性能统计信息（请参阅统计信息类型），例如parse、fix 和 lint 时间（每个规则的时间）到传递给格式化器的result 对象（请参阅统计信息 CLI 用法）。

• 参数类型：无参数。

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

--stats 示例

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

yarn dlx eslint --stats --format json file.js 
1

pnpm dlx eslint --stats --format json file.js 
1

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

--flag

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

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

--flag 示例

npx eslint --flag x_feature file.js 
1

yarn dlx eslint --flag x_feature file.js 
1

pnpm dlx eslint --flag x_feature file.js 
1

bunx eslint --flag x_feature file.js 
1

退出代码

在 linting 文件时，ESLint 以以下退出代码之一退出

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