mm_eslint 1.4.4 → 1.4.5

package/README.md

@@ -22,12 +22,12 @@
 ## 实际支持的规则
 
 插件实际支持以下ESLint规则：
-- `naming-convention/class-name` - 类名检测
-- `naming-convention/class-instance-name` - 类实例名检测  
-- `naming-convention/function-name` - 函数名检测
-- `naming-convention/param-name` - 参数名检测
-- `naming-convention/variable-name` - 变量名检测
-- `naming-convention/constant-name` - 常量名检测
+- `mm_eslint/class-name` - 类名检测
+- `mm_eslint/class-instance-name` - 类实例名检测  
+- `mm_eslint/function-name` - 函数名检测
+- `mm_eslint/param-name` - 参数名检测
+- `mm_eslint/variable-name` - 变量名检测
+- `mm_eslint/constant-name` - 常量名检测
 
 ## 安装
 
@@ -54,28 +54,30 @@ cp mm_eslint/index.js your-project/eslint-plugins/
 
 ```javascript
 // eslint.config.js
-const namingConventionPlugin = require("mm_eslint");
+const mmEslint = require('mm_eslint');
 
 module.exports = [
   {
-    files: ["**/*.js"],
+    files: ['**/*.js'],
     plugins: {
-      "naming-convention": namingConventionPlugin,
+      mm_eslint: {
+        rules: mmEslint
+      }
     },
     rules: {
       // 命名规范插件规则
-      "naming-convention/class-name": "error",
-      "naming-convention/class-instance-name": "error",
-      "naming-convention/function-name": "error",
-      "naming-convention/param-name": "warn",
-      "naming-convention/variable-name": "warn",
-      "naming-convention/constant-name": "error",
+      'mm_eslint/class-name': 'error',
+      'mm_eslint/class-instance-name': 'error',
+      'mm_eslint/function-name': 'error',
+      'mm_eslint/param-name': 'warn',
+      'mm_eslint/variable-name': 'warn',
+      'mm_eslint/constant-name': 'error',
 
       // 禁用与命名规范插件冲突的默认规则
-      camelcase: "off",
-      "id-match": "off",
-      "new-cap": "off",
-      "id-length": "off",
+      camelcase: 'off',
+      'id-match': 'off',
+      'new-cap': 'off',
+      'id-length': 'off',
     },
   },
 ];
@@ -273,7 +275,10 @@ mm_eslint/
 ├── corrector.js      # 命名修正器
 ├── tip.js            # 提示信息
 ├── util.js           # 工具函数
+├── handler.js        # 规则处理器
+├── fix.js            # 自动修复功能
 ├── package.json      # npm配置
+├── eslint.config.js  # ESLint配置示例
 ├── README.md         # 中文说明文档
 ├── README_EN.md      # 英文说明文档
 ├── LICENSE           # 许可证
@@ -303,6 +308,12 @@ ISC License
 
 ## 更新日志
 
+### v1.4.4
+- 更新插件名称和规则前缀为 `mm_eslint`
+- 优化模块结构和文件组织
+- 增强测试覆盖率和错误处理
+- 改进文档和示例
+
 ### v1.4.3
 - 优化模块结构和文件组织
 - 增强测试覆盖率和错误处理

package/README_EN.md

@@ -22,12 +22,12 @@ ESLint plugin for personal naming conventions - supports PascalCase, camelCase,
 ## Actual Supported Rules
 
 The plugin actually supports the following ESLint rules:
-- `naming-convention/class-name` - Class name detection
-- `naming-convention/class-instance-name` - Class instance name detection  
-- `naming-convention/function-name` - Function name detection
-- `naming-convention/param-name` - Parameter name detection
-- `naming-convention/variable-name` - Variable name detection
-- `naming-convention/constant-name` - Constant name detection
+- `mm_eslint/class-name` - Class name detection
+- `mm_eslint/class-instance-name` - Class instance name detection  
+- `mm_eslint/function-name` - Function name detection
+- `mm_eslint/param-name` - Parameter name detection
+- `mm_eslint/variable-name` - Variable name detection
+- `mm_eslint/constant-name` - Constant name detection
 
 ## Installation
 
@@ -54,28 +54,30 @@ Import the plugin in your ESLint configuration file:
 
 ```javascript
 // eslint.config.js
-const namingConventionPlugin = require("mm_eslint");
+const mmEslint = require('mm_eslint');
 
 module.exports = [
   {
-    files: ["**/*.js"],
+    files: ['**/*.js'],
     plugins: {
-      "naming-convention": namingConventionPlugin,
+      mm_eslint: {
+        rules: mmEslint
+      }
     },
     rules: {
       // Naming convention plugin rules
-      "naming-convention/class-name": "error",
-      "naming-convention/class-instance-name": "error",
-      "naming-convention/function-name": "error",
-      "naming-convention/param-name": "warn",
-      "naming-convention/variable-name": "warn",
-      "naming-convention/constant-name": "error",
+      'mm_eslint/class-name': 'error',
+      'mm_eslint/class-instance-name': 'error',
+      'mm_eslint/function-name': 'error',
+      'mm_eslint/param-name': 'warn',
+      'mm_eslint/variable-name': 'warn',
+      'mm_eslint/constant-name': 'error',
 
       // Disable default rules conflicting with naming convention plugin
-      camelcase: "off",
-      "id-match": "off",
-      "new-cap": "off",
-      "id-length": "off",
+      camelcase: 'off',
+      'id-match': 'off',
+      'new-cap': 'off',
+      'id-length': 'off',
     },
   },
 ];
