ESLint 入门

ESLint 是一款用于识别和报告 ECMAScript/JavaScript 代码中发现的模式的工具，其目标是使代码更具一致性并避免错误。

ESLint 完全可扩展。每个规则都是一个插件，您可以在运行时添加更多插件。您还可以添加社区插件、配置和解析器以扩展 ESLint 的功能。

先决条件

要使用 ESLint，您必须安装并构建支持 SSL 的 Node.js（^18.18.0、^20.9.0 或 >=21.1.0）。（如果您使用的是官方 Node.js 发行版，则始终内置 SSL。）

快速入门

您可以使用此命令安装和配置 ESLint

npm init @eslint/config@latest

# or

yarn create @eslint/config

# or

pnpm create @eslint/config@latest
1
2
3
4
5
6
7
8
9

如果您想使用 npm 上托管的特定可共享配置，则可以使用 --config 选项并指定包名称

# use `eslint-config-standard` shared config

# npm 7+
npm init @eslint/config@latest -- --config eslint-config-standard

1
2
3
4
5

注意：npm init @eslint/config 假设您已经拥有 package.json 文件。如果没有，请确保事先运行 npm init 或 yarn init。

之后，您可以像这样在任何文件或目录上运行 ESLint

npx eslint yourfile.js

# or

yarn run eslint yourfile.js
1
2
3
4
5

配置

注意：如果您来自 9.0.0 之前的版本，请参阅迁移指南。

运行 npm init @eslint/config 后，您的目录中将有一个 eslint.config.js（或 eslint.config.mjs）文件。在其中，您将看到一些像这样配置的规则

// eslint.config.js
export default [
    {
        rules: {
            "no-unused-vars": "error",
            "no-undef": "error"
        }
    }
];
1
2
3
4
5
6
7
8
9

"no-unused-vars" 和 "no-undef" 是 ESLint 中规则的名称。第一个值是规则的错误级别，可以是以下值之一

"off" 或 0 - 关闭规则
"warn" 或 1 - 将规则打开为警告（不影响退出代码）
"error" 或 2 - 将规则打开为错误（退出代码将为 1）

这三个错误级别允许您对 ESLint 如何应用规则进行细粒度控制（有关更多配置选项和详细信息，请参阅配置文档）。

您的 eslint.config.js 配置文件还将包含一个推荐的配置，如下所示

// eslint.config.js
import js from "@eslint/js";

export default [
    js.configs.recommended,

    {
        rules: {
            "no-unused-vars": "warn",
            "no-undef": "warn"
        }
    }
];
1
2
3
4
5
6
7
8
9
10
11
12
13

js.configs.recommended 对象包含配置，以确保规则页面上标记为推荐的所有规则都将打开。或者，您可以使用其他人创建的配置，方法是在 npmjs.com 上搜索“eslint-config”。除非您从共享配置扩展或在配置中明确打开规则，否则 ESLint 不会检查您的代码。

全局安装

还可以使用 npm install eslint --global 全局安装 ESLint，而不是本地安装。但是，不建议这样做，并且如果您全局安装 ESLint，则您使用的任何插件或可共享配置仍必须本地安装。

手动设置

您也可以在项目中手动设置 ESLint。

在开始之前，您必须已经拥有 package.json 文件。如果没有，请确保事先运行 npm init 或 yarn init 以创建该文件。

在您的项目中安装 ESLint 包

npm install --save-dev eslint @eslint/js
1

添加 eslint.config.js 文件

# Create JavaScript configuration file
touch eslint.config.js
1
2

将配置添加到 eslint.config.js 文件。请参阅配置 ESLint 文档，了解如何添加规则、自定义配置、插件等。

import js from "@eslint/js";

export default [
    js.configs.recommended,

   {
       rules: {
           "no-unused-vars": "warn",
           "no-undef": "warn"
       }
   }
];
1
2
3
4
5
6
7
8
9
10
11
12

使用 ESLint CLI 检查代码
```
npx eslint project-dir/ file1.js
1
```
有关可用 CLI 选项的更多信息，请参阅命令行界面。

后续步骤

了解 ESLint 的高级配置。
熟悉命令行选项。
探索 ESLint 与其他工具（如编辑器、构建系统等）的集成。
找不到合适的规则？创建您自己的自定义规则。
通过贡献使 ESLint 变得更好。

编辑此页面