ventojs 0.10.2 → 0.11.0

package/esm/mod.js

@@ -13,6 +13,7 @@ import exportTag from "./plugins/export.js";
 import echoTag from "./plugins/echo.js";
 import escape from "./plugins/escape.js";
 import unescape from "./plugins/unescape.js";
+import trim from "./plugins/trim.js";
 export default function (options = {}) {
     const loader = typeof options.includes === "object"
         ? options.includes
@@ -36,5 +37,6 @@ export default function (options = {}) {
     env.use(echoTag());
     env.use(escape());
     env.use(unescape());
+    env.use(trim());
     return env;
 }

package/esm/plugins/auto_trim.d.ts

@@ -0,0 +1,8 @@
+import type { Token } from "../src/tokenizer.js";
+import type { Environment } from "../src/environment.js";
+export declare const defaultTags: string[];
+export type AutoTrimOptions = {
+    tags: string[];
+};
+export default function (options?: AutoTrimOptions): (env: Environment) => void;
+export declare function autoTrim(tokens: Token[], options: AutoTrimOptions): void;

package/esm/plugins/auto_trim.js

@@ -0,0 +1,36 @@
+export const defaultTags = [
+    ">",
+    "#",
+    "set",
+    "/set",
+    "if",
+    "/if",
+    "else",
+    "for",
+    "/for",
+    "function",
+    "async",
+    "/function",
+    "export",
+    "/export",
+    "import",
+];
+export default function (options = { tags: defaultTags }) {
+    return (env) => {
+        env.tokenPreprocessors.push((_, tokens) => autoTrim(tokens, options));
+    };
+}
+export function autoTrim(tokens, options) {
+    for (let i = 0; i < tokens.length; i++) {
+        const previous = tokens[i - 1];
+        const token = tokens[i];
+        const next = tokens[i + 1];
+        const [type, code] = token;
+        if (type === "tag" && options.tags.find((tag) => code.startsWith(tag))) {
+            // Remove leading horizontal space
+            previous[1] = previous[1].replace(/[ \t]*$/, "");
+            // Remove trailing horizontal space + newline
+            next[1] = next[1].replace(/^[ \t]*(?:\r\n|\n)/, "");
+        }
+    }
+}

package/esm/plugins/escape.js

@@ -1,6 +1,7 @@
 import { html } from "../deps.js";
 export default function () {
     return (env) => {
-        env.filters.escape = html.escape;
+        // deno-lint-ignore no-explicit-any
+        env.filters.escape = (value) => value ? html.escape(value.toString()) : "";
     };
 }

package/esm/plugins/trim.d.ts

@@ -0,0 +1,4 @@
+import type { Token } from "../src/tokenizer.js";
+import type { Environment } from "../src/environment.js";
+export default function (): (env: Environment) => void;
+export declare function trim(_: Environment, tokens: Token[]): void;

package/esm/plugins/trim.js

@@ -0,0 +1,28 @@
+export default function () {
+    return (env) => {
+        env.tokenPreprocessors.push(trim);
+    };
+}
+export function trim(_, tokens) {
+    for (let i = 0; i < tokens.length; i++) {
+        const previous = tokens[i - 1];
+        const token = tokens[i];
+        const next = tokens[i + 1];
+        let [type, code] = token;
+        if (type === "tag" && code.startsWith("-")) {
+            previous[1] = previous[1].trimEnd();
+            code = code.slice(1);
+        }
+        if (type === "tag" && code.endsWith("-")) {
+            next[1] = next[1].trimStart();
+            code = code.slice(0, -1);
+        }
+        // Trim tag and filter code
+        switch (type) {
+            case "tag":
+            case "filter":
+                token[1] = code.trim();
+                break;
+        }
+    }
+}

package/esm/plugins/unescape.js

@@ -1,6 +1,7 @@
 import { html } from "../deps.js";
 export default function () {
     return (env) => {
-        env.filters.unescape = html.unescape;
+        // deno-lint-ignore no-explicit-any
+        env.filters.unescape = (value) => value ? html.unescape(value.toString()) : "";
     };
 }

package/esm/src/environment.d.ts

@@ -16,6 +16,7 @@ export interface TemplateSync {
     code: string;
     file?: string;
 }
+export type TokenPreprocessor = (env: Environment, tokens: Token[], path?: string) => Token[] | void;
 export type Tag = (env: Environment, code: string, output: string, tokens: Token[]) => string | undefined;
 export type FilterThis = {
     data: Record<string, unknown>;
@@ -33,6 +34,7 @@ export declare class Environment {
     cache: Map<string, Template>;
     options: Options;
     tags: Tag[];
+    tokenPreprocessors: TokenPreprocessor[];
     filters: Record<string, Filter>;
     utils: Record<string, unknown>;
     constructor(options: Options);
@@ -42,6 +44,7 @@ export declare class Environment {
     runStringSync(source: string, data?: Record<string, unknown>): TemplateResult;
     compile(source: string, path?: string, defaults?: Record<string, unknown>, sync?: false): Template;
     compile(source: string, path?: string, defaults?: Record<string, unknown>, sync?: true): TemplateSync;
+    tokenize(source: string, path?: string): Token[];
     load(file: string, from?: string): Promise<Template>;
     compileTokens(tokens: Token[], outputVar?: string, stopAt?: string[]): string[];
     compileFilters(tokens: Token[], output: string, autoescape?: boolean): string;

package/esm/src/environment.js

@@ -4,6 +4,7 @@ export class Environment {
     cache = new Map();
     options;
     tags = [];
+    tokenPreprocessors = [];
     filters = {};
     utils = {};
     constructor(options) {
@@ -34,10 +35,7 @@ export class Environment {
         return template(data);
     }
     compile(source, path, defaults, sync = false) {
-        const { tokens, position, error } = tokenize(source);
-        if (error) {
-            throw this.createError(path || "unknown", source, position, error);
-        }
+        const tokens = this.tokenize(source, path);
         const code = this.compileTokens(tokens).join("\n");
         const { dataVarname, useWith } = this.options;
         const constructor = new Function("__file", "__env", "__defaults", `return${sync ? "" : " async"} function (${dataVarname}) {
@@ -59,10 +57,29 @@ export class Environment {
         template.source = source;
         return template;
     }
+    tokenize(source, path) {
+        const result = tokenize(source);
+        let { tokens } = result;
+        const { position, error } = result;
+        if (error) {
+            throw this.createError(path || "unknown", source, position, error);
+        }
+        for (const tokenPreprocessor of this.tokenPreprocessors) {
+            const result = tokenPreprocessor(this, tokens, path);
+            if (result !== undefined) {
+                tokens = result;
+            }
+        }
+        return tokens;
+    }
     async load(file, from) {
         const path = from ? this.options.loader.resolve(from, file) : file;
         if (!this.cache.has(path)) {
-            const { source, data } = await this.options.loader.load(path);
+            // Remove query and hash params from path before loading
+            const cleanPath = path
+                .split("?")[0]
+                .split("#")[0];
+            const { source, data } = await this.options.loader.load(cleanPath);
             const template = this.compile(source, path, data);
             this.cache.set(path, template);
         }

package/esm/src/tokenizer.js

@@ -1,20 +1,13 @@
 export default function tokenize(source) {
     const tokens = [];
     let type = "string";
-    let trimNext = false;
     let position = 0;
     try {
         while (source.length > 0) {
             if (type === "string") {
                 const index = source.indexOf("{{");
                 const code = index === -1 ? source : source.slice(0, index);
-                if (trimNext) {
-                    tokens.push([type, code.trimStart(), position]);
-                    trimNext = false;
-                }
-                else {
-                    tokens.push([type, code, position]);
-                }
+                tokens.push([type, code, position]);
                 if (index === -1) {
                     break;
                 }
@@ -41,39 +34,23 @@ export default function tokenize(source) {
                 const lastIndex = indexes.length - 1;
                 let tag;
                 indexes.reduce((prev, curr, index) => {
-                    let code = source.slice(prev, curr - 2);
+                    const code = source.slice(prev, curr - 2);
                     // Tag
                     if (index === 1) {
-                        // Left trim
-                        if (code.startsWith("-")) {
-                            code = code.slice(1);
-                            const lastToken = tokens[tokens.length - 1];
-                            lastToken[1] = lastToken[1].trimEnd();
-                        }
-                        // Right trim
-                        if (code.endsWith("-") && index === lastIndex) {
-                            code = code.slice(0, -1);
-                            trimNext = true;
-                        }
-                        tag = [type, code.trim(), position];
+                        tag = [type, code, position];
                         tokens.push(tag);
                         return curr;
                     }
-                    // Right trim
-                    if (index === lastIndex && code.endsWith("-")) {
-                        code = code.slice(0, -1);
-                        trimNext = true;
-                    }
                     // Filters
-                    tokens.push(["filter", code.trim()]);
+                    tokens.push(["filter", code]);
                     return curr;
                 });
                 position += indexes[lastIndex];
                 source = source.slice(indexes[lastIndex]);
                 type = "string";
                 // Search the closing echo tag {{ /echo }}
-                if (tag?.[1] === "echo") {
-                    const end = source.match(/{{\s*\/echo\s*}}/);
+                if (tag?.[1].match(/^\-?\s*echo\s*\-?$/)) {
+                    const end = source.match(/{{\-?\s*\/echo\s*\-?}}/);
                     if (!end) {
                         throw new Error("Unclosed echo tag");
                     }

package/package.json

@@ -2,7 +2,7 @@
   "module": "./esm/mod.js",
   "main": "./script/mod.js",
   "name": "ventojs",
-  "version": "0.10.2",
+  "version": "0.11.0",
   "description": "🌬 A minimal but powerful template engine",
   "license": "MIT",
   "repository": "github:oscarotero/vento",
@@ -12,6 +12,10 @@
     ".": {
       "import": "./esm/mod.js",
       "require": "./script/mod.js"
+    },
+    "./plugins/auto_trim.js": {
+      "import": "./esm/plugins/auto_trim.js",
+      "require": "./script/plugins/auto_trim.js"
     }
   },
   "scripts": {

package/script/mod.js

@@ -41,6 +41,7 @@ const export_js_1 = __importDefault(require("./plugins/export.js"));
 const echo_js_1 = __importDefault(require("./plugins/echo.js"));
 const escape_js_1 = __importDefault(require("./plugins/escape.js"));
 const unescape_js_1 = __importDefault(require("./plugins/unescape.js"));
+const trim_js_1 = __importDefault(require("./plugins/trim.js"));
 function default_1(options = {}) {
     const loader = typeof options.includes === "object"
         ? options.includes
@@ -64,6 +65,7 @@ function default_1(options = {}) {
     env.use((0, echo_js_1.default)());
     env.use((0, escape_js_1.default)());
     env.use((0, unescape_js_1.default)());
+    env.use((0, trim_js_1.default)());
     return env;
 }
 exports.default = default_1;

package/script/plugins/auto_trim.d.ts

@@ -0,0 +1,8 @@
+import type { Token } from "../src/tokenizer.js";
+import type { Environment } from "../src/environment.js";
+export declare const defaultTags: string[];
+export type AutoTrimOptions = {
+    tags: string[];
+};
+export default function (options?: AutoTrimOptions): (env: Environment) => void;
+export declare function autoTrim(tokens: Token[], options: AutoTrimOptions): void;

package/script/plugins/auto_trim.js

@@ -0,0 +1,41 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.autoTrim = exports.defaultTags = void 0;
+exports.defaultTags = [
+    ">",
+    "#",
+    "set",
+    "/set",
+    "if",
+    "/if",
+    "else",
+    "for",
+    "/for",
+    "function",
+    "async",
+    "/function",
+    "export",
+    "/export",
+    "import",
+];
+function default_1(options = { tags: exports.defaultTags }) {
+    return (env) => {
+        env.tokenPreprocessors.push((_, tokens) => autoTrim(tokens, options));
+    };
+}
+exports.default = default_1;
+function autoTrim(tokens, options) {
+    for (let i = 0; i < tokens.length; i++) {
+        const previous = tokens[i - 1];
+        const token = tokens[i];
+        const next = tokens[i + 1];
+        const [type, code] = token;
+        if (type === "tag" && options.tags.find((tag) => code.startsWith(tag))) {
+            // Remove leading horizontal space
+            previous[1] = previous[1].replace(/[ \t]*$/, "");
+            // Remove trailing horizontal space + newline
+            next[1] = next[1].replace(/^[ \t]*(?:\r\n|\n)/, "");
+        }
+    }
+}
+exports.autoTrim = autoTrim;

package/script/plugins/escape.js

@@ -3,7 +3,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const deps_js_1 = require("../deps.js");
 function default_1() {
     return (env) => {
-        env.filters.escape = deps_js_1.html.escape;
+        // deno-lint-ignore no-explicit-any
+        env.filters.escape = (value) => value ? deps_js_1.html.escape(value.toString()) : "";
     };
 }
 exports.default = default_1;

package/script/plugins/trim.d.ts

@@ -0,0 +1,4 @@
+import type { Token } from "../src/tokenizer.js";
+import type { Environment } from "../src/environment.js";
+export default function (): (env: Environment) => void;
+export declare function trim(_: Environment, tokens: Token[]): void;

package/script/plugins/trim.js

@@ -0,0 +1,33 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.trim = void 0;
+function default_1() {
+    return (env) => {
+        env.tokenPreprocessors.push(trim);
+    };
+}
+exports.default = default_1;
+function trim(_, tokens) {
+    for (let i = 0; i < tokens.length; i++) {
+        const previous = tokens[i - 1];
+        const token = tokens[i];
+        const next = tokens[i + 1];
+        let [type, code] = token;
+        if (type === "tag" && code.startsWith("-")) {
+            previous[1] = previous[1].trimEnd();
+            code = code.slice(1);
+        }
+        if (type === "tag" && code.endsWith("-")) {
+            next[1] = next[1].trimStart();
+            code = code.slice(0, -1);
+        }
+        // Trim tag and filter code
+        switch (type) {
+            case "tag":
+            case "filter":
+                token[1] = code.trim();
+                break;
+        }
+    }
+}
+exports.trim = trim;

package/script/plugins/unescape.js

@@ -3,7 +3,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const deps_js_1 = require("../deps.js");
 function default_1() {
     return (env) => {
-        env.filters.unescape = deps_js_1.html.unescape;
+        // deno-lint-ignore no-explicit-any
+        env.filters.unescape = (value) => value ? deps_js_1.html.unescape(value.toString()) : "";
     };
 }
 exports.default = default_1;

package/script/src/environment.d.ts

@@ -16,6 +16,7 @@ export interface TemplateSync {
     code: string;
     file?: string;
 }
+export type TokenPreprocessor = (env: Environment, tokens: Token[], path?: string) => Token[] | void;
 export type Tag = (env: Environment, code: string, output: string, tokens: Token[]) => string | undefined;
 export type FilterThis = {
     data: Record<string, unknown>;
@@ -33,6 +34,7 @@ export declare class Environment {
     cache: Map<string, Template>;
     options: Options;
     tags: Tag[];
+    tokenPreprocessors: TokenPreprocessor[];
     filters: Record<string, Filter>;
     utils: Record<string, unknown>;
     constructor(options: Options);
@@ -42,6 +44,7 @@ export declare class Environment {
     runStringSync(source: string, data?: Record<string, unknown>): TemplateResult;
     compile(source: string, path?: string, defaults?: Record<string, unknown>, sync?: false): Template;
     compile(source: string, path?: string, defaults?: Record<string, unknown>, sync?: true): TemplateSync;
+    tokenize(source: string, path?: string): Token[];
     load(file: string, from?: string): Promise<Template>;
     compileTokens(tokens: Token[], outputVar?: string, stopAt?: string[]): string[];
     compileFilters(tokens: Token[], output: string, autoescape?: boolean): string;

package/script/src/environment.js

@@ -33,6 +33,7 @@ class Environment {
     cache = new Map();
     options;
     tags = [];
+    tokenPreprocessors = [];
     filters = {};
     utils = {};
     constructor(options) {
@@ -63,10 +64,7 @@ class Environment {
         return template(data);
     }
     compile(source, path, defaults, sync = false) {
-        const { tokens, position, error } = (0, tokenizer_js_1.default)(source);
-        if (error) {
-            throw this.createError(path || "unknown", source, position, error);
-        }
+        const tokens = this.tokenize(source, path);
         const code = this.compileTokens(tokens).join("\n");
         const { dataVarname, useWith } = this.options;
         const constructor = new Function("__file", "__env", "__defaults", `return${sync ? "" : " async"} function (${dataVarname}) {
@@ -88,10 +86,29 @@ class Environment {
         template.source = source;
         return template;
     }
+    tokenize(source, path) {
+        const result = (0, tokenizer_js_1.default)(source);
+        let { tokens } = result;
+        const { position, error } = result;
+        if (error) {
+            throw this.createError(path || "unknown", source, position, error);
+        }
+        for (const tokenPreprocessor of this.tokenPreprocessors) {
+            const result = tokenPreprocessor(this, tokens, path);
+            if (result !== undefined) {
+                tokens = result;
+            }
+        }
+        return tokens;
+    }
     async load(file, from) {
         const path = from ? this.options.loader.resolve(from, file) : file;
         if (!this.cache.has(path)) {
-            const { source, data } = await this.options.loader.load(path);
+            // Remove query and hash params from path before loading
+            const cleanPath = path
+                .split("?")[0]
+                .split("#")[0];
+            const { source, data } = await this.options.loader.load(cleanPath);
             const template = this.compile(source, path, data);
             this.cache.set(path, template);
         }

package/script/src/tokenizer.js

@@ -4,20 +4,13 @@ exports.parseTag = void 0;
 function tokenize(source) {
     const tokens = [];
     let type = "string";
-    let trimNext = false;
     let position = 0;
     try {
         while (source.length > 0) {
             if (type === "string") {
                 const index = source.indexOf("{{");
                 const code = index === -1 ? source : source.slice(0, index);
-                if (trimNext) {
-                    tokens.push([type, code.trimStart(), position]);
-                    trimNext = false;
-                }
-                else {
-                    tokens.push([type, code, position]);
-                }
+                tokens.push([type, code, position]);
                 if (index === -1) {
                     break;
                 }
@@ -44,39 +37,23 @@ function tokenize(source) {
                 const lastIndex = indexes.length - 1;
                 let tag;
                 indexes.reduce((prev, curr, index) => {
-                    let code = source.slice(prev, curr - 2);
+                    const code = source.slice(prev, curr - 2);
                     // Tag
                     if (index === 1) {
-                        // Left trim
-                        if (code.startsWith("-")) {
-                            code = code.slice(1);
-                            const lastToken = tokens[tokens.length - 1];
-                            lastToken[1] = lastToken[1].trimEnd();
-                        }
-                        // Right trim
-                        if (code.endsWith("-") && index === lastIndex) {
-                            code = code.slice(0, -1);
-                            trimNext = true;
-                        }
-                        tag = [type, code.trim(), position];
+                        tag = [type, code, position];
                         tokens.push(tag);
                         return curr;
                     }
-                    // Right trim
-                    if (index === lastIndex && code.endsWith("-")) {
-                        code = code.slice(0, -1);
-                        trimNext = true;
-                    }
                     // Filters
-                    tokens.push(["filter", code.trim()]);
+                    tokens.push(["filter", code]);
                     return curr;
                 });
                 position += indexes[lastIndex];
                 source = source.slice(indexes[lastIndex]);
                 type = "string";
                 // Search the closing echo tag {{ /echo }}
-                if (tag?.[1] === "echo") {
-                    const end = source.match(/{{\s*\/echo\s*}}/);
+                if (tag?.[1].match(/^\-?\s*echo\s*\-?$/)) {
+                    const end = source.match(/{{\-?\s*\/echo\s*\-?}}/);
                     if (!end) {
                         throw new Error("Unclosed echo tag");
                     }