mm_eslint 1.4.5 → 1.4.6

package/README.md

@@ -5,6 +5,8 @@
 [![npm version](https://img.shields.io/npm/v/mm_eslint.svg)](https://www.npmjs.com/package/mm_eslint)
 [![License: ISC](https://img.shields.io/badge/License-ISC-blue.svg)](https://opensource.org/licenses/ISC)
 [![Node.js Version](https://img.shields.io/badge/node-%3E%3D12.0.0-brightgreen.svg)](https://nodejs.org/)
+[![Downloads](https://img.shields.io/npm/dm/mm_eslint.svg)](https://www.npmjs.com/package/mm_eslint)
+[![GitHub stars](https://img.shields.io/github/stars/qiuwenwu91/mm_eslint.svg)](https://gitee.com/qiuwenwu91/mm_eslint/stargazers)
 
 ## 功能特性
 
@@ -298,6 +300,30 @@ npm test
 npm run lint
 ```
 
+## 发布说明
+
+### npm发布
+
+插件已发布到npm，可以通过以下命令安装：
+
+```bash
+npm install mm_eslint --save-dev
+```
+
+### 版本管理
+
+项目使用语义化版本控制（Semantic Versioning）：
+- **主版本号**：不兼容的API修改
+- **次版本号**：向下兼容的功能性新增
+- **修订号**：向下兼容的问题修正
+
+### 发布流程
+
+1. 更新版本号：`npm version patch|minor|major`
+2. 运行测试：`npm test`
+3. 代码检查：`npm run lint`
+4. 发布到npm：`npm publish`
+
 ## 许可证
 
 ISC License

package/README_EN.md

@@ -1,10 +1,12 @@
 # MM ESLint Plugin
 
-ESLint plugin for personal naming conventions - supports PascalCase, camelCase, snake_case, and UPPER_SNAKE_CASE naming rules.
+ESLint plugin for personal naming conventions - supports PascalCase, camelCase, snake_case, and UPPER_SNAKE_CASE naming rules with intelligent recommendations.
 
 [![npm version](https://img.shields.io/npm/v/mm_eslint.svg)](https://www.npmjs.com/package/mm_eslint)
 [![License: ISC](https://img.shields.io/badge/License-ISC-blue.svg)](https://opensource.org/licenses/ISC)
 [![Node.js Version](https://img.shields.io/badge/node-%3E%3D12.0.0-brightgreen.svg)](https://nodejs.org/)
+[![Downloads](https://img.shields.io/npm/dm/mm_eslint.svg)](https://www.npmjs.com/package/mm_eslint)
+[![GitHub stars](https://img.shields.io/github/stars/qiuwenwu91/mm_eslint.svg)](https://gitee.com/qiuwenwu91/mm_eslint/stargazers)
 
 ## Features
 
@@ -298,6 +300,30 @@ npm test
 npm run lint
 ```
 
+## Publishing Information
+
+### npm Publishing
+
+The plugin is published to npm and can be installed via:
+
+```bash
+npm install mm_eslint --save-dev
+```
+
+### Version Management
+
+Project uses Semantic Versioning:
+- **Major version**: Incompatible API changes
+- **Minor version**: Backward-compatible functionality additions
+- **Patch version**: Backward-compatible bug fixes
+
+### Publishing Process
+
+1. Update version: `npm version patch|minor|major`
+2. Run tests: `npm test`
+3. Code linting: `npm run lint`
+4. Publish to npm: `npm publish`
+
 ## License
 
 ISC License

package/index.js

@@ -2,343 +2,199 @@
  * ESLint命名规范检测插件
  * 版本: 2.0.0 - 模块化重构版，职责分离
  */
-const { Handler } = require('./handler');
+const { ClassName, ClassInstanceName, FunctionName, VariableName, ObjectName, ConstName, ParamName } = require('./lib/detector');
 
 /**
  * 规则定义类
  * 负责定义ESLint规则配置
  */
-class Rules {
-  /**
-   * 构造函数
-   */
-  constructor() {
-    this.handler = new Handler();
-  }
-
+module.exports = {
   /**
    * 创建类名规则
    * @returns {object} 类名规则配置
    */
-  createClassNameRule() {
-    var handler = this.handler;
-    
-    return {
-      meta: {
-        type: 'suggestion',
-        docs: {
-          description: '检测类名是否符合命名规范',
-          category: 'Stylistic Issues',
-          recommended: true,
-        },
-        fixable: 'code',
-        schema: [],
+  'class-name': {
+    meta: {
+      type: 'suggestion',
+      docs: {
+        description: '检测类名是否符合命名规范',
+        category: 'Stylistic Issues',
+        recommended: true,
       },
-      create: function (context) {
-        return {
-          ClassDeclaration: function (node) {
-            handler.handleClassDeclaration(context, node, node, 'class');
-          },
-          VariableDeclaration: function (node) {
-            handler.handleVariableDeclaration(context, node, node, 'class');
-          },
-          Property: function (node) {
-            handler.handleProperty(context, node, node, 'class');
-          },
-          AssignmentExpression: function (node) {
-            handler.handleAssignmentExpression(context, node, node, 'class');
-          },
-          ExportDefaultDeclaration: function (node) {
-            handler.handleExportDefaultDeclaration(context, node, node, 'class');
-          },
-          ExportNamedDeclaration: function (node) {
-            handler.handleExportNamedDeclaration(context, node, node, 'class');
-          },
-          ClassExpression: function (node) {
-            handler.handleClassExpression(context, node, node, 'class');
-          },
-          ImportDeclaration: function (node) {
-            handler.handleImportDeclaration(context, node, node, 'class');
-          },
-          Identifier: function (node) {
-            handler.handleIdentifier(context, node, node, 'class');
-          }
-        };
-      },
-    };
-  }
+      fixable: 'code',
+      schema: [],
+    },
+    create: function (context) {
+      var cs = new ClassName(context);
+      let obj = {};
+      for (let key in cs) {
+        if (typeof cs[key] === 'function' && !key.startsWith('_')) {
+          obj[key] = cs[key].bind(cs);
+        }
+      }
+      return obj
+    }
+  },
 
   /**
    * 创建类实例名规则
    * @returns {object} 类实例名规则配置
    */
-  createClassInstanceNameRule() {
-    var handler = this.handler;
-    
-    return {
-      meta: {
-        type: 'suggestion',
-        docs: {
-          description: '检测类实例名是否符合命名规范',
-          category: 'Stylistic Issues',
-          recommended: true,
-        },
-        fixable: 'code',
-        schema: [],
+  'class-instance-name': {
+    meta: {
+      type: 'suggestion',
+      docs: {
+        description: '检测类实例名是否符合命名规范',
+        category: 'Stylistic Issues',
+        recommended: true,
       },
-      create: function (context) {
-        return {
-          VariableDeclaration: function (node) {
-            handler.handleVariableDeclaration(context, node, node, 'class-instance');
-          },
-          Property: function (node) {
-            handler.handleProperty(context, node, node, 'class-instance');
-          },
-          AssignmentExpression: function (node) {
-            handler.handleAssignmentExpression(context, node, node, 'class-instance');
-          },
-          PropertyDefinition: function (node) {
-            handler.handlePropertyDefinition(context, node, node, 'class-instance');
-          }
-        };
+      fixable: 'code',
+      schema: [],
+    },
+    create: function (context) {
+      var cs = new ClassInstanceName(context);
+      let obj = {};
+      for (let key in cs) {
+        if (typeof cs[key] === 'function' && !key.startsWith('_')) {
+          obj[key] = cs[key].bind(cs);
+        }
+      }
+      return obj
+    }
+  },
+
+  /**
+   * 创建对象名规则
+   * @returns {object} 对象名规则配置
+   */
+  'object-name': {
+    meta: {
+      type: 'suggestion',
+      docs: {
+        description: '检测对象名是否符合命名规范',
+        category: 'Stylistic Issues',
+        recommended: true,
       },
-    };
-  }
+      fixable: 'code',
+      schema: [],
+    },
+    create: function (context) {
+      var cs = new ObjectName(context);
+      let obj = {};
+      for (let key in cs) {
+        if (typeof cs[key] === 'function' && !key.startsWith('_')) {
+          obj[key] = cs[key].bind(cs);
+        }
+      }
+      return obj
+    }
+  },
 
   /**
    * 创建函数名规则
    * @returns {object} 函数名规则配置
    */
-  createFunctionNameRule() {
-    var handler = this.handler;
-    
-    return {
-      meta: {
-        type: 'suggestion',
-        docs: {
-          description: '检测函数名是否符合命名规范',
-          category: 'Stylistic Issues',
-          recommended: true,
-        },
-        fixable: 'code',
-        schema: [],
+  'function-name': {
+    meta: {
+      type: 'suggestion',
+      docs: {
+        description: '检测函数名是否符合命名规范',
+        category: 'Stylistic Issues',
+        recommended: true,
       },
-      create: function (context) {
-        return {
-          FunctionDeclaration: function (node) {
-            handler.handleFunctionDeclaration(context, node, node, 'function');
-          },
-          FunctionExpression: function (node) {
-            handler.handleFunctionExpression(context, node, node, 'function');
-          },
-          ArrowFunctionExpression: function (node) {
-            handler.handleArrowFunctionExpression(context, node, node, 'function');
-          },
-          CallExpression: function (node) {
-            handler.handleCallExpression(context, node, node, 'function');
-          },
-          MethodDefinition: function (node) {
-            handler.handleMethodDefinition(context, node, node, 'function');
-          },
-          Property: function (node) {
-            handler.handleProperty(context, node, node, 'function');
-          },
-          PropertyDefinition: function (node) {
-            handler.handlePropertyDefinition(context, node, node, 'function');
-          },
-          AssignmentExpression: function (node) {
-            handler.handleAssignmentExpression(context, node, node, 'function');
-          },
-          VariableDeclaration: function (node) {
-            handler.handleVariableDeclaration(context, node, node, 'function');
-          },
-        };
-      },
-    };
-  }
+      fixable: 'code',
+      schema: [],
+    },
+    create: function (context) {
+      var cs = new FunctionName(context);
+      let obj = {};
+      for (let key in cs) {
+        if (typeof cs[key] === 'function' && !key.startsWith('_')) {
+          obj[key] = cs[key].bind(cs);
+        }
+      }
+      return obj
+    }
+  },
 
   /**
    * 创建变量名规则
    * @returns {object} 变量名规则配置
    */
-  createVariableNameRule() {
-    var handler = this.handler;
-    
-    return {
-      meta: {
-        type: 'suggestion',
-        docs: {
-          description: '检测变量名是否符合命名规范',
-          category: 'Stylistic Issues',
-          recommended: true,
-        },
-        fixable: 'code',
-        schema: [],
-      },
-      create: function (context) {
-        return {
-          VariableDeclaration: function (node) {
-            handler.handleVariableDeclaration(context, node, node, 'variable');
-          },
-          ForStatement: function (node) {
-            if (node.init && node.init.type === 'VariableDeclaration') {
-              handler.handleVariableDeclaration(context, node, node.init, 'variable');
-            }
-          },
-          ForInStatement: function (node) {
-            if (node.left && node.left.type === 'VariableDeclaration') {
-              handler.handleVariableDeclaration(context, node, node.left, 'variable');
-            }
-          },
-          ForOfStatement: function (node) {
-            if (node.left && node.left.type === 'VariableDeclaration') {
-              handler.handleVariableDeclaration(context, node, node.left, 'variable');
-            }
-          },
-          Property: function (node) {
-            handler.handleProperty(context, node, node, 'variable');
-          },
-          PropertyDefinition: function (node) {
-            handler.handlePropertyDefinition(context, node, node, 'variable');
-          },
-          AssignmentExpression: function (node) {
-            handler.handleAssignmentExpression(context, node, node, 'variable');
-          }
-        };
+  'variable-name': {
+    meta: {
+      type: 'suggestion',
+      docs: {
+        description: '检测变量名是否符合命名规范',
+        category: 'Stylistic Issues',
+        recommended: true,
       },
-    };
-  }
+      fixable: 'code',
+      schema: [],
+    },
+    create: function (context) {
+      var cs = new VariableName(context);
+      let obj = {};
+      for (let key in cs) {
+        if (typeof cs[key] === 'function' && !key.startsWith('_')) {
+          obj[key] = cs[key].bind(cs);
+        }
+      }
+      return obj
+    }
+  },
 
   /**
    * 创建常量名规则
    * @returns {object} 常量名规则配置
    */
-  createConstantNameRule() {
-    var handler = this.handler;
-    
-    return {
-      meta: {
-        type: 'suggestion',
-        docs: {
-          description: '检测常量名是否符合命名规范',
-          category: 'Stylistic Issues',
-          recommended: true,
-        },
-        fixable: 'code',
-        schema: [],
-      },
-      create: function (context) {
-        return {
-          VariableDeclaration: function (node) {
-            handler.handleVariableDeclaration(context, node, node, 'constant');
-          },
-          Property: function (node) {
-            handler.handleProperty(context, node, node, 'constant');
-          },
-          PropertyDefinition: function (node) {
-            handler.handlePropertyDefinition(context, node, node, 'constant');
-          },
-          AssignmentExpression: function (node) {
-            handler.handleAssignmentExpression(context, node, node, 'constant');
-          }
-        };
+  'constant-name': {
+    meta: {
+      type: 'suggestion',
+      docs: {
+        description: '检测常量名是否符合命名规范',
+        category: 'Stylistic Issues',
+        recommended: true,
       },
-    };
-  }
+      fixable: 'code',
+      schema: [],
+    },
+    create: function (context) {
+      var cs = new ConstName(context);
+      let obj = {};
+      for (let key in cs) {
+        if (typeof cs[key] === 'function' && !key.startsWith('_')) {
+          obj[key] = cs[key].bind(cs);
+        }
+      }
+      return obj
+    }
+  },
 
   /**
    * 创建参数名规则
    * @returns {object} 参数名规则配置
    */
-  createParamNameRule() {
-    var handler = this.handler;
-    
-    return {
-      meta: {
-        type: 'suggestion',
-        docs: {
-          description: '检测参数名是否符合命名规范',
-          category: 'Stylistic Issues',
-          recommended: true,
-        },
-        fixable: 'code',
-        schema: [],
-      },
-      create: function (context) {
-        return {
-          FunctionDeclaration: function (node) {
-            if (node.params && node.params.length > 0) {
-              for (var i = 0; i < node.params.length; i++) {
-                var param = node.params[i];
-                if (param.type === 'Identifier') {
-                  var result = handler.detector.detect(param, param.name);
-                  if (result) {
-                    result.node = param;
-                    result.fix = handler.fix.createParamFixFunction(context, param, result);
-                    context.report(result);
-                  }
-                }
-              }
-            }
-          },
-          FunctionExpression: function (node) {
-            if (node.params && node.params.length > 0) {
-              for (var i = 0; i < node.params.length; i++) {
-                var param = node.params[i];
-                if (param.type === 'Identifier') {
-                  var result = handler.detector.detect(param, param.name);
-                  if (result) {
-                    result.node = param;
-                    result.fix = handler.fix.createParamFixFunction(context, param, result);
-                    context.report(result);
-                  }
-                }
-              }
-            }
-          },
-          ArrowFunctionExpression: function (node) {
-            if (node.params && node.params.length > 0) {
-              for (var i = 0; i < node.params.length; i++) {
-                var param = node.params[i];
-                if (param.type === 'Identifier') {
-                  var result = handler.detector.detect(param, param.name);
-                  if (result) {
-                    result.node = param;
-                    result.fix = handler.fix.createParamFixFunction(context, param, result);
-                    context.report(result);
-                  }
-                }
-              }
-            }
-          }
-        };
+  'param-name': {
+    meta: {
+      type: 'suggestion',
+      docs: {
+        description: '检测参数名是否符合命名规范',
+        category: 'Stylistic Issues',
+        recommended: true,
       },
-    };
+      fixable: 'code',
+      schema: [],
+    },
+    create: function (context) {
+      var cs = new ParamName(context);
+      let obj = {};
+      for (let key in cs) {
+        if (typeof cs[key] === 'function' && !key.startsWith('_')) {
+          obj[key] = cs[key].bind(cs);
+        }
+      }
+      return obj
+    }
   }
-
-  /**
-   * 获取所有规则
-   * @returns {object} 所有规则配置
-   */
-  getAllRules() {
-    return {
-      'class-name': this.createClassNameRule(),
-      'class-instance-name': this.createClassInstanceNameRule(),
-      'function-name': this.createFunctionNameRule(),
-      'variable-name': this.createVariableNameRule(),
-      'constant-name': this.createConstantNameRule(),
-      'param-name': this.createParamNameRule()
-    };
-  }
-}
-
-/**
- * 创建ESLint规则配置
- * @returns {object} ESLint规则配置对象
- */
-function createNamingRules() {
-  var rules = new Rules();
-  return rules.getAllRules();
 }
-
-module.exports = createNamingRules();