eleventy-plugin-vento 5.4.2 → 5.5.0

package/CHANGELOG.md

@@ -1,5 +1,20 @@
 # eleventy-plugin-vento
 
+## 5.5.0
+
+### Minor Changes
+
+- a8f6efe: Update Vento to v2.4.0 ([release notes](https://github.com/ventojs/vento/blob/HEAD/CHANGELOG.md#240---2026-07-09))
+
+## 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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eleventy-plugin-vento",
-  "version": "5.4.2",
+  "version": "5.5.0",
   "description": "Adds support for the Vento templating language to Eleventy.",
   "type": "module",
   "engines": {
@@ -19,7 +19,10 @@
     "CHANGELOG.md",
     "readme.md"
   ],
-  "repository": "git@github.com:noelforte/eleventy-plugin-vento.git",
+  "repository": {
+    "type": "git",
+    "url": "git@github.com:noelforte/eleventy-plugin-vento.git"
+  },
   "bugs": {
     "url": "https://github.com/noelforte/eleventy-plugin-vento/issues"
   },
@@ -37,24 +40,23 @@
   "license": "MIT",
   "dependencies": {
     "debug": "4.4.3",
-    "ventojs": "2.3.1"
+    "ventojs": "2.4.0"
   },
   "devDependencies": {
-    "11ty.ts": "0.0.7",
-    "@11ty/eleventy": "3.1.2",
-    "@changesets/cli": "2.30.0",
+    "@11ty/eleventy": "3.1.6",
+    "@changesets/cli": "2.31.0",
     "@eslint/js": "10.0.1",
-    "@types/debug": "4.1.12",
-    "@types/node": "24.12.0",
-    "eslint": "10.0.3",
+    "@types/debug": "4.1.13",
+    "@types/node": "24.13.3",
+    "eslint": "10.7.0",
     "eslint-config-prettier": "10.1.8",
-    "eslint-plugin-unicorn": "63.0.0",
-    "globals": "17.4.0",
-    "knip": "5.86.0",
-    "prettier": "3.8.1",
-    "tsdown": "0.21.1",
-    "typescript": "5.9.3",
-    "typescript-eslint": "8.57.0",
-    "vitest": "4.0.18"
+    "eslint-plugin-unicorn": "71.1.0",
+    "globals": "17.7.0",
+    "knip": "6.26.0",
+    "prettier": "3.9.5",
+    "tsdown": "0.22.4",
+    "typescript": "6.0.3",
+    "typescript-eslint": "8.63.0",
+    "vitest": "4.1.10"
   }
 }

package/dist/plugin.d.mts

@@ -1,105 +0,0 @@
-/// <reference types="node" />
-import * as ventojs 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
-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 {
-    readonly observable: symbol;
-  }
-}
-/**
-Allows creating a union type by combining primitive types and literal types without sacrificing auto-completion in IDEs for the literal type part of the union.
-
-Currently, when a union type of a primitive type is combined with literal types, TypeScript loses all information about the combined literals. Thus, when such type is used in an IDE with autocompletion, no suggestions are made for the declared literals.
-
-This type is a workaround for [Microsoft/TypeScript#29729](https://github.com/Microsoft/TypeScript/issues/29729). It will be removed as soon as it's not needed anymore.
-
-@example
-```
-import type {LiteralUnion} from 'type-fest';
-
-// Before
-
-type Pet = 'dog' | 'cat' | string;
-
-const pet: Pet = '';
-// Start typing in your TypeScript-enabled IDE.
-// You **will not** get auto-completion for `dog` and `cat` literals.
-
-// After
-
-type Pet2 = LiteralUnion<'dog' | 'cat', string>;
-
-const pet: Pet2 = '';
-// You **will** get auto-completion for `dog` and `cat` literals.
-```
-
-@category Type
-*/
-//#endregion
-//#region src/types/utilities.d.ts
-/**
- * Matches any given string so autocomplete in literal unions works as expected
- */
-type AnyString = string & Record<never, never>;
-//#endregion
-//#region src/types/eleventy.d.ts
-interface UserConfig extends _UserConfig {
-  directories: {
-    input: string;
-    output: string;
-    includes: string;
-    layouts: string;
-  };
-}
-//#endregion
-//#region src/types/options.d.ts
-interface PluginOptions {
-  /**
-   * An array of Vento plugins
-   */
-  plugins: Plugin[];
-  /**
-   * Enables Vento's autotrim plugin.
-   * @example
-   * // Set to an array of tags
-   * autotrim: ['tag1', 'tag2']
-   * @example
-   * // Use Vento's defaults and Eleventy paired shortcodes
-   * // Setting `true` is functionally equivalent to both
-   * // `@vento` and `@11ty` being present
-   * autotrim: ['@vento', '@11ty']
-   * autotrim: true
-   */
-  autotrim: ('@11ty' | '@vento' | AnyString)[] | boolean;
-  /**
-   * Enable use of Eleventy filters
-   */
-  filters: boolean;
-  /**
-   * Enable use of Eleventy shortcodes
-   */
-  shortcodes: boolean;
-  /**
-   * Enable use of Eleventy paired shortcodes
-   */
-  pairedShortcodes: boolean;
-  /**
-   * A Vento configuration object.
-   * @see {@link https://vento.js.org/configuration/}
-   * @default
-   * {
-   *   // Defaults to Eleventy's own `includes` directory
-   *   includes: eleventyConfig.directories.includes
-   * }
-   */
-  ventoOptions: ventojs.Options;
-}
-//#endregion
-//#region src/plugin.d.ts
-declare function VentoPlugin(eleventyConfig: UserConfig, userOptions?: Partial<PluginOptions>): void;
-//#endregion
-export { VentoPlugin };

