@zenweb/template 3.0.3 → 3.2.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## [3.2.0] - 2023-4-3
+- 不再集成内置引擎，使用独立包
+
+## [3.1.0] - 2023-4-2
+- 完成 failTemplate 功能
+
 ## [3.0.3] - 2023-4-2
 - 清除遗留的 console.log
 

package/README.md

@@ -5,20 +5,19 @@ zenweb template render module
 ## Install
 
 ```bash
-npm install @zenweb/template
+yarn add @zenweb/template
 ```
 
 ### nunjucks
 
 ```bash
-npm install nunjucks
-npm install @types/nunjucks --save-dev
+yarn add @zenweb/template-nunjucks
 ```
 
 ### handlebars
 
 ```bash
-npm install handlebars
+yarn add @zenweb/template-handlebars
 ```
 
 ## App Config
@@ -27,36 +26,29 @@ 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';
+import nunjucks from '@zenweb/template-nunjucks';
+import handlebars from '@zenweb/template-handlebars';
 
-const app = create();
+create()
 
-app.setup(modTemplate({
+.setup(modTemplate({
   matchPath: [/\.html$/i],
   engine: nunjucks({
     filter: require('./template/filter'),
     global: require('./template/global'),
   }),
-}));
+}))
 
 // Multiple Engines
-app.setup(modTemplate({
+.setup(modTemplate({
   type: 'xml',
   matchPath: [/\.xml$/i],
   templateAffix: '.xml',
   engineName: 'xml',
   engine: handlebars(),
-}));
+}))
 
