mm_tpl 2.7.4 → 2.9.0

package/lib/lang.js

@@ -1,6 +1,7 @@
+// 语言实例由 mm_lang 提供，本文件的 Lang 只是语言包加载器，故以 BaseLang 别名引用
 const {
-  BaseLang
-} = require('./base_lang.js');
+  Lang: BaseLang
+} = require('mm_lang');
 const {
   TplUtil
 } = require('./util.js');
@@ -153,24 +154,70 @@ Lang.prototype.buildDict = function (force) {
   return Object.assign({}, dict);
 };
 
+/**
+ * 将嵌套语言包字典规范化为 mm_lang 的扁平词条表
+ * mm_lang 的 Lang 只接受 `语言.层级键 → 文本` 的扁平入参，控制键（default、silent）原样保留
+ * @param {Object} dict 语言包字典，语言代码对应嵌套词条对象
+ * @returns {Object} 扁平词条表
+ */
+function flattenLangPack(dict) {
+  var flat = {};
+  for (var key in dict) {
+    if (!Object.prototype.hasOwnProperty.call(dict, key)) {
+      continue;
+    }
+    var val = dict[key];
+    if (val && typeof (val) === 'object' && !Array.isArray(val)) {
+      flattenInto(val, key, flat);
+    } else {
+      flat[key] = val;
+    }
+  }
+  return flat;
+}
+
+/**
+ * 递归展开嵌套词条为点号路径键 - 内部函数
+ * @param {Object} obj 嵌套词条对象
+ * @param {string} prefix 键前缀
+ * @param {Object} flat 输出容器
+ * @returns {void}
+ */
+function flattenInto(obj, prefix, flat) {
+  for (var key in obj) {
+    if (!Object.prototype.hasOwnProperty.call(obj, key)) {
+      continue;
+    }
+    var val = obj[key];
+    var path = prefix + '.' + key;
+    if (val && typeof (val) === 'object' && !Array.isArray(val)) {
+      flattenInto(val, path, flat);
+    } else {
+      flat[path] = val;
+    }
+  }
+}
+
 /**
  * 创建语言实例
  * 语言包字典在实例间共享，仅当前语言各自独立
  * @param {Object} config - 配置参数
  * @param {boolean} force - 是否跳过语言包缓存强制重新加载
- * @returns {BaseLang} 语言实例
+ * @returns {BaseLang} 语言实例（mm_lang 的 Lang）
  */
 Lang.prototype.create = function (config, force) {
   var dict = this.buildDict(force);
   dict.default = config.default_lang || dict.default || 'zh_cn';
-  var lang = new BaseLang(dict);
+  // 词条缺失时静默返回 undefined，日志由模板引擎自身的 log 体系统一输出
+  dict.silent = true;
+  var lang = new BaseLang(flattenLangPack(dict));
   this.registerPlural(lang, config.plural_rules);
   return lang;
 };
 
 /**
  * 登记复数规则
- * BaseLang 内置规则仅覆盖 zh_cn、en，配置中的语言代码需显式登记才能按语言取复数形式
+ * mm_lang 的 Lang 内置规则仅覆盖 zh_cn、en，配置中的语言代码需显式登记才能按语言取复数形式
  * @param {BaseLang} lang - 语言实例
  * @param {Object} plural_rules - 复数规则，键为语言代码
  */

package/lib/tpl.js

