Versions

ESLint 入门

ESLint 是一个根据方案识别并报告 ECMAScript/JavaScript 代码问题的工具,其目的是使代码风格更加一致并避免错误。在很多地方它都与 JSLint 和 JSHint 类似,除了:

  • ESLint 使用 Espree 对 JavaScript 进行解析。
  • ESLint 在代码中使用 AST 评估方案。
  • ESLint 完全是插件式的,每个规则都是一个插件,你可以在运行时中添加更多插件。

安装并使用

前提条件:内置 SSL 支持的 Node.js 版本(^12.22.0^14.17.0>=16.0.0),如果你使用的是官方 Node.js 发行版,那么已经内置了 SSL 支持。

你可以使用该命令安装并配置 ESLint:

npm init @eslint/config

注意:使用 npm init @eslint/config 时,运行目录需要已经有 package.json 文件了。如果还没有该文件,请确保在此之前运行 npm inityarn init

在此之后,你可以像这样使用 ESLint 检查任一文件或目录:

npx eslint yourfile.js

# 或

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 规则的名称。第一个值代表规则的错误级别,有以下几种可供选择:

  • "off"0 - 关闭该规则
  • "warn"1 - 启用并警告(不影响现有代码)
  • "error"2 - 启用并报错(错误代码 1)

你可以调节这三档错误级别以精准控制 ESLint 规则实施方式(更多配置项和细节,参见配置文档)。

你的 .eslintrc.{js,yml,json} 配置文件也会包括这一行:

{
"extends": "eslint:recommended"
}

这一行将启用所有标记为“推荐”的规则。另外,你也可以通过在 npmjs.com 上搜索“eslint-config”并使用别人创建的配置。在没有扩展别人的可共享配置或在配置中明确启用规则时,ESLint 不会限制你的代码。


下一步