ESLint 在代码源文件添加配置的方法

Question

除了通过添加配置文件的方式，来指定 ESLint 相关规则之外，还可以在源文件中使用 JavaScript 注释来指定。

1. 指定环境

/* eslint-env node, browser */

// 相当于
{
  "env": {
    "browser": true,
    "node": true
  }
}

2. 指定全局变量

/* global var1, var2 */

// 选择性地指定这些全局变量可以被写入(而不是只被读取)
/* global var1:writable, var2:readonly */

// 由于历史原因，
// 布尔值 false 和字符串值 "readable" 等价于 "readonly"。
// 布尔值 true 和字符串值 "writeable" 等价于 "writable"。但是，不建议使用旧值。
// 使用字符串 "off" 禁用全局变量。假如当前环境不支持使用 Promise 可以通过 "Promise": "off" 全局禁用。
{
  "globals": {
    "var1": "writable",
    "var2": "readonly"
  }
}

3. 指定禁用或者启用规则

/* eslint eqeqeq: "off", curly: "error" */
/* eslint eqeqeq: 0, curly: 2 */

// 如果一个规则有额外的选项，你可以使用数组字面量指定它们，比如：
/* eslint quotes: ["error", "double"], curly: 2 */

// 规则 plugin1/rule1 表示来自插件 plugin1 的 rule1 规则。你也可以使用这种格式的注释配置，比如：
/* eslint "plugin1/rule1": "error" */

// 相当于
{
  "rules": {
    "eqeqeq": "off",
    "curly": "error",
    "quotes": ["error", "double"],
    "plugin1/rule1": "error"
  }
}

4. 临时禁止规则出现警告

/* eslint-disable */
alert('foo');
/* eslint-enable */