mm_eslint 1.0.2 → 1.0.4

package/README.md

@@ -43,91 +43,91 @@ cp mm_eslint/index.js your-project/eslint-plugins/
 
 ```javascript
 // eslint.config.js
-const namingConventionPlugin = require('mm_eslint');
+const namingConventionPlugin = require("mm_eslint");
 
 module.exports = [
   {
-    files: ['**/*.js'],
+    files: ["**/*.js"],
     plugins: {
-      'naming-convention': namingConventionPlugin,
-      'jsdoc': require('eslint-plugin-jsdoc')
+      "naming-convention": namingConventionPlugin,
+      jsdoc: require("eslint-plugin-jsdoc"),
     },
     rules: {
       // 自定义命名规范插件规则（优先使用）
-      'naming-convention/class-name': 'error',
-      'naming-convention/function-name': 'error',
-      'naming-convention/method-name': 'error',
-      'naming-convention/variable-name': 'warn',
-      'naming-convention/constant-name': 'error',
-      'naming-convention/private-naming': 'warn',
-      'naming-convention/param-name': 'warn',
-      'naming-convention/property-name': 'warn',
-      
+      "naming-convention/class-name": "error",
+      "naming-convention/function-name": "error",
+      "naming-convention/method-name": "error",
+      "naming-convention/variable-name": "warn",
+      "naming-convention/constant-name": "error",
+      "naming-convention/private-naming": "warn",
+      "naming-convention/param-name": "warn",
+      "naming-convention/property-name": "warn",
+
       // 禁用与命名规范插件冲突的默认规则
-      'camelcase': 'off',
-      'id-match': 'off',
-      'new-cap': 'off',
-      'id-length': 'off',
-      'id-denylist': 'off',
-      'id-blacklist': 'off'
-    }
+      camelcase: "off",
+      "id-match": "off",
+      "new-cap": "off",
+      "id-length": "off",
+      "id-denylist": "off",
+      "id-blacklist": "off",
+    },
   },
-  
+
   {
     // 代码风格规则
     rules: {
-      'max-len': ['error', { code: 100 }],
-      'indent': ['error', 2],
-      'quotes': ['error', 'single'],
-      'no-tabs': 'error',
-      'semi': ['error', 'always']
-    }
+      "max-len": ["error", { code: 100 }],
+      indent: ["error", 2],
+      quotes: ["error", "single"],
+      "no-tabs": "error",
+      semi: ["error", "always"],
+    },
   },
-  
+
   {
     // 错误处理规则
     rules: {
-      'no-unused-vars': ['error', { args: 'all' }],
-      'no-unsafe-finally': 'warn',
-      'no-throw-literal': 'error'
-    }
+      "no-unused-vars": ["error", { args: "all" }],
+      "no-unsafe-finally": "warn",
+      "no-throw-literal": "error",
+    },
   },
-  
+
   {
     // 最佳实践规则
     rules: {
-      'prefer-promise-reject-errors': 'error',
-      'no-param-reassign': 'error',
-      'prefer-object-spread': 'error',
-      'prefer-arrow-callback': 'error',
-      'max-lines-per-function': ['warn', { max: 40 }],
-      'complexity': ['warn', 10]
-    }
+      "prefer-promise-reject-errors": "error",
+      "no-param-reassign": "error",
+      "prefer-object-spread": "error",
+      "prefer-arrow-callback": "error",
+      "max-lines-per-function": ["warn", { max: 40 }],
+      complexity: ["warn", 10],
+    },
   },
-  
+
   {
     // JSDoc规则
     rules: {
-      'jsdoc/require-jsdoc': ['warn', { publicOnly: true }],
-      'jsdoc/check-alignment': 'warn',
-      'jsdoc/check-indentation': 'warn',
-      'jsdoc/check-param-names': 'warn',
-      'jsdoc/check-syntax': 'warn',
-      'jsdoc/check-tag-names': 'warn',
-      'jsdoc/check-types': 'warn',
-      'jsdoc/no-undefined-types': 'warn',
-      'jsdoc/require-description': 'warn',
-      'jsdoc/require-param': 'warn',
-      'jsdoc/require-param-description': 'warn',
-      'jsdoc/require-param-name': 'warn',
-      'jsdoc/require-param-type': 'warn',
-      'jsdoc/require-returns': 'warn',
-      'jsdoc/require-returns-check': 'warn',
-      'jsdoc/require-returns-description': 'warn',
-      'jsdoc/require-returns-type': 'warn',
-      'jsdoc/valid-types': 'warn'
-    }
-  }
+      "jsdoc/require-jsdoc": ["warn", { publicOnly: true }],
+      "jsdoc/check-alignment": "warn",
+      "jsdoc/check-indentation": "warn",
+      "jsdoc/check-param-names": "warn",
+      "jsdoc/check-syntax": "warn",
+      "jsdoc/check-tag-names": "warn",
+      "jsdoc/check-types": "warn",
+      "jsdoc/no-undefined-types": "warn",
+      "jsdoc/require-description": "warn",
+      "jsdoc/require-param": "warn",
+      "jsdoc/require-param-description": "warn",
+      "jsdoc/require-param-name": "warn",
+      "jsdoc/require-param-type": "warn",
+      "jsdoc/require-returns": "warn",
+      "jsdoc/require-returns-check": "warn",
+      "jsdoc/require-returns-description": "warn",
+      "jsdoc/require-returns-type": "warn",
+      "jsdoc/valid-types": "warn",
+    },
+  },
 ];
 ```
 
