mm_mongodb 1.5.4 → 1.5.6

package/eslint.config.js

@@ -1,68 +1,211 @@
-const jsdoc = require('eslint-plugin-jsdoc');
-
-module.exports = [
-  {
-    files: ['lib/**/*.js'],
-    languageOptions: {
-      ecmaVersion: 2020,
-      sourceType: 'script'
-    },
-    plugins: {
-      jsdoc: jsdoc
-    },
-    rules: {
-      // JSDoc相关规则 - 设置为error级别强制要求
-      'jsdoc/require-jsdoc': ['error', {
-        require: {
-          FunctionDeclaration: true,
-          MethodDefinition: true,
-          ClassDeclaration: true,
-          ArrowFunctionExpression: true
-        }
-      }],
-      'jsdoc/check-param-names': 'off',
-      'jsdoc/check-tag-names': 'off',
-      'jsdoc/check-types': 'off',
-      'jsdoc/require-param': 'off',
-      'jsdoc/require-param-description': 'off',
-      'jsdoc/require-returns': 'off',
-      'jsdoc/require-returns-description': 'off',
-      
-      // 基础语法规则
-      'no-unused-vars': ['error', { args: 'none', vars: 'all' }],
-      'no-console': 'warn',
-      
-      // 代码风格规则
-      'indent': ['error', 2],
-      'quotes': ['error', 'single'],
-      'semi': ['error', 'always'],
-      'comma-dangle': ['error', 'never'],
-      'no-trailing-spaces': 'error',
-      'eol-last': 'error',
-      'max-len': ['error', { code: 100 }],
-      'max-lines-per-function': ['error', { max: 40 }],
-      'complexity': ['error', 12],
-      'max-depth': ['error', 4],
-      'max-params': ['error', 4],
-      
-      // 命名规则
-      'id-length': ['error', {
-        min: 1,
-        max: 20,
-        properties: 'always'
-      }]
-    }
-  },
-  {
-    files: ['test/**/*.js'],
-    languageOptions: {
-      ecmaVersion: 2020,
-      sourceType: 'script'
-    },
-    rules: {
-      // 测试文件中允许使用console
-      'no-console': 'off',
-      'no-unused-vars': 'off'
-    }
-  }
+'use strict';
+
+const namingConventionPlugin = require('mm_eslint');
+
+/**
+ * 基于个人规则的ESLint配置
+ * 符合最新ESLint Flat Config格式
+ */
+
+module.exports = [
+  {
+    files: ['**/*.js'],
+    plugins: {
+      'naming-convention': namingConventionPlugin,
+      'jsdoc': require('eslint-plugin-jsdoc')
+    },
+    languageOptions: {
+      ecmaVersion: 'latest',
+      sourceType: 'module',
+      parserOptions: {
+        ecmaVersion: 'latest',
+        sourceType: 'module'
+      }
+    },
+    
+    // 命名规范规则 - 由自定义插件处理
+    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-method-naming': 'warn',
+      'naming-convention/private-variable-naming': 'warn',
+      'naming-convention/param-name': 'warn',
+      'naming-convention/property-name': 'warn',
+      'naming-convention/instance-property': 'warn',
+      
+      // 禁用与命名规范插件冲突的默认规则
+      'camelcase': 'off',
+      'id-match': 'off',
+      'new-cap': 'off',
+      'id-length': 'off',
+      'id-denylist': 'off',
+      'id-blacklist': 'off'
+    }
+  },
+  
+  {
+    // 代码风格规则
+    rules: {
+      // 最大行长度100字符
+      'max-len': ['error', {
+        code: 100,
+        ignoreComments: true,
+        ignoreUrls: true,
+        ignoreStrings: true,
+        ignoreTemplateLiterals: true
+      }],
+      
+      // 缩进2空格
+      'indent': ['error', 2, {
+        SwitchCase: 1,
+        VariableDeclarator: 1,
+        outerIIFEBody: 1,
+        MemberExpression: 1,
+        FunctionDeclaration: { parameters: 1, body: 1 },
+        FunctionExpression: { parameters: 1, body: 1 },
+        CallExpression: { arguments: 1 },
+        ArrayExpression: 1,
+        ObjectExpression: 1,
+        ImportDeclaration: 1,
+        flatTernaryExpressions: false,
+        ignoreComments: false
+      }],
+      
+      // 单引号
+      'quotes': ['error', 'single', {
+        avoidEscape: true,
+        allowTemplateLiterals: true
+      }],
+      
+      // 禁止制表符
+      'no-tabs': 'error',
+      
+      // 行尾分号
+      'semi': ['error', 'always'],
+      
+      // 逗号风格
+      'comma-style': ['error', 'last'],
+      
+      // 逗号后必须有空格，逗号前不能有空格
+      'comma-spacing': ['error', {
+        before: false,
+        after: true
+      }]
+    }
+  },
+  
+  {
+    // 错误处理规则
+    rules: {
+      // 必须进行参数校验
+      'no-unused-vars': ['error', {
+        args: 'all',
+        argsIgnorePattern: '^_',
+        caughtErrors: 'all',
+        caughtErrorsIgnorePattern: '^_',
+        destructuredArrayIgnorePattern: '^_',
+        varsIgnorePattern: '^_',
+        ignoreRestSiblings: true
+      }],
+      
+      // 建议使用try-catch
+      'no-unsafe-finally': 'warn',
+      
+      // 禁止直接抛出字符串
+      'no-throw-literal': 'error'
+    }
+  },
+  
+  {
+    // 最佳实践规则
+    rules: {
+      // 优先使用async/await
+      'prefer-promise-reject-errors': 'error',
+      
+      // 避免副作用
+      'no-param-reassign': ['error', {
+        props: true,
+        ignorePropertyModificationsFor: [
+          'acc', // for reduce accumulators
+          'accumulator', // for reduce accumulators
+          'e', // for e.returnvalue
+          'ctx', // for Koa routing
+          'context', // for Koa routing
+          'req', // for Express requests
+          'request', // for Express requests
+          'res', // for Express responses
+          'response', // for Express responses
+          '$scope', // for Angular 1 scopes
+          'staticContext' // for ReactRouter context
+        ]
+      }],
+      
+      // 优先链式编程
+      'prefer-object-spread': 'error',
+      
+      // 优先函数式编程
+      'prefer-arrow-callback': 'error',
+      
+      // 方法长度限制
+      'max-lines-per-function': ['warn', {
+        max: 40,
+        skipBlankLines: true,
+        skipComments: true
+      }],
+      
+      // 复杂度限制
+      'complexity': ['warn', 10]
+    }
+  },
+  
+  {
+    // JSDoc规则
+    rules: {
+      // 要求公开方法有JSDoc注释
+      'jsdoc/require-jsdoc': ['warn', {
+        publicOnly: true,
+        require: {
+          FunctionDeclaration: true,
+          MethodDefinition: true,
+          ClassDeclaration: true,
+          ArrowFunctionExpression: false,
+          FunctionExpression: false
+        }
+      }],
+      
+      // 检查JSDoc语法
+      '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'
+    }
+  },
+  
+  {
+    // 忽略规则
+    ignores: [
+      'node_modules/**',
+      'dist/**',
+      'build/**',
+      'coverage/**',
+      '*.min.js'
+    ]
+  }
 ];

