mm_tpl 2.4.3 → 2.4.5

package/README.md

@@ -1,212 +1,218 @@
-# mm_tpl
-
-这是超级美眉模板帮助类模块，用于MVC模式下的视图渲染。基于art-template模板引擎，提供了更强大的模板渲染功能。
-
-## 安装
-
-```bash
-npm install mm_tpl
-```
-
-## 基本使用
-
-### 1. 初始化模板引擎
-
-```javascript
-const Tpl = require('mm_tpl');
-const tpl = new Tpl({
-    // 可选配置参数
-    root: process.cwd(),           // 根目录
-    default_dir: "./template/",    // 默认模板目录
-    default_theme: 'default',      // 默认主题
-    extname: ".html",             // 模板文件扩展名
-    cache_root: './cache',        // 缓存目录
-    cache_extname: '.cache.html'  // 缓存文件扩展名
-});
-```
-
-### 2. 基础模板渲染
-
-```javascript
-// 简单变量替换
-const result = tpl.render("<div>${message}</div>", {
-    message: "Hello World"
-});
-
-// 输出: <div>Hello World</div>
-```
-
-### 3. 循环渲染
-
-```javascript
-// 数组循环
-const arrayResult = tpl.render(`
-    <ul>
-        ${loop arr value idx}
-            <li>${idx}: ${value}</li>
-        ${/loop}
-    </ul>
-`, { 
-    arr: [123, 234] 
-});
-
-// 对象循环
-const objectResult = tpl.render(`
-    <dl>
-        ${loop obj value key}
-            <dt>${key}</dt>
-            <dd>${value}</dd>
-        ${/loop}
-    </dl>
-`, { 
-    obj: { name: "张三", age: 25 } 
-});
-
-// 传统for循环
-const forResult = tpl.render(`
-    <ul>
-        <!--[ for(var i = 0; i < arr.length; i++){ ]-->
-            <li>${arr[i]}</li>
-        <!--[ } ]-->
-    </ul>
-`, {
-    arr: [123, 234]
-});
-
-// each循环
-const eachResult = tpl.render(`
-    <ul>
-        ${each arr}
-            <li>${$value}</li>
-        ${/each}
-    </ul>
-`, {
-    arr: [123, 234]
-});
-```
-
-### 4. 视图渲染
-
-```javascript
-// 设置全局变量
-$.globalBag.siteName = "我的网站";
-
-// 设置视图变量
-tpl.viewBag.title = "首页";
-
-// 渲染视图文件
-const html = tpl.view("./views/index.html", {
-    user: { name: "张三" }
-});
-```
-
-### 5. 缓存机制
-
-```javascript
-// 使用缓存渲染视图
-const html = tpl.view("./views/page", {
-    data: someData
-}, {
-    cache: true,                // 是否使用缓存
-    cache_filename: "./cache"   // 缓存文件名
-});
-
-// 清除指定目录的缓存
-tpl.clear_cache('./views/mall');
-```
-
-### 6. 钩子系统
-
-#### 添加函数钩子
-```javascript
-$.hook.addFunc('list', async function(viewBag, req, type) {
-    // 处理列表逻辑
-    var query = req.query;
-    if (query.user_id) {
-        viewBag.user_id = query.user_id;
-    }
-    return someData;
-});
-```
-
-#### 添加动作钩子
-```javascript
-$.hook.addAction('header', function(viewBag, param) {
-    return "<header>网站头部</header>";
-}, 1, "headerAction");
-```
-
-#### 添加过滤器钩子
-```javascript
-$.hook.addFilter('content', function(viewBag, content, param) {
-    return content.replace("旧文本", "新文本");
-}, 1, "contentFilter");
-```
-
-#### 在模板中使用钩子
-```javascript
-// 运行函数钩子
-await tpl.runFunc('list', {
-    query: { page: 1 }
-}, 'article');
-
-// 在模板中使用动作钩子
-${hook_action('header')}
-
-// 在模板中使用过滤器钩子
-${hook_filter('content', '原始内容')}
-```
-
-## 高级特性
-
-### 1. 主题支持
-```javascript
-// 设置当前主题
-tpl.current_theme = "dark";
-```
-
-### 2. 模板规则
-模块内置支持多种模板规则，包括：
-- nativeRule: 原生语法规则
-- artRule: art-template语法规则
-- htmlRule: HTML注释语法规则
-- jsRule: JavaScript语法规则
-- pyRule: Python风格语法规则
-
-### 3. 错误处理
-```javascript
-const html = tpl.view("./template.html", data);
-if (tpl.error) {
-    console.error("渲染错误:", tpl.error);
-}
-```
-
-### 4. 视图背包操作
-```javascript
-// 设置视图变量
-tpl.set({
-    title: "页面标题",
-    keywords: "关键词"
-});
-
-// 获取视图变量
-const title = tpl.get("title");
-
-// 删除视图变量
-tpl.del("title");
-// 或批量删除
-tpl.del(["title", "keywords"]);
-```
-
-## 注意事项
-
-1. 确保模板目录具有正确的读写权限
-2. 使用缓存时注意及时清理过期缓存
-3. 钩子的优先级数值越小，执行顺序越靠前
-4. 建议在生产环境开启模板缓存以提高性能
-5. 模板文件查找顺序：diy > current_theme > default_theme
-6. 使用钩子系统时注意处理异步操作
-
-## 许可证
-
+# mm_tpl
+
+这是超级美眉模板帮助类模块，用于MVC模式下的视图渲染。基于art-template模板引擎，提供了更强大的模板渲染功能。
+
+## 安装
+
+```bash
+npm install mm_tpl
+```
+
+## 基本使用
+
+### 1. 初始化模板引擎
+
+```javascript
+const {Tpl} = require('mm_tpl');
+const tpl = new Tpl({
+    // 可选配置参数
+    root: process.cwd(),           // 根目录
+    default_dir: "./template/",    // 默认模板目录
+    default_theme: 'default',      // 默认主题
+    extname: ".html",             // 模板文件扩展名
+    cache_root: './cache',        // 缓存目录
+    cache_extname: '.cache.html'  // 缓存文件扩展名
+});
+```
+
+### 2. 基础模板渲染
+
+```javascript
+// 简单变量替换
+const result = tpl.render("<div>${message}</div>", {
+    message: "Hello World"
+});
+
+// 输出: <div>Hello World</div>
+```
+
+### 3. 循环渲染
+
+```javascript
+// 数组循环
+const arrayResult = tpl.render(`
+    <ul>
+        ${loop arr value idx}
+            <li>${idx}: ${value}</li>
+        ${/loop}
+    </ul>
+`, { 
+    arr: [123, 234] 
+});
+
+// 对象循环
+const objectResult = tpl.render(`
+    <dl>
+        ${loop obj value key}
+            <dt>${key}</dt>
+            <dd>${value}</dd>
+        ${/loop}
+    </dl>
+`, { 
+    obj: { name: "张三", age: 25 } 
+});
+
+// 传统for循环
+const forResult = tpl.render(`
+    <ul>
+        <!--[ for(var i = 0; i < arr.length; i++){ ]-->
+            <li>${arr[i]}</li>
+        <!--[ } ]-->
+    </ul>
+`, {
+    arr: [123, 234]
+});
+
+// each循环
+const eachResult = tpl.render(`
+    <ul>
+        ${each arr}
+            <li>${$value}</li>
+        ${/each}
+    </ul>
+`, {
+    arr: [123, 234]
+});
+// 输出: 
+// <ul>
+//     <li>123</li>
+//     <li>234</li>
+// </ul>
+```
+
+### 4. 视图渲染
+
+```javascript
+// 设置全局变量
+$.globalBag.siteName = "我的网站";
+
+// 设置视图变量
+tpl.viewBag.title = "首页";
+
+// 渲染视图文件
+const html = tpl.view("./views/index.html", {
+    user: { name: "张三" }
+});
+// 输出: 渲染结果 <div>Hello World</div>
+```
+
+### 5. 缓存机制
+
+```javascript
+// 使用缓存渲染视图
+const html = tpl.view("./views/page", {
+    data: someData
+}, {
+    cache: true,                // 是否使用缓存
+    cache_filename: "./cache"   // 缓存文件名
+});
+
+// 清除指定目录的缓存
+tpl.clear_cache('./views/mall');
+```
+
+### 6. 钩子系统
+
+#### 添加函数钩子
+```javascript
+$.hook.addFunc('list', async function(viewBag, req, type) {
+    // 处理列表逻辑
+    var query = req.query;
+    if (query.user_id) {
+        viewBag.user_id = query.user_id;
+    }
+    return someData;
+});
+```
+
+#### 添加动作钩子
+```javascript
+$.hook.addAction('header', function(viewBag, param) {
+    return "<header>网站头部</header>";
+}, 1, "headerAction");
+```
+
+#### 添加过滤器钩子
+```javascript
+$.hook.addFilter('content', function(viewBag, content, param) {
+    return content.replace("旧文本", "新文本");
+}, 1, "contentFilter");
+```
+
+#### 在模板中使用钩子
+```javascript
+// 运行函数钩子
+await tpl.runFunc('list', {
+    query: { page: 1 }
+}, 'article');
+
+// 在模板中使用动作钩子
+${hook_action('header')}
+
+// 在模板中使用过滤器钩子
+${hook_filter('content', '原始内容')}
+```
+
+## 高级特性
+
+### 1. 主题支持
+```javascript
+// 设置当前主题
+tpl.current_theme = "dark";
+```
+
+### 2. 模板规则
+模块内置支持多种模板规则，包括：
+- nativeRule: 原生语法规则
+- artRule: art-template语法规则
+- htmlRule: HTML注释语法规则
+- jsRule: JavaScript语法规则
+- pyRule: Python风格语法规则
+
+### 3. 错误处理
+```javascript
+const html = tpl.view("./template.html", data);
+if (tpl.error) {
+    $.log.error("渲染错误:", tpl.error);
+}
+```
+
+### 4. 视图背包操作
+```javascript
+// 设置视图变量
+tpl.set({
+    title: "页面标题",
+    keywords: "关键词"
+});
+
+// 获取视图变量
+const title = tpl.get("title");
+
+// 删除视图变量
+tpl.del("title");
+// 或批量删除
+tpl.del(["title", "keywords"]);
+```
+
+## 注意事项
+
+1. 确保模板目录具有正确的读写权限
+2. 使用缓存时注意及时清理过期缓存
+3. 钩子的优先级数值越小，执行顺序越靠前
+4. 建议在生产环境开启模板缓存以提高性能
+5. 模板文件查找顺序：diy > current_theme > default_theme
+6. 使用钩子系统时注意处理异步操作
+
+## 许可证
+
 MIT

package/cache/test.cache.html

@@ -6,8 +6,8 @@
 	</head>
 	<body>
 		<h5>系统名称</h5>
-		<p>您真的是人才！</p>
-		<p>您真的是人才！</p>
+		<p>你真的是人才！</p>
+		<p>你真的是人才！</p>
 		<ul>
 			<li>\·$·{· value }</li>
 			<li>\·$·{· value }</li>
@@ -17,9 +17,10 @@
 			<li>234</li>
 		</ul>
 		<ul>
-			<li>\·$·{· value }</li>
-			<li>\·$·{· value }</li>
+			<li>123</li>
+			<li>234</li>
 		</ul>
+		<strong>hello world！</strong>
 		<script type="text/javascript">
 			var a_0 =123;
 			var a_1 =234;