Disabling Rules with Inline Comments
注释语句
- /* eslint-disable */ 和 /* eslint-enable */
- /* global */
- /* eslint */
- /* eslint-env */
一、
- 注释禁用多行代码的eslint规则
/\* eslint-disable \*/ ... /\* eslint-enable \*/
- 注释禁用多行代码指定的eslint规则
/\* eslint-disable no-alert \*/ ... /\* eslint-enable no-alert */
- 禁用单行代码的eslint规则
alert('foo'); // eslint-disable-line // eslint-disable-next-line alert('foo');
- 禁用单行代码的指定eslint规则
alert('foo'); // eslint-disable-line no-alert, quotes, semi // eslint-disable-next-line no-alert, quotes, semi alert('foo');
- 对整个文件禁用或启用eslint规则,讲这句注释加到文件开头
/\* eslint-disable \*/
二、 当访问未定义的变量时,no-undef 规则将发出警告。如果你想在一个文件里使用全局变量,推荐你定义这些全局变量,这样 ESLint 就不会发出警告了。你可以使用注释或在配置文件中定义全局变量。
在你的 JavaScript 文件中,用注释指定全局变量,格式如下:
/* global var1, var2 */
这里定义了两个全局变量:var1 和 var2。如果你想指定这些变量不应被重写(只读),你可以将它们设置为 false:
/* global var1:false, var2:false */
在配置文件里配置全局变量时,使用 globals 指出你要使用的全局变量。设置每个变量等于 true 允许变量被重写,或 false 不允许被重写。比如:
{
"globals": {
"var1": true,
"var2": false
}
}
三、 为了在文件注释里配置规则,使用以下格式的注释:
/* eslint eqeqeq: "off", curly: "error" */
四、 在你的 JavaScript 文件中使用注释来指定环境,格式如下:
/ eslint-env node, mocha / 该设置启用了 Node.js 和 Mocha 环境。
在配置文件里指定环境,使用 env,指定你想启用的环境,设置它们为 true。例如,以下示例启用了 browser 和 Node.js 的环境:
{
"env": {
"browser": true,
"node": true
}
}
上面的所有方法同样适用于插件规则。例如,禁止 eslint-plugin-example 的 rule-name 规则,把插件名(example)和规则名(rule-name)结合为 example/rule-name:
foo(); // eslint-disable-line example/rule-name
注意:为文件的某部分禁用警告的注释,告诉 ESLint 不要对禁用的代码报告规则的冲突。ESLint 仍解析整个文件,然而,禁用的代码仍需要是有效的 JavaScript 语法。
=
=