使用流程
1. install
npm i -g eslint
2. install for ide
sublime 2 package
SublimeLinter
SublimeLinter-contrib-eslint
vscode 1 package
eslint
3. init config file
in command write:
eslint --init
配置方式
1.comments ,直接在javscript中注释
2.configuration files
2.1 .eslintrc.* 文件
2.2 package.json中的eslintConfig字段
属性
Environments
指定脚本的运行环境。每种环境都有一组特定的预定义全局变量。
Globals
脚本在执行期间访问的额外的全局变量
Rules
启用的规则及各自的错误级别
env
这些环境并不是相互排斥的,所以你可以一次定义多个。
可以在一个文件里,在配置文件中或使用 --env 命令行来指定环境。
在你的 JavaScript 文件中使用注释来指定环境,格式如下:
/* eslint-env node, mocha */
该设置启用了 Node.js 和 Mocha 环境。
在配置文件里指定环境,使用 env,指定你想启用的环境,设置它们为 true。例如,以下示例启用了 browser 和 Node.js 的环境:
{
"env": {
"browser": true,
"node": true
}
}
Specifying Globals
当访问未定义的变量时,no-undef 规则将发出警告。如果你想在一个文件里使用全局变量,推荐你定义这些全局变量,这样 ESLint 就不会发出警告了。你可以使用注释或在配置文件中定义全局变量。
在你的 JavaScript 文件中,用注释指定全局变量,格式如下:
/* global var1, var2 */
这里定义了两个全局变量:var1 和 var2。如果你想指定这些变量不应被重写(只读),你可以将它们设置为 false:
/* global var1:false, var2:false */
在配置文件里配置全局变量时,使用 globals 指出你要使用的全局变量。设置每个变量等于 true 允许变量被重写,或 false 不允许被重写。比如:
{
"globals": {
"var1": true,
"var2": false
}
}
rules
values
1."off" 或 0
关闭规则
2. "warn" 或 1
开启规则,使用警告级别的错误:warn (不会导致程序退出)
3."error" 或 2
开启规则,使用错误级别的错误:error (当被触发的时候,程序会退出)
为了在文件注释里配置规则,使用以下格式的注释:
/* eslint eqeqeq: "off", curly: "error" */
在这个例子里,eqeqeq 规则被关闭,curly 规则被打开,定义为错误级别。你也可以使用对应的数字定义规则严重程度:
/* eslint eqeqeq: 0, curly: 2 */
这个例子和上个例子是一样的,只不过它是用的数字而不是字符串。eqeqeq 规则是关闭的,curly 规则被设置为错误级别。
如果一个规则有额外的选项,你可以使用数组字面量指定它们,比如:
/* eslint quotes: ["error", "double"], curly: 2 */
这条注释为规则 quotes 指定了 “double”选项。数组的第一项总是规则的严重程度(数字或字符串)。
使用 rules 连同错误级别和任何你想使用的选项在配置文件中进行规则配置。例如:
{
"rules": {
"eqeqeq": "off",
"curly": "error",
"quotes": ["error", "double"]
}
}