mm_eslint 1.0.1 → 1.0.3

package/README.md

@@ -10,16 +10,20 @@
 - ✅ **变量名检测** - 小写蛇形命名法（snake_case）
 - ✅ **常量名检测** - 大写蛇形命名法（UPPER_SNAKE_CASE）
 - ✅ **私有成员检测** - 下划线开头的小写蛇形命名
+- ✅ **入参名检测** - 小写蛇形命名法（snake_case）
+- ✅ **属性名检测** - 基于值类型的多风格命名
 - ✅ **长度限制** - 所有命名长度限制在1-20字符
 - ✅ **单个单词优先** - 鼓励使用单个单词命名
+- ✅ **单词长度限制** - 每个单词限制在最大8字符
 - ✅ **禁止废话词** - 避免使用Manager、Handler等冗余词汇
+- ✅ **JSDoc支持** - 集成JSDoc文档要求
 
 ## 安装
 
 ### npm安装
 
 ```bash
-npm install mm-eslint-plugin --save-dev
+npm install mm_eslint --save-dev
 ```
 
 ### 本地安装
@@ -28,34 +32,102 @@ npm install mm-eslint-plugin --save-dev
 
 ```bash
 # 复制插件文件到您的项目
-cp mm-eslint-plugin/index.js your-project/eslint-plugins/
+cp mm_eslint/index.js your-project/eslint-plugins/
 ```
 
 ## 快速开始
 
-### 1. 基本配置
+### 1. 完整配置
 
 在您的ESLint配置文件中引入插件：
 
 ```javascript
 // eslint.config.js
-const namingConventionPlugin = require('mm-eslint-plugin');
+const namingConventionPlugin = require("mm_eslint");
 
 module.exports = [
   {
-    files: ['**/*.js'],
+    files: ["**/*.js"],
     plugins: {
-      'naming-convention': namingConventionPlugin
+      "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/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",
+    },
+  },
+
+  {
+    // 代码风格规则
+    rules: {
+      "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",
+    },
+  },
+
+  {
+    // 最佳实践规则
+    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],
+    },
+  },
+
+  {
+    // 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",
+    },
+  },
 ];
 ```
 
@@ -75,37 +147,44 @@ npx eslint --fix your-file.js
 ## 命名规范规则
 
 ### 类名规则（class-name）
+
 - **级别**: error
 - **要求**: 大驼峰命名法（PascalCase）
 - **长度**: 1-20字符
-- **示例**: `UserService`, `ProductManager`
-- **错误示例**: `userService`, `USER_SERVICE`
+- **单词长度**: 每个单词≤8字符
+- **示例**: `User`, `Product`
+- **错误示例**: `UserConfiguration`, `ProductManagement`
 
 ### 函数名规则（function-name）
+
 - **级别**: error
 - **要求**: 小驼峰命名法（camelCase）
 - **长度**: 1-20字符
+- **单词长度**: 每个单词≤8字符
 - **优先**: 单个单词
-- **示例**: `getUser`, `calculateTotal`
-- **错误示例**: `GetUser`, `get_user`
+- **示例**: `get`, `getName`, `process`
+- **错误示例**: `getConfiguration`, `processInformation`
 
 ### 方法名规则（method-name）
+
 - **级别**: error
 - **要求**: 小驼峰命名法（camelCase）
 - **长度**: 1-20字符
+- **单词长度**: 每个单词≤8字符
 - **优先**: 单个单词
-- **示例**: `getName`, `setValue`
-- **错误示例**: `GetName`, `get_name`
+- **示例**: `add`, `setName`, `isValid`
+- **错误示例**: `addConfiguration`, `validateAuthentication`
 
 ### 变量名规则（variable-name）
+
 - **级别**: warn
 - **要求**: 小写蛇形命名法（snake_case）
 - **长度**: 1-20字符
-- **优先**: 单个单词
 - **示例**: `user_count`, `max_retry`
 - **错误示例**: `userCount`, `MAX_RETRY`
 
 ### 常量名规则（constant-name）
+
 - **级别**: error
 - **要求**: 大写蛇形命名法（UPPER_SNAKE_CASE）
 - **长度**: 1-20字符
@@ -113,28 +192,48 @@ npx eslint --fix your-file.js
 - **错误示例**: `maxRetry`, `defaultTimeout`
 
 ### 私有成员规则（private-naming）
+
 - **级别**: warn
 - **要求**: 下划线开头的小写蛇形命名
 - **长度**: 2-20字符
 - **示例**: `_user_count`, `_internal_data`
 - **错误示例**: `userCount`, `_UserCount`
 
