mm_eslint 1.2.6 → 1.2.8

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mm_eslint",
-  "version": "1.2.6",
+  "version": "1.2.8",
   "description": "ESLint plugin for naming conventions - PascalCase, camelCase, snake_case, and UPPER_SNAKE_CASE naming rules",
   "main": "index.js",
   "keywords": [
@@ -32,11 +32,13 @@
     "eslint": ">=8.0.0"
   },
   "scripts": {
-    "test": "node tests/test_new_recommen_words.js",
+    "test": "node tests/test_basic.js",
     "lint": "npx eslint . --config eslint.config.js"
   },
   "files": [
     "index.js",
+    "detector.js",
+    "config.js",
     "README.md",
     "README_EN.md",
     "LICENSE"

package/README.md

@@ -1,410 +0,0 @@
-# MM ESLint Plugin
-
-基于个人命名规范的ESLint插件，支持类名、函数名、变量名、常量名等命名规范检测。
-
-## 功能特性
-
-- ✅ **类名检测** - 大驼峰命名法（PascalCase）
-- ✅ **函数名检测** - 小驼峰命名法（camelCase）
-- ✅ **方法名检测** - 小驼峰命名法（camelCase）
-- ✅ **变量名检测** - 小写蛇形命名法（snake_case）
-- ✅ **常量名检测** - 大写蛇形命名法（UPPER_SNAKE_CASE）
-- ✅ **私有成员检测** - 下划线开头的小写蛇形命名
-- ✅ **入参名检测** - 小写蛇形命名法（snake_case）
-- ✅ **属性名检测** - 基于值类型的多风格命名
-- ✅ **长度限制** - 所有命名长度限制在1-20字符
-- ✅ **单个单词优先** - 鼓励使用单个单词命名
-- ✅ **单词长度限制** - 每个单词限制在最大8字符
-- ✅ **禁止废话词** - 避免使用Manager、Handler等冗余词汇
-- ✅ **JSDoc支持** - 集成JSDoc文档要求
-- ✅ **命名推荐功能** - 推荐更短的替代名称，同时保持语义不变
-
-## 安装
-
-### npm安装
-
-```bash
-npm install mm_eslint --save-dev
-```
-
-### 本地安装
-
-如果您想使用本地版本，可以将插件文件复制到项目中：
-
-```bash
-# 复制插件文件到您的项目
-cp mm_eslint/index.js your-project/eslint-plugins/
-```
-
-## 快速开始
-
-### 1. 完整配置
-
-在您的ESLint配置文件中引入插件：
-
-```javascript
-// eslint.config.js
-const namingConventionPlugin = require("mm_eslint");
-
-module.exports = [
-  {
-    files: ["**/*.js"],
-    plugins: {
-      "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",
-
-      // 禁用与命名规范插件冲突的默认规则
-      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",
-    },
-  },
-];
-```
-
-### 2. 命令行使用
-
-```bash
-# 验证单个文件
-npx eslint your-file.js
-
-# 验证所有JS文件
-npx eslint "**/*.js"
-
-# 验证并自动修复
-npx eslint --fix your-file.js
-```
-
-## 命名规范规则
-
-### 类名规则（class-name）
-
-- **级别**: error
-- **要求**: 大驼峰命名法（PascalCase）
-- **长度**: 1-20字符
-- **单词长度**: 每个单词≤8字符
-- **示例**: `User`, `Product`
-- **错误示例**: `UserConfiguration`, `ProductManagement`
-
-### 函数名规则（function-name）
-
-- **级别**: error
-- **要求**: 小驼峰命名法（camelCase）
-- **长度**: 1-20字符
-- **单词长度**: 每个单词≤8字符
-- **优先**: 单个单词
-- **示例**: `get`, `getName`, `process`
-- **错误示例**: `getConfiguration`, `processInformation`
-
-### 方法名规则（method-name）
-
-- **级别**: error
-- **要求**: 小驼峰命名法（camelCase）
-- **长度**: 1-20字符
-- **单词长度**: 每个单词≤8字符
-- **优先**: 单个单词
-- **示例**: `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字符
-- **示例**: `MAX_RETRY`, `DEFAULT_TIMEOUT`
-- **错误示例**: `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 UserConfiguration {     // "Configuration"超过8字符
-const getConfiguration = function() {}; // "Configuration"超过8字符
-let maxRetryCount = 5;       // 变量名应该小写蛇形
-const userCount = 10;        // 常量名应该大写蛇形
-
-// ✅ 正确的命名示例
-class User {
-  constructor() {
-    this._user_count = 0;    // 私有属性正确
-  }
-
-  /**
-   * 获取用户数量
-   * @returns {number} 用户数量
-   */
-  get() {                    // 方法名正确（单个单词≤8字符）
-    return this._user_count;
-  }
-}
-
-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）
-
-## 配置选项
-
-您可以通过配置自定义规则参数：
-
-```javascript
-// 自定义配置示例
-const customConfig = {
-  "class-name": {
-    regex: /^[A-Z][a-zA-Z]*$/,
-    min: 1,
-    max: 25, // 扩展最大长度
-    single_word_len: 10, // 扩展单词长度限制
-    message: "类名{name}必须使用大驼峰命名法",
-  },
-};
-
-const detector = new NamingDetector(customConfig);
-
-## 命名推荐功能
-
-插件包含智能命名推荐系统，建议使用更短的替代名称，同时保持语义不变。
-
-### 核心原则
-
-核心原则是**"缩短命名而不改变语义"**。推荐系统：
-- 推荐更短的单词，同时保持相同含义
-- 避免会改变功能的概念性变化
-- 确保推荐词始终比原词短
-- 保留编程特定术语和概念差异
-
-### 配置
-
-在ESLint配置中启用推荐功能：
-
-```javascript
-// eslint.config.js
-const namingConventionPlugin = require("mm_eslint");
-
-module.exports = [
-  {
-    files: ["**/*.js"],
-    plugins: {
-      "naming-convention": namingConventionPlugin,
-    },
-    rules: {
-      "naming-convention/class-name": "error",
-      "naming-convention/function-name": ["error", { recommen: true }], // 启用推荐功能
-      // ... 其他规则
-    },
-  },
-];
-```
-
-### 可用推荐
-
-插件为常见编程操作提供推荐：
-
-| 原词 | 推荐词 | 描述 |
-|------|--------|------|
-| `calculate` | `calc` | 数学运算 |
-| `generate` | `gen` | 数据生成 |
-| `initialize` | `init` | 初始化操作 |
-| `execute` | `exec` | 命令执行 |
-| `process` | `run` | 数据处理 |
-| `retrieve` | `load` | 数据加载 |
-| `persist` | `save` | 数据存储 |
-| `compare` | `cmp` | 比较操作 |
-| `duplicate` | `copy` | 数据复制 |
-| `transfer` | `move` | 数据移动 |
-| `convert` | `to` | 类型转换 |
-| `verify` | `check` | 验证检查 |
-| `construct` | `create` | 对象创建 |
-| `handle` | `run` | 事件处理 |
-
-### 示例
-
-```javascript
-// ❌ 原词（较长名称）
-function calculateTotal() {}
-function generateUserData() {}
-function initializeSystem() {}
-function executeCommand() {}
-function processData() {}
-
-// ✅ 推荐词（较短名称）
-function calcTotal() {}
-function genUserData() {}
-function initSystem() {}
-function execCommand() {}
-function runData() {}
-```
-
-### 带推荐的错误消息
-
-启用推荐功能后，ESLint将建议替代名称：
-
-```bash
-# ESLint输出示例
-function calculateTotal() {}
-# ^ 建议使用'calc'替代'calculate'以获得更短的命名
-```
-
-### 优势
-
-1. **提高可读性**：更短的名称更容易阅读和理解
-2. **一致的代码库**：项目中的标准化命名
-3. **语义保持**：在减少冗长的同时保持含义
-4. **编程最佳实践**：遵循简洁命名的行业标准
-
-## 开发
-
-### 项目结构
-
-```
-mm_eslint/
-├── index.js          # 主插件文件
-├── package.json      # npm配置
-├── eslint.config.js  # ESLint配置
-├── test.js           # 单元测试
-├── example.js        # 使用示例
-└── README.md         # 说明文档
-```
-
-### 运行测试
-
-```bash
-# 运行单元测试
-npm test
-
-# 运行ESLint检查
-npm run lint
-```
-
-## 许可证
-
-ISC License
-
-## 贡献
-
-欢迎提交Issue和Pull Request来改进这个插件。
-
-## 更新日志
-
-### v1.1.0
-
-- 添加单词长度验证（每个单词最大8字符）
-- 添加入参名和属性名检测
-- 集成JSDoc文档要求
-- 增强配置，包含完整的ESLint规则
-
-### v1.0.0
-
-- 初始版本发布
-- 支持类名、函数名、方法名、变量名、常量名、私有成员命名规范检测
-- 支持长度限制和单个单词优先规则
-- 支持禁止废话词检测