配置
2023年02月22日
ESlint
被设计为完全可配置的,我们可以混合和匹配 ESLint
默认绑定的规则和自己定义的规则,根据实际需求对每一个规则进行开启或关闭,以让 ESLint
更适合我们的项目。一般有两种主要的方式来配置 ESLint
:
一、Configuration Comments - 使用注释把lint规则嵌入到源码中
这种配置方式允许我们使用JavaScript
注释把配置信息直接嵌入到一个代码源文件中,如下面的代码所示,可以直接在代码中使用ESLint
能够识别的注释方式,进行Lint
规则的定义,下面的规则表示如果使用console
语法 便会报错。
/* eslint no-console: "error" */
console.log('this is an eslint rule check!');
当我们用命令行执行eslint xxx.js
检查上述文件时,就会发现eslint
给出报错信息。
二、Configuration Files - 使用配置文件进行lint规则配置
除了上面的配置方式,另外一个更好的方式就是在项目根目录创建配置文件进行ESLint
的配置,目前配置文件主要支持以下三种文件类型:
-
JavaScript(eslintrc.js)
-
YAML(eslintrc.yaml)
-
JSON(eslintrc.json)
-
package.json
的eslintConfig