@foundbyte/eslint-plugin 1.1.4-alpha.5 → 1.1.4-alpha.7

package/README.md

@@ -47,6 +47,12 @@ module.exports = {
         }
       ]
     }],
+    '@foundbyte/no-restricted-components': ['error', [
+      {
+        pattern: '/^a-(textarea|table)$/',
+        message: '禁止使用的Arco Design组件，请使用Keyblade组件替代'
+      }
+    ]],
     '@foundbyte/no-excessive-any': ['error', { maxAnyCount: 5 }],
     '@foundbyte/no-disabled-comments': ['error', {
        patterns: [
@@ -438,6 +444,59 @@ const x: any = 1;
 - 建议只禁用特定的、有问题的规则，而不是使用无参数的 `eslint-disable` 禁用所有规则
 - 如果确实需要排除某些文件，建议使用 `.eslintignore` 文件
 
+### no-restricted-components
+
+通过正则表达式配置禁止使用某些组件，支持自定义错误消息。
+
+**配置示例：**
+```javascript
+'@foundbyte/no-restricted-components': ['error', [
+  {
+    pattern: '/^a-(textarea|table)$/',  // 正则表达式字符串，匹配 a-textarea 和 a-input
+    message: '禁止使用 a-textarea 和 a-table 组件，请使用自定义组件替代'
+  },
+  {
+    pattern: 'kb-pro-table',            // 普通字符串，自动转义为正则表达式
+    message: '禁止使用 kb-pro-table 组件，请使用其他表格组件'
+  }
+]]
+```
+
+**支持的语法：**
+- 正则表达式字符串：以 `/` 开头和结尾，如 `/^a-(textarea|table)$/`
+- 普通字符串：自动转义并创建正则表达式，如 `'a-textarea'`
+- 支持自闭合标签：`<a-textarea />`
+- 支持普通标签：`<a-textarea></a-textarea>`
+- 支持带属性的标签：`<a-textarea v-model="value" />`
+- 只对 .vue 文件生效，不会影响其他文件类型
+
+**示例：**
+```vue
+<!-- ✅ 正确 - 不匹配任何禁止模式的组件 -->
+<div>正常内容</div>
+<span>正常内容</span>
+<custom-component />
+
+<!-- ❌ 错误 - 匹配 a-textarea 模式 -->
+<a-textarea />
+<a-textarea></a-textarea>
+
+<!-- ❌ 错误 - 匹配 a-input 模式 -->
+<a-input />
+
+<!-- ❌ 错误 - 匹配 kb-pro-table 模式 -->
+<kb-pro-table />
+```
+
+**错误消息：**
+- 显示配置中指定的自定义消息，如：`禁止使用 a-textarea 和 a-input 组件，请使用自定义组件替代`
+
+**注意：**
+- 该规则只检查 .vue 文件中的模板部分，不会检查 JavaScript/TypeScript 代码中的字符串
+- 支持同时配置多个禁止模式，每个模式独立检查
+- 正则表达式匹配组件名，不区分大小写
+- 建议使用具体的组件名模式，避免过度匹配
+
 ### tag-attribute-restriction
 
 限制特定标签使用某些属性或属性值。

package/index.d.ts

@@ -1,10 +1,14 @@
 import { ESLint } from 'eslint'
 import { Rules } from './lib/rules'
+import { Rule } from 'eslint'
 
 export { ArrowFunctionPaddingOptions, HooksExportLimitOptions, TypeCommentRequirementOptions, VueScriptLinesLimitOptions, HooksArrowFunctionOnlyOptions } from './types'
 
 declare const plugin: ESLint.Plugin & {
   rules: Rules
+  configs: {
+    customize: (options?: Record<string, any>) => { rules: Rule }
+  }
 }
 
 export { type Rules, plugin as default }

package/index.js

@@ -7,6 +7,26 @@ const tagAttributeRestrictionRule = require('./lib/rules/tag-attribute-restricti
 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')
+const noRestrictedComponentsRule = require('./lib/rules/no-restricted-components')
+
+// 限制属性，同时相当于限制某些组件禁止使用
+const restrictions = [
+  {
+    // 禁止<image />直接使用空的mode: <image mode="" />
+    tag: 'image',
+    attributes: [
+      { name: 'mode', disallowedValues: [''] },
+    ]
+  },
+  {
+    // 禁止<kb-pro-table /> 使用v-bind，请使用main.ts全局配置
+    tag: 'kb-pro-table',
+    attributes: [
+      { name: 'v-bind' },
+      { name: 'bordered' },
+    ],
+  },
+]
 
 module.exports = {
   rules: {
@@ -19,5 +39,49 @@ module.exports = {
     'no-initial-as-assertion': noInitialAsAssertionRule,
     'no-excessive-any': noExcessiveAnyRule,
     'no-disabled-comments': noDisabledCommentsRule,
+    'no-restricted-components': noRestrictedComponentsRule,
   },
+  configs: {
+    customize: (options) => {
+      return {
+        rules: {
+          '@foundbyte/hooks-arrow-function-only': 'error',
+          '@foundbyte/arrow-function-padding': 'error',
+          '@foundbyte/vue-script-lines-limit': ['error', { maxLines: 300 }],
+          '@foundbyte/no-excessive-any': ['error', { maxAnyCount: 5 }],
+          '@foundbyte/hooks-export-limit': ['error', { maxExports: 20 }],
+          '@foundbyte/no-initial-as-assertion': ['error', {
+            excludeVariableAssertions: true,
+            excludeTypePatterns: ['^const$', '^[A-Z]$', '^unknown$', '^EAppEnv$'],
+            excludeMethodReturns: ['parse', 'querySelector'],
+          }],
+          '@foundbyte/no-restricted-components': ['error', [
+            {
+              pattern: '/^a-(textarea|table)$/',
+              message: '禁止使用的Arco Design组件，请使用Keyblade组件替代'
+            }
+          ]],
+          '@foundbyte/tag-attribute-restriction': ['error', { restrictions }],
+          // 类型加注释
+          '@foundbyte/type-comment-requirement': ['error', {
+            minCommentsPerGroup: 1,
+            groupSize: 8,
+            includeTypes: true,
+            includeInterfaces: true,
+          }],
+          // 禁止使用某些注释
+          '@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/',
+            ],
+          }],
+          ...(options || {}),
+        }
+      }
+    }
+  }
 }

package/lib/rules/index.d.ts

@@ -7,6 +7,7 @@ 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'
+export { NoRestrictedComponentsOptions } from './no-restricted-components'
 
 import { Rule } from 'eslint'
 
@@ -59,6 +60,11 @@ export interface Rules {
    */
   'no-disabled-comments': Rule.RuleModule
 
+  /**
+   * 通过正则配置禁止使用某些组件
+   */
+  'no-restricted-components': Rule.RuleModule
+
   /**
    * 索引签名，用于兼容 ESLint 插件类型
    */

package/lib/rules/no-restricted-components.d.ts

@@ -0,0 +1,45 @@
+import { Rule } from 'eslint'
+
+export interface NoRestrictedComponentsOptions {
+  pattern: string
+  message: string
+}
+
+export interface NoRestrictedComponentsRule extends Rule.RuleModule {
+  meta: {
+    type: 'problem'
+    docs: {
+      description: '通过正则配置禁止使用某些组件'
+      category: 'Best Practices'
+      recommended: false
+    }
+    fixable: null
+    schema: [
+      {
+        type: 'array'
+        items: {
+          type: 'object'
+          properties: {
+            pattern: {
+              type: 'string'
+              description: '用于匹配组件名的正则表达式字符串'
+            }
+            message: {
+              type: 'string'
+              description: '自定义错误消息'
+            }
+          }
+          required: ['pattern', 'message']
+          additionalProperties: false
+        }
+        minItems: 1
+      },
+    ]
+    messages: {
+      restrictedComponent: string
+    }
+  }
+}
+
+declare const rule: NoRestrictedComponentsRule
+export default rule

package/lib/rules/no-restricted-components.js

@@ -0,0 +1,128 @@
+module.exports = {
+    meta: {
+        type: 'problem',
+        docs: {
+            description: '通过正则配置禁止使用某些组件',
+            category: 'Best Practices',
+            recommended: false,
+        },
+        fixable: null,
+        schema: [
+            {
+                type: 'array',
+                items: {
+                    type: 'object',
+                    properties: {
+                        pattern: {
+                            type: 'string',
+                            description: '用于匹配组件名的正则表达式字符串',
+                        },
+                        message: {
+                            type: 'string',
+                            description: '自定义错误消息',
+                        },
+                    },
+                    required: ['pattern', 'message'],
+                    additionalProperties: false,
+                },
+                minItems: 1,
+            },
+        ],
+        messages: {
+            restrictedComponent: '{{message}}',
+        },
+    },
+
+    create(context) {
+        const options = context.options[0] || [];
+
+        // 如果没有配置，则不进行检查
+        if (options.length === 0) {
+            return {};
+        }
+
+        // 将字符串模式转换为正则表达式
+        const patterns = options.map(option => {
+            const pattern = option.pattern;
+            const message = option.message;
+            
+            // 如果模式已经是正则表达式字符串，如 "/a-textarea/"
+            if (pattern.startsWith('/') && pattern.endsWith('/')) {
+                const regexBody = pattern.slice(1, -1);
+                return {
+                    regex: new RegExp(regexBody),
+                    message,
+                };
+            }
+            
+            // 普通字符串，进行转义并创建正则表达式
+            const escapedPattern = pattern.replace(/[.*+?^${}()|[\]\\]/g, '\\$&');
+            return {
+                regex: new RegExp(escapedPattern),
+                message,
+            };
+        });
+
+        // 获取文件名，只对 .vue 文件生效
+        const filename = context.getFilename();
+        if (!filename.endsWith('.vue')) {
+            return {};
+        }
+
+        return {
+            Program(node) {
+                // 获取整个文件的源代码
+                const sourceCode = context.getSourceCode();
+                const text = sourceCode.getText();
+                
+                // 使用正则表达式匹配模板中的标签
+                // 匹配自闭合标签：<component />
+                // 匹配普通标签：<component> 或 <component attr="value">
+                const tagRegex = /<([\w-]+)(?:\s+[^>]*)?\/?>|<\/([\w-]+)>/g;
+                let match;
+                
+                while ((match = tagRegex.exec(text)) !== null) {
+                    // match[1] 是开始标签名，match[2] 是结束标签名
+                    const tagName = match[1] || match[2];
+                    
+                    if (tagName) {
+                        // 检查标签名是否匹配任何禁止模式
+                        patterns.forEach(({ regex, message }) => {
+                            if (regex.test(tagName)) {
+                                context.report({
+                                    loc: {
+                                        start: sourceCode.getLocFromIndex(match.index),
+                                        end: sourceCode.getLocFromIndex(match.index + match[0].length),
+                                    },
+                                    messageId: 'restrictedComponent',
+                                    data: {
+                                        message,
+                                    },
+                                });
+                            }
+                        });
+                    }
+                }
+            },
+
+            JSXOpeningElement(node) {
+                // 处理 JSX 元素
+                if (node.name.type === 'JSXIdentifier') {
+                    const tagName = node.name.name;
+                    
+                    patterns.forEach(({ regex, message }) => {
+                        if (regex.test(tagName)) {
+                            context.report({
+                                node,
+                                messageId: 'restrictedComponent',
+                                data: {
+                                    message,
+                                },
+                            });
+                        }
+                    });
+                }
+            },
+        };
+    },
+};

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.5",
+  "version": "1.1.4-alpha.7",
   "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",