+### 入参名规则（param-name）
+
+- **级别**: warn
+- **要求**: 小写蛇形命名法（snake_case）
+- **长度**: 1-20字符
+- **示例**: `user_name`, `max_count`
+- **错误示例**: `userName`, `maxCount`
+
+### 属性名规则（property-name）
+
+- **级别**: warn
+- **要求**: 基于值类型的多风格命名
+- **长度**: 1-20字符
+- **示例**: `user_name`（字符串）, `getUser`（函数）, `User`（类）
+
 ## 错误示例
 
 ```javascript
 // ❌ 错误的命名示例
-class userService {          // 类名应该大驼峰
-const GetUser = function() {}; // 函数名应该小驼峰
+class UserConfiguration {     // "Configuration"超过8字符
+const getConfiguration = function() {}; // "Configuration"超过8字符
 let maxRetryCount = 5;       // 变量名应该小写蛇形
 const userCount = 10;        // 常量名应该大写蛇形
 
 // ✅ 正确的命名示例
-class UserService {
+class User {
   constructor() {
     this._user_count = 0;    // 私有属性正确
   }
-  
-  getUser() {                // 方法名正确
+
+  /**
+   * 获取用户数量
+   * @returns {number} 用户数量
+   */
+  get() {                    // 方法名正确（单个单词≤8字符）
     return this._user_count;
   }
 }
@@ -143,6 +242,15 @@ const MAX_RETRY = 5;         // 常量名正确
 let user_count = 10;         // 变量名正确
 ```
 
+## 单词长度验证
+
+插件验证复合名称中的每个单词不超过8个字符：
+
+- **有效**: `UserService`（"User"=4, "Service"=7）
+- **无效**: `UserConfiguration`（"Configuration"=13 > 8）
+- **有效**: `getUser`（"get"=3, "User"=4）
+- **无效**: `getConfiguration`（"Configuration"=13 > 8）
+
 ## 配置选项
 
 您可以通过配置自定义规则参数：
@@ -150,12 +258,13 @@ let user_count = 10;         // 变量名正确
 ```javascript
 // 自定义配置示例
 const customConfig = {
-  'class-name': {
+  "class-name": {
     regex: /^[A-Z][a-zA-Z]*$/,
     min: 1,
-    max: 25,  // 扩展最大长度
-    message: '类名{name}必须使用大驼峰命名法'
-  }
+    max: 25, // 扩展最大长度
+    single_word_len: 10, // 扩展单词长度限制
+    message: "类名{name}必须使用大驼峰命名法",
+  },
 };
 
 const detector = new NamingDetector(customConfig);
@@ -166,7 +275,7 @@ const detector = new NamingDetector(customConfig);
 ### 项目结构
 
 ```
-mm-eslint-plugin/
+mm_eslint/
 ├── index.js          # 主插件文件
 ├── package.json      # npm配置
 ├── eslint.config.js  # ESLint配置
@@ -195,8 +304,16 @@ ISC License
 
 ## 更新日志
 
+### v1.1.0
+
+- 添加单词长度验证（每个单词最大8字符）
+- 添加入参名和属性名检测
+- 集成JSDoc文档要求
+- 增强配置，包含完整的ESLint规则
+
 ### v1.0.0
+
 - 初始版本发布
 - 支持类名、函数名、方法名、变量名、常量名、私有成员命名规范检测
 - 支持长度限制和单个单词优先规则
-- 支持禁止废话词检测
+- 支持禁止废话词检测

package/README_EN.md

@@ -10,9 +10,13 @@ An ESLint plugin based on personal naming conventions, supporting naming convent
 - ✅ **Variable Name Detection** - snake_case naming convention
 - ✅ **Constant Name Detection** - UPPER_SNAKE_CASE naming convention
 - ✅ **Private Member Detection** - underscore-prefixed snake_case naming
+- ✅ **Parameter Name Detection** - snake_case naming convention
+- ✅ **Property Name Detection** - Multi-style naming based on value type
 - ✅ **Length Restrictions** - All names limited to 1-20 characters
 - ✅ **Single Word Preferred** - Encourages single word naming
+- ✅ **Word Length Limit** - Each word limited to maximum 8 characters
 - ✅ **Forbidden Words** - Avoids redundant words like Manager, Handler, etc.
+- ✅ **JSDoc Support** - Integrated JSDoc documentation requirements
 
 ## Installation
 
@@ -33,29 +37,97 @@ cp mm-eslint-plugin/index.js your-project/eslint-plugins/
 
 ## Quick Start
 
-### 1. Basic Configuration
+### 1. Complete Configuration
 
 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