package/index.js

@@ -12,31 +12,32 @@ const MongoClient = require('mongodb').MongoClient;
  * @description MongoDB帮助类
  */
 class MongoDB extends Base {
+	static config = {
+		// 服务器地址
+		host: "localhost",
+		// 端口号
+		port: 27017,
+		// 数据库名
+		database: "mm",
+		// 用户名
+		user: "",
+		// 密码
+		password: "",
+		// 连接选项 (MongoDB驱动7.x版本支持的参数)
+		min_pool_size: 10,
+		max_pool_size: 100,
+		connect_timeout_ms: 10000,
+		server_selection_timeout_ms: 5000,
+		retry_writes: true
+	};
+
 	/**
 	 * @description 创建MongoDB帮助类函数 (构造函数)
 	 * @param {Object} config 配置参数
 	 * @constructor
 	 */
 	constructor(config) {
-		super();
-		this.config = {
-			// 服务器地址
-			host: "localhost",
-			// 端口号
-			port: 27017,
-			// 数据库名
-			database: "mm",
-			// 用户名
-			user: "",
-			// 密码
-			password: "",
-			// 连接选项 (MongoDB驱动7.x版本支持的参数)
-			min_pool_size: 10,
-			max_pool_size: 100,
-			connect_timeout_ms: 10000,
-			server_selection_timeout_ms: 5000,
-			retry_writes: true
-		};
+		super(MongoDB.config);
 
 		// 数据库连接器
 		this.conn = null;
@@ -156,7 +157,6 @@ MongoDB.prototype._ensureConnected = async function () {
 						await this._ensureIndexes();
 					}
 
-					this.log('info', `成功连接到数据库，表名: ${this.table}`);
 				} else {
 					this.log('error', `[_ensureConnected] 连接失败，db对象为空或不具有collection方法`);
 					throw new Error('数据库连接失败，db对象为空');
@@ -2914,9 +2914,6 @@ MongoDB.prototype.open = async function () {
 					this.connected = false;
 				});
 
-				this.log('info',
-					`成功连接到 ${this.config.host}:${this.config.port}/${this.config.database}`
-				);
 				return true;
 			} catch (error) {
 				this.log('error', 'MongoDB连接失败:', error);
@@ -2931,7 +2928,6 @@ MongoDB.prototype.open = async function () {
  */
 MongoDB.prototype.close = async function () {
 	if (this.conn) {
-		this.log('info', `关闭连接`);
 		await this.conn.close().catch(err => this.log('error', '关闭MongoDB连接时出错:', err));
 		this.conn = null;
 		this.db = null;
@@ -2977,10 +2973,6 @@ MongoDB.prototype.createIndex = async function (keys, options = {}) {
 			throw new Error('数据库未连接或未指定表名');
 		}
 
-		this.log('info',
-			`创建索引: ${this.table}, keys: ${JSON.stringify(keys)}, options: ${JSON.stringify(options)}`
-		);
-
 		return await this.db.collection(this.table).createIndex(keys, options);
 	} catch (error) {
 		this.log('error', `创建索引失败: ${error.message}`);
@@ -3014,9 +3006,6 @@ MongoDB.prototype.createTTLIndex = async function (keys, expireAfterSeconds) {
 			expireAfterSeconds: expireAfterSeconds
 		};
 
-		this.log('info',
-			`创建TTL索引: ${this.table}, keys: ${JSON.stringify(keys)}, 过期时间: ${expireAfterSeconds}秒`);
-
 		return await this.db.collection(this.table).createIndex(keys, options);
 	} catch (error) {
 		this.log('error', `创建TTL索引失败: ${error.message}`);
@@ -3035,7 +3024,6 @@ MongoDB.prototype.getIndexes = async function () {
 				throw new Error('未指定表名');
 			}
 
-			this.log('info', `获取索引: ${this.table}`);
 			return await this.db.collection(this.table).indexes();
 		} catch (error) {
 			this.log('error', `[getIndexes] 获取索引失败: ${error.message}`);
@@ -3057,7 +3045,6 @@ MongoDB.prototype.dropIndex = async function (indexName) {
 		throw new TypeError('索引名称不能为空');
 	}
 	try {
-		this.log('info', `[dropIndex] 删除索引: ${this.table}, 索引名: ${indexName}`);
 		await this.db.collection(this.table).dropIndex(indexName);
 		return true;
 	} catch (error) {
@@ -3076,7 +3063,6 @@ MongoDB.prototype.dropTable = async function () {
 		throw new Error('未指定表名');
 	}
 	try {
-		this.log('info', `[dropTable] 删除集合: ${this.table}`);
 		await this.db.collection(this.table).drop();
 		return true;
 	} catch (error) {
@@ -3951,11 +3937,6 @@ MongoDB.prototype.rollbackTransaction = async function (session) {
 	}
 };
 
-/**
- * 导出MongoDB类
- */
-exports.MongoDB = MongoDB;
-
 /**
  * 确保连接池对象存在
  */
@@ -3991,7 +3972,7 @@ function mongodbAdmin(scope, config) {
 	return obj;
 }
 
-/**
- * @module 导出MongoDB管理器
- */
-exports.mongodbAdmin = mongodbAdmin;
+module.exports = {
+	MongoDB,
+	mongodbAdmin
+};

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "mm_mongodb",
-    "version": "1.5.4",
+    "version": "1.5.6",
     "description": "MongoDB数据库操作模块，提供简洁易用的API、缓存功能以及完整的Redis兼容接口，支持事件系统、事务和连接池管理",
     "main": "index.js",
     "scripts": {