@@ -537,22 +537,14 @@ Tpl.prototype.tc = function (key, count, ...args) {
 
 /**
  * 获取支持的语言列表
- * 过滤掉无词条的语言，Lang 内置的 zh_cn、en 空字典不计入
+ * 语言列表来自 mm_lang 的扁平词条表，无词条的语言不会出现，无需过滤空字典
  * @returns {Array<string>} 语言代码数组
  */
 Tpl.prototype.getLangs = function () {
   if (!this.lang) {
     return [];
   }
-  var langs = this.lang.getLangs();
-  var list = [];
-  for (var i = 0; i < langs.length; i++) {
-    var dict = this.lang.config[langs[i]];
-    if (dict && Object.keys(dict).length) {
-      list.push(langs[i]);
-    }
-  }
-  return list;
+  return this.lang.getLangs();
 };
 
 /**
@@ -580,7 +572,8 @@ Tpl.prototype.loadLang = function (lang) {
     return null;
   }
   this.reloadLangs();
-  var dict = this.lang ? this.lang.config[lang] : null;
+  // 通过 getDict 导出该语言的嵌套词条字典（形态与语言包文件一致）
+  var dict = this.lang ? this.lang.getDict(lang) : null;
   if (!dict) {
     this.log('warn', '语言包不存在：' + lang);
     return null;

package/package.json

@@ -1,65 +1,66 @@
-{
-    "name": "mm_tpl",
-    "version": "2.7.4",
-    "description": "Super Meimei Template Engine - High-performance template engine based on art-template with MVC pattern, hook system, theme switching and caching mechanism",
-    "main": "index.js",
-    "io": true,
-    "priority": 100,
-    "scripts": {
-        "dev": "nodemon test.js",
-        "demo": "node example/demo.js",
-        "test": "node test.js",
-        "coverage": "node --experimental-vm-modules node_modules/jest/bin/jest.js --coverage"
-    },
-    "repository": {
-        "type": "git",
-        "url": "git+https://gitee.com/qiuwenwu91/mm_tpl.git"
-    },
-    "keywords": [
-        "mm_mod",
-        "mm_infra",
-        "mm_common",
-        "mm_web",
-        "template",
-        "engine",
-        "mvc",
-        "web",
-        "view",
-        "render",
-        "art-template",
-        "hook",
-        "theme",
-        "cache",
-        "nodejs",
-        "javascript"
-    ],
-    "layer": "infra",
-    "group": "common",
-    "author": "邱文武",
-    "license": "MIT",
-    "bugs": {
-        "url": "https://gitee.com/qiuwenwu91/mm_tpl/issues"
-    },
-    "homepage": "https://gitee.com/qiuwenwu91/mm_tpl#readme",
-    "dependencies": {
-        "art-template": "4.13.4",
-        "mm_corejs": "^1.1.6"
-    },
-    "engines": {
-        "node": ">=12.0.0"
-    },
-    "files": [
-        "index.js",
-        "hook.js",
-        "tpl_rule.js",
-        "lib/",
-        "doc/",
-        "README.md",
-        "README_EN.md",
-        "package.json"
-    ],
-    "devDependencies": {
-        "eslint": "^9.39.5",
-        "eslint-plugin-jsdoc": "^65.0.0"
-    }
-}
+{
+    "name": "mm_tpl",
+    "version": "2.9.0",
+    "description": "Super Meimei Template Engine - High-performance template engine based on art-template with MVC pattern, hook system, theme switching and caching mechanism",
+    "main": "index.js",
+    "io": true,
+    "priority": 100,
+    "scripts": {
+        "dev": "nodemon test.js",
+        "demo": "node example/demo.js",
+        "test": "node test.js",
+        "coverage": "node --experimental-vm-modules node_modules/jest/bin/jest.js --coverage"
+    },
+    "repository": {
+        "type": "git",
+        "url": "git+https://gitee.com/qiuwenwu91/mm_tpl.git"
+    },
+    "keywords": [
+        "mm_mod",
+        "mm_infra",
+        "mm_common",
+        "mm_web",
+        "template",
+        "engine",
+        "mvc",
+        "web",
+        "view",
+        "render",
+        "art-template",
+        "hook",
+        "theme",
+        "cache",
+        "nodejs",
+        "javascript"
+    ],
+    "layer": "infra",
+    "group": "common",
+    "author": "邱文武",
+    "license": "MIT",
+    "bugs": {
+        "url": "https://gitee.com/qiuwenwu91/mm_tpl/issues"
+    },
+    "homepage": "https://gitee.com/qiuwenwu91/mm_tpl#readme",
+    "dependencies": {
+        "art-template": "4.13.4",
+        "mm_corejs": "^1.1.6",
+        "mm_lang": "^3.0.0"
+    },
+    "engines": {
+        "node": ">=12.0.0"
+    },
+    "files": [
+        "index.js",
+        "hook.js",
+        "tpl_rule.js",
+        "lib/",
+        "doc/",
+        "README.md",
+        "README_EN.md",
+        "package.json"
+    ],
+    "devDependencies": {
+        "eslint": "^9.39.5",
+        "eslint-plugin-jsdoc": "^65.0.0"
+    }
+}

package/lib/base_lang.js

@@ -1,200 +0,0 @@
-/**
- * 基础语言类
- * @description 提供语言包字典存储、翻译取词、复数形式选择与占位符插值能力
- */
-
-/**
- * 基础语言类
- * @class BaseLang
- */
-class BaseLang {
-  /**
-   * 创建语言实例
-   * @param {Object} config 语言包字典，形如 { zh_cn: { key: 值 }, default: 'zh_cn' }
-   */
-  constructor(config) {
-    /**
-     * 语言包字典
-     * @type {Object}
-     */
-    this.config = config || {};
-    /**
-     * 当前语言代码
-     * @type {String}
-     */
-    this.now = this.config.default || 'zh_cn';
-    /**
-     * 复数规则表，键为语言代码，值为根据数量返回复数索引的函数
-     * @type {Object}
-     */
-    this.rules = {
-      zh_cn: function (count) {
-        return 0;
-      },
-      en: function (count) {
-        return count === 1 ? 0 : 1;
-      }
-    };
-  }
-
-  /**
-   * 注册语言复数规则
-   * @param {String} code 语言代码
-   * @param {Function} fn 复数规则函数，入参为数量，返回复数索引
-   * @returns {BaseLang} 当前实例
-   */
-  registerPlural(code, fn) {
-    if (code && typeof fn === 'function') {
-      this.rules[code] = fn;
-    }
-    return this;
-  }
-
-  /**
-   * 设置当前语言
-   * 请求的语言不支持时回退到默认语言
-   * @param {String} lang 语言代码
-   * @returns {String} 设置后的语言代码
-   */
-  setLang(lang) {
-    if (this.isSupported(lang)) {
-      this.now = lang;
-    } else if (this.isSupported(this.config.default)) {
-      this.now = this.config.default;
-    }
-    return this.now;
-  }
-
-  /**
-   * 获取支持的语言列表
-   * 过滤掉配置中的默认语言标记
-   * @returns {Array<String>} 语言代码数组
-   */
-  getLangs() {
-    return Object.keys(this.config).filter(function (key) {
-      return key !== 'default';
-    });
-  }
-
-  /**
-   * 判断语言是否支持
-   * @param {String} lang 语言代码
-   * @returns {Boolean} 支持返回true，否则返回false
-   */
-  isSupported(lang) {
-    return !!lang && lang !== 'default' && typeof this.config[lang] === 'object' && this.config[lang] !== null;
-  }
-
-  /**
-   * 获取翻译词条
-   * 键支持 a.b 层级形式，词条缺失时回退到默认语言
-   * @param {String} key 词条键名
-   * @param {...any} args 位置占位符替换参数，依次替换 {0}、{1} 等
-   * @returns {*} 翻译文本；数组词条不带数量时原样返回
-   */
-  get(key, ...args) {
-    var val = this._getValue(key);
-    if (typeof val !== 'string' || !args.length) {
-      return val;
-    }
-    for (var i = 0; i < args.length; i++) {
-      val = val.split('{' + i + '}').join(args[i]);
-    }
-    return val;
-  }
-
-  /**
-   * 获取带复数形式的翻译文本
-   * @param {String} key 词条键名
-   * @param {Number} count 数量，用于选择复数形式并替换 {count} 占位符
-   * @param {...any} args 位置占位符替换参数
-   * @returns {String} 翻译文本
-   */
-  tc(key, count, ...args) {
-    var val = this._getValue(key);
-    var rule = this.rules[this.now] || this.rules.zh_cn;
-    var index = typeof rule === 'function' ? rule(count) : 0;
-    var text = Array.isArray(val) ? (val[index] || val[0] || '') : (typeof val === 'string' ? val : '');
-    text = String(text).split('{count}').join(count);
-    for (var i = 0; i < args.length; i++) {
-      text = text.split('{' + i + '}').join(args[i]);
-    }
-    return text;
-  }
-
-  /**
-   * 写入词条
-   * 写入当前语言字典，键支持 a.b 层级形式
-   * @param {String} key 词条键名
-   * @param {*} value 词条值
-   * @returns {BaseLang} 当前实例
-   */
-  set(key, value) {
-    var lang = this.config[this.now];
-    if (!lang || typeof lang !== 'object') {
-      lang = {};
-      this.config[this.now] = lang;
-    }
-    setByPath(lang, key, value);
-    return this;
-  }
-
-  /**
-   * 从当前语言字典取值，词条缺失时回退到默认语言
-   * @param {String} key 词条键名
-   * @returns {*} 词条值
-   * @private
-   */
-  _getValue(key) {
-    var now_dict = this.config[this.now];
-    var val = now_dict ? getByPath(now_dict, key) : undefined;
-    if (val === undefined && this.now !== this.config.default) {
-      var def_dict = this.config[this.config.default];
-      if (def_dict) {
-        val = getByPath(def_dict, key);
-      }
-    }
-    return val;
-  }
-}
-
-/**
- * 按路径从对象中取值
- * @param {Object} obj 对象
- * @param {String} path 点号路径
- * @returns {*} 路径对应的值
- */
-function getByPath(obj, path) {
-  var keys = String(path).split('.');
-  var val = obj;
-  for (var i = 0; i < keys.length; i++) {
-    if (val === null || val === undefined || typeof val !== 'object') {
-      return undefined;
-    }
-    val = val[keys[i]];
-  }
-  return val;
-}
-
-/**
- * 按路径向对象写入值
- * @param {Object} obj 对象
- * @param {String} path 点号路径
- * @param {*} value 写入的值
- * @returns {void}
- */
-function setByPath(obj, path, value) {
-  var keys = String(path).split('.');
-  var cur = obj;
-  for (var i = 0; i < keys.length - 1; i++) {
-    if (typeof cur[keys[i]] !== 'object' || cur[keys[i]] === null) {
-      cur[keys[i]] = {};
-    }
-    cur = cur[keys[i]];
-  }
-  cur[keys[keys.length - 1]] = value;
-}
-
-module.exports = {
-  BaseLang
-};