# 新手上路

ESLint 是一种用于识别和报告在 ECMAScript/JavaScript 代码中发现的模式的工具，其目标是使代码更加一致并避免错误。在许多方面，它类似于 JSLint 和 JSHint，但有一些例外：

# 安装与使用

先决条件：Node.js（^12.22.0、^14.17.0 或 >=16.0.0）内置 SSL 支持。（如果您使用的是官方 Node.js 发行版，则始终内置 SSL。）

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

npm init @eslint/config

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

之后，您可以在任何文件或目录上运行 ESLint，如下所示：

npx eslint yourfile.js

# or

yarn run eslint yourfile.js

也可以全局安装 ESLint 而不是本地安装（使用 npm install eslint --global）。但是，不建议这样做，并且无论哪种情况，您使用的任何插件或可共享配置都必须在本地安装。

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

运行 npm init @eslint/config 后，您的目录中将有一个 .eslintrc.{js,yml,json} 文件。在其中，您将看到一些配置如下的规则：

{
    "rules": {
        "semi": ["error", "always"],
        "quotes": ["error", "double"]
    }
}

名称 "semi" 和 "quotes" 是 ESLint 中 规则 的名称。第一个值是规则的错误级别，可以是以下值之一：

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

您的 .eslintrc.{js,yml,json} 配置文件还将包括以下行：

{
    "extends": "eslint:recommended"
}

因为这行，规则页 上所有标记为 "(recommended)" 的规则都会被开启。或者，您可以通过在 npmjs.com 上搜索 "eslint-config" 来使用其他人创建的配置。除非您从共享配置扩展或在配置中明确打开规则，否则 ESLint 不会检查您的代码。