@zenweb/template 3.2.1 → 4.1.0

package/dist/index.d.ts

@@ -1,13 +1,10 @@
 import { SetupFunction } from '@zenweb/core';
-import { RenderManager } from '@zenweb/result';
 import { TemplateSetupOption, TemplateOption } from './types';
-import { TEMPLATE_OPTION } from './render';
 export * from './types';
-export { RenderManager };
 export default function setup(option: TemplateSetupOption): SetupFunction;
 declare module '@zenweb/core' {
     interface Context {
-        [TEMPLATE_OPTION]?: TemplateOption;
+        templateOption?: TemplateOption;
         /**
          * 启用并设置模版渲染
          * - 不传参数: 启用

package/dist/index.js

@@ -14,24 +14,22 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.RenderManager = void 0;
 const result_1 = require("@zenweb/result");
-Object.defineProperty(exports, "RenderManager", { enumerable: true, get: function () { return result_1.RenderManager; } });
 const render_1 = require("./render");
 __exportStar(require("./types"), exports);
 function contextTemplate(template_or_option) {
     if (template_or_option === false) {
-        delete this[render_1.TEMPLATE_OPTION];
+        this.templateOption = undefined;
         return;
     }
-    if (!this[render_1.TEMPLATE_OPTION]) {
-        this[render_1.TEMPLATE_OPTION] = {};
+    if (!this.templateOption) {
+        this.templateOption = {};
     }
     if (typeof template_or_option === 'string') {
-        Object.assign(this[render_1.TEMPLATE_OPTION], { template: template_or_option });
+        Object.assign(this.templateOption, { template: template_or_option });
     }
     else if (typeof template_or_option === 'object') {
-        Object.assign(this[render_1.TEMPLATE_OPTION], template_or_option);
+        Object.assign(this.templateOption, template_or_option);
     }
 }
 function setup(option) {

package/dist/render.d.ts

@@ -1,9 +1,9 @@
 import { Context } from '@zenweb/core';
 import { ResultRender } from '@zenweb/result';
 import { TemplateSetupOption } from './types';
-export declare const TEMPLATE_OPTION: unique symbol;
 export declare class TemplateRender implements ResultRender {
     private _option;
+    enwrap: boolean;
     type: string;
     constructor(_option: TemplateSetupOption);
     match(ctx: Context): boolean;

package/dist/render.js

@@ -1,20 +1,36 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.TemplateRender = exports.TEMPLATE_OPTION = void 0;
+exports.TemplateRender = void 0;
 const result_1 = require("@zenweb/result");
 const utils_1 = require("./utils");
-exports.TEMPLATE_OPTION = Symbol('template@option');
 class TemplateRender {
     constructor(_option) {
         this._option = _option;
+        this.enwrap = false;
         this.type = this._option.type || 'html';
     }
     match(ctx) {
-        const opt = ctx[exports.TEMPLATE_OPTION];
-        // 匹配引擎, 如果不设置引擎则直接匹配
-        if (opt && (!opt.engine || opt.engine === this._option.engineName)) {
-            (0, utils_1.debug)('matchEngine: %o', this._option.engineName);
-            return true;
+        const opt = ctx.templateOption;
+        if (opt) {
+            // 匹配引擎
+            if (opt.engine === this._option.engineName) {
+                (0, utils_1.debug)('matchEngine: %o', this._option.engineName);
+                return true;
+            }
+            // 指定模版
+            if (opt.template && this._option.templateAffix && opt.template.endsWith(this._option.templateAffix)) {
+                (0, utils_1.debug)('matchTemplateAffix: %o', this._option.templateAffix);
+                return true;
+            }
+        }
+        // 忽略路径规则
+        if (this._option.ignorePath) {
+            for (const reg of this._option.ignorePath) {
+                if (reg.test(ctx.path)) {
+                    (0, utils_1.debug)('ignorePath: %o', reg);
+                    return false;
+                }
+            }
         }
         // 匹配路径规则
         if (this._option.matchPath) {
@@ -27,7 +43,7 @@ class TemplateRender {
         }
         // 匹配 Accept 头类型
         if (this._option.matchAccept) {
-            const _type = ctx.accepts(this._option.matchAccept);
+            const _type = ctx.accepts().some(accept => { var _a; return (_a = this._option.matchAccept) === null || _a === void 0 ? void 0 : _a.includes(accept); });
             if (_type) {
                 (0, utils_1.debug)('matchAccept: %o', _type);
                 return true;
@@ -36,7 +52,7 @@ class TemplateRender {
         return false;
     }
     render(ctx, data) {
-        const opt = ctx[exports.TEMPLATE_OPTION] || {};
+        const opt = ctx.templateOption || {};
         let template = opt.template;
         if (data instanceof result_1.ResultFail) {
             data = { fail: data };

package/dist/types.d.ts

@@ -10,9 +10,13 @@ export interface TemplateSetupOption {
      */
     type?: string;
     /**
-     * 匹配路径结尾例如 `/.html$/i`
+     * 匹配路径，例如 `/.html$/i`
      */
     matchPath?: RegExp[];
+    /**
+     * 忽略路径，例如 `/^\/api\//i`
+     */
+    ignorePath?: RegExp[];
     /**
      * 匹配 Accept Type 头信息
      */

package/dist/utils.d.ts

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

package/dist/utils.js

@@ -2,8 +2,8 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.cwdPath = exports.debug = void 0;
 const path = require("path");
-const debug_1 = require("debug");
-exports.debug = (0, debug_1.default)('zenweb:template');
+const core_1 = require("@zenweb/core");
+exports.debug = core_1.debug.extend('template');
 function cwdPath(p) {
     if (p.startsWith('./')) {
         return path.join(process.cwd(), p.slice(2));

package/package.json

@@ -1,13 +1,15 @@
 {
   "name": "@zenweb/template",
-  "version": "3.2.1",
+  "packageManager": "yarn@4.0.2",
+  "version": "4.1.0",
   "description": "zenweb template render module",
   "exports": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "scripts": {
+    "vscode": "yarn dlx @yarnpkg/sdks vscode",
     "build": "rimraf dist && tsc",
-    "prepublishOnly": "npm run build",
-    "dev": "cd example && cross-env DEBUG=* ts-node app"
+    "prepack": "yarn run build",
+    "dev": "cd example && cross-env DEBUG=\\* ts-node app"
   },
   "files": [
     "dist"
@@ -24,15 +26,18 @@
   "license": "MIT",
   "homepage": "https://zenweb.node.ltd",
   "devDependencies": {
+    "@types/node": "^20.10.6",
+    "@zenweb/inject": "^4.1.1",
     "@zenweb/template-handlebars": "^3.0.0",
-    "@zenweb/template-nunjucks": "^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.0.2",
-    "zenweb": "^3.18.0"
+    "typescript": "~5.3.3",
+    "zenweb": "^4.5.0"
   },
   "dependencies": {
-    "debug": "^4.3.4"
+    "@zenweb/core": "^4.3.2",
+    "@zenweb/result": "^4.0.0"
   }
 }

package/CHANGELOG.md

@@ -1,16 +0,0 @@
-# Changelog
-
-## [3.2.1] - 2023-4-26
-- fix: 使用 ctx.fail 时错误已设置 template 被至空问题
-
-## [3.2.0] - 2023-4-3
-- 不再集成内置引擎，使用独立包
-
-## [3.1.0] - 2023-4-2
-- 完成 failTemplate 功能
-
-## [3.0.3] - 2023-4-2
-- 清除遗留的 console.log
-
-## [3.0.2] - 2023-4-2
-- 使用 ctx.template 方法无 engine 指定的情况下使用第一匹配的 engine