mm_config 2.1.6 → 2.1.7

package/index.js

@@ -1,360 +1,363 @@
 require('mm_expand');
 
+/**
+ * 配置字典（私有）
+ * @type {object}
+ */
+const dict = {};
+
 /**
  * 配置类
  * @class
  */
 class Config {
-	/**
-	 * 创建配置实例
-	 * @param {Object} options - 配置对象
-	 * @param {String} file - 配置文件路径
-	 * @param {Object} config - 配置选项
-	 * @param {Number} config.debounce_time - 防抖时间(ms)
-	 * @param {Boolean} config.pretty - 是否美化输出
-	 * @param {String} config.format - 格式(json/json5)
-	 * @throws {TypeError} 当options非对象时
-	 * @throws {TypeError} 当file非字符串时
-	 */
-	constructor(options, file, config) {
-		// 参数校验
-		if (options && typeof options !== 'object') {
-			throw new TypeError('options must be an object');
-		}
-		if (file && typeof file !== 'string') {
-			throw new TypeError('file must be a string');
-		}
-
-		this.config = {
-			debounce_time: 0, // 默认不防抖
-			pretty: true,
-			format: 'json'
-		};
-		this.options = {};
-		this._file = file;
-		this._conn = null;
-		this._timer = null;
-		this._promise = Promise.resolve();
-		this._logger = $.log || console;
-		// 如果没有提供配置且有文件路径，则从文件加载
-		if (!options && file) {
-			try {
-				this.options = file.loadJson();
-			} catch (err) {
-				this.log('error', `Error loading options from ${file}:`, err.message);
-				this.options = {};
-			}
-		}
-		// 设置配置
-		this.setOptions(options);
-		// 设置配置
-		this.setConfig(config);
-	}
+  /**
+   * 创建配置实例
+   * @param {object} config - 配置选项
+   * @param {number} config.debounce_time - 防抖时间(ms)
+   * @param {boolean} config.pretty - 是否美化输出
+   * @param {string} config.format - 格式(json/json5)
+   * @param {string} config.file - 配置文件路径
+   * @param {object} options - 选项
+   */
+  constructor(config, options = {}) {
+    this.config = {
+      debounce_time: 0, // 默认不防抖
+      pretty: true,
+      format: 'json',
+      file: ''
+    };
+
+    this.options = options || {};
+    this._conn = null;
+    this._timer = null;
+    this._promise = Promise.resolve();
+    this._logger = $.log || console;
+    // 设置配置
+    this.setConfig(config);
+  }
 }
 
 /**
  * 日志输出
- * @param {String} level - 日志级别(debug/info/warn/error)
- * @param {String} message - 日志消息
+ * @param {string} level - 日志级别(debug/info/warn/error)
+ * @param {string} message - 日志消息
  * @param {...*} args - 可选参数
  */
-Config.prototype.log = function(level, message, ...args){
-	this._logger[level](`[${this.constructor.name}] ${message}`, ...args);
-}
+Config.prototype.log = function (level, message, ...args) {
+  this._logger[level](`[${this.constructor.name}] ${message}`, ...args);
+};
 
 /**
  * 设置配置
- * @param {Object} config - 配置对象
+ * @param {object} config - 配置对象
  */
 Config.prototype.setConfig = function (config) {
-	Object.assign(this.config, config);
-}
+  $.push(this.config, config);
+};
 
 /**
  * 设置配置
- * @param {Object} options - 配置对象
+ * @param {object} options - 配置对象
  */
 Config.prototype.setOptions = function (options) {
-	$.push(this.options, options, true);
-}
+  $.push(this.options, options, true);
+};
 
 /**
  * 初始化配置（连接文件）
- * @param {Object} conn - 已连接的文件对象
- * @returns {Promise} 连接结果
+ * @param {object} conn - 已连接的文件对象
+ * @returns {object} 连接的文件对象
  */
