怎样安装简单配置ESLint

最近更新时间 2020-02-19 16:29:59

ESLint 是在 ECMAScript/JavaScript 代码中识别和报告模式匹配的工具,它的目标是保证代码的一致性和避免错误。在许多方面,它和 JSLint、JSHint 相似。

ESLint最初是由 Nicholas C. Zakas 于2013年6月创建的开源项目。它的目标是提供一个插件化的 javascript 代码检测工具。

  • ESLint 使用 Espree 解析 JavaScript。
  • ESLint 使用 AST 分析代码中的模式。
  • ESLint 是完全插件化的。每一个规则都是一个插件并且你可以在运行时添加更多的规则。

安装 ESLint

安装要求:Node.js (^10.12.0, or >=12.0.0)。

使用 npm 安装 ESLint:

npm install eslint --save-dev

初始化配置文件:

./node_modules/.bin/eslint --init

运行 ESLint:

./node_modules/.bin/eslint yourfile.js

也可以全局安装 ESLint ,使用的任何插件或可共享配置都必须安装在本地。

npm install eslint --global

 配置文件

运行 eslint --init 命令之后,会自动创建 .eslintrc 文件。在 .eslintrc 文件中可以看到许多像这样的规则:

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

"semi""quotes" 是 ESLint 中规则名称。第一个是错误级别,可以使下面的值之一:

  • "off" or 0 - 关闭规则。
  • "warn" or 1 - 将规则视为一个警告(不会影响退出码)。
  • "error" or 2 - 将规则视为一个错误 (退出码为1)。

这三个错误级别可以允许你细粒度的控制 ESLint 是如何应用规则。

.eslintrc 配置文件可以包含下面的一行:

"extends": "eslint:recommended"

这行代码表示启用默认规则配置。只有在你的配置文件中扩展了一个可分享的配置或者明确开启一个规则,ESLint 才会去校验你的代码。

rss_feed