@zenweb/template 4.1.0 → 5.0.0

package/README.md

@@ -1,33 +1,23 @@
-# zenweb-template
+# template - 服务端模版渲染
 
-zenweb template render module
+## 功能说明
 
-## Install
+在服务器端使用模版引擎渲染模版并根据请求条件按需输出
 
-```bash
-yarn add @zenweb/template
-```
-
-### nunjucks
-
-```bash
-yarn add @zenweb/template-nunjucks
-```
+## 演示
 
-### handlebars
+### 安装
 
 ```bash
-yarn add @zenweb/template-handlebars
+yarn add @zenweb/template @zenweb/template-nunjucks
 ```
 
-## App Config
+### 配置
 
-src/index.ts
 ```ts
 import { create } from 'zenweb';
 import modTemplate from '@zenweb/template';
 import nunjucks from '@zenweb/template-nunjucks';
-import handlebars from '@zenweb/template-handlebars';
 
 create()
 
@@ -39,55 +29,59 @@ create()
   }),
 }))
 
-// Multiple Engines
-.setup(modTemplate({
-  type: 'xml',
-  matchPath: [/\.xml$/i],
-  templateAffix: '.xml',
-  engineName: 'xml',
-  engine: handlebars(),
-}))
-
 .start();
 ```
 
-## Use
+控制器使用
 
-src/controller/demo.ts
 ```ts
-import { Context, mapping } from "zenweb";
+import { Context, mapping, Body, $body } from 'zenweb';
 
-export class DemoController {
-  @mapping({ path: ['/', '/index.html'] })
-  index(ctx: Context) {
-    ctx.template('index.html');
-    return { name: 'Hello' };
+export class Controller {
+  @mapping({ path: '/', method: 'POST' })
+  post(body: Body) {
+    console.log(body.type); // POST body 内容类型
+    console.log(body.data); // POST Body 内容解析完成后的数据
   }
 
-  @mapping({ path: '/test.html' })
-  test() {
-    return { name: 'Test' };
+  @mapping({ path: '/', method: 'POST' })
+  async post() {
+    console.log(await getAge()); // 类型转换&校验
   }
+}
 
-  @mapping()
-  xml(ctx: Context) {
-    ctx.template({ engine: 'xml' })
-    return { name: 'Test' };
-  }
+async function getAge() {
+  return (await $body.get({ age: '!int' })).age;
 }
 ```
 
+模版代码
+
 template/index.html
 ```html
 <h1>Hello {{name}}</h1>
 ```
 
-template/test.html
-```html
-<h1>Hello {{name}}</h1>
-```
+## 依赖模块
 
-template/xml.xml
-```xml
-<root>{{name}}</root>
-```
+- @zenweb/result
+
+## Core 挂载项
+
+无
+
+## Context 挂载项
+
+- `templateOption`
+- `template(option)` 设置当前请求的模版渲染选项
+
+## 全局模式
+
+| 方法 | 功能 |
+| ----- | ---- |
+| $template() | 设置当前请求的模版渲染选项 |
+
+## 目前已支持的模版引擎
+
+[nunjucks](https://www.npmjs.com/package/@zenweb/template-nunjucks)
+[handlebars](https://www.npmjs.com/package/@zenweb/template-handlebars)

package/dist/global.d.ts

@@ -0,0 +1,9 @@
+import { TemplateOption } from "./types";
+/**
+ * 启用并设置模版渲染
+ * - 不传参数: 启用
+ * - false: 关闭模版渲染
+ * - string: 设置模版文件名
+ * - TemplateOption: 详细设置
+ */
+export declare function $template(template_or_option?: false | string | TemplateOption): void;

package/dist/global.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.$template = void 0;
+const core_1 = require("@zenweb/core");
+/**
+ * 启用并设置模版渲染
+ * - 不传参数: 启用
+ * - false: 关闭模版渲染
+ * - string: 设置模版文件名
+ * - TemplateOption: 详细设置
+ */
+function $template(template_or_option) {
+    return (0, core_1.$getContext)().template(template_or_option);
+}
+exports.$template = $template;

package/dist/index.d.ts

@@ -1,6 +1,7 @@
 import { SetupFunction } from '@zenweb/core';
 import { TemplateSetupOption, TemplateOption } from './types';
 export * from './types';
+export * from './global';
 export default function setup(option: TemplateSetupOption): SetupFunction;
 declare module '@zenweb/core' {
     interface Context {

package/dist/index.js

@@ -17,6 +17,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const result_1 = require("@zenweb/result");
 const render_1 = require("./render");
 __exportStar(require("./types"), exports);
+__exportStar(require("./global"), exports);
 function contextTemplate(template_or_option) {
     if (template_or_option === false) {
         this.templateOption = undefined;

package/dist/utils.d.ts

@@ -1,3 +1,2 @@
-import { Debugger } from '@zenweb/core';
-export declare const debug: Debugger;
+export declare const debug: import("@zenweb/core").Debugger;
 export declare function cwdPath(p: string): string;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@zenweb/template",
   "packageManager": "yarn@4.0.2",
-  "version": "4.1.0",
+  "version": "5.0.0",
   "description": "zenweb template render module",
   "exports": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -27,17 +27,17 @@
   "homepage": "https://zenweb.node.ltd",
   "devDependencies": {
     "@types/node": "^20.10.6",
-    "@zenweb/inject": "^4.1.1",
+    "@zenweb/inject": "^5.0.1",
     "@zenweb/template-handlebars": "^3.0.0",
     "@zenweb/template-nunjucks": "^3.3.0",
     "cross-env": "^7.0.3",
     "rimraf": "^4.4.1",
     "ts-node": "^10.9.1",
     "typescript": "~5.3.3",
-    "zenweb": "^4.5.0"
+    "zenweb": "^5.0.0"
   },
   "dependencies": {
-    "@zenweb/core": "^4.3.2",
-    "@zenweb/result": "^4.0.0"
+    "@zenweb/core": "^5.0.0",
+    "@zenweb/result": "^4.1.3"
   }
 }