如何在ESLint单行禁用规则注释中添加原因说明？

1. 同一条注释标注规则+禁用原因的实现方式 #

ESLint 原生支持使用两个短横线 -- 作为分隔符，-- 之后的所有内容都会被识别为备注说明，不会被解析为要禁用的规则名，完全符合你期望的同一条注释写全信息的需求，你之前尝试的分号、//等都不是官方约定的分隔符，因此会失效。

正确写法示例：

// eslint-disable-next-line rulename -- 此处填写具体的禁用原因
code.that.violates==rulename

2. 强制要求禁用规则时填写原因 #

可以通过 ESLint 配套插件实现强制校验：

1. 安装 eslint-plugin-eslint-comments 插件
2. 在你的 ESLint 配置文件中新增如下配置：

{
  "plugins": ["eslint-comments"],
  "rules": {
    "eslint-comments/require-description": ["error", {
      // 可配置不需要强制加说明的禁用类型，空数组代表所有禁用场景都要求写原因
      "ignore": []
    }]
  }
}

配置生效后，所有未附带原因的ESLint禁用注释都会直接触发ESLint报错，从流程上强制开发者填写禁用说明。

内容的提问来源于stack exchange，提问作者DJL