@@ -147,6 +147,7 @@ npx eslint --fix your-file.js
 ## 命名规范规则
 
 ### 类名规则（class-name）
+
 - **级别**: error
 - **要求**: 大驼峰命名法（PascalCase）
 - **长度**: 1-20字符
@@ -155,6 +156,7 @@ npx eslint --fix your-file.js
 - **错误示例**: `UserConfiguration`, `ProductManagement`
 
 ### 函数名规则（function-name）
+
 - **级别**: error
 - **要求**: 小驼峰命名法（camelCase）
 - **长度**: 1-20字符
@@ -164,6 +166,7 @@ npx eslint --fix your-file.js
 - **错误示例**: `getConfiguration`, `processInformation`
 
 ### 方法名规则（method-name）
+
 - **级别**: error
 - **要求**: 小驼峰命名法（camelCase）
 - **长度**: 1-20字符
@@ -173,6 +176,7 @@ npx eslint --fix your-file.js
 - **错误示例**: `addConfiguration`, `validateAuthentication`
 
 ### 变量名规则（variable-name）
+
 - **级别**: warn
 - **要求**: 小写蛇形命名法（snake_case）
 - **长度**: 1-20字符
@@ -180,6 +184,7 @@ npx eslint --fix your-file.js
 - **错误示例**: `userCount`, `MAX_RETRY`
 
 ### 常量名规则（constant-name）
+
 - **级别**: error
 - **要求**: 大写蛇形命名法（UPPER_SNAKE_CASE）
 - **长度**: 1-20字符
@@ -187,6 +192,7 @@ npx eslint --fix your-file.js
 - **错误示例**: `maxRetry`, `defaultTimeout`
 
 ### 私有成员规则（private-naming）
+
 - **级别**: warn
 - **要求**: 下划线开头的小写蛇形命名
 - **长度**: 2-20字符
@@ -194,6 +200,7 @@ npx eslint --fix your-file.js
 - **错误示例**: `userCount`, `_UserCount`
 
 ### 入参名规则（param-name）
+
 - **级别**: warn
 - **要求**: 小写蛇形命名法（snake_case）
 - **长度**: 1-20字符
@@ -201,6 +208,7 @@ npx eslint --fix your-file.js
 - **错误示例**: `userName`, `maxCount`
 
 ### 属性名规则（property-name）
+
 - **级别**: warn
 - **要求**: 基于值类型的多风格命名
 - **长度**: 1-20字符