@@ -273,7 +275,10 @@ mm_eslint/
 ├── corrector.js      # Name corrector
 ├── tip.js            # Tip messages
 ├── util.js           # Utility functions
+├── handler.js        # Rule handler
+├── fix.js            # Auto-fix functionality
 ├── package.json      # npm configuration
+├── eslint.config.js  # ESLint configuration example
 ├── README.md         # Chinese documentation
 ├── README_EN.md      # English documentation
 ├── LICENSE           # License
@@ -303,6 +308,12 @@ Issues and Pull Requests are welcome to improve this plugin.
 
 ## Changelog
 
+### v1.4.4
+- Updated plugin name and rule prefix to `mm_eslint`
+- Optimized module structure and file organization
+- Enhanced test coverage and error handling
+- Improved documentation and examples
+
 ### v1.4.3
 - Optimized module structure and file organization
 - Enhanced test coverage and error handling

package/config.js

@@ -47,8 +47,8 @@ class Config {
  */
 Config.prototype.getRegex = function (style) {
   var regex = {
-    "PascalCase": /^[A-Z][a-z]*([A-Z][a-z]*)*$/,
-    "camelCase": /^[a-z][a-z]*([A-Z][a-z]*)*$/,
+    "PascalCase": /^[A-Z][a-z]+[A-Za-z]*$/,
+    "camelCase": /^[a-z][a-z]*([A-Z][a-z]*)*[a-z0-9]*$/,
     "snake_case": /^[a-z][a-z0-9]*(_[a-z0-9]+)*$/,
     "UPPER_SNAKE_CASE": /^[A-Z][A-Z0-9]*(_[A-Z0-9]+)*$/,
     "lowercase": /^[a-z]+([a-z0-9]+)*$/,
@@ -65,7 +65,7 @@ Config.prototype.getRegex = function (style) {
  * @returns {Array} 禁止拼接词列表
  */
 Config.prototype.getForbiddenWords = function (name_type) {
-  let type = name_type.replace('property-', '').replace('instance-', '');
+  let type = name_type.replace('property-', '').replace('instance-', '').replace('private-', '').replace('internal-', '').replace('prototype-', '');
   var forbidden = {
     'class': [
       'manager',
@@ -103,6 +103,7 @@ Config.prototype.getForbiddenWords = function (name_type) {
       'field',
       'property',
       'entity',
+      'data'
     ],
     'function': [
       'data',
@@ -149,10 +150,10 @@ Config.prototype.getForbiddenWords = function (name_type) {
       'array',
       'map',
       'set',
-      'collection',
       'container',
       'instance',
       'data',
+      'collection',
       'item',
       'items',
       'element',
@@ -300,6 +301,38 @@ Config.prototype.getBaseRule = function (name_type) {
       single_word: true,
       single_word_len: 8
     },
+    'param-function': {
+      name: '函数类型参数',
+      min: 1,
+      max: 20,
+      styles: ['camelCase'],
+      single_word: true,
+      single_word_len: 8
+    },
+    'param-class': {
+      name: '类类型参数',
+      min: 1,
+      max: 20,
+      styles: ['PascalCase'],
+      single_word: true,
+      single_word_len: 8
+    },
+    'param-object': {
+      name: '对象类型参数',
+      min: 1,
+      max: 20,
+      styles: ['snake_case'],
+      single_word: true,
+      single_word_len: 8
+    },
+    'param-variable': {
+      name: '变量类型参数',
+      min: 1,
+      max: 20,
+      styles: ['snake_case'],
+      single_word: true,
+      single_word_len: 8
+    },
     'variable': {
       name: '变量名',
       min: 1,
@@ -341,13 +374,7 @@ Config.prototype.getRule = function (name_type) {
  * @returns {object} 推荐词映射
  */
 Config.prototype.getRecommendWords = function (name_type) {
-  let type = name_type.replace('property-', '').replace('instance-', '');
-  if (type == 'function') {
-    type = 'function';
-  }
-  else if (type == 'value') {
-    type = 'variable';
-  }
+  let type = name_type.replace('property-', '').replace('instance-', '').replace('private-', '').replace('internal-', '').replace('prototype-', '');
   var recommend = {
     'class': {
       'App': ['Application'],
@@ -466,7 +493,7 @@ Config.prototype.getRecommendWords = function (name_type) {
  * @returns {Array} 忽略词列表
  */
 Config.prototype.getIgnoreWords = function (name_type) {
-  let type = name_type.replace('property-', '').replace('instance-', '');
+  let type = name_type.replace('property-', '').replace('instance-', '').replace('private-', '').replace('internal-', '').replace('prototype-', '');
   var ignore = {
     'class': [
       'exports', 'Middleware', 'Component', 'Controller', 'Repository', 'Interface', 'Transformer', 'Template'
@@ -535,23 +562,34 @@ Config.prototype.getTypeNameMap = function () {
     'class-instance': '类实例',
     'class': '类',
     'constant': '常量',
-    'property-function': '属性函数',
-    'property-variable': '属性变量',
-    'property-class-instance': '属性类实例',
-    'property-class': '属性类',
-    'property-constant': '属性常量',
-    'static-function': '静态函数',
-    'static-variable': '静态变量',
-    'static-class-instance': '静态类实例',
-    'static-class': '静态类',
-    'static-constant': '静态常量',
+    'property-function': '属性—函数',
+    'property-variable': '属性—变量',
+    'property-class-instance': '属性—类实例',
+    'property-class': '属性—类',
+    'property-constant': '属性—常量',
+    'static-function': '静态属性—函数',
+    'static-variable': '静态属性—变量',
+    'static-class-instance': '静态属性—类实例',
+    'static-class': '静态属性—类',
+    'static-constant': '静态属性—常量',
     'prototype-function': '原型函数',
     'prototype-variable': '原型变量',
     'prototype-class-instance': '原型类实例',
-    'prototype-class': '原型类',
-    'prototype-constant': '原型常量',
-    'private-function': '私有函数',
-    'private-variable': '私有变量'
+    'private-function': '私有属性—函数',
+    'private-variable': '私有属性—变量',
+    'private-class-instance': '私有属性—类实例',
+    'internal-function': '内部属性—函数',
+    'internal-variable': '内部属性—变量',
+    'internal-class-instance': '内部属性—类实例',
+    'use-variable': '引用-变量',
+    'use-function': '引用-函数',
+    'use-class': '引用-类',
+    'use-constant': '引用-常量',
+    'use-class-instance': '引用-类实例',
+    'param-class': '参数—类',
+    'param-class-instance': '参数—类实例',
+    'param-variable': '参数—变量',
+    'param-function': '参数—函数'
   };
   return type_name_map;
 }

package/corrector.js

@@ -43,7 +43,15 @@ Corrector.prototype.getSuggestion = function (error) {
   } catch {
     return error.name;
   }
-  return error.prefix + word;
+  
+  var suggestion = error.prefix + word;
+  
+  // 检查建议名称是否与原名称相同，如果相同则不显示建议
+  if (suggestion === error.name || word === error.name) {
+    return null;
+  }
+  
+  return suggestion;
 };
 
 /**
@@ -273,9 +281,54 @@ Corrector.prototype._filterForbiddenWord = function (words, forbidden_words) {
       new_word.push(word);
     }
   }
+  if (new_word.length === 0) {
+    new_word.push(words[words.length - 1]);
+  }
   return new_word;
 }
 
+/**
+ * 替换禁止词汇为推荐词汇
+ * @param {string[]} words 单词数组
+ * @param {Array} forbidden_words 禁止词列表
+ * @param {object} recommend_words 推荐词配置
+ * @returns {string[]} 替换后的单词数组
+ */
+Corrector.prototype._replaceForbiddenWords = function (words, forbidden_words, recommend_words) {
+  var new_words = [];
+  for (let i = 0; i < words.length; i++) {
+    let word = words[i];
+    if (this._isForbiddenWord(word, forbidden_words)) {
+      // 尝试为禁用词找到替代建议
+      var replacement = this._getForbiddenWordReplacement(word, recommend_words);
+      if (replacement) {
+        new_words.push(replacement);
+      }
+    } else {
+      new_words.push(word);
+    }
+  }
+  return new_words;
+}
+
+/**
+ * 获取禁用词的替代建议
+ * @param {string} forbidden_word 禁用词
+ * @param {object} recommend_words 推荐词配置
+ * @returns {string} 替代建议词
+ */
+Corrector.prototype._getForbiddenWordReplacement = function (forbidden_word, recommend_words) {
+  for (var replacement in recommend_words) {
+    var forbidden_list = recommend_words[replacement];
+    for (let i = 0; i < forbidden_list.length; i++) {
+      if (forbidden_word.toLowerCase() === forbidden_list[i].toLowerCase()) {
+        return replacement;
+      }
+    }
+  }
+  return null;
+}
+
 /**
  * 获取推荐的单词
  * @param {string[]} words 单词数组
@@ -284,7 +337,6 @@ Corrector.prototype._filterForbiddenWord = function (words, forbidden_words) {
  * @returns {string[]} 推荐的单词数组
  */
 Corrector.prototype._toRecommendWords = function (words, recommend, single_word_len) {
-  // console.log('推荐单词', words, recommend, single_word_len);
   let recommend_words = [];
   for (let i = 0; i < words.length; i++) {
     let word = words[i];