mm_machine 2.1.1 → 2.1.3

package/methods_documentation.md

@@ -3,18 +3,21 @@
 ## 1. index.js - Index类方法
 
 ### 构造函数
+
 - **constructor(scope, dir_base)** - 初始化Index类实例
   - `scope`: 作用域（同时作为检索的后缀名）
   - `dir_base`: 模块目录
 
 ### 私有方法
-- **_execute(module, method, params)** - 执行模块方法
+
+- **\_execute(module, method, params)** - 执行模块方法
   - `module`: 模块对象
   - `method`: 方法名称
   - `params`: 参数数组
   - 返回: Promise<any> - 执行结果
 
 ### 公共方法
+
 - **clear()** - 清除接口缓存
 - **load(dir, cg, file)** - 加载项
   - `dir`: 文件路径
@@ -94,20 +97,24 @@
   - 返回: Promise<any> - 执行结果
 
 ### 属性
+
 - **Drive** - 默认驱动类，指向Item类
 
 ## 2. item.js - Item类方法
 
 ### 构造函数
+
 - **constructor(dir, dir_base)** - 初始化Item类实例
   - `dir`: 当前目录
   - `dir_base`: 模块目录
 
 ### 私有方法
-- **_remove(module)** - 移除模块
+
+- **\_remove(module)** - 移除模块
   - `module`: 模块对象或路径
 
 ### 公共方法
+
 - **setConfig(config)** - 设置配置
   - `config`: 配置对象
 - **setConfig_after()** - 设置配置后钩子方法
@@ -165,6 +172,7 @@
 ## 方法命名规范检查
 
 ### 符合规范的方法名（小驼峰）
+
 - clear
 - load
 - loads
@@ -195,6 +203,7 @@
 - main
 
 ### 符合规范的时态方法名
+
 - update_before
 - update_after
 - setConfig_after
@@ -202,13 +211,15 @@
 - load_before
 
 ### 需要注意的方法名
+
 - **updateScript** - 已从update_script修改为符合小驼峰命名规范
-- **update_main** - 保持不变，因为_main属于时态方法命名格式（main表示主逻辑）
+- **update_main** - 保持不变，因为\_main属于时态方法命名格式（main表示主逻辑）
 
 ## 重复方法名
 
 在index.js中发现两个同名的load方法：
+
 1. `load(dir, cg, file)` - 加载项
 2. `load(name)` - 加载插件
 
-建议重命名其中一个以避免混淆。
+建议重命名其中一个以避免混淆。

package/nodemon.json

@@ -1,26 +1,25 @@
-{
-	"restartable": "rs",
-	"ignore": [
-		".git",
-		".svn",
-		"node_modules/**/node_modules",
-		"static/src/*",
-		"static/js/*",
-		"static/**/js",
-		"static/*.js",
-		"*data.json",
-		"*cache.json"
-	],
-	"verbose": true,
-	"execMap": {
-		"": "node",
-		"js": "node --harmony"
-	},
-	"watch": [
-	],
-	"env": {
-		"NODE_ENV": "development"
-	},
-	"ext": "js json",
-	"legacy-watch": false
-}
+{
+  "restartable": "rs",
+  "ignore": [
+    ".git",
+    ".svn",
+    "node_modules/**/node_modules",
+    "static/src/*",
+    "static/js/*",
+    "static/**/js",
+    "static/*.js",
+    "*data.json",
+    "*cache.json"
+  ],
+  "verbose": true,
+  "execMap": {
+    "": "node",
+    "js": "node --harmony"
+  },
+  "watch": [],
+  "env": {
+    "NODE_ENV": "development"
+  },
+  "ext": "js json",
+  "legacy-watch": false
+}

package/package.json

@@ -1,39 +1,49 @@
-{
-	"name": "mm_machine",
-	"version": "2.1.1",
-	"description": "这是超级美眉框架机制构建辅助模块，用于快速构建一个机制，支持动态加载、热更新、模块管理等功能，并具有增强的错误处理和现代JavaScript特性支持。",
-	"main": "index.js",
-	"scripts": {
-		"test": "node ./test.js",
-		"dev": "nodemon ./test.js"
-	},
-	"repository": {
-		"type": "git",
-		"url": "git+https://gitee.com/qiuwenwu91/mm_machine.git"
-	},
-	"keywords": [
-		"common",
-		"com",
-		"run",
-		"cmd",
-		"load",
-		"save",
-		"get",
-		"set",
-		"add",
-		"del",
-		"hot-reload",
-		"module-management",
-		"modern-js"
-	],
-	"author": "邱文武",
-	"license": "ISC",
-	"bugs": {
-		"url": "https://gitee.com/qiuwenwu91/mm_machine/issues"
-	},
-	"homepage": "https://gitee.com/qiuwenwu91/mm_machine#readme",
-	"dependencies": {
-		"mm_config": "^2.1.3",
-		"mm_hot_reload": "^1.1.3"
-	}
-}
+{
+  "name": "mm_machine",
+  "version": "2.1.3",
+  "description": "这是超级美眉框架机制构建辅助模块，用于快速构建一个机制，支持动态加载、热更新、模块管理等功能，并具有增强的错误处理和现代JavaScript特性支持。",
+  "main": "index.js",
+  "scripts": {
+    "test": "node ./test.js",
+    "dev": "nodemon ./test.js",
+    "lint": "eslint .",
+    "lint:fix": "eslint . --fix",
+    "format": "prettier --write .",
+    "format:check": "prettier --check ."
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://gitee.com/qiuwenwu91/mm_machine.git"
+  },
+  "keywords": [
+    "common",
+    "com",
+    "run",
+    "cmd",
+    "load",
+    "save",
+    "get",
+    "set",
+    "add",
+    "del",
+    "hot-reload",
+    "module-management",
+    "modern-js"
+  ],
+  "author": "邱文武",
+  "license": "ISC",
+  "bugs": {
+    "url": "https://gitee.com/qiuwenwu91/mm_machine/issues"
+  },
+  "homepage": "https://gitee.com/qiuwenwu91/mm_machine#readme",
+  "dependencies": {
+    "mm_config": "^2.1.9",
+    "mm_hot_reload": "^1.1.4"
+  },
+  "devDependencies": {
+    "eslint": "^9.39.2",
+    "eslint-plugin-jsdoc": "^61.5.0",
+    "mm_eslint": "^1.4.0",
+    "prettier": "^3.7.4"
+  }
+}

