mm_dict 1.0.1 → 1.0.3

package/README.md

@@ -18,12 +18,12 @@ npm install mm_dict
 const { Dict, dictAdmin } = require('mm_dict');
 
 // 直接使用存储类
-const dict = new Dict('./data/dict.json');
+const dict = new Dict({ file: './data/dict.json' });
 dict.set('val', 'value').set('生命值', 'hp');
 dict.save();
 
 // 通过管理器按作用域获取实例（相同作用域返回同一实例）
-const scoped = dictAdmin('app', './data/app_dict.json');
+const scoped = dictAdmin('app', { file: './data/app_dict.json' });
 scoped.set('HP', 'hp');
 ```
 

package/example/index.js

@@ -0,0 +1,52 @@
+/**
+ * mm_dict 字典存储示例
+ * 演示 dictAdmin() 作用域工厂，以及 Dict 类的字符串键值
+ * 增删查与 JSON 文件持久化（save / load）。
+ * 运行：node example/index.js
+ */
+const fs = require('fs');
+const os = require('os');
+const path = require('path');
+const { Dict, dictAdmin } = require('../index.js');
+
+/** 示例临时目录 */
+const TMP_DIR = fs.mkdtempSync(path.join(os.tmpdir(), 'mm-dict-example-'));
+
+/**
+ * 主流程
+ */
+function main() {
+  // 方式1：作用域工厂，获取 os 作用域的字典存储实例
+  const store = dictAdmin('os');
+  store.set('country', 'CN');
+  console.log('工厂实例读取 country:', store.get('country'));
+
+  // 方式2：类实例 + 文件持久化
+  const file = path.join(TMP_DIR, 'dict.json');
+  const dict = new Dict({ file });
+  dict.set('zh', '中文').set('en', 'English');
+  console.log('字典列表:', dict.list());
+  console.log('has(zh):', dict.has('zh'));
+  console.log('保存到文件:', dict.save());
+
+  // 从文件重新加载
+  const loaded = new Dict({ file });
+  loaded.load();
+  console.log('加载后读取 en:', loaded.get('en'));
+
+  // 删除字典项
+  console.log('删除 en:', loaded.del('en'));
+  console.log('删除后列表:', loaded.list());
+
+  // 值必须是字符串
+  try {
+    dict.set('num', 123);
+  } catch (err) {
+    console.log('非字符串值被拒绝:', err.message);
+  }
+
+  // 清理临时目录
+  fs.rmSync(TMP_DIR, { recursive: true, force: true });
+}
+
+main();

package/lib/dict.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_dict",
-  "version": "1.0.1",
+  "version": "1.0.3",
   "description": "字典存储模块：键和值都只能是字符串，用于键值映射",
   "main": "index.js",
+  "repository": {
+    "type": "git",
+    "url": "git+https://gitee.com/qiuwenwu91/mm_dict.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/dict.test.js

@@ -37,14 +37,14 @@ describe('Dict', () => {
   describe('构造', () => {
     it('默认不传文件路径时 file 为空字符串', () => {
       const dict = new Dict();
-      expect(dict._file).toBe('');
+      expect(dict.config.file).toBe('');
       expect(dict.list()).toEqual({});
     });
 
     it('传入文件路径时保存路径', () => {
       const file = path.join(tmp_dir, 'dict.json');
-      const dict = new Dict(file);
-      expect(dict._file).toBe(file);
+      const dict = new Dict({ file });
+      expect(dict.config.file).toBe(file);
     });
   });
 
@@ -146,7 +146,7 @@ describe('Dict', () => {
 
     it('save 写入文件返回 true', () => {
       const file = path.join(tmp_dir, 'dict.json');
-      const dict = new Dict(file);
+      const dict = new Dict({ file });
       dict.set('val', 'value');
       expect(dict.save()).toBe(true);
       expect(JSON.parse(fs.readFileSync(file, 'utf8'))).toEqual({ val: 'value' });
@@ -158,14 +158,14 @@ describe('Dict', () => {
     });
 
     it('文件不存在时 load 返回 false', () => {
-      const dict = new Dict(path.join(tmp_dir, 'nope.json'));
+      const dict = new Dict({ file: path.join(tmp_dir, 'nope.json') });
       expect(dict.load()).toBe(false);
     });
 
     it('文件存在时 load 加载数据返回 true', () => {
       const file = path.join(tmp_dir, 'dict.json');
       fs.writeFileSync(file, JSON.stringify({ val: 'value', key: 'k' }));
-      const dict = new Dict(file);
+      const dict = new Dict({ file });
       expect(dict.load()).toBe(true);
       expect(dict.get('val')).toBe('value');
       expect(dict.get('key')).toBe('k');
@@ -174,7 +174,7 @@ describe('Dict', () => {
     it('文件含非字符串值时 load 抛 TypeError', () => {
       const file = path.join(tmp_dir, 'dict.json');
       fs.writeFileSync(file, JSON.stringify({ val: 123 }));
-      const dict = new Dict(file);
+      const dict = new Dict({ file });
       expect(() => dict.load()).toThrow('dict 的值必须是字符串');
     });
   });