+      "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'
-    }
-  }
+      // 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",
+
+      // Disable conflicting default rules
+      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"],
+    },
+  },
+
+  {
+    // Error handling rules
+    rules: {
+      "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],
+    },
+  },
+
+  {
+    // 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",
+    },
+  },
 ];
 ```
 
@@ -75,37 +147,44 @@ npx eslint --fix your-file.js
 ## Naming Convention Rules
 
 ### Class Name Rule (class-name)
+
 - **Level**: error
 - **Requirement**: PascalCase naming convention
 - **Length**: 1-20 characters
-- **Examples**: `UserService`, `ProductManager`
-- **Invalid Examples**: `userService`, `USER_SERVICE`
+- **Word Length**: Each word ≤8 characters
+- **Examples**: `User`, `Product`
+- **Invalid Examples**: `UserConfiguration`, `ProductManagement`
 
 ### Function Name Rule (function-name)
+
 - **Level**: error
 - **Requirement**: camelCase naming convention
 - **Length**: 1-20 characters
+- **Word Length**: Each word ≤8 characters
 - **Preference**: Single word
-- **Examples**: `getUser`, `calculateTotal`
-- **Invalid Examples**: `GetUser`, `get_user`
+- **Examples**: `get`, `getName`, `process`
+- **Invalid Examples**: `getConfiguration`, `processInformation`
 
 ### Method Name Rule (method-name)
+
 - **Level**: error
 - **Requirement**: camelCase naming convention
 - **Length**: 1-20 characters
+- **Word Length**: Each word ≤8 characters
 - **Preference**: Single word
-- **Examples**: `getName`, `setValue`
-- **Invalid Examples**: `GetName`, `get_name`
+- **Examples**: `add`, `setName`, `isValid`
+- **Invalid Examples**: `addConfiguration`, `validateAuthentication`
 
 ### Variable Name Rule (variable-name)
+
 - **Level**: warn
 - **Requirement**: snake_case naming convention
 - **Length**: 1-20 characters
-- **Preference**: Single word
 - **Examples**: `user_count`, `max_retry`
 - **Invalid Examples**: `userCount`, `MAX_RETRY`
 
 ### Constant Name Rule (constant-name)
+
 - **Level**: error
 - **Requirement**: UPPER_SNAKE_CASE naming convention
 - **Length**: 1-20 characters
@@ -113,28 +192,48 @@ 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
 - **Examples**: `_user_count`, `_internal_data`
 - **Invalid Examples**: `userCount`, `_UserCount`
 
+### Parameter Name Rule (param-name)
+
+- **Level**: warn
+- **Requirement**: snake_case naming convention
+- **Length**: 1-20 characters
+- **Examples**: `user_name`, `max_count`
+- **Invalid Examples**: `userName`, `maxCount`
+
+### Property Name Rule (property-name)
+
+- **Level**: warn
+- **Requirement**: Multi-style naming based on value type
+- **Length**: 1-20 characters
+- **Examples**: `user_name` (string), `getUser` (function), `User` (class)
+
 ## Error Examples
 
 ```javascript
 // ❌ Invalid naming examples
-class userService {          // Class name should be PascalCase
-const GetUser = function() {}; // Function name should be camelCase
+class UserConfiguration {     // "Configuration" exceeds 8 characters
+const getConfiguration = function() {}; // "Configuration" exceeds 8 characters
 let maxRetryCount = 5;       // Variable name should be snake_case
 const userCount = 10;        // Constant name should be UPPER_SNAKE_CASE
 
 // ✅ Correct naming examples
-class UserService {
+class User {
   constructor() {
     this._user_count = 0;    // Private property correct
   }
-  
-  getUser() {                // Method name correct
+
+  /**
+   * Get user count
+   * @returns {number} User count
+   */
+  get() {                    // Method name correct (single word ≤8 chars)
     return this._user_count;
   }
 }
@@ -143,6 +242,15 @@ const MAX_RETRY = 5;         // Constant name correct
 let user_count = 10;         // Variable name correct
 ```
 
+## Word Length Validation
+
+The plugin validates that each word in compound names does not exceed 8 characters:
+
+- **Valid**: `UserService` ("User"=4, "Service"=7)
+- **Invalid**: `UserConfiguration` ("Configuration"=13 > 8)
+- **Valid**: `getUser` ("get"=3, "User"=4)
+- **Invalid**: `getConfiguration` ("Configuration"=13 > 8)
+
 ## Configuration Options
 
 You can customize rule parameters through configuration:
@@ -150,12 +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
-    message: 'Class name {name} must use PascalCase naming convention'
-  }
+    max: 25, // Extend maximum length
+    single_word_len: 10, // Extend word length limit
+    message: "Class name {name} must use PascalCase naming convention",
+  },
 };
 
 const detector = new NamingDetector(customConfig);
@@ -195,8 +304,16 @@ 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