配置规则
规则是 ESLint 的核心构建块。规则验证你的代码是否符合特定期望，以及在不符合期望时该怎么做。规则还可以包含特定于该规则的额外配置选项。
ESLint 附带了大量的内置规则，你可以通过插件添加更多规则。你可以使用配置注释或配置文件来修改你的项目使用的规则。
规则严重程度
要更改规则的严重程度，请将规则 ID 设置为以下值之一
"off"或0- 关闭规则。"warn"或1- 将规则作为警告打开（不影响退出代码）。"error"或2- 将规则作为错误打开（触发时退出代码为 1）。
规则通常设置为 "error"，以便在持续集成测试、pre-commit 检查和 pull request 合并期间强制执行规则，因为这样做会导致 ESLint 以非零退出代码退出。
如果你不想强制执行规则，但仍希望 ESLint 报告规则的违规行为，请将严重程度设置为 "warn"。这通常用于引入一个最终将设置为 "error" 的新规则，当规则标记的不是潜在的构建时或运行时错误（例如未使用的变量）时，或者当规则无法确定是否已找到问题（当规则可能存在误报并需要手动审查时）。
使用配置注释
要在文件中使用配置注释来配置规则，请使用以下格式的注释
/* eslint eqeqeq: "off", curly: "error" */
在此示例中，eqeqeq 已关闭，curly 已作为错误打开。你也可以使用数字等效值来表示规则严重程度
/* eslint eqeqeq: 0, curly: 2 */
此示例与上一个示例相同，只是它使用了数字代码而不是字符串值。eqeqeq 规则已关闭，curly 规则设置为错误。
如果规则有其他选项，你可以使用数组字面量语法来指定它们，例如
/* eslint quotes: ["error", "double"], curly: 2 */
此注释为 quotes 规则指定了 “double” 选项。数组中的第一项始终是规则严重程度（数字或字符串）。
配置注释描述
配置注释可以包含描述，以解释为什么需要该注释。描述必须出现在配置之后，并用两个或多个连续的 - 字符与配置分隔开。例如
/* eslint eqeqeq: "off", curly: "error" -- Here's a description about why this configuration is necessary. */
/* eslint eqeqeq: "off", curly: "error"
--------
Here's a description about why this configuration is necessary. */
/* eslint eqeqeq: "off", curly: "error"
* --------
* This will not work due to the line above starting with a '*' character.
*/
报告未使用的 eslint 内联配置注释
要报告未使用的 eslint 内联配置注释（那些不更改任何已配置内容的注释），请使用 reportUnusedInlineConfigs 设置。例如
// eslint.config.js
import { defineConfig } from "eslint/config";
export default defineConfig([
{
linterOptions: {
reportUnusedInlineConfigs: "error"
}
}
]);
此设置默认为 "off"。
此设置类似于 --report-unused-inline-configs CLI 选项。
使用配置文件
要在配置文件中配置规则，请使用 rules 键以及错误级别和你想要使用的任何选项。例如
// eslint.config.js
import { defineConfig } from "eslint/config";
export default defineConfig([
{
rules: {
eqeqeq: "off",
"no-unused-vars": "error",
"prefer-const": ["error", { "ignoreReadBeforeAssign": true }]
}
}
]);
当多个配置对象指定相同的规则时，规则配置将被合并，后面的对象优先于任何之前的对象。例如
import { defineConfig } from "eslint/config";
export default defineConfig([
{
rules: {
semi: ["error", "never"]
}
},
{
rules: {
semi: ["warn", "always"]
}
}
]);
使用此配置，semi 的最终规则配置为 ["warn", "always"]，因为它在数组中最后出现。该数组表示配置是针对严重程度和任何选项的。你可以仅通过定义字符串或数字来更改严重程度，如本例所示
import { defineConfig } from "eslint/config";
export default defineConfig([
{
rules: {
semi: ["error", "never"]
}
},
{
rules: {
semi: "warn"
}
}
]);
在这里，第二个配置对象仅覆盖了严重程度，因此 semi 的最终配置为 ["warn", "never"]。
来自插件的规则
要配置在插件中定义的规则，请在规则 ID 前加上插件命名空间和 /。
例如，在配置文件中
// eslint.config.js
import example from "eslint-plugin-example";
import { defineConfig } from "eslint/config";
export default defineConfig([
{
plugins: {
example
},
rules: {
"example/rule1": "warn"
}
}
]);
在此配置文件中，规则 example/rule1 来自名为 eslint-plugin-example 的插件。
你也可以在配置注释中使用这种格式，例如
/* eslint "example/rule1": "error" */
禁用规则
使用配置注释
- 谨慎使用。 应该限制内联禁用 ESLint 规则，并且仅在有明确且有效理由的情况下使用。内联禁用规则不应该是解决 lint 错误的默认解决方案。
- 记录原因。 在注释的
--部分之后提供注释，解释禁用特定规则的原因。此文档应阐明为什么要禁用该规则以及为什么在特定情况下有必要禁用它。 - 临时解决方案。 如果添加禁用注释作为临时措施来解决紧迫问题，请创建一个后续任务来充分解决根本问题。这确保了在稍后阶段重新审视和解决禁用注释。
- 代码审查和结对编程。 鼓励团队成员定期审查彼此的代码。代码审查可以帮助识别禁用注释背后的原因，并确保它们被适当使用。
- 配置。 尽可能优先使用 ESLint 配置文件而不是禁用注释。配置文件允许一致且项目范围的规则处理。
要在文件的一部分中禁用规则警告，请使用以下格式的块注释
/* eslint-disable */
alert('foo');
/* eslint-enable */
你也可以禁用或启用特定规则的警告
/* eslint-disable no-alert, no-console */
alert('foo');
console.log('bar');
/* eslint-enable no-alert, no-console */
要在整个文件中禁用规则警告，请在文件顶部放置 /* eslint-disable */ 块注释
/* eslint-disable */
alert('foo');
你也可以为整个文件禁用或启用特定规则
/* eslint-disable no-alert */
alert('foo');
为了确保规则永远不会应用（无论将来是否有任何启用/禁用行）
/* eslint no-alert: "off" */
alert('foo');
要在特定行上禁用所有规则，请使用以下格式之一的行注释或块注释
alert('foo'); // eslint-disable-line
// eslint-disable-next-line
alert('foo');
/* eslint-disable-next-line */
alert('foo');
alert('foo'); /* eslint-disable-line */
要在特定行上禁用特定规则
alert('foo'); // eslint-disable-line no-alert
// eslint-disable-next-line no-alert
alert('foo');
alert('foo'); /* eslint-disable-line no-alert */
/* eslint-disable-next-line no-alert */
alert('foo');
要在特定行上禁用多个规则
alert('foo'); // eslint-disable-line no-alert, quotes, semi
// eslint-disable-next-line no-alert, quotes, semi
alert('foo');
alert('foo'); /* eslint-disable-line no-alert, quotes, semi */
/* eslint-disable-next-line no-alert, quotes, semi */
alert('foo');
/* eslint-disable-next-line
no-alert,
quotes,
semi
*/
alert('foo');
以上所有方法也适用于插件规则。例如，要禁用 eslint-plugin-example 的 rule-name 规则，请将插件名称 (example) 和规则名称 (rule-name) 组合成 example/rule-name
foo(); // eslint-disable-line example/rule-name
foo(); /* eslint-disable-line example/rule-name */
注释描述
配置注释可以包含描述，以解释为什么禁用或重新启用规则是必要的。描述必须出现在配置之后，并且需要用两个或多个连续的 - 字符与配置分隔开。例如
// eslint-disable-next-line no-console -- Here's a description about why this configuration is necessary.
console.log('hello');
/* eslint-disable-next-line no-console --
* Here's a very long description about why this configuration is necessary
* along with some additional information
**/
console.log('hello');
使用配置文件
要在配置文件中为一组文件禁用规则，请使用带有 files 键的后续配置对象。例如
// eslint.config.js
import { defineConfig } from "eslint/config";
export default defineConfig([
{
rules: {
"no-unused-expressions": "error"
}
},
{
files: ["*-test.js","*.spec.js"],
rules: {
"no-unused-expressions": "off"
}
}
]);
禁用内联注释
要禁用所有内联配置注释，请在配置文件中使用 noInlineConfig 设置。例如
// eslint.config.js
import { defineConfig } from "eslint/config";
export default defineConfig([
{
linterOptions: {
noInlineConfig: true
},
rules: {
"no-unused-expressions": "error"
}
}
]);
你也可以使用 --no-inline-config CLI 选项来禁用规则注释，以及其他内联配置。
报告未使用的 eslint-disable 注释
要报告未使用的 eslint-disable 注释（那些禁用了不会在禁用行上报告的规则的注释），请使用 reportUnusedDisableDirectives 设置。例如
// eslint.config.js
import { defineConfig } from "eslint/config";
export default defineConfig([
{
linterOptions: {
reportUnusedDisableDirectives: "error"
}
}
]);
此设置默认为 "warn"。
此设置类似于 --report-unused-disable-directives 和 --report-unused-disable-directives-severity CLI 选项。