eslint配置方式有两种:
- 注释配置:使用js注释来直接嵌入ESLint配置信息到一个文件里
- 配置文件:使用一个js,JSON或者YAML文件来给整个目录和它的子目录指定配置信息。这些配置可以写在一个文件名为.eslintrc.*的文件或者在package.json文件里的eslintConfig项里,这两种方式ESLint都会自动寻找然后读取,或者你也可以在命令行里指定一个配置文件。
有几种东西是可以配置的:
- 环境:你的脚本会在哪种环境下运行。每个环境带来了一组特定的预定义的全局变量。
- 全局变量:脚本运行期间会访问额外的全局变量。
- 规则:使用那些规则,并且规则的等级是多少。
我们这里使用配置文件.eslintrc.js来配置,它导出一个模块供ESLint识别。
// http://eslint.org/docs/user-guide/configuring
module.exports = {
root: true,
parser: 'babel-eslint',//解析器,这里我们使用babel-eslint
parserOptions: {
sourceType: 'module'//类型为module,因为代码使用了使用了ECMAScript模块
},
env: {
browser: true,//预定义的全局变量,这里是浏览器环境
},
// https://github.com/feross/standard/blob/master/RULES.md#javascript-standard-style
//extends: 'standard', //扩展,可以通过字符串或者一个数组来扩展规则
// required to lint *.vue files
plugins: [
'html' //插件,此插件用于识别文件中的js代码,没有MIME类型标识没有script标签也可以识别到,因此拿来识别.vue文件中的js代码
],
// add your custom rules here
'rules': {
//这里写自定义规则
}
}
ESLint的规则有三种级别:
- "off"或者0,不启用这个规则
- "warn"或者1,出现问题会有警告
- "error"或者2,出现问题会报错
有时候代码里有些特殊情况需要我们在某一行或者某几行关闭ESLint检测,可以使用注释:
下面的代码会关闭所有规则
/* eslint-disable */ alert('foo'); /* eslint-enable */
下面的代码会关闭某一行的所有规则
alert('foo'); // eslint-disable-line // eslint-disable-next-line alert('foo');
下面的代码在某一行关闭指定的规则
alert('foo'); // eslint-disable-line no-alert // eslint-disable-next-line no-alert alert('foo');
常用规则:
规则的细节请到ESLint官方网站查看List of available rules - ESLint - Pluggable JavaScript linter