@foundbyte/eslint-plugin 1.1.4-alpha.4 → 1.1.4-alpha.6

package/README.md

@@ -48,6 +48,14 @@ module.exports = {
       ]
     }],
     '@foundbyte/no-excessive-any': ['error', { maxAnyCount: 5 }],
+    '@foundbyte/no-disabled-comments': ['error', {
+       patterns: [
+        '/^\\s*eslint-disable-next-line\\s*$/', 
+        '/^\\s*eslint-disable\\s*$/',
+        '/no-explicit-any/',
+        '/vue-script-lines-limit/',
+        '/hooks-export-limit/'
+    ]}]
   },
 }
 ```
@@ -341,6 +349,95 @@ export default {
 </script>
 ```
 
+### no-disabled-comments
+
+禁止使用特定的 ESLint 禁用注释，如 `eslint-disable`、`eslint-disable-next-line` 等。支持 JavaScript/TypeScript 注释和 Vue 模板中的 HTML 注释。
+
+**配置示例：**
+```javascript
+'@foundbyte/no-disabled-comments': ['error', {
+  patterns: [
+    '/^\\s*eslint-disable-next-line\\s*$/',  // 匹配 "eslint-disable-next-line"（不加后缀规则）
+    '/^\\s*eslint-disable\\s*$/',            // 匹配 "eslint-disable"
+    '/no-explicit-any/',                     // 模糊匹配包含 "no-explicit-any" 的注释
+    '/vue-script-lines-limit/',              // 模糊匹配包含 "vue-script-lines-limit" 的注释
+    '/hooks-export-limit/'                   // 模糊匹配包含 "hooks-export-limit" 的注释
+  ]
+}]
+```
+
+**支持的注释类型：**
+1. **JavaScript/TypeScript 注释**：
+   - 行注释：`// eslint-disable-next-line`
+   - 块注释：`/* eslint-disable */`
+
+2. **Vue 模板中的 HTML 注释**：
+   - `<!-- eslint-disable -->`
+   - `<!-- eslint-disable-next-line -->`
+
+**检测的注释内容：**
+- 注释内容经过 `trim()` 处理，去除前后空白字符
+- 支持正则表达式模糊匹配
+- 支持多个模式同时匹配
+
+**示例：**
+```javascript
+// ✅ 正确 - 不匹配任何禁用模式
+// 普通注释
+/* 另一个普通注释 */
+
+// ❌ 错误 - 匹配 "eslint-disable-next-line" 模式
+// eslint-disable-next-line
+console.log('test');
+
+// ❌ 错误 - 匹配 "eslint-disable" 模式
+/* eslint-disable */
+console.log('test');
+
+// ❌ 错误 - 模糊匹配包含 "no-explicit-any" 的注释
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+const x: any = 1;
+
+// ❌ 错误 - 模糊匹配包含 "vue-script-lines-limit" 的注释
+/* eslint-disable vue-script-lines-limit */
+```
+
+```vue
+<!-- ✅ 正确 - 普通 HTML 注释 -->
+<!-- 这是一个普通注释 -->
+
+<!-- ❌ 错误 - 匹配 "eslint-disable" 模式 -->
+<!-- eslint-disable -->
+
+<!-- ❌ 错误 - 匹配 "eslint-disable-next-line" 模式 -->
+<!-- eslint-disable-next-line -->
+
+<!-- ❌ 错误 - 模糊匹配包含 "no-explicit-any" 的注释 -->
+<!-- eslint-disable @typescript-eslint/no-explicit-any -->
+```
+
+**配置选项：**
+
+- `patterns` (array, 必填): 要禁用的注释模式列表
+  - 可以是正则表达式字符串，如 `'/^\\s*eslint-disable-next-line\\s*$/'`
+  - 可以是普通字符串，会自动转义并创建正则表达式
+  - 支持多个模式，只要匹配任意一个模式就会报错
+
+- `caseSensitive` (boolean, 默认 false): 是否区分大小写
+  - 当为 false 时，匹配不区分大小写
+  - 当为 true 时，匹配区分大小写
+
+**错误消息：**
+- `禁止使用注释: "eslint-disable-next-line"，如必须排除，请在 .eslintignore 中排除，并写清楚排除原因`
+- `禁止使用注释: "eslint-disable"，如必须排除，请在 .eslintignore 中排除，并写清楚排除原因`
+- `禁止使用注释: "eslint-disable-next-line @typescript-eslint/no-explicit-any"，如必须排除，请在 .eslintignore 中排除，并写清楚排除原因`
+
+**注意：**
+- 该规则会检查所有 JavaScript/TypeScript 注释和 Vue 模板中的 HTML 注释
+- 对于 Vue 文件，规则会同时检查 `<script>` 中的 JavaScript 注释和 `<template>` 中的 HTML 注释
+- 建议只禁用特定的、有问题的规则，而不是使用无参数的 `eslint-disable` 禁用所有规则
+- 如果确实需要排除某些文件，建议使用 `.eslintignore` 文件
+
 ### tag-attribute-restriction
 
 限制特定标签使用某些属性或属性值。

