eleventy-plugin-vento 3.0.1 → 3.0.2

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # eleventy-plugin-vento
 
+## 3.0.2
+
+### Patch Changes
+
+- e46ce6e: Integrate eleventy and vento caching.
+
+  There have been a few issues around managing Vento's cache that have yielded uninteded results when compiling templates (ie #10, #34). This update integrates Vento's cache with Eleventy's custom extension API.
+
+  This means that whether running Eleventy in `--serve` mode or compiling dynamic permalinks, stale cache data actually gets removed so Vento can compile the template from source again.
+
+  Raise any issues if caching behavior continues to be an issue!
+
 ## 3.0.1
 
 ### Patch Changes

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eleventy-plugin-vento",
-  "version": "3.0.1",
+  "version": "3.0.2",
   "description": "Adds support for the Vento templating language to Eleventy.",
   "type": "module",
   "engines": {
@@ -35,15 +35,15 @@
     "ventojs": "1.12.10"
   },
   "devDependencies": {
-    "@11ty/eleventy": "3.0.0-beta.1",
-    "@changesets/cli": "2.27.8",
-    "eslint": "9.11.1",
+    "@11ty/eleventy": "3.0.0",
+    "@changesets/cli": "2.27.9",
+    "eslint": "9.12.0",
     "eslint-config-flat-gitignore": "0.3.0",
     "eslint-config-prettier": "9.1.0",
-    "eslint-plugin-unicorn": "55.0.0",
-    "globals": "15.9.0",
-    "vitest": "2.1.1",
-    "zx": "8.1.8"
+    "eslint-plugin-unicorn": "56.0.0",
+    "globals": "15.11.0",
+    "vitest": "2.1.2",
+    "zx": "8.1.9"
   },
   "prettier": {
     "bracketSameLine": true,
@@ -54,7 +54,7 @@
   "scripts": {
     "test": "vitest --run",
     "lint": "eslint '**/*.js'",
-    "ci:version": "npm audit signatures && changeset version && pnpm install --no-frozen-lockfile",
+    "ci:version": "changeset version && pnpm install --no-frozen-lockfile",
     "ci:publish": "changeset publish",
     "ci:generate-changesets": "node ./scripts/generate-changesets.js",
     "format": "pnpm dlx prettier --config ./package.json --write ."

package/src/engine.js

@@ -25,9 +25,14 @@ export function createVentoEngine(options) {
 	env.utils._11ty = { ctx: {}, functions: {} };
 
 	return {
-		/** @param {string?} key */
-		emptyCache(key) {
-			return key ? env.cache.delete(key) : env.cache.clear();
+		/** @param {string} path */
+		getCachedSource(path) {
+			return env.cache.get(path)?.source;
+		},
+
+		/** @param {string} path */
+		emptyCache(path) {
+			return path ? env.cache.delete(path) : env.cache.clear();
 		},
 
 		/** @param {import('ventojs/src/environment.js').Plugin[]} plugins */
@@ -63,20 +68,13 @@ export function createVentoEngine(options) {
 			}
 		},
 
-		/**
-		 * @param {PageData} data
-		 * @param {string} content
-		 * @param {string} path
-		 */
-		async process(data, content, path) {
+		/** @param {{data: PageData, source: string, path: string}} input */
+		async process(input) {
 			// Reload context
-			this.loadContext(data);
+			this.loadContext(input.data);
 
 			// Process the templates
-			const result = await env.runString(content, data, path);
-
-			// Clear the cache for this path if the input doesn't match
-			if (data.page?.rawInput !== content) env.cache.clear(path);
+			const result = await env.runString(input.source, input.data, input.path);
 
 			return result.content;
 		},

package/src/index.js

@@ -113,17 +113,25 @@ export function VentoPlugin(eleventyConfig, userOptions) {
 
 		// Main compile function
 		async compile(inputContent, inputPath) {
-			return async (data) => engine.process(data, inputContent, inputPath);
+			return async (data) => await engine.process({ data, source: inputContent, path: inputPath });
 		},
 
 		// Custom permalink compilation
 		compileOptions: {
+			cache: true,
+			getCacheKey(inputContent, inputPath) {
+				if (engine.getCachedSource(inputPath) !== inputContent) {
+					engine.emptyCache(inputPath);
+				}
+
+				return engine.getCachedSource(inputPath);
+			},
 			permalink(linkContents) {
 				if (typeof linkContents !== 'string') {
 					return linkContents;
 				}
 
-				return async (data) => engine.process(data, linkContents);
+				return async (data) => engine.process({ data, source: linkContents });
 			},
 		},
 	});