package/test

@@ -0,0 +1,3 @@
+{
+    "a": 1
+}

package/test.js

@@ -1,30 +1,27 @@
-var {
-	Item,
-	Index
-} = require('./index.js');
+var { Item, Index } = require('./index.js');
 
 class Drive extends Item {
-	constructor(dir, dir_base) {
-		super(dir, dir_base);
-		this.default_file = "./demo.json";
-	}
+  constructor(dir, dir_base) {
+    super(dir, dir_base);
+    this.default_file = './demo.json';
+  }
 }
 
 class Engine extends Index {
-	constructor(scope, dir_base) {
-		super(scope, dir_base);
-		/**
-		 * 模式 
-		 * 1.生产模式，改变文件不会重新加载
-		 * 2.热更新模式，改变配置文件会重新加载配置，不重新加载脚本
-		 * 3.热重载模式，改变配置文件都会加载配置和脚本
-		 * 4.热更新+重载模式，改变配置文件重新加载配置和脚本，执行完后重新加载脚本
-		 * 5.重载模式，执行完后重新加载脚本，避免变量污染
-		 */
-		this.mode = 3;
-		// 机制类型，必须填写，用于检索文件
-		this.type = "demo";
-	}
+  constructor(scope, dir_base) {
+    super(scope, dir_base);
+    /**
+     * 模式
+     * 1.生产模式，改变文件不会重新加载
+     * 2.热更新模式，改变配置文件会重新加载配置，不重新加载脚本
+     * 3.热重载模式，改变配置文件都会加载配置和脚本
+     * 4.热更新+重载模式，改变配置文件重新加载配置和脚本，执行完后重新加载脚本
+     * 5.重载模式，执行完后重新加载脚本，避免变量污染
+     */
+    this.mode = 3;
+    // 机制类型，必须填写，用于检索文件
+    this.type = 'demo';
+  }
 }
 
 /**
@@ -33,102 +30,122 @@ class Engine extends Index {
  */
 Engine.prototype.Drive = Drive;
 
