https://eslint.org/
https://cn.eslint.org/
https://cn.eslint.org/docs/user-guide/configuring
https://cn.eslint.org/docs/rules/
ESLint
是在 ECMAScript/JavaScript
代码中识别和报告模式匹配的工具,它的目标是保证代码的一致性和避免错误。
Installation and Usage
- 安装
npm install eslint --save-dev
- 设置一个配置文件
./node_modules/.bin/eslint --init
- 你可以在任何文件或目录上运行
ESLint
./node_modules/.bin/eslint yourfile.js
Configuration
有两种主要的方式来配置 ESLint
:
-
Configuration Comments
- 使用JavaScript
注释把配置信息直接嵌入到一个代码源文件中。 -
Configuration Files
- 使用JavaScript
、JSON
或者YAML
文件为整个目录(处理你的主目录)和它的子目录指定配置信息。
可以配置一个独立的.eslintrc.*
文件,或者直接在package.json
文件里的eslintConfig
字段指定配置,ESLint 会查找和自动读取它们。
有很多信息可以配置
-
Environments
- 指定脚本的运行环境。每种环境都有一组特定的预定义全局变量。 -
Globals
- 脚本在执行期间访问的额外的全局变量。 -
Rules
- 启用的规则及其各自的错误级别。
Rules
运行 eslint --init
之后,.eslintrc
文件会自动创建。你可以在 .eslintrc
文件中看到许多像这样的规则:
{
"rules": {
"semi": ["error", "always"],
"quotes": ["error", "double"]
}
}
-
"semi"
和"quotes"
是 ESLint 中规则
的名称。 - 数组中第一个是错误级别,可以使下面的值之一:
"off"
or0
- 关闭规则
"warn"
or1
- 将规则视为一个警告(不会影响退出码)
"error"
or2
- 将规则视为一个错误 (退出码为1)
所有的规则默认都是禁用的。在配置文件
中,使用 "extends": "eslint:recommended"
来启用推荐的规则,报告一些常见的问题。
你的 .eslintrc
配置文件可以包含下面的一行:
"extends": "eslint:recommended"
由于这行,所有在 规则页面 被标记为 “” 的规则将会默认开启。
网友评论