@foundbyte/eslint-plugin 1.0.2 → 1.0.4

package/index.d.ts

@@ -0,0 +1,10 @@
+import { Config, Rules } from './lib/rules'
+
+declare const eslintPlugin: {
+  rules: Rules
+  configs: {
+    recommended: Config
+  }
+}
+
+export = eslintPlugin

package/index.js

@@ -1,11 +1,15 @@
-const arrowFunctionPaddingRule = require('./lib/rules/arrow-function-padding');
-const vueScriptLinesLimitRule = require('./lib/rules/vue-script-lines-limit');
-const typeCommentRequirementRule = require('./lib/rules/type-comment-requirement');
+const arrowFunctionPaddingRule = require('./lib/rules/arrow-function-padding')
+const vueScriptLinesLimitRule = require('./lib/rules/vue-script-lines-limit')
+const typeCommentRequirementRule = require('./lib/rules/type-comment-requirement')
+const hooksExportLimitRule = require('./lib/rules/hooks-export-limit')
+const hooksArrowFunctionOnlyRule = require('./lib/rules/hooks-arrow-function-only')
 
 module.exports = {
-    rules: {
-        'arrow-function-padding': arrowFunctionPaddingRule,
-        'vue-script-lines-limit': vueScriptLinesLimitRule,
-        'type-comment-requirement': typeCommentRequirementRule,
-    },
-};
+  rules: {
+    'arrow-function-padding': arrowFunctionPaddingRule,
+    'vue-script-lines-limit': vueScriptLinesLimitRule,
+    'type-comment-requirement': typeCommentRequirementRule,
+    'hooks-export-limit': hooksExportLimitRule,
+    'hooks-arrow-function-only': hooksArrowFunctionOnlyRule,
+  },
+}

package/lib/rules/arrow-function-padding.d.ts

@@ -0,0 +1,14 @@
+import { Rule } from 'eslint'
+
+/**
+ * 箭头函数间距规则配置
+ */
+export interface ArrowFunctionPaddingOptions {
+  // 此规则没有配置选项
+}
+
+/**
+ * 箭头函数间距规则
+ */
+declare const arrowFunctionPaddingRule: Rule.RuleModule
+export default arrowFunctionPaddingRule

package/lib/rules/hooks-arrow-function-only.d.ts

@@ -0,0 +1,14 @@
+import { Rule } from 'eslint'
+
+/**
+ * Hooks 箭头函数要求规则配置
+ */
+export interface HooksArrowFunctionOnlyOptions {
+  // 此规则没有配置选项
+}
+
+/**
+ * Hooks 箭头函数要求规则
+ */
+declare const hooksArrowFunctionOnlyRule: Rule.RuleModule
+export default hooksArrowFunctionOnlyRule

package/lib/rules/hooks-arrow-function-only.js

@@ -0,0 +1,69 @@
+module.exports = {
+  meta: {
+    type: 'suggestion',
+    docs: {
+      description: '禁止 hooks 使用 function 声明，必须使用箭头函数',
+      category: 'Best Practices',
+      recommended: false,
+    },
+    fixable: 'code',
+    schema: [],
+    messages: {
+      useArrowFunction: 'hooks 必须使用箭头函数，不能使用 function 声明',
+    },
+  },
+
+  create(context) {
+    return {
+      // 检查函数声明
+      FunctionDeclaration(node) {
+        // 检查函数名是否以 use 开头（hooks 命名约定）
+        if (node.id && node.id.name && node.id.name.startsWith('use')) {
+          context.report({
+            node: node,
+            messageId: 'useArrowFunction',
+            fix(fixer) {
+              // 将 function 声明转换为箭头函数
+              const sourceCode = context.getSourceCode()
+              const functionName = node.id.name
+              const params = node.params.map(param => sourceCode.getText(param)).join(', ')
+              const body = sourceCode.getText(node.body)
+              
+              // 构建箭头函数
+              const arrowFunction = `const ${functionName} = (${params}) => ${body}`
+              
+              return fixer.replaceText(node, arrowFunction)
+            },
+          })
+        }
+      },
+
+      // 检查函数表达式（变量声明中的函数表达式）
+      VariableDeclarator(node) {
+        if (
+          node.init && 
+          node.init.type === 'FunctionExpression' && 
+          node.id && 
+          node.id.name && 
+          node.id.name.startsWith('use')
+        ) {
+          context.report({
+            node: node.init,
+            messageId: 'useArrowFunction',
+            fix(fixer) {
+              // 将函数表达式转换为箭头函数
+              const sourceCode = context.getSourceCode()
+              const params = node.init.params.map(param => sourceCode.getText(param)).join(', ')
+              const body = sourceCode.getText(node.init.body)
+              
+              // 构建箭头函数
+              const arrowFunction = `(${params}) => ${body}`
+              
+              return fixer.replaceText(node.init, arrowFunction)
+            },
+          })
+        }
+      },
+    }
+  },
+}

