vue/comment-directive

在 <template> 中支持注释指令

⚙️ 此规则包含在所有 "plugin:vue/base"、*.configs["flat/base"]、"plugin:vue/essential"、*.configs["flat/vue2-essential"]、"plugin:vue/vue3-essential"、*.configs["flat/essential"]、"plugin:vue/strongly-recommended"、*.configs["flat/vue2-strongly-recommended"]、"plugin:vue/vue3-strongly-recommended"、*.configs["flat/strongly-recommended"]、"plugin:vue/recommended"、*.configs["flat/vue2-recommended"]、"plugin:vue/vue3-recommended" 和 *.configs["flat/recommended"] 中。

此规则的唯一目的是在 <template> 和块级提供 eslint-disable 功能。它支持使用以下注释

注意

我们不能在标签中编写 HTML 注释。

📖 规则详情

ESLint 没有提供任何 API 来增强 eslint-disable 功能，并且 ESLint 规则不能影响其他规则。但 ESLint 提供了处理器 API。

此规则将所有类似 eslint-disable 的注释作为错误发送到 .vue 文件处理器的后处理，然后后处理删除所有 vue/comment-directive 错误和禁用区域中报告的错误。

正在加载...

类似 eslint-disable 的注释可以在 <template> 和块级使用。

正在加载...

eslint-disable 注释在一个块之后无效。

正在加载...

类似 eslint-disable 的注释可以包含描述，以解释为什么需要该注释。描述必须出现在指令之后，并由两个或多个连续的 - 字符与指令分隔。例如

正在加载...

json

{
  "vue/comment-directive": ["error", {
    "reportUnusedDisableDirectives": false
  }]
}

reportUnusedDisableDirectives ... 如果为 true，则报告未使用的 eslint-disable HTML 注释。默认为 false

正在加载...

注意

无法使用 eslint-disable HTML 注释抑制未使用的报告。

此规则是在 eslint-plugin-vue v4.1.0 版本中引入的。