-Config.prototype.setup = async function (conn) {
-	if (conn) this._conn = conn;
-	return this._conn;
+Config.prototype.setup = function (conn) {
+  if (conn) this._conn = conn;
+  return this._conn;
 };
 
 /**
  * 保存配置到文件（同步）
- * @returns {Boolean} 保存是否成功
+ * @returns {boolean} 保存是否成功
  */
 Config.prototype.saveSync = function () {
-	if (!this._file) return false;
-	try {
-		this._file.saveJson(this.options);
-		return true;
-	} catch (err) {
-		this.log('error', `Error saving options to ${this._file}:`, err.message);
-		return false;
-	}
+  if (!this.config.file) return false;
+  try {
+    this.config.file.saveJson(this.options);
+    return true;
+  } catch (err) {
+    this.log('error', `Error saving options to ${this.config.file}:`, err.message);
+    return false;
+  }
 };
 
 /**
  * 保存配置到文件（异步）
- * @returns {Promise<Boolean>}
+ * @returns {Promise<boolean>} 保存操作是否成功
  */
 Config.prototype.saveAsync = async function () {
-	if (!this._file) return Promise.resolve(true);
-
-	// 确保之前的写操作完成
-	await this._promise;
-
-	this._promise = Promise.resolve()
-		.then(() => {
-			this._file.saveJson(this.options);
-			return true;
-		})
-		.catch(err => {
-			this.log('error', `Error saving options to ${this._file}:`, err.message);
-			return false;
-		});
-
-	return this._promise;
+  if (!this.config.file) return Promise.resolve(true);
+
+  // 确保之前的写操作完成
+  await this._promise;
+
+  this._promise = Promise.resolve()
+    .then(() => {
+      this.config.file.saveJson(this.options);
+      return true;
+    })
+    .catch(err => {
+      this.log('error', `Error saving options to ${this.config.file}:`, err.message);
+      return false;
+    });
+
+  return this._promise;
 };
 
 /**
  * 获取代理对象
- * @returns {Proxy}
+ * @returns {Proxy} 配置对象的代理实例
  */
 Config.prototype.getProxy = function () {
-	var self = this;
-
-	return new Proxy(this.options, {
-		set(obj, prop, val) {
-			obj[prop] = val;
-
-			if (self.config.debounce_time > 0) {
-				// 防抖处理
-				if (self._timer) {
-					clearTimeout(self._timer);
-				}
-				self._timer = setTimeout(() => {
-					self.saveSync();
-				}, self.config.debounce_time);
-			} else {
-				// 无防抖，直接保存
-				self.saveSync();
-			}
-
-			return true;
-		},
-
-		get(obj, prop) {
-			// 提供一些特殊属性访问
-			if (prop === '_saveAsync') {
-				return () => self.saveAsync();
-			}
-			if (prop === '_saveSync') {
-				return () => self.saveSync();
-			}
-			if (prop === '_raw') {
-				return obj;
-			}
-
-			return obj[prop];
-		}
-	});
+  const self = this;
+
+  return new Proxy(this.options, {
+    set(obj, prop, val) {
+      obj[prop] = val;
+
+      if (self.config.debounce_time > 0) {
+        // 防抖处理
+        if (self._timer) {
+          clearTimeout(self._timer);
+        }
+        self._timer = setTimeout(() => {
+          self.saveSync();
+        }, self.config.debounce_time);
+      } else {
+        // 无防抖，直接保存
+        self.saveSync();
+      }
+
+      return true;
+    },
+
+    get(obj, prop) {
+      // 提供一些特殊属性访问
+      if (prop === '_saveAsync') {
+        return () => self.saveAsync();
+      }
+      if (prop === '_saveSync') {
+        return () => self.saveSync();
+      }
+      if (prop === '_raw') {
+        return obj;
+      }
+
+      return obj[prop];
+    }
+  });
 };
 
 /**
  * 获取异步代理对象
- * @returns {Proxy}
+ * @returns {Proxy} 异步配置对象的代理实例
  */
 Config.prototype.getAsyncProxy = function () {
-	var self = this;
-
-	return new Proxy(this.options, {
-		set(obj, prop, val) {
-			obj[prop] = val;
-
-			if (self.config.debounce_time > 0) {
-				if (self._timer) {
-					clearTimeout(self._timer);
-				}
-				self._timer = setTimeout(() => {
-					self.saveAsync();
-				}, self.config.debounce_time);
-			} else {
-				self.saveAsync();
-			}
-
-			return true;
-		},
-
-		get(obj, prop) {
-			if (prop === '_saveAsync') {
-				return () => self.saveAsync();
-			}
-			if (prop === '_saveSync') {
-				return () => self.saveSync();
-			}
-			if (prop === '_raw') {
-				return obj;
-			}
-
-			return obj[prop];
-		}
-	});
+  const self = this;
+
+  return new Proxy(this.options, {
+    set(obj, prop, val) {
+      obj[prop] = val;
+
+      if (self.config.debounce_time > 0) {
+        if (self._timer) {
+          clearTimeout(self._timer);
+        }
+        self._timer = setTimeout(() => {
+          self.saveAsync();
+        }, self.config.debounce_time);
+      } else {
+        self.saveAsync();
+      }
+
+      return true;
+    },
+
+    get(obj, prop) {
+      if (prop === '_saveAsync') {
+        return () => self.saveAsync();
+      }
+      if (prop === '_saveSync') {
+        return () => self.saveSync();
+      }
+      if (prop === '_raw') {
+        return obj;
+      }
+
+      return obj[prop];
+    }
+  });
 };
 
-/**
- * 配置字典（私有）
- * @type {Object}
- */
-const dict = {};
-
-/**
- * 创建配置（同步）
- * @param {String} file - 配置文件路径
- * @param {Object} options - 配置对象
- * @param {Object} config - 配置选项
- * @returns {Proxy}
- */
-function create(file, options = {}, config = {}) {
-	let f = file.fullname();
-	// 检查是否已存在配置
-	if (dict[f]) {
-		return dict[f].getProxy();
-	}
-	var cfg = new Config(options, f, config);
-	cfg.saveSync(); // 确保文件存在
-	// 注册配置字典
-	dict[f] = cfg;
-	return dict[f].getProxy();
-}
-
-/**
- * 创建配置（异步）
- * @param {String} file - 配置文件路径
- * @param {Object} options - 配置对象
- * @param {Object} config - 配置选项
- * @returns {Promise<Proxy>}
- */
-async function createAsync(file, options = {}, config = {}) {
-	let f = file.fullname();
-	// 检查是否已存在配置
-	if (dict[f]) {
-		this.log('warn', `Config for file ${f} already exists.`);
-		return dict[f].getAsyncProxy();
-	}
-	var cfg = new Config(options, f, config);
-	await cfg.saveAsync(); // 确保文件存在
-	// 注册配置字典
-	dict[f] = cfg;
-	return dict[f].getAsyncProxy();
-}
-
-/**
- * 清理指定文件配置缓存
- * @param {String} file - 配置文件路径
- */
-function clear(file) {
-	if (!file) return clearAll();
-	let f = file.fullname();
-	if (dict[f]) {
-		delete dict[f];
-	}
-}
-
-/**
- * 清理所有配置缓存
- */
-function clearAll() {
-	Object.keys(dict).forEach(key => {
-		delete dict[key];
-	});
-}
-
 /**
  * 获取配置值
- * @param {String} key - 配置键
- * @returns {*}
+ * @param {string} key - 配置键
+ * @returns {*} 配置值
  */
 Config.prototype.get = async function (key) {
-	var value;
-	if (this._conn) {
-		value = await this._conn.get(key);
-	}
-	if (!value) {
-		value = this.options[key];
-	}
-	return value;
+  let value;
+  if (this._conn) {
+    value = await this._conn.get(key);
+  }
+  if (!value) {
+    value = this.options[key];
+  }
+  return value;
 };
 
 /**
  * 设置配置值
- * @param {String} key - 配置键
+ * @param {string} key - 配置键
  * @param {*} value - 配置值
  */
 Config.prototype.set = async function (key, value) {
-	if (this._conn) {
-		await this._conn.set(key, value);
-	}
-	else {
-		this.options[key] = value;
-	}
+  if (this._conn) {
+    await this._conn.set(key, value);
+  }
+  else {
+    this.options[key] = value;
+  }
 };
 
 /**
  * 检查配置是否存在
- * @param {String} key - 配置键
- * @returns {Boolean}
+ * @param {string} key - 配置键
+ * @returns {boolean} 配置项是否存在
  */
 Config.prototype.has = async function (key) {
-	var bl = false;
-	if (this._conn) {
-		bl = await this._conn.has(key);
-	};
-	if (!bl) {
-		bl = this.options.hasOwnProperty(key);
-	}
-	return bl;
+  let bl = false;
+  if (this._conn) {
+    bl = await this._conn.has(key);
+  };
+  if (!bl) {
+    bl = this.options.hasOwnProperty(key);
+  }
+  return bl;
 };
 
 /**
  * 删除配置项
- * @param {String} key - 配置键
+ * @param {string} key - 配置键
  */
 Config.prototype.del = async function (key) {
-	if (this._conn) {
-		await this._conn.del(key);
-	};
-	delete this.options[key];
+  if (this._conn) {
+    await this._conn.del(key);
+  };
+  delete this.options[key];
 };
 
 /**
  * 获取所有配置键
- * @returns {Array<String>}
+ * @returns {Array<string>} 配置键列表
  */
 Config.prototype.keys = async function () {
-	let keys = [];
-	if (this._conn) {
-		keys = await this._conn.keys();
-	}
-	let local_keys = Object.keys(this.options);
-	keys = keys.concat(local_keys);
-	return keys;
+  let keys = [];
+  if (this._conn) {
+    keys = await this._conn.keys();
+  }
+  const local_keys = Object.keys(this.options);
+  keys = keys.concat(local_keys);
+  return keys;
 };
 
+/**
+ * 销毁
+ */
+Config.prototype.destroy = function () {
+  if (this._conn) {
+    this._conn.close();
+  }
+  delete dict[this.config.file];
+};
+
+/**
+ * 创建配置（同步）
+ * @param {string} file - 配置文件路径
+ * @param {object} options - 配置对象
+ * @param {object} config - 配置选项
+ * @returns {Proxy} 配置代理对象
+ */
+function create(file, options = {}, config = {}) {
+  const f = file.fullname();
+  // 检查是否已存在配置
+  if (dict[f]) {
+    return dict[f].getProxy();
+  }
+  const cfg = new Config({ file: f, ...config }, options);
+  cfg.saveSync(); // 确保文件存在
+  // 注册配置字典
+  dict[f] = cfg;
+  return dict[f].getProxy();
+}
+
+/**
+ * 创建配置（异步）
+ * @param {string} file - 配置文件路径
+ * @param {object} options - 配置对象
+ * @param {object} config - 配置选项
+ * @returns {Promise<Proxy>} 异步配置代理对象
+ */
+async function createAsync(file, options = {}, config = {}) {
+  const f = file.fullname();
+  // 检查是否已存在配置
+  if (dict[f]) {
+    this.log('warn', `Config for file ${f} already exists.`);
+    return dict[f].getAsyncProxy();
+  }
+  const cfg = new Config({ file: f, ...config }, options);
+  await cfg.saveAsync(); // 确保文件存在
+  // 注册配置字典
+  dict[f] = cfg;
+  return dict[f].getAsyncProxy();
+}
+
+/**
+ * 清理指定文件配置缓存
+ * @param {string} file - 配置文件路径
+ * @returns {void}
+ */
+function clear(file) {
+  if (!file) return clearAll();
+  const f = file.fullname();
+  if (dict[f]) {
+    delete dict[f];
+  }
+}
+
+/**
+ * 清理所有配置缓存
+ */
+function clearAll() {
+  Object.keys(dict).forEach(key => {
+    delete dict[key];
+  });
+}
+
+/**
+ * 获取配置代理对象
+ * @param {object} options - 配置对象
+ * @param {string} file - 配置文件路径
+ * @param {object} config - 配置选项
+ * @returns {Proxy} 配置代理对象
+ */
+function conf(options, file, config = {}) {
+  return createAsync(file, options, config);
+}
+
 // 模块导出
 module.exports = {
-	Config,
-	create,
-	createAsync,
-	clear,
-	clearAll
+  Config,
+  create,
+  createAsync,
+  clear,
+  clearAll,
+  conf
 };

package/package.json

@@ -1,10 +1,12 @@
 {
     "name": "mm_config",
-    "version": "2.1.6",
-    "description": "这是超级美眉配置同步器,用于更改配置同步保存为JSON文件",
+    "version": "2.1.7",
+    "description": "Super Meimei Configuration Synchronizer - Automatically sync configuration changes to JSON files",
     "main": "index.js",
     "scripts": {
-        "test": "node test.js"
+        "test": "node test.js",
+        "lint": "eslint index.js",
+        "lint:fix": "eslint index.js --fix"
     },
     "repository": {
         "type": "git",
@@ -17,7 +19,10 @@
         "sync",
         "async",
         "debounce",
-        "json5"
+        "json5",
+        "configuration",
+        "settings",
+        "automation"
     ],
     "author": "邱文武",
     "license": "ISC",
@@ -25,7 +30,21 @@
         "url": "https://gitee.com/qiuwenwu91/mm_config/issues"
     },
     "homepage": "https://gitee.com/qiuwenwu91/mm_config#readme",
+    "engines": {
+        "node": ">=14.0.0"
+    },
+    "files": [
+        "index.js",
+        "README.md",
+        "README_EN.md",
+        "LICENSE"
+    ],
     "dependencies": {
         "mm_expand": "^2.0.0"
+    },
+    "devDependencies": {
+        "eslint": "^9.39.2",
+        "eslint-plugin-jsdoc": "^61.5.0",
+        "mm_eslint": "^1.0.6"
     }
-}
+}

package/.gitattributes

@@ -1,5 +0,0 @@
-# Auto detect text files and perform LF normalization
-* text=auto
-*.js linguist-language=JavaScript
-*.css linguist-language=JavaScript
-*.html linguist-language=JavaScript