package/lib/rules/hooks-export-limit.d.ts

@@ -0,0 +1,18 @@
+import { Rule } from 'eslint'
+
+/**
+ * Hooks 导出限制规则配置
+ */
+export interface HooksExportLimitOptions {
+  /**
+   * 最大导出数量
+   * @default 20
+   */
+  maxExports?: number
+}
+
+/**
+ * Hooks 导出限制规则
+ */
+declare const hooksExportLimitRule: Rule.RuleModule
+export default hooksExportLimitRule

package/lib/rules/hooks-export-limit.js

@@ -0,0 +1,76 @@
+module.exports = {
+  meta: {
+    type: 'problem',
+    docs: {
+      description: '限制 hooks 导出的变量和方法数量不超过20个',
+      category: 'Best Practices',
+      recommended: false,
+    },
+    fixable: null,
+    schema: [
+      {
+        type: 'object',
+        properties: {
+          maxExports: {
+            type: 'number',
+            minimum: 1,
+          },
+        },
+        additionalProperties: false,
+      },
+    ],
+    messages: {
+      exceedMaxExports: 'hooks 导出的变量和方法数量不能超过 {{maxExports}} 个，当前有 {{currentExports}} 个',
+    },
+  },
+
+  create(context) {
+    const options = context.options[0] || {}
+    const maxExports = options.maxExports || 20
+
+    // 只处理 .vue 文件
+    const filename = context.getFilename()
+    if (!filename.endsWith('.vue')) {
+      return {}
+    }
+
+    return {
+      Program() {
+        // 获取整个文件的源代码
+        const sourceCode = context.getSourceCode()
+        const text = sourceCode.getText()
+
+        // 使用正则表达式匹配所有 hooks 的解构赋值
+        const hooksPattern = /const\s*{\s*([^}]+)\s*}\s*=\s*use[A-Z][a-zA-Z]*\(\s*\)/g
+        let match
+
+        while ((match = hooksPattern.exec(text)) !== null) {
+          const exportsString = match[1]
+
+          // 计算导出的变量和方法数量
+          const exports = exportsString.split(',').map((item) => item.trim()).filter((item) => item)
+          const exportCount = exports.length
+
+          if (exportCount > maxExports) {
+            // 找到 hooks 解构赋值的位置
+            const hooksStartIndex = match.index
+            const hooksEndIndex = hooksStartIndex + match[0].length
+
+            // 在 hooks 解构赋值的位置报告错误
+            context.report({
+              loc: {
+                start: sourceCode.getLocFromIndex(hooksStartIndex),
+                end: sourceCode.getLocFromIndex(hooksEndIndex),
+              },
+              messageId: 'exceedMaxExports',
+              data: {
+                maxExports,
+                currentExports: exportCount,
+              },
+            })
+          }
+        }
+      },
+    }
+  },
+}

package/lib/rules/index.d.ts