package/index.js

@@ -6,6 +6,7 @@ const hooksArrowFunctionOnlyRule = require('./lib/rules/hooks-arrow-function-onl
 const tagAttributeRestrictionRule = require('./lib/rules/tag-attribute-restriction')
 const noInitialAsAssertionRule = require('./lib/rules/no-initial-as-assertion')
 const noExcessiveAnyRule = require('./lib/rules/no-excessive-any')
+const noDisabledCommentsRule = require('./lib/rules/no-disabled-comments')
 
 module.exports = {
   rules: {
@@ -17,5 +18,6 @@ module.exports = {
     'tag-attribute-restriction': tagAttributeRestrictionRule,
     'no-initial-as-assertion': noInitialAsAssertionRule,
     'no-excessive-any': noExcessiveAnyRule,
+    'no-disabled-comments': noDisabledCommentsRule,
   },
 }

package/lib/rules/index.d.ts

@@ -6,6 +6,7 @@ export { HooksArrowFunctionOnlyOptions } from './hooks-arrow-function-only'
 export { TagAttributeRestrictionOptions } from './tag-attribute-restriction'
 export { NoInitialAsAssertionOptions } from './no-initial-as-assertion'
 export { NoExcessiveAnyOptions } from './no-excessive-any'
+export { NoDisabledCommentsOptions } from './no-disabled-comments'
 
 import { Rule } from 'eslint'
 
@@ -53,6 +54,11 @@ export interface Rules {
    */
   'no-excessive-any': Rule.RuleModule
 
+  /**
+   * 禁止使用特定的注释，如 // eslint-disable-next-line no-console
+   */
+  'no-disabled-comments': Rule.RuleModule
+
   /**
    * 索引签名，用于兼容 ESLint 插件类型
    */

package/lib/rules/no-disabled-comments.d.ts

@@ -0,0 +1,18 @@
+import { Rule } from 'eslint'
+
+export interface NoDisabledCommentsOptions {
+  /**
+   * 要禁用的注释模式列表
+   * 可以是普通字符串或正则表达式字符串（以 / 开头和结尾）
+   */
+  patterns?: string[]
+  /**
+   * 是否区分大小写
+   * @default false
+   */
+  caseSensitive?: boolean
+}
+
+declare const rule: Rule.RuleModule
+
+export default rule

package/lib/rules/no-disabled-comments.js

@@ -0,0 +1,127 @@
+module.exports = {
+  meta: {
+    type: 'problem',
+    docs: {
+      description: '禁止使用特定的注释，如 // eslint-disable-next-line no-console',
+      category: 'Best Practices',
+      recommended: false,
+    },
+    fixable: null,
+    schema: [
+      {
+        type: 'object',
+        properties: {
+          patterns: {
+            type: 'array',
+            items: {
+              type: 'string',
+            },
+            description: '要禁用的注释模式列表',
+          },
+          caseSensitive: {
+            type: 'boolean',
+            default: false,
+            description: '是否区分大小写',
+          },
+        },
+        additionalProperties: false,
+      },
+    ],
+    messages: {
+      disabledComment: '禁止使用注释: "{{comment}}"，如必须排除，请在 .eslintignore 中排除，并写清楚排除原因',
+    },
+  },
+
+  create(context) {
+    const options = context.options[0] || {}
+    const patterns = options.patterns || []
+    const caseSensitive = options.caseSensitive || false
+
+    // 如果没有配置模式，则不进行检查
+    if (patterns.length === 0) {
+      return {}
+    }
+
+    // 将字符串模式转换为正则表达式
+    const regexPatterns = patterns.map(pattern => {
+      // 如果模式已经是正则表达式字符串，如 "/eslint-disable-next-line/"
+      if (pattern.startsWith('/') && pattern.endsWith('/')) {
+        const regexBody = pattern.slice(1, -1)
+        return new RegExp(regexBody, caseSensitive ? '' : 'i')
+      }
+      // 普通字符串，进行转义并创建正则表达式
+      const escapedPattern = pattern.replace(/[.*+?^${}()|[\]\\]/g, '\\$&')
+      return new RegExp(escapedPattern, caseSensitive ? '' : 'i')
+    })
+
+    /**
+     * 检查注释是否匹配任何禁用模式
+     */
+    function isCommentDisabled(comment) {
+      const commentText = comment.value.trim()
+      return regexPatterns.some(regex => regex.test(commentText))
+    }
+
+    /**
+     * 检查 Vue 文件中的 HTML 注释
+     */
+    function checkVueHtmlComments(context, sourceCode, regexPatterns) {
+      const text = sourceCode.getText()
+      
+      // 匹配 HTML 注释：<!-- 注释内容 -->
+      // 包括多行注释
+      const htmlCommentRegex = /<!--([\s\S]*?)-->/g
+      let match
+      
+      while ((match = htmlCommentRegex.exec(text)) !== null) {
+        const commentContent = match[1].trim()
+        
+        // 检查注释内容是否匹配任何禁用模式
+        const isDisabled = regexPatterns.some(regex => regex.test(commentContent))
+        
+        if (isDisabled) {
+          // 计算注释的位置
+          const startIndex = match.index
+          const endIndex = match.index + match[0].length
+          
+          context.report({
+            loc: {
+              start: sourceCode.getLocFromIndex(startIndex),
+              end: sourceCode.getLocFromIndex(endIndex),
+            },
+            messageId: 'disabledComment',
+            data: {
+              comment: commentContent,
+            },
+          })
+        }
+      }
+    }
+
+    return {
+      Program() {
+        const sourceCode = context.getSourceCode()
+        const comments = sourceCode.getAllComments()
+
+        // 检查 JavaScript/TypeScript 注释
+        comments.forEach(comment => {
+          if (isCommentDisabled(comment)) {
+            context.report({
+              node: comment,
+              messageId: 'disabledComment',
+              data: {
+                comment: comment.value.trim(),
+              },
+            })
+          }
+        })
+
+        // 检查 Vue 文件中的 HTML 注释
+        const filename = context.getFilename()
+        if (filename.endsWith('.vue')) {
+          checkVueHtmlComments(context, sourceCode, regexPatterns)
+        }
+      },
+    }
+  },
+}

package/lib/rules/tag-attribute-restriction.js

@@ -81,7 +81,7 @@ module.exports = {
                 const text = sourceCode.getText();
                 
                 // 使用正则表达式匹配模板中的标签和属性
-                const tagRegex = /<(\w+)([^>]*)>/g;
+                const tagRegex = /<([\w-]+)([^>]*)>/g;
                 let match;
                 
                 while ((match = tagRegex.exec(text)) !== null) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@foundbyte/eslint-plugin",
-  "version": "1.1.4-alpha.4",
+  "version": "1.1.4-alpha.6",
   "description": "ESLint plugin for enforcing code style rules including arrow function padding, Vue script lines limit, and TypeScript type comment requirements",
   "main": "index.js",
   "types": "index.d.ts",

package/types.d.ts

@@ -1,2 +1,2 @@
 // 导出所有规则配置类型
-export type { ArrowFunctionPaddingOptions, HooksExportLimitOptions, TypeCommentRequirementOptions, VueScriptLinesLimitOptions, HooksArrowFunctionOnlyOptions, NoExcessiveAnyOptions } from './lib/rules'
+export type { ArrowFunctionPaddingOptions, HooksExportLimitOptions, TypeCommentRequirementOptions, VueScriptLinesLimitOptions, HooksArrowFunctionOnlyOptions, NoExcessiveAnyOptions, NoDisabledCommentsOptions } from './lib/rules'