eleventy-plugin-vento 5.4.1 → 5.4.3

package/CHANGELOG.md

@@ -1,5 +1,20 @@
 # eleventy-plugin-vento
 
+## 5.4.3
+
+### Patch Changes
+
+- 138db0f: Refactor Vento engine internal methods, should not introduce any functionally breaking changes
+- 2f42cc1: Refactor render function declaration
+  - Replaced `getTemplateFunction` with `getRenderFunction`
+  - New method now returns the render function signature Eleventy expects with all error handling logic built in, eliminating the need for a separate render function handler
+
+## 5.4.2
+
+### Patch Changes
+
+- 3ae32e5: Revise error creation method to explicitly check for `undefined` in `ctx.position` and `ctx.file` as opposed to coercing to booleans. This resolves edge cases where errors thrown with a position of `0` would incorrectly log position warnings.
+
 ## 5.4.1
 
 ### Patch Changes

package/dist/plugin.d.mts

@@ -1,9 +1,9 @@
 /// <reference types="node" />
-import * as ventojs from "ventojs";
+import * as ventojs$1 from "ventojs";
 import _UserConfig from "@11ty/eleventy/UserConfig";
 import { Plugin } from "ventojs/core/environment.js";
 
-//#region node_modules/.pnpm/11ty.ts@0.0.7_@11ty+eleventy@3.1.2/node_modules/11ty.ts/dist/index.d.ts
+//#region node_modules/.pnpm/11ty.ts@0.0.7_@11ty+eleventy@3.1.5/node_modules/11ty.ts/dist/index.d.ts
 declare global {
   // eslint-disable-next-line @typescript-eslint/consistent-type-definitions -- It has to be an `interface` so that it can be merged.
   interface SymbolConstructor {
@@ -96,7 +96,7 @@ interface PluginOptions {
    *   includes: eleventyConfig.directories.includes
    * }
    */
-  ventoOptions: ventojs.Options;
+  ventoOptions: ventojs$1.Options;
 }
 //#endregion
 //#region src/plugin.d.ts

package/dist/plugin.mjs

@@ -1,14 +1,13 @@
 import path from "node:path";
 import autotrimPlugin, { defaultTags } from "ventojs/plugins/auto_trim.js";
-import createVentoEnv from "ventojs";
+import ventojs from "ventojs";
 import { VentoError } from "ventojs/core/errors.js";
 import { styleText } from "node:util";
 import createDebugger from "debug";
-
 //#region src/utils/create-vento-tag.ts
 function createVentoTag(tagInfo) {
 	let LEVEL = 1;
-	const IS_PAIRED = tagInfo.group === "pairedShortcodes";
+	const IS_PAIRED = tagInfo.group === "paired";
 	const tag = (env, token, output, tokens) => {
 		const code = token[1];
 		if (!(code === tagInfo.name || code.startsWith(`${tagInfo.name} `))) return;
@@ -17,7 +16,7 @@ function createVentoTag(tagInfo) {
 			page: ${dataVarname}.page,
 			eleventy: ${dataVarname}.eleventy
 		}`;
-		const fn = `__env.utils.eleventyFunctions.${tagInfo.group}.${tagInfo.name}`;
+		const fn = `__env.utils.eleventyFunctions.get('${tagInfo.group}:${tagInfo.name}')`;
 		const args = [code.replace(tagInfo.name, "").trim()];
 		const compiled = [];
 		if (IS_PAIRED) {
@@ -32,7 +31,6 @@ function createVentoTag(tagInfo) {
 	};
 	return Object.defineProperty(tag, "name", { value: `${tagInfo.name}_${IS_PAIRED ? `EleventyPairedTag` : `EleventyTag`}` });
 }
-
 //#endregion
 //#region src/utils/logging.ts
 const debug = {
@@ -50,7 +48,6 @@ const debug = {
 function warn(...messages) {
 	for (const message of messages) console.error(styleText("gray", "[warning]"), styleText("yellow", message));
 }
-
 //#endregion
 //#region src/utils/errors.ts
 const LINE_TERMINATOR = /(\r\n?|[\n\u2028\u2029])/;
@@ -62,7 +59,7 @@ var EleventyVentoError = class extends Error {
 	static async createFromContext(error) {
 		const ctx = await error.getContext();
 		const err = new this("An unknown error occured processing Vento templates", ctx, error);
-		if (!ctx.position || !ctx.file) warn(`A \`${ctx.type}\` was thrown, but the exact position within the source code cannot be obtained`, "Use DEBUG=\"Eleventy:Vento*\" to view raw `ErrorContext` information");
+		if (ctx.position === void 0 || ctx.file === void 0) warn(`A \`${ctx.type}\` was thrown, but the exact position within the source code cannot be obtained`, "Use DEBUG=\"Eleventy:Vento*\" to view raw `ErrorContext` information");
 		debug.error("Received `ErrorContext` from Vento: %O", ctx);
 		if (ctx.file === void 0) return err;
 		err.message = `${ctx.type} in ${ctx.file}`;
@@ -102,18 +99,19 @@ function locateInCode(lines, position) {
 	}
 	throw new Error(`Positon ${position} is out of bounds for the provided source`);
 }
-
 //#endregion
 //#region src/engine.ts
 function createVentoEngine(options) {
-	const env = createVentoEnv(options);
-	env.utils.eleventyFunctions = {
-		shortcodes: {},
-		pairedShortcodes: {}
-	};
+	const env = ventojs(options);
+	/**
+	* Load plugins into Vento environment
+	*/
 	function loadPlugins(plugins) {
 		for (const plugin of plugins) env.use(plugin);
 	}
+	/**
+	* Load filters into Vento environment
+	*/
 	function loadFilters(filters) {
 		for (const [name, fn] of Object.entries(filters)) env.filters[name] = function(...args) {
 			const { page, eleventy } = this.data;
@@ -124,62 +122,67 @@ function createVentoEngine(options) {
 			}, args);
 		};
 	}
-	function loadShortcodes(shortcodes) {
+	/**
+	* Load shortcodes (tags) into Vento environment
+	*/
+	function loadShortcodes(group, shortcodes) {
+		if (!(env.utils.eleventyFunctions instanceof Map)) env.utils.eleventyFunctions = /* @__PURE__ */ new Map();
 		for (const [name, fn] of Object.entries(shortcodes)) {
-			env.utils.eleventyFunctions.shortcodes[name] = fn;
-			const shortcodeTag = createVentoTag({
+			env.utils.eleventyFunctions.set(`${group}:${name}`, fn);
+			env.tags.push(createVentoTag({
 				name,
-				group: "shortcodes"
-			});
-			env.tags.push(shortcodeTag);
+				group
+			}));
 		}
 	}
-	function loadPairedShortcodes(pairedShortcodes) {
-		for (const [name, fn] of Object.entries(pairedShortcodes)) {
-			env.utils.eleventyFunctions.pairedShortcodes[name] = fn;
-			const shortcodeTag = createVentoTag({
-				name,
-				group: "pairedShortcodes"
-			});
-			env.tags.push(shortcodeTag);
+	/**
+	* Clear one or more items from Vento's cache
+	*/
+	function removeCachedItems(items) {
+		for (let item of items) {
+			item = path.normalize(item);
+			debug.cache("Delete cache entry for %s", item);
+			env.cache.delete(item);
 		}
 	}
-	async function getTemplateFunction(source, file, useVentoCache = true) {
+	/**
+	* Given a source string and file, compile or get a cached template function,
+	* then produce an Eleventy render function for it and return it.
+	*/
+	async function getRenderFunction(source, file, options) {
+		debug.main("Getting render function for `%s`", file);
 		let template = await env.cache.get(file);
-		if (template?.source === source) {
-			debug.cache("Cache HIT for `%s`, using precompiled template", file);
-			return template;
-		}
-		try {
-			debug.cache("Cache MISS for `%s`, will compile new template function", file);
-			template = env.compile(source, file);
-			if (useVentoCache) env.cache.set(file, template);
-			return template;
-		} catch (error) {
-			if (error instanceof VentoError) throw await EleventyVentoError.createFromContext(error);
-			throw error;
+		if (template?.source === source) debug.cache("Cache HIT for `%s`, using precompiled template", file);
+		else {
+			try {
+				debug.cache("Cache MISS for `%s`, will compile new template function", file);
+				template = env.compile(source, file);
+			} catch (error) {
+				if (error instanceof VentoError) throw await EleventyVentoError.createFromContext(error);
+				throw error;
+			}
+			if (options?.cache !== false) env.cache.set(file, template);
 		}
+		const render = async (data) => {
+			try {
+				debug.render("Rendering %s", file);
+				const { content } = await template(data);
+				return content;
+			} catch (error) {
+				if (error instanceof VentoError) throw await EleventyVentoError.createFromContext(error);
+				throw error;
+			}
+		};
+		return render;
 	}
 	return {
-		cache: env.cache,
 		loadPlugins,
 		loadFilters,
 		loadShortcodes,
-		loadPairedShortcodes,
-		getTemplateFunction
+		removeCachedItems,
+		getRenderFunction
 	};
 }
-async function renderVentoTemplate(template, data, from) {
-	try {
-		debug.render("Rendering `%s`", from);
-		const { content } = await template(data);
-		return content;
-	} catch (error) {
-		if (error instanceof VentoError) throw await EleventyVentoError.createFromContext(error);
-		throw error;
-	}
-}
-
 //#endregion
 //#region src/plugin.ts
 function VentoPlugin(eleventyConfig, userOptions) {
@@ -224,20 +227,14 @@ function VentoPlugin(eleventyConfig, userOptions) {
 	}
 	if (options.shortcodes) {
 		debug.main("Loading shortcodes: %o", shortcodes);
-		engine.loadShortcodes(shortcodes);
+		engine.loadShortcodes("single", shortcodes);
 	}
 	if (options.pairedShortcodes) {
 		debug.main("Loading paired shortcodes: %o", pairedShortcodes);
-		engine.loadPairedShortcodes(pairedShortcodes);
+		engine.loadShortcodes("paired", pairedShortcodes);
 	}
-	debug.main("Registering Vento cache handler on eleventy.beforeWatch event");
-	eleventyConfig.on("eleventy.beforeWatch", async (updatedFiles) => {
-		for (let file of updatedFiles) {
-			file = path.normalize(file);
-			debug.cache("Delete cache entry for %s", file);
-			engine.cache.delete(file);
-		}
-	});
+	debug.main("Adding Vento cache handler for eleventy.beforeWatch event");
+	eleventyConfig.on("eleventy.beforeWatch", engine.removeCachedItems);
 	debug.main("Registering .vto as a template format");
 	eleventyConfig.addTemplateFormats("vto");
 	debug.main("Registering .vto extension with eleventy");
@@ -246,20 +243,15 @@ function VentoPlugin(eleventyConfig, userOptions) {
 		read: true,
 		async compile(inputContent, inputPath) {
 			inputPath = path.normalize(inputPath);
-			debug.main("Getting template function for `%s`", inputPath);
-			const template = await engine.getTemplateFunction(inputContent, inputPath, false);
-			return async (data) => await renderVentoTemplate(template, data, inputPath);
+			return await engine.getRenderFunction(inputContent, inputPath, { cache: false });
 		},
 		compileOptions: { async permalink(permalinkContent, inputPath) {
 			if (typeof permalinkContent !== "string" || !/\{\{\s+.+\s+\}\}/.test(permalinkContent)) return permalinkContent;
 			inputPath = "EleventyVentoDynamicPermalink:".concat(path.normalize(inputPath));
-			debug.main("Getting template function for `%s`", inputPath);
-			const template = await engine.getTemplateFunction(permalinkContent, inputPath);
-			return async (data) => await renderVentoTemplate(template, data, inputPath);
+			return await engine.getRenderFunction(permalinkContent, inputPath);
 		} }
 	});
 	debug.main("eleventy-plugin-vento initialized");
 }
-
 //#endregion
-export { VentoPlugin };
+export { VentoPlugin };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eleventy-plugin-vento",
-  "version": "5.4.1",
+  "version": "5.4.3",
   "description": "Adds support for the Vento templating language to Eleventy.",
   "type": "module",
   "engines": {
@@ -41,20 +41,20 @@
   },
   "devDependencies": {
     "11ty.ts": "0.0.7",
-    "@11ty/eleventy": "3.1.2",
-    "@changesets/cli": "2.29.8",
+    "@11ty/eleventy": "3.1.5",
+    "@changesets/cli": "2.30.0",
     "@eslint/js": "10.0.1",
-    "@types/debug": "4.1.12",
-    "@types/node": "24.11.0",
-    "eslint": "10.0.2",
+    "@types/debug": "4.1.13",
+    "@types/node": "24.12.0",
+    "eslint": "10.1.0",
     "eslint-config-prettier": "10.1.8",
-    "eslint-plugin-unicorn": "63.0.0",
+    "eslint-plugin-unicorn": "64.0.0",
     "globals": "17.4.0",
-    "knip": "5.85.0",
+    "knip": "6.0.6",
     "prettier": "3.8.1",
-    "tsdown": "0.20.3",
-    "typescript": "5.9.3",
-    "typescript-eslint": "8.56.1",
-    "vitest": "4.0.18"
+    "tsdown": "0.21.4",
+    "typescript": "6.0.2",
+    "typescript-eslint": "8.57.2",
+    "vitest": "4.1.2"
   }
 }