mpx/comment-directive

支持 <template> 中的注释指令

• ⚙️ 这条规则包含在"plugin:mpx/base", "plugin:mpx/mpx-essential"。

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

• eslint-disable
• eslint-enable
• eslint-disable-line
• eslint-disable-next-line

Note

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

📖 规则详情

ESLint 不提供任何 API 来增强 eslint-disable 功能，并且 ESLint 规则不会影响其他规则。 但是 ESLint 提供了 处理器 API (opens new window).

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

<template> <!-- eslint-disable-next-line mpx/valid-wx-if --> <view wx:if=""/> </template>

Now loading...

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

<template> <!-- eslint-disable-next-line mpx/valid-wx-if --> <view wx:if=""/> </template> <!-- eslint-disable-next-line mpx/component-tags-order --> <style> </style>

Now loading...

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

<style> </style> <!-- eslint-disable --> <script> /* <- Warning has been disabled. */ </script> <template> <!-- <- Warning are not disabled. --> </template>

Now loading...

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

<template> <!-- eslint-disable-next-line mpx/valid-wx-if -- 这是关于为什么需要禁用此功能的说明。 --> <view wx:if=""/> </template>

Now loading...

🔧 Options

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

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

{ "reportUnusedDisableDirectives": true }

<template> <!-- ✓ GOOD --> <!-- eslint-disable-next-line mpx/valid-wx-if --> <view wx:if=""/> <!-- ✗ BAD --> <!-- eslint-disable-next-line mpx/valid-wx-if --> <view wx:if="{{abc}}"/> </template>

Now loading...

Note

无法使用 eslint-disable HTML 注释禁止未使用的报告。

📚 延伸阅读

• 使用内联注释禁用规则 (opens new window)

🔍 具体实现

• 规则 (opens new window)
• 测试 (opens new window)