-app.start();
-```
-
-tsconfig.json
-```json
-"compilerOptions": {
-  "moduleResolution": "node16",
-}
+.start();
 ```
 
 ## Use

package/dist/render.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.TemplateRender = exports.TEMPLATE_OPTION = void 0;
+const result_1 = require("@zenweb/result");
 const utils_1 = require("./utils");
 exports.TEMPLATE_OPTION = Symbol('template@option');
 class TemplateRender {
@@ -35,8 +36,14 @@ class TemplateRender {
         return false;
     }
     render(ctx, data) {
-        const opt = ctx[exports.TEMPLATE_OPTION];
-        let template = opt === null || opt === void 0 ? void 0 : opt.template;
+        const opt = ctx[exports.TEMPLATE_OPTION] || {};
+        let template = opt.template;
+        if (data instanceof result_1.ResultFail) {
+            data = { fail: data };
+            if (opt.failTemplate !== false) {
+                template = opt.failTemplate || this._option.failTemplate;
+            }
+        }
         if (!template) {
             template = ctx.path.slice(1);
             if (this._option.templateAffix) {

package/dist/types.d.ts

@@ -24,7 +24,10 @@ export interface TemplateSetupOption {
      */
     templateAffix?: string;
     /**
-     * 失败使用模版
+     * 使用 `ctx.fail` 操作所使用的模版 - 全局
+     * - 不指定则使用 `TemplateOption.template` 值
+     * - 指定后可以在控制器中设置 `TemplateOption.failTemplate = false` 关闭全局 `failTemplate`
+     * @default undefined
      */
     failTemplate?: string;
     /**
@@ -42,6 +45,12 @@ export interface TemplateOption {
      * 指定模版名，不指定取 `ctx.path`
      */
     template?: string;
+    /**
+     * 使用 `ctx.fail` 操作所使用的模版
+     * - 默认使用全局配置的 `failTemplate`
+     * - 如果设置为 `false` 则强制使用 `template`
+     */
+    failTemplate?: string | false;
     /**
      * 使用的渲染引擎
      * - 对应的是 `TemplateSetupOption.engineName`

package/package.json

@@ -1,18 +1,8 @@
 {
   "name": "@zenweb/template",
-  "version": "3.0.3",
+  "version": "3.2.0",
   "description": "zenweb template render module",
-  "exports": {
-    ".": "./dist/index.js",
-    "./handlebars": {
-      "require": "./dist/engine/handlebars.js",
-      "types": "./dist/engine/handlebars.d.ts"
-    },
-    "./nunjucks": {
-      "require": "./dist/engine/nunjucks.js",
-      "types": "./dist/engine/nunjucks.d.ts"
-    }
-  },
+  "exports": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "scripts": {
     "build": "rimraf dist && tsc",
@@ -29,16 +19,14 @@
   "keywords": [
     "zenweb",
     "koa",
-    "template",
-    "nunjucks"
+    "template"
   ],
   "license": "MIT",
   "homepage": "https://zenweb.node.ltd",
   "devDependencies": {
-    "@types/nunjucks": "^3.2.1",
+    "@zenweb/template-handlebars": "^3.0.0",
+    "@zenweb/template-nunjucks": "^3.0.0",
     "cross-env": "^7.0.3",
-    "handlebars": "^4.7.7",
-    "nunjucks": "^3.2.3",
     "rimraf": "^4.4.1",
     "ts-node": "^10.9.1",
     "typescript": "^5.0.2",

package/dist/engine/handlebars.d.ts

@@ -1,15 +0,0 @@
-/// <reference types="handlebars" />
-import { TemplateEngine } from '../types';
-export interface HandlebarsOption extends CompileOptions {
-    /**
-     * 模版文件夹
-     * @default './template'
-     */
-    path?: string | string[];
-    /**
-     * 缓存已编译模版
-     * @default true
-     */
-    cache?: boolean;
-}
-export default function (option?: HandlebarsOption): TemplateEngine;

package/dist/engine/handlebars.js

@@ -1,36 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-/// <reference types="handlebars" />
-const path = require("path");
-const fs = require("fs");
-const util_1 = require("util");
-const handlebars_1 = require("handlebars");
-const utils_1 = require("../utils");
-const fs_exists = (0, util_1.promisify)(fs.exists);
-const fs_readFile = (0, util_1.promisify)(fs.readFile);
-function default_1(option) {
-    const opt = Object.assign({
-        path: './template',
-        cache: true,
-    }, option);
-    (0, utils_1.debug)('option: %o', opt);
-    const paths = (Array.isArray(opt.path) ? opt.path : [opt.path]).map(p => (0, utils_1.cwdPath)(p));
-    async function loadTemplate(template) {
-        for (const p of paths) {
-            const filename = path.join(p, template);
-            if (await fs_exists(filename)) {
-                return await fs_readFile(filename, 'utf-8');
-            }
-        }
-        throw new Error(`Template file not found: ${template}`);
-    }
-    const cache = {};
-    return async function handlebars(template, data) {
-        if (opt.cache && !cache[template]) {
-            const content = await loadTemplate(template);
-            cache[template] = (0, handlebars_1.compile)(content, opt);
-        }
-        return cache[template](data);
-    };
-}
-exports.default = default_1;

package/dist/engine/nunjucks.d.ts

@@ -1,36 +0,0 @@
-import { Environment, ConfigureOptions, Extension } from 'nunjucks';
-import { TemplateEngine } from '../types';
-export interface NunjucksOption {
-    /**
-     * 模版文件夹
-     * @default './template'
-     */
-    path?: string | string[];
-    /**
-     * 配置过滤器
-     */
-    filter?: {
-        [name: string]: (...args: any[]) => any;
-    };
-    /**
-     * 配置自定义扩展
-     */
-    extension?: {
-        [name: string]: Extension;
-    };
-    /**
-     * 配置全局变量
-     */
-    global?: {
-        [name: string]: any;
-    };
-    /**
-     * 设置 nunjucks 配置
-     */
-    nunjucksConfig?: ConfigureOptions;
-    /**
-     * 设置 nunjucks 环境变量
-     */
-    configureEnvironment?: (env: Environment) => any;
-}
-export default function (option?: NunjucksOption): TemplateEngine;

package/dist/engine/nunjucks.js

@@ -1,34 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const nunjucks_1 = require("nunjucks");
-const utils_1 = require("../utils");
-function default_1(option) {
-    const opt = Object.assign({
-        path: './template',
-    }, option);
-    (0, utils_1.debug)('option: %o', opt);
-    const paths = (Array.isArray(opt.path) ? opt.path : [opt.path]).map(p => (0, utils_1.cwdPath)(p));
-    const env = (0, nunjucks_1.configure)(paths, opt.nunjucksConfig);
-    if (opt.filter) {
-        Object.entries(opt.filter).forEach(([name, func]) => env.addFilter(name, func));
-    }
-    if (opt.extension) {
-        Object.entries(opt.extension).forEach(([name, ext]) => env.addExtension(name, ext));
-    }
-    if (opt.global) {
-        Object.entries(opt.global).forEach(([name, value]) => env.addGlobal(name, value));
-    }
-    if (typeof opt.configureEnvironment === 'function') {
-        opt.configureEnvironment(env);
-    }
-    return function nunjucks(name, data) {
-        return new Promise((resolve, reject) => {
-            env.render(name, data, (err, res) => {
-                if (err)
-                    return reject(err);
-                resolve(res);
-            });
-        });
-    };
-}
-exports.default = default_1;