-async function demo() {
-	var engine = new Engine('sys', __dirname);
-	console.info("→ 加载mod");
-	await engine.update("./app/".fullname(__dirname));
+async function initEngine() {
+  var engine = new Engine('sys', __dirname);
+  console.info('→ 加载mod');
+  await engine.update('./app/'.fullname(__dirname));
+  console.log('模块数', engine.list.length);
+  return engine;
+}
 
-	console.log("模块数", engine.list.length);
-	// console.log("模块", engine.list);
+async function runBasicTests(engine) {
+  await engine.run('test1', 'init');
+  await engine.exec('test1', 'init');
+  await engine.run(null, 'main');
+  await engine.exec(null, 'main');
 
-	await engine.run('test1', 'init'); // 只有启动状态的插件才会执行
-	await engine.exec('test1', 'init'); // 未启动也会执行，并且如果未加载脚本则会自动加载
-	await engine.run(null, 'main');
-	await engine.exec(null, 'main');
+  var ret = await engine.run('test2', 'main');
+  console.log('指明回调test2', ret);
+
+  var ret = await engine.exec('test1', 'main');
+  console.log('指明回调test1', ret);
+}
 
-	var ret = await engine.run('test2', 'main');
-	console.log("指明回调test2", ret);
+function setupMainTimer(engine) {
+  var i = 0;
+  var timer = setInterval(async () => {
+    await engine.run('test1', 'main');
+    await engine.run('test2', 'main');
+    i++;
+    if (i == 3) {
+      console.info('→ 重载mod');
+      await engine.reload('test1');
+    } else if (i == 5) {
+      console.info('→ 卸载mod');
+      await engine.unload('test2');
+    } else if (i == 16) {
+      console.info('→ 卸载并删除mod');
+      await engine.unload('test1', true);
+    } else if (i == 18) {
+      clearTimeout(timer);
+    }
+  }, 3000);
+  return timer;
+}
 
-	var ret = await engine.exec('test1', 'main');
-	console.log("指明回调test1", ret);
+function setupFileMods(engine) {
+  setTimeout(async () => {
+    var file = './app/test1/index.js'.fullname(__dirname);
+    if (file.hasFile()) {
+      var text = file.loadText();
+      text = text.replace('counter = 0', 'counter = 100');
+      file.saveText(text);
+      var ret = await engine.exec('test1', 'main');
+      console.log('这结果', ret);
+    }
+  }, 7000);
 
-	var i = 0;
-	var timer = setInterval(async () => {
-		await engine.run('test1', 'main');
-		await engine.run('test2', 'main');
-		i++;
-		if (i == 3) {
-			console.info("→ 重载mod");
-			await engine.reload("test1");
-		} else if (i == 5) {
-			console.info("→ 卸载mod");
-			await engine.unload("test2");
-		} else if (i == 16) {
-			console.info("→ 卸载并删除mod");
-			await engine.unload("test1", true);
-		} else if (i == 18) {
-			clearTimeout(timer);
-		}
-	}, 3000);
+  setTimeout(() => {
+    var file = './demo/test2/index.js'.fullname(__dirname);
+    if (file.hasFile()) {
+      var text = file.loadText();
+      text = text.replace('123', '7654321');
+      file.saveText(text);
+    }
+  }, 11000);
 
-	setTimeout(async() => {
-		var file = "./app/test1/index.js";
-		var text = file.loadText();
-		text = text.replace("counter = 0", "counter = 100");
-		file.saveText(text);
-		var ret = await engine.exec("test1", 'main');
-		console.log("这结果", ret);
-	}, 7000)
+  setTimeout(async () => {
+    console.info('→ 热重载失效');
+    $.mod.config.watch = false;
+    var file = './app/test1/index.js'.fullname(__dirname);
+    if (file.hasFile()) {
+      var text = file.loadText();
+      text = text.replace('counter = 100', 'counter = 200');
+      file.saveText(text);
+      var ret = await engine.exec('test1', 'main');
+      console.log('这结果', ret);
+    }
+  }, 16000);
+}
 
-	setTimeout(() => {
-		var file = "./demo/test2/index.js";
-		var text = file.loadText();
-		text = text.replace("123", "7654321");
-		file.saveText(text);
-	}, 11000)
+function setupFinalTimer(engine) {
+  var n = 0;
+  var timer_2 = setInterval(async () => {
+    var ret = await engine.exec('test1', 'main');
+    console.info('最后运行test1', ret);
+    var plug = engine.get('test1');
+    if (plug) {
+      console.log('查看变化1', plug.config);
+    }
+    var plug = engine.get('test2');
+    if (plug) {
+      var ret = await plug.run();
+      console.log('查看变化2', plug.config);
+    }
+    n++;
+    if (n == 6) {
+      clearInterval(timer_2);
+      process.exit(0);
+    }
+  }, 10000);
+  return timer_2;
+}
 
-	setTimeout(async () => {
-		// 让热重载失效
-		console.info("→ 热重载失效");
-		$.mod.config.watch = false;
-		// 失效后再加载的模块修改文件没有变化
-		var file = "./app/test1/index.js";
-		var text = file.loadText();
-		text = text.replace("counter = 100", "counter = 200");
-		file.saveText(text);
-		var ret = await engine.exec("test1", 'main');
-		console.log("这结果", ret);
-	}, 16000)
-	
-	var n = 0;
-	var timer_2 = setInterval(async () => {
-		// await engine.update(null, false, false, false);
-		var ret = await engine.exec('test1', 'main');
-		console.info("最后运行test1", ret);
-		var plug = engine.get("test1");
-		if (plug) {
-			console.log("查看变化1", plug.config);
-		}
-		var plug = engine.get("test2");
-		if (plug) {
-			var ret = await plug.run();
-			console.log("查看变化2", plug.config);
-		}
-		n++;
-		if (n == 6) {
-			clearInterval(timer_2);
-			process.exit(0);
-		}
-	}, 10000);
+async function demo() {
+  var engine = await initEngine();
+  await runBasicTests(engine);
+  setupMainTimer(engine);
+  setupFileMods(engine);
+  setupFinalTimer(engine);
 }
 
 /* 调用示例 */
 async function test() {
-	'./demo2'.fullname(__dirname).copyDir('./demo'.fullname(__dirname), () => {
-		setTimeout(() => {
-			demo();
-		}, 1000)
-	});
+  './demo2'.fullname(__dirname).copyDir('./demo'.fullname(__dirname), () => {
+    setTimeout(() => {
+      demo();
+    }, 1000);
+  });
 }
 
-test();
+test();

package/test.json

@@ -0,0 +1,9 @@
+{
+    "name": "test1",
+    "sort": 10,
+    "state": 1,
+    "show": 1,
+    "SORT": 10,
+    "STATE": 1,
+    "SHOW": 0
+}