@@ -220,7 +228,7 @@ class User {
   constructor() {
     this._user_count = 0;    // 私有属性正确
   }
-  
+
   /**
    * 获取用户数量
    * @returns {number} 用户数量
@@ -250,13 +258,13 @@ let user_count = 10;         // 变量名正确
 ```javascript
 // 自定义配置示例
 const customConfig = {
-  'class-name': {
+  "class-name": {
     regex: /^[A-Z][a-zA-Z]*$/,
     min: 1,
-    max: 25,  // 扩展最大长度
+    max: 25, // 扩展最大长度
     single_word_len: 10, // 扩展单词长度限制
-    message: '类名{name}必须使用大驼峰命名法'
-  }
+    message: "类名{name}必须使用大驼峰命名法",
+  },
 };
 
 const detector = new NamingDetector(customConfig);
@@ -297,13 +305,15 @@ ISC License
 ## 更新日志
 
 ### v1.1.0
+
 - 添加单词长度验证（每个单词最大8字符）
 - 添加入参名和属性名检测
 - 集成JSDoc文档要求
 - 增强配置，包含完整的ESLint规则
 
 ### v1.0.0
+
 - 初始版本发布
 - 支持类名、函数名、方法名、变量名、常量名、私有成员命名规范检测
 - 支持长度限制和单个单词优先规则
-- 支持禁止废话词检测
+- 支持禁止废话词检测

package/README_EN.md

@@ -43,91 +43,91 @@ Import the plugin in your ESLint configuration file:
 
 ```javascript
 // eslint.config.js
-const namingConventionPlugin = require('mm-eslint-plugin');
+const namingConventionPlugin = require("mm-eslint-plugin");
 
 module.exports = [
   {
-    files: ['**/*.js'],
+    files: ["**/*.js"],
     plugins: {
-      'naming-convention': namingConventionPlugin,
-      'jsdoc': require('eslint-plugin-jsdoc')
+      "naming-convention": namingConventionPlugin,
+      jsdoc: require("eslint-plugin-jsdoc"),
     },
     rules: {
       // Custom naming convention rules (priority)
-      'naming-convention/class-name': 'error',
-      'naming-convention/function-name': 'error',
-      'naming-convention/method-name': 'error',
-      'naming-convention/variable-name': 'warn',
-      'naming-convention/constant-name': 'error',
-      'naming-convention/private-naming': 'warn',
-      'naming-convention/param-name': 'warn',
-      'naming-convention/property-name': 'warn',
-      
+      "naming-convention/class-name": "error",
+      "naming-convention/function-name": "error",
+      "naming-convention/method-name": "error",
+      "naming-convention/variable-name": "warn",
+      "naming-convention/constant-name": "error",
+      "naming-convention/private-naming": "warn",
+      "naming-convention/param-name": "warn",
+      "naming-convention/property-name": "warn",
+
       // Disable conflicting default rules
-      'camelcase': 'off',
-      'id-match': 'off',
-      'new-cap': 'off',
-      'id-length': 'off',
-      'id-denylist': 'off',
-      'id-blacklist': 'off'
-    }
+      camelcase: "off",
+      "id-match": "off",
+      "new-cap": "off",
+      "id-length": "off",
+      "id-denylist": "off",
+      "id-blacklist": "off",
+    },
   },
-  
+
   {
     // Code style rules
     rules: {
-      'max-len': ['error', { code: 100 }],
-      'indent': ['error', 2],
-      'quotes': ['error', 'single'],
-      'no-tabs': 'error',
-      'semi': ['error', 'always']
-    }
+      "max-len": ["error", { code: 100 }],
+      indent: ["error", 2],
+      quotes: ["error", "single"],
+      "no-tabs": "error",
+      semi: ["error", "always"],
+    },
   },
-  
+
   {
     // Error handling rules
     rules: {
-      'no-unused-vars': ['error', { args: 'all' }],
-      'no-unsafe-finally': 'warn',
-      'no-throw-literal': 'error'
-    }
+      "no-unused-vars": ["error", { args: "all" }],
+      "no-unsafe-finally": "warn",
+      "no-throw-literal": "error",
+    },
   },
-  
+
   {
     // Best practices
     rules: {
-      'prefer-promise-reject-errors': 'error',
-      'no-param-reassign': 'error',
-      'prefer-object-spread': 'error',
-      'prefer-arrow-callback': 'error',
-      'max-lines-per-function': ['warn', { max: 40 }],
-      'complexity': ['warn', 10]
-    }
+      "prefer-promise-reject-errors": "error",
+      "no-param-reassign": "error",
+      "prefer-object-spread": "error",
+      "prefer-arrow-callback": "error",
+      "max-lines-per-function": ["warn", { max: 40 }],
+      complexity: ["warn", 10],
+    },
   },