@@ -0,0 +1,47 @@
+export { ArrowFunctionPaddingOptions } from './arrow-function-padding'
+export { HooksExportLimitOptions } from './hooks-export-limit'
+export { TypeCommentRequirementOptions } from './type-comment-requirement'
+export { VueScriptLinesLimitOptions } from './vue-script-lines-limit'
+export { HooksArrowFunctionOnlyOptions } from './hooks-arrow-function-only'
+
+import { Rule } from 'eslint'
+
+/**
+ * @foundbyte/eslint-plugin 规则配置
+ */
+export interface Rules {
+  /**
+   * 要求箭头函数声明之间有空行
+   */
+  'arrow-function-padding': Rule.RuleModule
+
+  /**
+   * 限制 hooks 导出的变量和方法数量
+   */
+  'hooks-export-limit': Rule.RuleModule
+
+  /**
+   * 要求 TypeScript interface 和 type 定义中字段必须有注释
+   */
+  'type-comment-requirement': Rule.RuleModule
+
+  /**
+   * 限制 Vue 文件 script 标签内的行数
+   */
+  'vue-script-lines-limit': Rule.RuleModule
+
+  /**
+   * 禁止 hooks (useXXX) 使用 function 声明，必须使用箭头函数
+   */
+  'hooks-arrow-function-only': Rule.RuleModule
+}
+
+/**
+ * @foundbyte/eslint-plugin 配置
+ */
+export interface Config {
+  rules: Rules
+}
+
+declare const config: Config
+export default config

package/lib/rules/type-comment-requirement.d.ts

@@ -0,0 +1,33 @@
+import { Rule } from 'eslint'
+
+/**
+ * 类型注释要求规则配置
+ */
+export interface TypeCommentRequirementOptions {
+  /**
+   * 每多少个字段为一组进行检查
+   * @default 5
+   */
+  groupSize?: number
+  /**
+   * 每组中至少有多少个字段必须加注释
+   * @default 1
+   */
+  minCommentsPerGroup?: number
+  /**
+   * 是否检查 type 定义
+   * @default true
+   */
+  includeTypes?: boolean
+  /**
+   * 是否检查 interface 定义
+   * @default true
+   */
+  includeInterfaces?: boolean
+}
+
+/**
+ * 类型注释要求规则
+ */
+declare const typeCommentRequirementRule: Rule.RuleModule
+export default typeCommentRequirementRule

package/lib/rules/vue-script-lines-limit.d.ts

@@ -0,0 +1,18 @@
+import { Rule } from 'eslint'
+
+/**
+ * Vue Script 行数限制规则配置
+ */
+export interface VueScriptLinesLimitOptions {
+  /**
+   * 最大行数限制
+   * @default 300
+   */
+  maxLines?: number
+}
+
+/**
+ * Vue Script 行数限制规则
+ */
+declare const vueScriptLinesLimitRule: Rule.RuleModule
+export default vueScriptLinesLimitRule

package/package.json

@@ -1,29 +1,30 @@
 {
-    "name": "@foundbyte/eslint-plugin",
-    "version": "1.0.2",
-    "description": "ESLint plugin for enforcing code style rules including arrow function padding, Vue script lines limit, and TypeScript type comment requirements",
-    "main": "index.js",
-    "scripts": {
-        "test": "echo \"Error: no test specified\" && exit 1"
-    },
-    "keywords": [
-        "eslint",
-        "eslintplugin",
-        "arrow-function",
-        "padding",
-        "vue",
-        "script",
-        "lines-limit",
-        "typescript",
-        "type-comment",
-        "comment-requirement"
-    ],
-    "author": "",
-    "license": "ISC",
-    "publishConfig": {
-        "access": "public"
-    },
-    "peerDependencies": {
-        "eslint": ">=8.0.0"
-    }
-}
+  "name": "@foundbyte/eslint-plugin",
+  "version": "1.0.4",
+  "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",
+  "keywords": [
+    "eslint",
+    "eslintplugin",
+    "arrow-function",
+    "padding",
+    "vue",
+    "script",
+    "lines-limit",
+    "typescript",
+    "type-comment",
+    "comment-requirement"
+  ],
+  "author": "",
+  "license": "ISC",
+  "publishConfig": {
+    "access": "public"
+  },
+  "peerDependencies": {
+    "eslint": ">=8.0.0"
+  },
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  }
+}

package/types.d.ts

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