ESLint是一个用来识别 ECMAScript 并且按照规则给出报告的代码检测工具,使用它可以避免低级错误和统一代码的风格。ESLint被设计为完全可配置的,主要有两种方式来配置ESLint:
- 在注释中配置:使用JavaScript注释直接把配置嵌入到JS文件中。
- 配置文件:使用下面任一的文件来为全部的目录和它的子目录指定配置信息。
- javascript:使用.eslintrc.js文件并导出一个包含配置的对象。
- YAML:.eslintrc.yaml或者.eslintrc.yml
- JSON:.eslintrc.json,并且此文件允许使用JS形式的注释
- package.json:在package.json文件中创建eslintConfig属性,所有的配置包含在此属性中。
可以被配置的信息主要分为3类:
- Environments:你的 javascript 脚步将要运行在什么环境(如:nodejs,browser,commonjs等)中。
- Globals:执行代码时脚步需要访问的额外全局变量。
- Rules:开启某些规则,也可以设置规则的等级。
配置全局环境变量
-
javascript代码可以配置eslint在浏览器或者在 nodejs环境中运行:
.eslintrc.js
module.exports = {
env: {
browser: true,
node: true,
},
}; eslint可以在配置文件或注释中指定额外的全局变量,true表示可配置,false表明变量只读:
使用注释来配置:
/* global var1, var2 /
/ global var1:false, var2:false */
- 使用配置文件来配置:
// .eslintrc.js
module.exports = {
globals: {
var1: true,
var2: true,
},
};
规则
在eslint中可以自己定义一些规则:
- "off" 或者 0:关闭规则。
- "warn" 或者 1:打开规则,并且作为一个警告(不影响exit code)。
- "error" 或者 2:打开规则,并且作为一个错误(exit code将会是1)。