package/dist/plugin.mjs

@@ -1,259 +0,0 @@
-import path from "node:path";
-import autotrimPlugin, { defaultTags } from "ventojs/plugins/auto_trim.js";
-import createVentoEnv 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 tag = (env, token, output, tokens) => {
-		const code = token[1];
-		if (!(code === tagInfo.name || code.startsWith(`${tagInfo.name} `))) return;
-		const { dataVarname } = env.options;
-		const thisArg = `{
-			page: ${dataVarname}.page,
-			eleventy: ${dataVarname}.eleventy
-		}`;
-		const fn = `__env.utils.eleventyFunctions.${tagInfo.group}.${tagInfo.name}`;
-		const args = [code.replace(tagInfo.name, "").trim()];
-		const compiled = [];
-		if (IS_PAIRED) {
-			const nestedVarname = `__content${output.startsWith("__content") ? LEVEL++ : 0}`;
-			args.unshift(env.compileFilters(tokens, nestedVarname, env.options.autoescape));
-			compiled.push("{", `let ${nestedVarname} = "";`, ...env.compileTokens(tokens, nestedVarname, `/${tagInfo.name}`));
-		}
-		args.unshift(thisArg);
-		compiled.push("{", `const __result = await ${fn}.call(${args.filter(Boolean).join(", ")});`, `${output} += ${env.compileFilters(tokens, "__result", env.options.autoescape)}`, "}");
-		if (IS_PAIRED) compiled.push("}");
-		return compiled.join("\n");
-	};
-	return Object.defineProperty(tag, "name", { value: `${tagInfo.name}_${IS_PAIRED ? `EleventyPairedTag` : `EleventyTag`}` });
-}
-//#endregion
-//#region src/utils/logging.ts
-const debug = {
-	main: createDebugger("Eleventy:Vento"),
-	get cache() {
-		return this.main.extend("Cache");
-	},
-	get render() {
-		return this.main.extend("Render");
-	},
-	get error() {
-		return this.main.extend("Error");
-	}
-};
-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])/;
-var EleventyVentoError = class extends Error {
-	constructor(message, context, cause) {
-		super(message, { cause });
-		this.context = context;
-	}
-	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 === 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}`;
-		if (ctx.position === void 0 || ctx.source === void 0) return err;
-		const sourceLines = codeToLines(ctx.source);
-		const [sourceLine, sourceColumn] = locateInCode(sourceLines, ctx.position);
-		err.message += `:${sourceLine}:${sourceColumn}:\n\n`;
-		const pad = sourceLine.toString().length;
-		const indent = " ".repeat(pad);
-		for (let line = Math.max(sourceLine - 3, 1); line <= sourceLine; line++) err.message += `${`${line}`.padStart(pad)} │ ${sourceLines[line - 1].trimEnd()}\n`;
-		err.message += `${indent}   ${" ".repeat(sourceColumn - 1)}^`;
-		if (!ctx.code || ctx.line === void 0 || ctx.column === void 0) return err;
-		const codelines = codeToLines(ctx.code);
-		err.message += `\n\n${indent} │ /// compiled Vento function for ${ctx.file} ///\n${indent} │ ${codelines[ctx.line - 1].trimEnd()}\n${indent}   ${" ".repeat(ctx.column - 1)}^`;
-		return err;
-	}
-};
-/**
-* Converts a code string to an array of lines
-*/
-function codeToLines(code) {
-	const doubleLines = code.split(LINE_TERMINATOR);
-	const lines = [];
-	for (let i = 0; i < doubleLines.length; i += 2) lines.push(`${doubleLines[i]}${doubleLines[i + 1] ?? ""}`);
-	return lines;
-}
-/**
-* Identifies the line/column location from a character index
-*/
-function locateInCode(lines, position) {
-	if (position < 0) return [1, 1];
-	let index = 0;
-	for (const [line, content] of lines.entries()) {
-		const { length } = content;
-		if (position < index + length) return [line + 1, position - index + 1];
-		index += length;
-	}
-	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: {}
-	};
-	function loadPlugins(plugins) {
-		for (const plugin of plugins) env.use(plugin);
-	}
-	function loadFilters(filters) {
-		for (const [name, fn] of Object.entries(filters)) env.filters[name] = function(...args) {
-			const { page, eleventy } = this.data;
-			return fn.apply({
-				...this,
-				page,
-				eleventy
-			}, args);
-		};
-	}
-	function loadShortcodes(shortcodes) {
-		for (const [name, fn] of Object.entries(shortcodes)) {
-			env.utils.eleventyFunctions.shortcodes[name] = fn;
-			const shortcodeTag = createVentoTag({
-				name,
-				group: "shortcodes"
-			});
-			env.tags.push(shortcodeTag);
-		}
-	}
-	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);
-		}
-	}
-	async function getTemplateFunction(source, file, useVentoCache = true) {
-		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;
-		}
-	}
-	return {
-		cache: env.cache,
-		loadPlugins,
-		loadFilters,
-		loadShortcodes,
-		loadPairedShortcodes,
-		getTemplateFunction
-	};
-}
-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) {
-	debug.main("Initializing eleventy-plugin-vento");
-	eleventyConfig.versionCheck(">=3.0.0");
-	const options = {
-		autotrim: false,
-		plugins: [],
-		filters: true,
-		shortcodes: true,
-		pairedShortcodes: true,
-		ventoOptions: { includes: eleventyConfig.directories.includes },
-		...userOptions
-	};
-	debug.main("Merged default and user config: %O", options);
-	const filters = eleventyConfig.getFilters();
-	debug.main("Reading filters from Eleventy: %o", filters);
-	const shortcodes = eleventyConfig.getShortcodes();
-	debug.main("Reading shortcodes from Eleventy: %o", shortcodes);
-	const pairedShortcodes = eleventyConfig.getPairedShortcodes();
-	debug.main("Reading paired shortcodes from Eleventy: %o", pairedShortcodes);
-	if (options.autotrim) {
-		const tagSet = new Set(options.autotrim === true ? ["@vento", "@11ty"] : options.autotrim);
-		if (tagSet.has("@vento")) {
-			tagSet.delete("@vento");
-			for (const name of defaultTags) tagSet.add(name);
-		}
-		if (tagSet.has("@11ty")) {
-			tagSet.delete("@11ty");
-			for (const name in pairedShortcodes) tagSet.add(name);
-		}
-		debug.main("Enabled autotrim for tags: %o", tagSet);
-		options.plugins.push(autotrimPlugin({ tags: [...tagSet] }));
-	}
-	debug.main("Initializing Vento environment");
-	const engine = createVentoEngine(options.ventoOptions);
-	debug.main("Loading plugins: %o", options.plugins);
-	engine.loadPlugins(options.plugins);
-	if (options.filters) {
-		debug.main("Loading filters: %o", filters);
-		engine.loadFilters(filters);
-	}
-	if (options.shortcodes) {
-		debug.main("Loading shortcodes: %o", shortcodes);
-		engine.loadShortcodes(shortcodes);
-	}
-	if (options.pairedShortcodes) {
-		debug.main("Loading paired shortcodes: %o", pairedShortcodes);
-		engine.loadPairedShortcodes(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("Registering .vto as a template format");
-	eleventyConfig.addTemplateFormats("vto");
-	debug.main("Registering .vto extension with eleventy");
-	eleventyConfig.addExtension("vto", {
-		outputFileExtension: "html",
-		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);
-		},
-		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);
-		} }
-	});
-	debug.main("eleventy-plugin-vento initialized");
-}
-//#endregion
-export { VentoPlugin };