ventojs 0.7.2 → 0.8.0

package/esm/mod.d.ts

@@ -3,5 +3,6 @@ import { Loader } from "./src/loader.js";
 export interface Options {
     includes?: string | Loader;
     dataVarname?: string;
+    autoescape?: boolean;
 }
 export default function (options?: Options): Environment;

package/esm/mod.js

@@ -10,7 +10,9 @@ import layoutTag from "./plugins/layout.js";
 import functionTag from "./plugins/function.js";
 import importTag from "./plugins/import.js";
 import exportTag from "./plugins/export.js";
+import echoTag from "./plugins/echo.js";
 import escape from "./plugins/escape.js";
+import unescape from "./plugins/unescape.js";
 export default function (options = {}) {
     const loader = typeof options.includes === "object"
         ? options.includes
@@ -18,6 +20,7 @@ export default function (options = {}) {
     const env = new Environment({
         loader,
         dataVarname: options.dataVarname || "it",
+        autoescape: options.autoescape || false,
     });
     // Register basic plugins
     env.use(ifTag());
@@ -29,6 +32,8 @@ export default function (options = {}) {
     env.use(functionTag());
     env.use(importTag());
     env.use(exportTag());
+    env.use(echoTag());
     env.use(escape());
+    env.use(unescape());
     return env;
 }

package/esm/plugins/echo.d.ts

@@ -0,0 +1,2 @@
+import type { Environment } from "../src/environment.js";
+export default function (): (env: Environment) => void;

package/esm/plugins/echo.js

@@ -0,0 +1,13 @@
+export default function () {
+    return (env) => {
+        env.tags.push(setTag);
+    };
+}
+function setTag(env, code, output, tokens) {
+    if (!code.startsWith("echo ")) {
+        return;
+    }
+    const value = code.replace(/^echo\s+/, "");
+    const val = env.compileFilters(tokens, value, env.options.autoescape);
+    return `${output} += ${val};`;
+}

package/esm/plugins/include.js

@@ -3,7 +3,7 @@ export default function () {
         env.tags.push(includeTag);
     };
 }
-function includeTag(_env, code, output) {
+function includeTag(env, code, output, tokens) {
     if (!code.startsWith("include ")) {
         return;
     }
@@ -17,6 +17,6 @@ function includeTag(_env, code, output) {
       {...__data${data ? `, ${data}` : ""}},
       __file
     );
-    ${output} += __tmp.content;
+    ${output} += ${env.compileFilters(tokens, "__tmp.content")};
   }`;
 }

package/esm/plugins/layout.js

@@ -24,7 +24,7 @@ function layoutTag(env, code, output, tokens) {
     tokens.shift();
     compiled.push(`${varname} = ${compiledFilters};`);
     compiled.push(`__tmp = await __env.run(${file},
-      {...__data${data ? `, ${data}` : ""}, content: ${varname}},
+      {...__data${data ? `, ${data}` : ""}, content: ${env.compileFilters(tokens, varname)}},
       __file
     );
     ${output} += __tmp.content;`);

package/esm/plugins/unescape.d.ts

@@ -0,0 +1,2 @@
+import type { Environment } from "../src/environment.js";
+export default function (): (env: Environment) => void;

package/esm/plugins/unescape.js

@@ -0,0 +1,16 @@
+export default function () {
+    return (env) => {
+        env.filters.unescape = unescape;
+    };
+}
+const unescapeMap = {
+    "&": "&",
+    "&lt;": "<",
+    "&gt;": ">",
+    "&quot;": '"',
+    "&#39;": "'",
+    "&#x60;": "`",
+};
+function unescape(str) {
+    return str.replace(/(&amp;|&lt;|&gt;|&quot;|&#39;|&#x60;)/g, (match) => unescapeMap[match]);
+}

package/esm/src/environment.d.ts

@@ -19,7 +19,8 @@ export type Filter = (...args: any[]) => any;
 export type Plugin = (env: Environment) => void;
 export interface Options {
     loader: Loader;
-    dataVarname?: string;
+    dataVarname: string;
+    autoescape: boolean;
 }
 export declare class Environment {
     cache: Map<string, Template>;
@@ -36,5 +37,5 @@ export declare class Environment {
     compile(source: string, path?: string, defaults?: Record<string, unknown>, sync?: true): TemplateSync;
     load(file: string, from?: string): Promise<Template>;
     compileTokens(tokens: Token[], outputVar?: string, stopAt?: string[]): string[];
-    compileFilters(tokens: Token[], output: string): string;
+    compileFilters(tokens: Token[], output: string, autoescape?: boolean): string;
 }

package/esm/src/environment.js

@@ -67,9 +67,9 @@ export class Environment {
         if (!this.cache.has(path)) {
             const { source, data } = await this.options.loader.load(path);
             const template = this.compile(source, path, data);
-            this.cache.set(file, template);
+            this.cache.set(path, template);
         }
-        return this.cache.get(file);
+        return this.cache.get(path);
     }
     compileTokens(tokens, outputVar = "__exports.content", stopAt) {
         const compiled = [];
@@ -81,10 +81,8 @@ export class Environment {
             if (type === "comment") {
                 continue;
             }
-            if (type === "string" || type === "raw") {
-                compiled.push(`${outputVar} += \`${code
-                    .replaceAll("`", "\\`")
-                    .replaceAll("${", "\\${")}\`;`);
+            if (type === "string") {
+                compiled.push(`${outputVar} += ${JSON.stringify(code)};`);
                 continue;
             }
             if (type === "tag") {
@@ -96,7 +94,7 @@ export class Environment {
                     }
                 }
                 // Unknown tag, just print it
-                const expression = this.compileFilters(tokens, code);
+                const expression = this.compileFilters(tokens, code, this.options.autoescape);
                 compiled.push(`${outputVar} += (${expression}) ?? "";`);
                 continue;
             }
@@ -104,7 +102,8 @@ export class Environment {
         }
         return compiled;
     }
-    compileFilters(tokens, output) {
+    compileFilters(tokens, output, autoescape = false) {
+        let unescaped = false;
         while (tokens.length > 0 && tokens[0][0] === "filter") {
             const [, code] = tokens.shift();
             const match = code.match(/^(await\s+)?([\w.]+)(?:\((.*)\))?$/);
@@ -123,10 +122,17 @@ export class Environment {
                 }
             }
             else {
+                if (name === "unescape") {
+                    unescaped = true;
+                }
                 // It's a filter (e.g. filters.upper())
                 output = `${isAsync ? "await " : ""}__env.filters.${name}(${output}${args ? `, ${args}` : ""})`;
             }
         }
+        // Escape by default
+        if (autoescape && !unescaped) {
+            output = `__env.filters.escape(${output})`;
+        }
         return output;
     }
 }

package/esm/src/tokenizer.d.ts

@@ -1,4 +1,4 @@
-export type TokenType = "string" | "tag" | "filter" | "comment" | "raw";
+export type TokenType = "string" | "tag" | "filter" | "comment";
 export type Token = [TokenType, string];
 export default function tokenize(source: string): Token[];
 /**

package/esm/src/tokenizer.js

@@ -17,15 +17,6 @@ export default function tokenize(source) {
                 break;
             }
             source = source.slice(index);
-            // Check if it's a {{raw}} tag
-            const raw = parseRawTag(source);
-            if (raw) {
-                const rawCode = source.slice(raw[0], raw[1]);
-                tokens.push(["raw", rawCode]);
-                source = source.slice(raw[2]);
-                type = "string";
-                continue;
-            }
             type = source.startsWith("{{#") ? "comment" : "tag";
             continue;
         }
@@ -44,6 +35,7 @@ export default function tokenize(source) {
         if (type === "tag") {
             const indexes = parseTag(source);
             const lastIndex = indexes.length - 1;
+            let tag;
             indexes.reduce((prev, curr, index) => {
                 let code = source.slice(prev, curr - 2);
                 // Tag
@@ -59,7 +51,8 @@ export default function tokenize(source) {
                         code = code.slice(0, -1);
                         trimNext = true;
                     }
-                    tokens.push([type, code.trim()]);
+                    tag = [type, code.trim()];
+                    tokens.push(tag);
                     return curr;
                 }
                 // Right trim
@@ -73,6 +66,16 @@ export default function tokenize(source) {
             });
             source = source.slice(indexes[indexes.length - 1]);
             type = "string";
+            // Search the closing echo tag {{ /echo }}
+            if (tag?.[1] === "echo") {
+                const end = source.match(/{{\s*\/echo\s*}}/);
+                if (!end) {
+                    throw new Error("Unclosed echo tag");
+                }
+                const rawCode = source.slice(0, end.index);
+                tag[1] = `echo ${JSON.stringify(rawCode)}`;
+                source = source.slice(Number(end.index) + end[0].length);
+            }
             continue;
         }
     }
@@ -180,18 +183,3 @@ export function parseTag(source) {
     }
     throw new Error("Unclosed tag");
 }
-function parseRawTag(source) {
-    const startResult = source.match(/^{{\s*raw\s*}}/);
-    if (!startResult) {
-        return;
-    }
-    const endResult = source.match(/{{\s*\/raw\s*}}/);
-    if (!endResult) {
-        throw new Error("Unclosed raw tag");
-    }
-    return [
-        startResult[0].length,
-        endResult.index,
-        endResult.index + endResult[0].length,
-    ];
-}

package/package.json

@@ -1,7 +1,7 @@
 {
   "module": "./esm/mod.js",
   "name": "ventojs",
-  "version": "0.7.2",
+  "version": "0.8.0",
   "description": "🌬 A minimal but powerful template engine",
   "license": "MIT",
   "repository": "github:oscarotero/vento",