mm_eslint 1.4.4 → 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)
 
 ## 功能特性
 
@@ -22,12 +24,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 +56,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 +277,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           # 许可证
@@ -293,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
@@ -303,6 +334,12 @@ ISC License
 
 ## 更新日志
 
+### v1.4.4
+- 更新插件名称和规则前缀为 `mm_eslint`
+- 优化模块结构和文件组织
+- 增强测试覆盖率和错误处理
+- 改进文档和示例
+
 ### v1.4.3
 - 优化模块结构和文件组织
 - 增强测试覆盖率和错误处理

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
 
@@ -22,12 +24,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 +56,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 +277,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
@@ -293,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
@@ -303,6 +334,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