ESLint 被设计为完全可配置的，这表示我们可以关闭每一个规则，而只运行基本语法验证，或混合和匹配 ESLint 默认绑定的规则和自定义规则，以让 ESLint 更适合我们的项目。
配置 ESLint有如下两种方式：
-
配置注释：使用 JavaScript 注释将配置信息直接嵌入文件中。
-
配置文件：使用 JavaScript，JSON 或 YAML 文件为整个目录及其所有子目录指定配置信息。可以配置一个独立的
.eslintrc.*文件，或者直接在package.json文件里的eslintConfig字段指定配置，ESLint 会查找和自动读取它们，也可以在命令行上指定配置文件。
配置文件
-
package.json文件配置：
一般每个项目下都有一而个package.json文件，这个文件定义了项目所需要的各种模块，以及项目的配置信息（比如名称、版本、许可证等元数据）。可以手动创建这个文件或者直接使用npm init命令自动生成。npm install命令回根据这个配置文件，自动下载所需的模块，也就是配置项目所需的运行和开发环境。
-
.eslintrc文件配置：
然后我们可以开始创建配置文件.eslintrc，生成配置文件的命令如下所示：
$ eslint --init
如果我们选择的本地安装，那么则需要进入到node_modules/.bin目录来该执行命令：
$ cd node_modules/.bin
$ eslint --init
示例：
我们可以在终端中输入命令执行上述命令：
如图所示，会以问答的形式生成来配置文件，我们可以根据自己的需求来选择，出现如下图所示提示则表示文件创建成功：
生成的.eslintrc.js文件内容大致如下所示：
module.exports = {
"env": {
"browser": true,
"es6": true
},
"extends": [
"eslint:recommended",
"plugin:vue/essential"
],
"globals": {
"Atomics": "readonly",
"SharedArrayBuffer": "readonly"
},
"parserOptions": {
"ecmaVersion": 2018,
"sourceType": "module"
},
"plugins": [
"vue"
],
"rules": {
}
};
文件中有如下几个配置项：
-
env：指定代码运行的宿主环境。 -
extends：指定 eslint 规范。 -
globals：声明在代码中的自定义全局变量。 -
parserOptions：设置解析器选项。 -
plugins：引用第三方的插件。 -
rules：启用额外的规则或覆盖默认的规则。
运行ESLint
配置文件创建成功后，我们可以使用ESLint命令来测试文件。注意要在.bin目录下，执行eslint命令：
$ cd node_modules/.bin
$ eslint filename.js
其中filename.js就是需要测试的文件名，记得要在.bin目录下运行eslint命令。
示例：
例如我们创建一个用于测试的add.js文件，文件内容如下所示：
function add(i) {
if (i != NaN) {
return i ++
} else {
return
}
};
然后在终端中执行eslint add.js，可以看到输出 3个错误：
例如第一个错误no-unused-vars表示禁止使用未使用的变量。第二个错误use-isnan表示在在检查“NaN”时需要调用isNaN()。第三个错误no-extra-semi表示不允许不必要的分号。
配置文件格式
ESLint 支持几种格式的配置文件：
-
JavaScript：使用.eslintrc.js然后输出一个配置对象。 -
YAML：使用.eslintrc.yaml或.eslintrc.yml去定义配置的结构。 -
JSON：使用.eslintrc.json去定义配置的结构，ESLint 的 JSON 文件允许 JavaScript 风格的注释。 -
package.json：在package.json里创建一个eslintConfig属性，在那里定义你的配置。
如果同一个目录下有多个配置文件，ESLint 只会使用一个。优先级顺序如下：
.eslintrc.js
.eslintrc.yaml
.eslintrc.yml
.eslintrc.json
.eslintrc
package.json
网友评论