mm_machine 2.1.6 → 2.1.8

package/item.js

@@ -1,6 +1,7 @@
-const util = require('util');
-const { conf } = require('mm_config');
-const { HotReload } = require('mm_hot_reload');
+let util = require('util');
+let { conf } = require('mm_config');
+let Tpl = require('mm_tpl');
+let { HotReload } = require('mm_hot_reload');
 
 // 初始化全局对象
 if (typeof global.$ === 'undefined') {
@@ -11,6 +12,10 @@ if (!$.mod) {
   $.mod = new HotReload();
 }
 
+if (!$.tpl) {
+  $.tpl = new Tpl();
+}
+
 /**
  * 增强require函数，支持热更新
  * @param {string} file 文件路径
@@ -61,7 +66,7 @@ class Item {
       // 描述, 用于描述该有什么用的
       description: '',
       // 文件路径, 当调用函数不存在时，会先从文件中加载
-      func_file: './index.js',
+      main: './index.js',
       // 回调函数名 用于决定调用脚本的哪个函数
       func_name: '',
       // 排序
@@ -103,8 +108,8 @@ Item.prototype.log = function (level, message, ...args) {
 Item.prototype.setConfig = function (config) {
   if (!config) return;
 
-  // 如果func_file改变，重置加载状态
-  if (config.func_file !== this.config.func_file) {
+  // 如果main改变，重置加载状态
+  if (config.main !== this.config.main) {
     this.complete = false;
   }
 
@@ -124,9 +129,54 @@ Item.prototype.setConfigAfter = function () {
  * @param {string} file 目标文件路径
  */
 Item.prototype.newScript = function (file) {
-  const template_file = './script.js'.fullname(this.dir_base);
-  if (template_file.hasFile()) {
-    template_file.copyFile(file);
+  this._createScriptFile(file, this.config, this.dir_base);
+};
+
+
+/**
+ * 创建脚本
+ * @param {string} file 文件路径
+ * @param {object} model 模板数据
+ * @param {string} tpl_dir 模板文件路径
+ * @returns {boolean} 创建是否成功
+ */
+Item.prototype._createScriptFile = function (file, model = {}, tpl_dir = '') {
+  var tpl = this.getScriptTpl(tpl_dir);
+  var content = $.tpl.render(tpl, model);
+  file.saveText(content);
+  return file;
+};
+
+/**
+ * 获取脚本模板
+ * @param {string} tpl_dir 模板文件路径
+ * @returns {string} 脚本模板内容
+ */
+Item.prototype.getScriptTpl = function (tpl_dir = '') {
+  var f = './script.tpl.js'.fullname(tpl_dir || this.dir_base);
+  if (f.hasFile()) {
+    return f.loadText();
+  } else {
+    return `module.exports = {
+  /**
+   * 初始化
+   */
+  async _init() {
+    this.log('debug', \`初始化！\`);
+  },
+  /**
+   * 销毁
+   */
+  async _destroy(...args) {
+    this.log('debug', \`销毁！\`);
+  },
+  /**
+   * 主要逻辑
+   */
+  async main(...args) {
+    // 主要代码写在这
+  }
+}`;
   }
 };
 
@@ -143,7 +193,7 @@ Item.prototype._remove = function (module) {
       $.mod.unload(module);
     } else {
       // 移除模块缓存
-      const filename = require.resolve(module);
+      let filename = require.resolve(module);
       if (require.cache[filename]) {
         require.cache[filename] = null;
         delete require.cache[filename];
@@ -161,9 +211,9 @@ Item.prototype._remove = function (module) {
 Item.prototype.unloadScript = function (file) {
   let target_file = file;
   if (!target_file) {
-    const func_file = this.config.func_file;
-    if (func_file) {
-      target_file = func_file.fullname(this.dir);
+    let main = this.config.main;
+    if (main) {
+      target_file = main.fullname(this.dir);
     }
   }
 
@@ -208,13 +258,13 @@ Item.prototype.unloadAfter = async function (remove) {
  * @returns {object | null} 返回加载的模块对象
  */
 Item.prototype.loadScript = function (file, name = '') {
-  const target_file = this._getScriptFile(file);
+  let target_file = this._getScriptFile(file);
   if (!target_file) return null;
 
-  const target_name = this._getScriptName(name);
+  let target_name = this._getScriptName(name);
 
   try {
-    const cs = this._loadScript(target_file, target_name);
+    let cs = this._loadScript(target_file, target_name);
     this._setMainMethod(cs, target_name);
     return cs;
   } catch (err) {
@@ -231,10 +281,10 @@ Item.prototype.loadScript = function (file, name = '') {
 Item.prototype._getScriptFile = function (file) {
   if (file) return file;
 
-  const func_file = this.config.func_file;
-  if (!func_file) return null;
+  let main = this.config.main;
+  if (!main) return null;
 
-  const target_file = func_file.fullname(this.dir);
+  let target_file = main.fullname(this.dir);
   if (!target_file.hasFile()) {
     this.newScript(target_file);
   }
@@ -286,8 +336,46 @@ Item.prototype._setMainMethod = function (module, name) {
  * @param {string} file 目标文件路径
  */
 Item.prototype.newConfig = function (file) {
-  const template_file = './config.tpl.json'.fullname(this.dir_base);
-  template_file.copyFile(file);
+  if (!this.config.name) {
+    this.config.name = file.dirname().basename();
+  }
+  this._createConfigFile(file, this.config, this.dir_base);
+};
+
+Item.prototype._createConfigFile = function (file, model = {}, tpl_dir = '') {
+  var tpl = this.getConfigTpl(tpl_dir);
+  var content = $.tpl.render(tpl, model);
+  file.saveText(content);
+  return file;
+};
+
+/**
+ * 获取配置模板
+ * @param {string} tpl_dir 模板文件路径
+ * @returns {string} 配置模板内容
+ */
+Item.prototype.getConfigTpl = function (tpl_dir = '') {
+  var f = './config.tpl.json'.fullname(tpl_dir || this.dir_base);
+  if (f.hasFile()) {
+    return f.loadText();
+  } else {
+    return `{
+  // 模块名称，必填
+  'name': '\${name}',
+  // 模块标题，可选，默认"示例标题"
+  'title': '\${title || "示例标题"}',
+  // 模块描述，可选，默认"示例描述"
+  'description': '\${description || "示例描述"}',
+  // 主脚本文件路径，可选，默认"./index.js"
+  'main': '\${main || "./index.js"}',
+  // 模块作用域，可选，默认"server"
+  'scope': '\${scope || "server"}',
+  // 模块状态，可选，默认1
+  'state': \${state || 1},
+  // 模块排序，可选，默认100
+  'sort': \${sort || 100}
+}`;
+  }
 };
 
 /**
@@ -298,7 +386,7 @@ Item.prototype.newConfig = function (file) {
  */
 Item.prototype.loadFile = function (file, name) {
   try {
-    const full_path = file.fullname(this.dir);
+    let full_path = file.fullname(this.dir);
     let text = full_path.loadText();
 
     // 如果文件不存在，创建新的配置文件
@@ -309,8 +397,8 @@ Item.prototype.loadFile = function (file, name) {
 
     if (!text) return null;
 
-    const config = this._loadHotReload(full_path);
-    const final_config = this._findConfigByName(config, name);
+    let config = this._loadHotReload(full_path);
+    let final_config = this._findConfigByName(config, name);
 
     // 更新目录和文件名引用
     this.dir = full_path.dirname();
@@ -378,8 +466,8 @@ Item.prototype._reloadIfNeeded = function () {
  * 删除目录
  */
 Item.prototype.delDir = function () {
-  const func_file = this.config.func_file;
-  if (func_file && $.dir && $.dir.del) {
+  let main = this.config.main;
+  if (main && $.dir && $.dir.del) {
     $.dir.del(this.dir);
   }
 };
@@ -389,8 +477,8 @@ Item.prototype.delDir = function () {
  * @returns {string | null} 错误消息，如果没有错误则返回null
  */
 Item.prototype.removeFile = function () {
-  const name = this.config.name;
-  const file = this.filename;
+  let name = this.config.name;
+  let file = this.filename;
 
   let error_message = null;
   try {
@@ -415,13 +503,13 @@ Item.prototype.removeFile = function () {
  * @returns {string | null} 错误消息
  */
 Item.prototype._removeConfigFile = function (file, name) {
-  const text = file.loadText();
+  let text = file.loadText();
   if (!text) {
     this.delDir();
     return null;
   }
 
-  const config = text.toJson();
+  let config = text.toJson();
   if (Array.isArray(config)) {
     return this._removeArrayItem(file, config, name);
   }
@@ -438,7 +526,7 @@ Item.prototype._removeConfigFile = function (file, name) {
  * @returns {string | null} 错误消息
  */
 Item.prototype._removeArrayItem = function (file, config, name) {
-  const index = config.findIndex((item) => item.name === name);
+  let index = config.findIndex((item) => item.name === name);
   if (index === -1) return null;
 
   this.delDir();
@@ -483,7 +571,7 @@ Item.prototype.loadConfig = async function (config_data, name) {
  */
 Item.prototype.loadBefore = async function () {
   try {
-    const module = this.loadScript();
+    let module = this.loadScript();
     if (module) {
       this.complete = true;
     }
@@ -515,15 +603,15 @@ Item.prototype.save = function () {
   try {
     if (!this.filename) return;
 
-    const full_path = this.filename.fullname(this.dir);
-    const text = full_path.loadText();
+    let full_path = this.filename.fullname(this.dir);
+    let text = full_path.loadText();
 
     if (text && text.trim().startsWith('[')) {
       // 数组格式配置
-      const config_array = text.toJson();
+      let config_array = text.toJson();
       if (Array.isArray(config_array)) {
         // 查找并更新现有配置项
-        const existing_index = config_array.findIndex((item) => item.name === this.config.name);
+        let existing_index = config_array.findIndex((item) => item.name === this.config.name);
         if (existing_index !== -1) {
           config_array[existing_index] = this.config;
         } else {
@@ -568,7 +656,7 @@ Item.prototype.run = async function (...params) {
  * @returns {Promise<any>} 执行结果
  */
 Item.prototype.exec = async function (method, ...params) {
-  const method_func = this._getMethod(method);
+  let method_func = this._getMethod(method);
   if (!method_func) return null;
 
   let result;
@@ -605,8 +693,8 @@ Item.prototype._getMethod = function (method) {
  * @returns {Promise<any>} 前置钩子结果
  */
 Item.prototype._execBefore = async function (method, params) {
-  const before_method = `${method}Before`;
-  const before_func = this._getMethod(before_method);
+  let before_method = `${method}Before`;
+  let before_func = this._getMethod(before_method);
 
   if (!before_func) return undefined;
 
@@ -630,8 +718,8 @@ Item.prototype._execBefore = async function (method, params) {
  * @returns {Promise<any>} 主方法结果
  */
 Item.prototype._execMain = async function (method_func, params, before_result) {
-  const method_result = method_func.call(this._mod || this, ...params);
-  const result = util.types.isPromise(method_result) ? await method_result : method_result;
+  let method_result = method_func.call(this._mod || this, ...params);
+  let result = util.types.isPromise(method_result) ? await method_result : method_result;
   return result;
 };
 
@@ -643,16 +731,16 @@ Item.prototype._execMain = async function (method_func, params, before_result) {
  * @returns {Promise<any>} 后置钩子结果
  */
 Item.prototype._execAfter = async function (method, params, main_result) {
-  const after_method = `${method}After`;
-  const after_func = this._getMethod(after_method);
+  let after_method = `${method}After`;
+  let after_func = this._getMethod(after_method);
 
   if (!after_func) return main_result;
 
   try {
-    const after_result = after_func.call(this._mod || this, main_result, ...params);
+    let after_result = after_func.call(this._mod || this, main_result, ...params);
 
     if (util.types.isPromise(after_result)) {
-      const resolved_result = await after_result;
+      let resolved_result = await after_result;
       return resolved_result !== undefined ? resolved_result : main_result;
     }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mm_machine",
-  "version": "2.1.6",
+  "version": "2.1.8",
   "description": "A flexible Node.js plugin mechanism system for dynamic loading, management and execution of modules. Supports hot reload, lifecycle management, and modern JavaScript features.",
   "main": "index.js",
   "scripts": {
@@ -32,6 +32,7 @@
   ],
   "dependencies": {
     "mm_config": "^2.2.3",
-    "mm_hot_reload": "^1.2.0"
+    "mm_hot_reload": "^1.2.0",
+    "mm_tpl": "^2.4.7"
   }
 }