-  
+
   {
     // JSDoc rules
     rules: {
-      'jsdoc/require-jsdoc': ['warn', { publicOnly: true }],
-      'jsdoc/check-alignment': 'warn',
-      'jsdoc/check-indentation': 'warn',
-      'jsdoc/check-param-names': 'warn',
-      'jsdoc/check-syntax': 'warn',
-      'jsdoc/check-tag-names': 'warn',
-      'jsdoc/check-types': 'warn',
-      'jsdoc/no-undefined-types': 'warn',
-      'jsdoc/require-description': 'warn',
-      'jsdoc/require-param': 'warn',
-      'jsdoc/require-param-description': 'warn',
-      'jsdoc/require-param-name': 'warn',
-      'jsdoc/require-param-type': 'warn',
-      'jsdoc/require-returns': 'warn',
-      'jsdoc/require-returns-check': 'warn',
-      'jsdoc/require-returns-description': 'warn',
-      'jsdoc/require-returns-type': 'warn',
-      'jsdoc/valid-types': 'warn'
-    }
-  }
+      "jsdoc/require-jsdoc": ["warn", { publicOnly: true }],
+      "jsdoc/check-alignment": "warn",
+      "jsdoc/check-indentation": "warn",
+      "jsdoc/check-param-names": "warn",
+      "jsdoc/check-syntax": "warn",
+      "jsdoc/check-tag-names": "warn",
+      "jsdoc/check-types": "warn",
+      "jsdoc/no-undefined-types": "warn",
+      "jsdoc/require-description": "warn",
+      "jsdoc/require-param": "warn",
+      "jsdoc/require-param-description": "warn",
+      "jsdoc/require-param-name": "warn",
+      "jsdoc/require-param-type": "warn",
+      "jsdoc/require-returns": "warn",
+      "jsdoc/require-returns-check": "warn",
+      "jsdoc/require-returns-description": "warn",
+      "jsdoc/require-returns-type": "warn",
+      "jsdoc/valid-types": "warn",
+    },
+  },
 ];
 ```
 
@@ -147,6 +147,7 @@ npx eslint --fix your-file.js
 ## Naming Convention Rules
 
 ### Class Name Rule (class-name)
+
 - **Level**: error
 - **Requirement**: PascalCase naming convention
 - **Length**: 1-20 characters
@@ -155,6 +156,7 @@ npx eslint --fix your-file.js
 - **Invalid Examples**: `UserConfiguration`, `ProductManagement`
 
 ### Function Name Rule (function-name)
+
 - **Level**: error
 - **Requirement**: camelCase naming convention
 - **Length**: 1-20 characters
@@ -164,6 +166,7 @@ npx eslint --fix your-file.js
 - **Invalid Examples**: `getConfiguration`, `processInformation`
 
 ### Method Name Rule (method-name)
+
 - **Level**: error
 - **Requirement**: camelCase naming convention
 - **Length**: 1-20 characters
@@ -173,6 +176,7 @@ npx eslint --fix your-file.js
 - **Invalid Examples**: `addConfiguration`, `validateAuthentication`
 
 ### Variable Name Rule (variable-name)
+
 - **Level**: warn
 - **Requirement**: snake_case naming convention
 - **Length**: 1-20 characters
@@ -180,6 +184,7 @@ npx eslint --fix your-file.js
 - **Invalid Examples**: `userCount`, `MAX_RETRY`
 
 ### Constant Name Rule (constant-name)
+
 - **Level**: error
 - **Requirement**: UPPER_SNAKE_CASE naming convention
 - **Length**: 1-20 characters
@@ -187,6 +192,7 @@ npx eslint --fix your-file.js
 - **Invalid Examples**: `maxRetry`, `defaultTimeout`
 
 ### Private Member Rule (private-naming)
+
 - **Level**: warn
 - **Requirement**: underscore-prefixed snake_case naming
 - **Length**: 2-20 characters
@@ -194,6 +200,7 @@ npx eslint --fix your-file.js
 - **Invalid Examples**: `userCount`, `_UserCount`
 
 ### Parameter Name Rule (param-name)
+
 - **Level**: warn
 - **Requirement**: snake_case naming convention
 - **Length**: 1-20 characters
@@ -201,6 +208,7 @@ npx eslint --fix your-file.js
 - **Invalid Examples**: `userName`, `maxCount`
 
 ### Property Name Rule (property-name)
+
 - **Level**: warn
 - **Requirement**: Multi-style naming based on value type
 - **Length**: 1-20 characters
@@ -220,7 +228,7 @@ class User {
   constructor() {
     this._user_count = 0;    // Private property correct
   }
-  
+
   /**
    * Get user count
    * @returns {number} User count
@@ -250,13 +258,13 @@ You can customize rule parameters through configuration:
 ```javascript
 // Custom configuration example
 const customConfig = {
-  'class-name': {
+  "class-name": {
     regex: /^[A-Z][a-zA-Z]*$/,
     min: 1,
-    max: 25,  // Extend maximum length
+    max: 25, // Extend maximum length
     single_word_len: 10, // Extend word length limit
-    message: 'Class name {name} must use PascalCase naming convention'
-  }
+    message: "Class name {name} must use PascalCase naming convention",
+  },
 };
 
 const detector = new NamingDetector(customConfig);
@@ -297,13 +305,15 @@ Welcome to submit Issues and Pull Requests to improve this plugin.
 ## Changelog
 
 ### v1.1.0
+
 - Added word length validation (max 8 characters per word)
 - Added parameter name and property name detection
 - Integrated JSDoc documentation requirements
 - Enhanced configuration with complete ESLint rules
 
 ### v1.0.0
+
 - Initial version release
 - Support for class name, function name, method name, variable name, constant name, and private member naming convention detection
 - Support for length restrictions and single word preference rules
-- Support for forbidden words detection
+- Support for forbidden words detection