eleventy-plugin-vento 3.2.0 → 4.0.0-beta.0

package/CHANGELOG.md

@@ -1,5 +1,57 @@
 # eleventy-plugin-vento
 
+## 4.0.0-beta.0
+
+### Major Changes
+
+- fc80b5f: Removed ignore tag `{{! ... }}` syntax. As mentioned in the 3.3.0 release notes, the now preferred way to "pass through" tags is with string literals.
+
+  You should update code with `{{! ... }}` to be `{{ '{{ }}' }}` like so:
+
+  ```diff
+  - {{! if condition }}
+  + {{ '{{ if condition }}' }}
+      do something
+  - {{! /if }}
+  - {{ '{{ /if }}' }}
+  ```
+
+  While more verbose, this change ensures that there isn't any ambiguity between a tag that needs ignoring and JS negation expressions.
+
+### Minor Changes
+
+- 2b5f337: Rewrite project in Typescript and add a build/packaging step for releases and testing.
+
+  These changes also include `.d.ts` generation as part of the build step. If you're using `11ty.ts`'s `defineConfig` function, it will pick the types from this plugin up automatically. (resolves #22)
+
+## 3.3.0
+
+### Minor Changes
+
+- 387eb48: ⚠️ DEPRECATION NOTICE: Ignore tag `{{! ... }}` syntax is now deprecated and will be removed in 4.0.0.
+
+  This change comes in favor of using string literals to "pass through" tags without rendering them, like so:
+
+  ```diff
+  - {{! if condition }}
+  + {{ '{{ if condition }}' }}
+      do something
+  - {{! /if }}
+  - {{ '{{ /if }}' }}
+  ```
+
+  While more verbose, this change ensures that there isn't any ambiguity between a tag that needs ignoring and JS negation expressions:
+
+  ```hbs
+  <!-- These are functionally equivalent and can lead to collisions in rendering functionality -->
+
+  {{! conditionStatementToIgnore }}
+
+  {{ !conditionStatementToIgnore }}
+  ```
+
+  If an improved syntax for deferred rendering scenarios ever makes its way to Vento, it will be made available in this plugin.
+
 ## 3.2.0
 
 ### Minor Changes

package/dist/index.d.ts

@@ -0,0 +1,46 @@
+import { UserConfig } from '@11ty/eleventy';
+import { Options } from 'ventojs';
+import { Plugin } from 'ventojs/src/environment.js';
+
+type AutotrimConfig = boolean | ('@11ty' | '@vento' | (string & Record<never, never>))[];
+interface VentoPluginOptions {
+    /**
+     * An array of Vento plugins
+     */
+    plugins: Plugin[];
+    /**
+     * Enables Vento's autotrim plugin.
+     * ```js
+     * // Set to an array of tags
+     * autotrim: ['tag1', 'tag2']
+     *
+     * // Use Vento's defaults and Eleventy paired shortcodes
+     * // If set to `true`, uses both
+     * autotrim: ['@vento', '@11ty']
+     * autotrim: true
+     * ```
+     */
+    autotrim: AutotrimConfig;
+    /** 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.
+     *
+     * **Note that `ventoOptions.includes` defaults to
+     * Eleventy's own `dir.includes` location.**
+     * @see {@link https://vento.js.org/configuration/}
+     */
+    ventoOptions: Options;
+}
+
+/**
+ * @file Main plugin declaration
+ */
+
+declare function VentoPlugin(eleventyConfig: UserConfig, userOptions: Partial<VentoPluginOptions>): void;
+
+export { VentoPlugin };

package/dist/index.js

@@ -0,0 +1,244 @@
+// src/index.ts
+import path from "node:path";
+import autotrimPlugin, { defaultTags as autotrimDefaultTags } from "ventojs/plugins/auto_trim.js";
+
+// src/engine.ts
+import { default as ventojs } from "ventojs";
+
+// src/modules/create-vento-tag.ts
+function createVentoTag(spec) {
+  const IS_PAIRED = spec.group === "pairedShortcodes";
+  const tag = (env, code, output, tokens) => {
+    if (!code.startsWith(spec.name)) return;
+    const fn = `__env.utils._11tyFns.${spec.group}.${spec.name}`;
+    const ctx = "__env.utils._11tyCtx";
+    const args = [code.replace(spec.name, "").trim()];
+    const varname = output.startsWith("__shortcode_content") ? `${output}_precomp` : "__shortcode_content";
+    const compiled = [];
+    if (IS_PAIRED) {
+      args.unshift(env.compileFilters(tokens, varname, env.options.autoescape));
+      compiled.push(
+        "{",
+        `let ${varname} = "";`,
+        ...env.compileTokens(tokens, varname, [`/${spec.name}`])
+      );
+      if (tokens.length > 0 && (tokens[0][0] !== "tag" || tokens[0][1] !== `/${spec.name}`)) {
+        throw new Error(`Vento: Missing closing tag for ${spec.name} tag: ${code}`);
+      }
+      tokens.shift();
+    }
+    args.unshift(ctx);
+    compiled.push(
+      "{",
+      `const __shortcode_result = await ${fn}.call(${args.filter(Boolean).join(", ")});`,
+      `${output} += ${env.compileFilters(tokens, "__shortcode_result", env.options.autoescape)}`,
+      "}"
+    );
+    if (IS_PAIRED) {
+      compiled.push("}");
+    }
+    const compiledTag = compiled.join("\n");
+    return compiledTag;
+  };
+  return Object.defineProperty(tag, "name", {
+    value: spec.name + IS_PAIRED ? `PairedTag` : `Tag`
+  });
+}
+
+// src/modules/utils.ts
+import createDebugger from "debug";
+var debugBaseNamespace = "Eleventy:Vento";
+var DEBUG = {
+  setup: createDebugger(`${debugBaseNamespace}:Setup`),
+  cache: createDebugger(`${debugBaseNamespace}:Cache`),
+  render: createDebugger(`${debugBaseNamespace}:Render`)
+};
+var REQUIRED_API_METHODS = [
+  ["getShortcodes", "v3.0.0-alpha.15"],
+  ["getPairedShortcodes", "v3.0.0-alpha.15"],
+  ["getFilters", "v3.0.0-alpha.15"],
+  ["addExtension", "v1.0.0"]
+];
+var CONTEXT_DATA_KEYS = ["page", "eleventy"];
+function runCompatibilityCheck(config) {
+  DEBUG.setup("Run compatibility check");
+  for (const [method, version] of REQUIRED_API_METHODS) {
+    if (!(method in config)) {
+      console.error(
+        "[eleventy-plugin-vento] Plugin compatibility error:",
+        `\`${method}\``,
+        "not found. Please use Eleventy",
+        version,
+        "or later."
+      );
+    }
+  }
+}
+
+// src/engine.ts
+function createVentoEngine(options) {
+  const env = ventojs(options);
+  env.utils._11tyFns = { shortcodes: {}, pairedShortcodes: {} };
+  env.utils._11tyCtx = {};
+  function setContext(newContext) {
+    if (env.utils._11tyCtx?.page?.inputPath === newContext?.page?.inputPath) {
+      return;
+    }
+    for (const K of CONTEXT_DATA_KEYS) {
+      env.utils._11tyCtx[K] = newContext[K];
+    }
+    DEBUG.setup("Reload context, new context is: %o", env.utils._11tyCtx);
+  }
+  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] = fn.bind(env.utils._11tyCtx);
+    }
+  }
+  function loadShortcodes(shortcodes) {
+    for (const [name, fn] of Object.entries(shortcodes)) {
+      env.utils._11tyFns.shortcodes[name] = fn;
+      env.tags.push(createVentoTag({ name, group: "shortcodes" }));
+    }
+  }
+  function loadPairedShortcodes(pairedShortcodes) {
+    for (const [name, fn] of Object.entries(pairedShortcodes)) {
+      env.utils._11tyFns.pairedShortcodes[name] = fn;
+      env.tags.push(createVentoTag({ name, group: "pairedShortcodes" }));
+    }
+  }
+  function getTemplateFunction(source, file, useVentoCache = true) {
+    let template = env.cache.get(file);
+    if (template?.source === source) {
+      DEBUG.cache("Cache HIT for `%s`, used precompiled template", file);
+    } else {
+      template = env.compile(source, file);
+      DEBUG.cache(
+        `Cache MISS for \`%s\`, compiled new template:
+Use Vento cache: %o
+
+${template}`,
+        file,
+        useVentoCache
+      );
+      if (useVentoCache) {
+        env.cache.set(file, template);
+      }
+    }
+    return template;
+  }
+  async function render(template, data, from) {
+    setContext(data);
+    DEBUG.render("Rendering `%s`", from);
+    const { content } = await template(data);
+    return content;
+  }
+  return {
+    cache: env.cache,
+    loadPlugins,
+    loadFilters,
+    loadShortcodes,
+    loadPairedShortcodes,
+    getTemplateFunction,
+    render
+  };
+}
+
+// src/index.ts
+function VentoPlugin(eleventyConfig, userOptions) {
+  DEBUG.setup("Initializing eleventy-plugin-vento");
+  runCompatibilityCheck(eleventyConfig);
+  const options = {
+    // Define defaults
+    autotrim: false,
+    plugins: [],
+    filters: true,
+    shortcodes: true,
+    pairedShortcodes: true,
+    ventoOptions: {
+      includes: eleventyConfig.directories.includes
+    },
+    // Merge in user-provided options
+    ...userOptions
+  };
+  DEBUG.setup("Merged default and user config: %O", options);
+  const filters = eleventyConfig.getFilters();
+  DEBUG.setup("Reading filters from Eleventy: %o", filters);
+  const shortcodes = eleventyConfig.getShortcodes();
+  DEBUG.setup("Reading shortcodes from Eleventy: %o", shortcodes);
+  const pairedShortcodes = eleventyConfig.getPairedShortcodes();
+  DEBUG.setup("Reading paired shortcodes from Eleventy: %o", pairedShortcodes);
+  if (options.autotrim) {
+    const defaults = ["@vento", "@11ty"];
+    const tagSet = new Set(options.autotrim === true ? defaults : options.autotrim);
+    if (tagSet.has("@vento")) {
+      tagSet.delete("@vento");
+      for (const name of autotrimDefaultTags) {
+        tagSet.add(name);
+      }
+    }
+    if (tagSet.has("@11ty")) {
+      tagSet.delete("@11ty");
+      for (const name in pairedShortcodes) {
+        tagSet.add(name);
+      }
+    }
+    DEBUG.setup("Enabled autotrim for tags: %o", tagSet);
+    options.plugins.push(autotrimPlugin({ tags: [...tagSet] }));
+  }
+  DEBUG.setup("Initializing Vento environment");
+  const engine = createVentoEngine(options.ventoOptions);
+  DEBUG.setup("Loading plugins: %o", options.plugins);
+  engine.loadPlugins(options.plugins);
+  if (options.filters) {
+    DEBUG.setup("Loading filters: %o", filters);
+    engine.loadFilters(filters);
+  }
+  if (options.shortcodes) {
+    DEBUG.setup("Loading shortcodes: %o", shortcodes);
+    engine.loadShortcodes(shortcodes);
+  }
+  if (options.pairedShortcodes) {
+    DEBUG.setup("Loading paired shortcodes: %o", pairedShortcodes);
+    engine.loadPairedShortcodes(pairedShortcodes);
+  }
+  DEBUG.setup("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.setup("Registering .vto as a template format");
+  eleventyConfig.addTemplateFormats("vto");
+  DEBUG.setup("Registering .vto extension with eleventy");
+  eleventyConfig.addExtension("vto", {
+    outputFileExtension: "html",
+    read: true,
+    compile(inputContent, inputPath) {
+      inputPath = path.normalize(inputPath);
+      const template = engine.getTemplateFunction(inputContent, inputPath, false);
+      return async (data) => await engine.render(template, data, inputPath);
+    },
+    compileOptions: {
+      // Custom permalink compilation
+      permalink(permalinkContent, inputPath) {
+        if (typeof permalinkContent === "string" && /\{\{\s+.+\s+\}\}/.test(permalinkContent)) {
+          inputPath = "Permalink::" + path.normalize(inputPath);
+          const template = engine.getTemplateFunction(permalinkContent, inputPath);
+          return async (data) => await engine.render(template, data, inputPath);
+        }
+        return permalinkContent;
+      }
+    }
+  });
+  DEBUG.setup("eleventy-plugin-vento initialized");
+}
+export {
+  VentoPlugin
+};

package/package.json

@@ -1,16 +1,23 @@
 {
   "name": "eleventy-plugin-vento",
-  "version": "3.2.0",
+  "version": "4.0.0-beta.0",
   "description": "Adds support for the Vento templating language to Eleventy.",
   "type": "module",
   "engines": {
-    "node": ">=16"
+    "node": ">=18"
   },
   "exports": {
     ".": {
-      "import": "./src/index.js"
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts"
     }
   },
+  "files": [
+    "dist/*",
+    "LICENSE",
+    "CHANGELOG.md",
+    "readme.md"
+  ],
   "repository": "git@github.com:noelforte/eleventy-plugin-vento.git",
   "bugs": {
     "url": "https://github.com/noelforte/eleventy-plugin-vento/issues"
@@ -27,23 +34,25 @@
     "url": "https://forte.is/"
   },
   "license": "MIT",
-  "files": [
-    "src/*",
-    "CHANGELOG.md"
-  ],
   "dependencies": {
     "debug": "4.3.7",
     "ventojs": "1.12.10"
   },
   "devDependencies": {
+    "11ty.ts": "0.0.5",
     "@11ty/eleventy": "3.0.0",
     "@changesets/cli": "2.27.9",
     "@eslint/js": "9.13.0",
+    "@types/debug": "4.1.12",
+    "@types/eslint-config-prettier": "6.11.3",
+    "@types/eslint__js": "8.42.3",
+    "@types/node": "22.8.4",
     "eslint": "9.13.0",
-    "eslint-config-flat-gitignore": "0.3.0",
     "eslint-config-prettier": "9.1.0",
     "eslint-plugin-unicorn": "56.0.0",
-    "globals": "15.11.0",
+    "tsup": "8.3.5",
+    "typescript": "5.6.3",
+    "typescript-eslint": "8.12.2",
     "vitest": "2.1.4"
   },
   "prettier": {
@@ -53,8 +62,11 @@
     "trailingComma": "es5"
   },
   "scripts": {
-    "test": "vitest",
-    "lint": "eslint '**/*.js'",
+    "test": "vitest --run",
+    "check": "pnpm --color run '/ts-check|lint/'",
+    "lint": "eslint '.'",
+    "ts-check": "tsc --noEmit",
+    "build": "tsup",
     "ci:version": "changeset version && pnpm install --no-frozen-lockfile",
     "ci:publish": "changeset publish",
     "ci:generate-changesets": "node ./scripts/generate-changesets.js",

package/readme.md

@@ -16,7 +16,6 @@ An [Eleventy](https://11ty.dev/) plugin that adds support for [Vento](https://ve
 [Shortcodes (Single & Paired)](#shortcodes-single--paired)<br>
 [Vento Plugins](#vento-plugins)<br>
 [Auto-Trimming Tags](#auto-trimming-tags)<br>
-[Ignoring Tags](#ignoring-tags)<br>
 [Debugging](#debugging)<br>
 
 ## Installing
@@ -136,7 +135,7 @@ For paired shortcodes, the syntax is the same, just add a closing tag. Paired sh
 
 If you'd prefer to set shortcodes yourself (via a plugin or other method) or prevent Eleventy from loading shortcodes into Vento, set `shortcodes: false` and/or `pairedShortcodes: false` in the plugin options.
 
-> [!CAUTION]
+> [!IMPORTANT]
 > While it's straightforward to load filters via a Vento plugin that appends filters to the filters object as `env.filters.[filter_name]()`, creating custom tags in Vento is more involved. It's highly advised to keep these two options enabled unless you know what you're doing.
 
 ### Relevant Documentation
@@ -199,74 +198,6 @@ eleventyConfig.addPlugin(VentoPlugin, {
 
 Vento: See [Auto Trim Plugin](https://vento.js.org/plugins/auto-trim/).
 
-## Ignoring Tags
-
-Exclusive to this plugin is the ability to skip processing a vento tag entirely and instead preserve the tag in the markup. This could be useful if you're doing some hybrid rendering and would like to defer certain tags from being processed until load time, so they can be rendered on the server.
-
-This feature is enabled through use of the `enableIgnoreTag` plugin option.
-
-```js
-eleventyConfig.addPlugin(VentoPlugin, {
-  enableIgnoreTag: true,
-});
-```
-
-To skip over a tag, add a `!` directly after the opening tag.
-
-```nunjucks
-<!-- This: -->
-{{! doSomeServerSideStuff() }}
-
-<!-- Renders as: -->
-{{ doSomeServerSideStuff() }}
-```
-
-Works with JS expressions too:
-
-```nunjucks
-{{!> 2 + 2 }}
-
-<!-- Renders as: -->
-{{> 2 + 2 }}
-```
-
-The Vento language offers similar functionality via the [`echo` tag](https://vento.js.org/syntax/print/#echo) which works great for blocks, but can be verbose for 1-off tags.
-
-Consider the following:
-
-```nunjucks
-{{ echo }}
-  <!-- Will be preserved in output -->
-  {{ if someCondition }}
-    <p>{{ getServerData }}</p>
-{{ /echo }}
-
-    <!-- Can't render this without exiting and re-entering echo -->
-    <p>Page built on: {{ localBuildTime }}</p>
-
-{{ echo }}
-  {{ /if }}
-{{ /echo }}
-```
-
-Rather than having to do multiple `{{ /echo }} ... {{ echo }}` statements, the previous can be rewritten as such:
-
-```nunjucks
-<!-- This: -->
-{{! if someCondition }}
-  <p>{{! getServerData }}</p>
-
-  <p>Page built on: {{ localBuildTime }}</p>
-{{! /if }}
-
-<!-- Renders as: -->
-{{ if someCondition }}
-  <p>{{ getServerData }}</p>
-
-  <p>Page built on: 09-19-2024</p>
-{{ /if }}
-```
-
 ## Debugging
 
 Like Eleventy, this plugin uses the [`debug`](https://www.npmjs.com/package/debug) package to handle verbose logging. The following `DEBUG` namespaces are implemented:

package/src/engine.js

@@ -1,126 +0,0 @@
-/**
- * @file Function that handles creating the Vento environment. Exposes
- * a simple API for Eleventy to interface with.
- *
- * @typedef {{eleventy?: Record<string, unknown>, page?: Record<string, unknown>}} EleventyContext
- * @typedef {EleventyContext & Record<string, unknown>} EleventyData
- * @typedef {(...args: unknown[]) => unknown} EleventyFunction
- * @typedef {Record<string, EleventyFunction>} EleventyFunctionSet
- * @typedef {import('ventojs/src/environment.js').Environment} VentoEnvironment
- * @typedef {VentoEnvironment & {
- *  utils: {
- * 	_11tyFns: { shortcodes: EleventyFunctionSet, pairedShortcodes: EleventyFunctionSet }
- * 	_11tyCtx: EleventyContext
- * }
- * }} EleventyVentoEnvironment
- */
-
-// External library
-import ventojs from 'ventojs';
-
-// Internal modules
-import { createVentoTag } from './modules/create-vento-tag.js';
-import { CONTEXT_DATA_KEYS, DEBUG } from './modules/utils.js';
-
-/** @param {import('ventojs').Options} options */
-export function createVentoEngine(options) {
-	/** @type {EleventyVentoEnvironment} */
-	const env = ventojs(options);
-	env.utils._11tyFns = { shortcodes: {}, pairedShortcodes: {} };
-	env.utils._11tyCtx = {};
-
-	/** @param {EleventyData} newContext */
-	function setContext(newContext) {
-		if (env.utils._11tyCtx?.page?.inputPath === newContext?.page?.inputPath) {
-			return;
-		}
-
-		for (const K of CONTEXT_DATA_KEYS) {
-			env.utils._11tyCtx[K] = newContext[K];
-		}
-
-		DEBUG.setup('Reload context, new context is: %o', env.utils._11tyCtx);
-	}
-
-	/** @param {import('ventojs/src/environment.js').Plugin[]} plugins */
-	function loadPlugins(plugins) {
-		for (const plugin of plugins) {
-			env.use(plugin);
-		}
-	}
-
-	/** @param {Record<string, EleventyFunction>} filters */
-	function loadFilters(filters) {
-		for (const [name, fn] of Object.entries(filters)) {
-			env.filters[name] = fn.bind(env.utils._11tyCtx);
-		}
-	}
-
-	/** @param {Record<string, EleventyFunction>} shortcodes */
-	function loadShortcodes(shortcodes) {
-		for (const [name, fn] of Object.entries(shortcodes)) {
-			env.utils._11tyFns.shortcodes[name] = fn;
-			env.tags.push(createVentoTag({ name, group: 'shortcodes' }));
-		}
-	}
-
-	/** @param {Record<string, EleventyFunction>} pairedShortcodes */
-	function loadPairedShortcodes(pairedShortcodes) {
-		for (const [name, fn] of Object.entries(pairedShortcodes)) {
-			env.utils._11tyFns.pairedShortcodes[name] = fn;
-			env.tags.push(createVentoTag({ name, group: 'pairedShortcodes' }));
-		}
-	}
-
-	/**
-	 * @param {string} source
-	 * @param {string} file
-	 * @param {boolean} [useVentoCache=true]
-	 */
-	function getTemplateFunction(source, file, useVentoCache = true) {
-		// Attempt to retrieve template function from cache
-		let template = env.cache.get(file);
-
-		if (template?.source === source) {
-			DEBUG.cache('Cache HIT for `%s`, used precompiled template', file);
-		} else {
-			template = env.compile(source, file);
-
-			DEBUG.cache(
-				`Cache MISS for \`%s\`, compiled new template:\nUse Vento cache: %o\n\n${template}`,
-				file,
-				useVentoCache
-			);
-			if (useVentoCache) {
-				env.cache.set(file, template);
-			}
-		}
-
-		return template;
-	}
-
-	/**
-	 * @param {import('ventojs/src/environment.js').Template} template
-	 * @param {EleventyData} data
-	 * @param {string} from
-	 */
-	async function render(template, data, from) {
-		// Load new context
-		setContext(data);
-
-		// Render template
-		DEBUG.render('Rendering `%s`', from);
-		const { content } = await template(data);
-		return content;
-	}
-
-	return {
-		cache: env.cache,
-		loadPlugins,
-		loadFilters,
-		loadShortcodes,
-		loadPairedShortcodes,
-		getTemplateFunction,
-		render,
-	};
-}

package/src/index.js

@@ -1,177 +0,0 @@
-/**
- * @file Main plugin declaration
- *
- * @typedef VentoPluginOptions
- * @prop {import('ventojs/src/environment.js').Plugin[]} plugins
- * Array of vento plugins to use when compiling templates
- * @prop {boolean|string[]} autotrim
- * Enable Vento's [`autoTrim`](https://vento.js.org/plugins/auto-trim/)
- * plugin to remove whitespace from tags in output
- * @prop {boolean} [shortcodes=true]
- * Create vento tags for Eleventy [Shortcodes](https://www.11ty.dev/docs/shortcodes/)
- * @prop {boolean} [pairedShortcodes=true]
- * Create vento tags for Eleventy [Paired Shortcodes](https://www.11ty.dev/docs/shortcodes/#paired-shortcodes)
- * @prop {boolean} [filters=true]
- * Create vento filters for Eleventy [Filters](https://www.11ty.dev/docs/filters/)
- * @prop {boolean} [ignoreTag=false]
- * Enables/disables tag ignore (`{{! ... }}`) syntax in templates
- * @prop {import('ventojs').Options} ventoOptions
- * Options to pass on to the `ventojs` engine.
- * (See [Vento Docs](https://vento.js.org/configuration/#options))
- */
-
-// Built-ins
-import path from 'node:path';
-
-// External modules
-import autotrimPlugin, { defaultTags as autotrimDefaultTags } from 'ventojs/plugins/auto_trim.js';
-
-// Local modules
-import { createVentoEngine } from './engine.js';
-import { ignoreTagPlugin } from './modules/ignore-tag.js';
-import { DEBUG, runCompatibilityCheck } from './modules/utils.js';
-
-/**
- * @param {import('@11ty/eleventy').UserConfig} eleventyConfig
- * @param {Partial<VentoPluginOptions>} userOptions
- */
-export function VentoPlugin(eleventyConfig, userOptions) {
-	DEBUG.setup('Initializing eleventy-plugin-vento');
-	runCompatibilityCheck(eleventyConfig);
-
-	/** @type {VentoPluginOptions} */
-	const options = {
-		// Define defaults
-		autotrim: false,
-		plugins: [],
-		filters: true,
-		shortcodes: true,
-		pairedShortcodes: true,
-		ignoreTag: false,
-		ventoOptions: {
-			includes: eleventyConfig.directories.includes,
-		},
-
-		// Merge in user-provided options
-		...userOptions,
-	};
-
-	DEBUG.setup('Merged default and user config: %O', options);
-
-	// Get list of filters, shortcodes and paired shortcodes
-	const filters = eleventyConfig.getFilters();
-	DEBUG.setup('Reading filters from Eleventy: %o', filters);
-
-	const shortcodes = eleventyConfig.getShortcodes();
-	DEBUG.setup('Reading shortcodes from Eleventy: %o', shortcodes);
-
-	const pairedShortcodes = eleventyConfig.getPairedShortcodes();
-	DEBUG.setup('Reading paired shortcodes from Eleventy: %o', pairedShortcodes);
-
-	// Add autotrim plugin if enabled
-	if (options.autotrim) {
-		const defaults = ['@vento', '@11ty'];
-
-		/** @type {Set<string>} */
-		const tagSet = new Set(options.autotrim === true ? defaults : options.autotrim);
-
-		if (tagSet.has('@vento')) {
-			tagSet.delete('@vento');
-			for (const name of autotrimDefaultTags) {
-				tagSet.add(name);
-			}
-		}
-
-		if (tagSet.has('@11ty')) {
-			tagSet.delete('@11ty');
-			for (const name in pairedShortcodes) {
-				tagSet.add(name);
-			}
-		}
-
-		DEBUG.setup('Enabled autotrim for tags: %o', tagSet);
-
-		options.plugins.push(autotrimPlugin({ tags: [...tagSet] }));
-	}
-
-	// Add ignore tag plugin if enabled
-	if (options.ignoreTag) {
-		DEBUG.setup('Enabling `{{! ... }}` tag syntax');
-		options.plugins.push(ignoreTagPlugin);
-	}
-
-	// Create the vento engine instance
-	DEBUG.setup('Initializing Vento environment');
-	const engine = createVentoEngine(options.ventoOptions);
-
-	// Load plugins
-	DEBUG.setup('Loading plugins: %o', options.plugins);
-	engine.loadPlugins(options.plugins);
-
-	// Add filters, single and paired shortcodes if enabled
-	if (options.filters) {
-		DEBUG.setup('Loading filters: %o', filters);
-		engine.loadFilters(filters);
-	}
-	if (options.shortcodes) {
-		DEBUG.setup('Loading shortcodes: %o', shortcodes);
-		engine.loadShortcodes(shortcodes);
-	}
-	if (options.pairedShortcodes) {
-		DEBUG.setup('Loading paired shortcodes: %o', pairedShortcodes);
-		engine.loadPairedShortcodes(pairedShortcodes);
-	}
-
-	// Handle emptying the cache when files are updated
-	DEBUG.setup('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);
-		}
-	});
-
-	// Add vto as a template format
-	DEBUG.setup('Registering .vto as a template format');
-	eleventyConfig.addTemplateFormats('vto');
-
-	// Add extension handling
-	DEBUG.setup('Registering .vto extension with eleventy');
-	eleventyConfig.addExtension('vto', {
-		outputFileExtension: 'html',
-		read: true,
-
-		compile(inputContent, inputPath) {
-			// Normalize input path
-			inputPath = path.normalize(inputPath);
-
-			// Retrieve the template function
-			const template = engine.getTemplateFunction(inputContent, inputPath, false);
-
-			// Return a render function
-			return async (data) => await engine.render(template, data, inputPath);
-		},
-
-		compileOptions: {
-			// Custom permalink compilation
-			permalink(permalinkContent, inputPath) {
-				// Short circuit if input isn't a string and doesn't look like a vento template
-				if (typeof permalinkContent === 'string' && /\{\{\s+.+\s+\}\}/.test(permalinkContent)) {
-					// Normalize input path
-					inputPath = 'Permalink::' + path.normalize(inputPath);
-
-					// Retrieve the template function
-					const template = engine.getTemplateFunction(permalinkContent, inputPath);
-
-					// Return a render function
-					return async (data) => await engine.render(template, data, inputPath);
-				}
-
-				return permalinkContent;
-			},
-		},
-	});
-
-	DEBUG.setup('eleventy-plugin-vento initialized');
-}

package/src/modules/create-vento-tag.js

@@ -1,60 +0,0 @@
-/**
- * @file Helper function that creates vento tags from eleventy functions
- *
- * @param {{name: string, group: 'shortcodes' | 'pairedShortcodes' }} options
- */
-
-export function createVentoTag(options) {
-	const IS_PAIRED = options.group === 'pairedShortcodes';
-
-	/** @type {import("ventojs/src/environment.js").Tag} */
-	const tag = (env, code, output, tokens) => {
-		if (!code.startsWith(options.name)) return;
-
-		// Declare helper variables for repeated strings in template
-		const fn = `__env.utils._11tyFns.${options.group}.${options.name}`;
-		const ctx = '__env.utils._11tyCtx';
-		const args = [code.replace(options.name, '').trim()];
-
-		const varname = output.startsWith('__shortcode_content')
-			? `${output}_precomp`
-			: '__shortcode_content';
-
-		// Create an array to hold compiled template code
-		const compiled = [];
-
-		if (IS_PAIRED) {
-			args.unshift(env.compileFilters(tokens, varname, env.options.autoescape));
-			compiled.push(
-				'{',
-				`let ${varname} = "";`,
-				...env.compileTokens(tokens, varname, [`/${options.name}`])
-			);
-			if (tokens.length > 0 && (tokens[0][0] !== 'tag' || tokens[0][1] !== `/${options.name}`)) {
-				throw new Error(`Vento: Missing closing tag for ${options.name} tag: ${code}`);
-			}
-			tokens.shift();
-		}
-
-		args.unshift(ctx);
-
-		compiled.push(
-			'{',
-			`const __shortcode_result = await ${fn}.call(${args.filter(Boolean).join(', ')});`,
-			`${output} += ${env.compileFilters(tokens, '__shortcode_result', env.options.autoescape)}`,
-			'}'
-		);
-
-		if (IS_PAIRED) {
-			compiled.push('}');
-		}
-
-		const compiledTag = compiled.join('\n');
-
-		return compiledTag;
-	};
-
-	return Object.defineProperty(tag, 'name', {
-		value: options.name + IS_PAIRED ? `PairedTag` : `Tag`,
-	});
-}

package/src/modules/ignore-tag.js

@@ -1,15 +0,0 @@
-/**
- * @file Definition for tag that preserves vento syntax in output
- */
-
-/** @type {import('ventojs/src/environment.js').Tag} */
-function ignoreTag(_env, code, output, _tokens) {
-	if (!code.startsWith('!')) return;
-	const compiled = `{{${code.replace(/!(>?)\s+/, '$1 ')}}}`;
-	return `${output} += "${compiled}";`;
-}
-
-/** @type {import('ventojs/src/environment.js').Plugin} */
-export function ignoreTagPlugin(env) {
-	env.tags.push(ignoreTag);
-}

package/src/modules/utils.js

@@ -1,34 +0,0 @@
-// Set up debugger global
-import createDebugger from 'debug';
-const debugBaseNamespace = 'Eleventy:Vento';
-export const DEBUG = {
-	setup: createDebugger(`${debugBaseNamespace}:Setup`),
-	cache: createDebugger(`${debugBaseNamespace}:Cache`),
-	render: createDebugger(`${debugBaseNamespace}:Render`),
-};
-
-// Project-wide constants
-export const REQUIRED_API_METHODS = [
-	['getShortcodes', 'v3.0.0-alpha.15'],
-	['getPairedShortcodes', 'v3.0.0-alpha.15'],
-	['getFilters', 'v3.0.0-alpha.15'],
-	['addExtension', 'v1.0.0'],
-];
-
-export const CONTEXT_DATA_KEYS = ['page', 'eleventy'];
-
-// Helper functions
-export function runCompatibilityCheck(config) {
-	DEBUG.setup('Run compatibility check');
-	for (const [method, version] of REQUIRED_API_METHODS) {
-		if (!config?.[method]) {
-			console.error(
-				'[eleventy-plugin-vento] Plugin compatibility error:',
-				`\`${method}\``,
-				'not found. Please use Eleventy',
-				version,
-				'or later.'
-			);
-		}
-	}
-}