mm_vars 1.0.0 → 1.0.1

package/README.md

@@ -19,12 +19,12 @@ npm install mm_vars
 const { Vars, varsAdmin } = require('mm_vars');
 
 // 直接使用存储类
-const vars = new Vars('./data/vars.json');
+const vars = new Vars({ file: './data/vars.json' });
 vars.set('step', 1).set('state', 'busy');
 vars.save();
 
 // 通过管理器按作用域获取实例（相同作用域返回同一实例）
-const scoped = varsAdmin('app', './data/app_vars.json');
+const scoped = varsAdmin('app', { file: './data/app_vars.json' });
 scoped.set('count', 10);
 ```
 

package/example/index.js

@@ -0,0 +1,49 @@
+/**
+ * mm_vars 变量存储示例
+ * 演示 varsAdmin() 作用域工厂，以及 Vars 类可随时修改、
+ * 删除的键值变量存取与 JSON 文件持久化（save / load）。
+ * 运行：node example/index.js
+ */
+const fs = require('fs');
+const os = require('os');
+const path = require('path');
+const { Vars, varsAdmin } = require('../index.js');
+
+/** 示例临时目录 */
+const TMP_DIR = fs.mkdtempSync(path.join(os.tmpdir(), 'mm-vars-example-'));
+
+/**
+ * 主流程
+ */
+function main() {
+  // 方式1：作用域工厂，获取 os 作用域的变量存储实例
+  const store = varsAdmin('os');
+  store.set('token', 'abc123');
+  console.log('工厂实例读取 token:', store.get('token'));
+
+  // 方式2：类实例 + 文件持久化
+  const file = path.join(TMP_DIR, 'vars.json');
+  const vars = new Vars({ file });
+  vars.set('name', 'demo').set('count', 1);
+  console.log('变量列表:', vars.list());
+  console.log('保存到文件:', vars.save());
+
+  // 变量可随时修改
+  vars.set('count', 2);
+  console.log('修改后 count:', vars.get('count'));
+
+  // 变量可删除
+  console.log('删除 name:', vars.del('name'));
+  console.log('删除后列表:', vars.list());
+
+  // 从文件重新加载（文件里是保存时的数据）
+  const loaded = new Vars({ file });
+  loaded.load();
+  console.log('重新加载后 name:', loaded.get('name'));
+  console.log('重新加载后 count:', loaded.get('count'));
+
+  // 清理临时目录
+  fs.rmSync(TMP_DIR, { recursive: true, force: true });
+}
+
+main();

package/lib/vars.js

@@ -1,4 +1,4 @@
-const KvStore = require('mm_corejs').KvStore;
+const KvStore = require('mm_kv_store').KvStore;
 
 /**
  * 变量存储类，可随时修改和删除

package/package.json

@@ -1,8 +1,12 @@
 {
   "name": "mm_vars",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "变量存储模块：用于存储可随时修改和删除的键值变量",
   "main": "index.js",
+  "repository": {
+    "type": "git",
+    "url": "git+https://gitee.com/qiuwenwu91/mm_vars.git"
+  },
   "keywords": [
     "mm_mod",
     "mm_infra",
@@ -19,7 +23,8 @@
     "test": "jest --coverage"
   },
   "dependencies": {
-    "mm_corejs": "^1.1.4"
+    "mm_corejs": "^1.1.4",
+    "mm_kv_store": "^1.0.0"
   },
   "devDependencies": {
     "jest": "^30.5.2"

package/test/vars.test.js

@@ -37,14 +37,14 @@ describe('Vars', () => {
   describe('构造', () => {
     it('默认不传文件路径时 file 为空字符串', () => {
       const vars = new Vars();
-      expect(vars._file).toBe('');
+      expect(vars.config.file).toBe('');
       expect(vars.list()).toEqual({});
     });
 
     it('传入文件路径时保存路径', () => {
       const file = path.join(tmp_dir, 'vars.json');
-      const vars = new Vars(file);
-      expect(vars._file).toBe(file);
+      const vars = new Vars({ file });
+      expect(vars.config.file).toBe(file);
     });
   });
 
@@ -141,7 +141,7 @@ describe('Vars', () => {
 
     it('save 写入文件返回 true', () => {
       const file = path.join(tmp_dir, 'vars.json');
-      const vars = new Vars(file);
+      const vars = new Vars({ file });
       vars.set('a', 1);
       expect(vars.save()).toBe(true);
       expect(JSON.parse(fs.readFileSync(file, 'utf8'))).toEqual({ a: 1 });
@@ -153,14 +153,14 @@ describe('Vars', () => {
     });
 
     it('文件不存在时 load 返回 false', () => {
-      const vars = new Vars(path.join(tmp_dir, 'nope.json'));
+      const vars = new Vars({ file: path.join(tmp_dir, 'nope.json') });
       expect(vars.load()).toBe(false);
     });
 
     it('文件存在时 load 加载数据返回 true', () => {
       const file = path.join(tmp_dir, 'vars.json');
       fs.writeFileSync(file, JSON.stringify({ a: 1, b: 'x' }));
-      const vars = new Vars(file);
+      const vars = new Vars({ file });
       expect(vars.load()).toBe(true);
       expect(vars.get('a')).toBe(1);
       expect(vars.get('b')).toBe('x');