@11ty/eleventy-plugin-webc 0.7.0 → 0.8.1

package/eleventyWebcPlugin.js

@@ -27,6 +27,9 @@ module.exports = function(eleventyConfig, options = {}) {
 
 		// Opt-out of Eleventy to process components
 		// Note that Eleventy’s default ignores already have _includes/**
+
+		// This will cause component files outside of _includes to not be watched: https://github.com/11ty/eleventy-plugin-webc/issues/29
+		// Fixed in @11ty/eleventy@2.0.0-canary.18: https://github.com/11ty/eleventy/issues/893
 		eleventyConfig.ignores.add(options.components);
 	}
 

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@11ty/eleventy-plugin-webc",
-	"version": "0.7.0",
+	"version": "0.8.1",
 	"description": "WebC support for Eleventy adds for Single File Web Components",
 	"main": "eleventyWebcPlugin.js",
 	"scripts": {
@@ -14,7 +14,7 @@
 		"node": ">=14.18"
 	},
 	"11ty": {
-		"compatibility": ">=2.0.0-canary.17"
+		"compatibility": ">=2.0.0-canary.19"
 	},
 	"funding": {
 		"type": "opencollective",
@@ -38,10 +38,10 @@
 		]
 	},
 	"dependencies": {
-		"@11ty/eleventy": "^2.0.0-canary.17",
-		"@11ty/webc": "^0.7.1"
+		"@11ty/eleventy": "^2.0.0-canary.19",
+		"@11ty/webc": "^0.8.0"
 	},
 	"devDependencies": {
-		"ava": "^5.0.1"
+		"ava": "^5.1.0"
 	}
 }

package/src/bundleAssets.js

@@ -0,0 +1,50 @@
+class BundleAssetsToContent {
+	static SPLIT_REGEX = /(\/\*__WebC:[^:]*:[^:]*:WebC__\*\/)/;
+	static SEPARATOR = ":";
+
+	constructor(content) {
+		this.content = content;
+		this.managers = {};
+	}
+
+	static getAssetKey(name, bucket) {
+		return `/*__WebC:${name}:${bucket || "default"}:WebC__*/`
+	}
+
+	setAssetManager(name, assetManager) {
+		this.managers[name] = assetManager;
+	}
+
+	normalizeMatch(match) {
+		if(match.startsWith("/*__WebC:")) {
+			let [prefix, name, bucket, suffix] = match.split(BundleAssetsToContent.SEPARATOR);
+			return { name, bucket };
+		}
+		return match;
+	}
+
+	findAll() {
+		let matches = this.content.split(BundleAssetsToContent.SPLIT_REGEX);
+		let ret = [];
+		for(let match of matches) {
+			ret.push(this.normalizeMatch(match));
+		}
+		return ret;
+	}
+
+	replaceAll(url) {
+		let matches = this.findAll();
+		return matches.map(match => {
+			if(typeof match === "string") {
+				return match;
+			}
+			let {name, bucket} = match;
+			if(!this.managers[name]) {
+				throw new Error(`No asset manager found for ${name}. Known keys: ${Object.keys(this.managers)}`);
+			}
+			return this.managers[name].getForPage(url, bucket);
+		}).join("");
+	}
+}
+
+module.exports = BundleAssetsToContent;

package/src/eleventyWebcTemplate.js

@@ -4,7 +4,7 @@ const { EleventyRenderPlugin } = require("@11ty/eleventy");
 const CompileString = EleventyRenderPlugin.String;
 
 const CodeManager = require("./codeManager.js");
-const WebCIncremental = require("./incremental.js");
+const BundleAssetsToContent = require("./bundleAssets.js");
 
 function relativePath(inputPath, newGlob) {
 	// project root
@@ -24,9 +24,9 @@ module.exports = function(eleventyConfig, options = {}) {
 
 	let cssManager = new CodeManager();
 	let jsManager = new CodeManager();
-	let incremental = new WebCIncremental();
+
+	let _WebC;
 	let componentsMap = false; // cache the glob search
-	let componentsMapKey;
 	let moduleScript;
 
 	eleventyConfig.on("eleventy.before", async () => {
@@ -36,60 +36,35 @@ module.exports = function(eleventyConfig, options = {}) {
 		// For ESM in CJS
 		let { WebC, ModuleScript } = await import("@11ty/webc");
 		moduleScript = ModuleScript;
-		incremental.setWebC(WebC);
+		_WebC = WebC;
 
 		if(options.components) {
 			componentsMap = WebC.getComponentsMap(options.components);
-			componentsMapKey = JSON.stringify(componentsMap);
 		}
 	});
 
-	function getCss(pageUrl, bucket = "default") {
-		return cssManager.getForPage(pageUrl, bucket);
-	}
-
-	function getJs(pageUrl, bucket = "default") {
-		return jsManager.getForPage(pageUrl, bucket);
-	}
-
+	// Expose bundled CSS code to other template languages
 	if(options.filters.css) {
+		function getCss(pageUrl, bucket = "default") {
+			return cssManager.getForPage(pageUrl, bucket);
+		}
+
 		eleventyConfig.addFilter(options.filters.css, (url, bucket) => getCss(url, bucket));
 	}
+
+	// Expose bundled JS code to other template languages
 	if(options.filters.js) {
+		function getJs(pageUrl, bucket = "default") {
+			return jsManager.getForPage(pageUrl, bucket);
+		}
+
 		eleventyConfig.addFilter(options.filters.js, (url, bucket) => getJs(url, bucket));
 	}
 
-	eleventyConfig.on("eleventy.layouts", layouts => {
-		incremental.setLayouts(layouts);
-	});
-
 	eleventyConfig.addExtension("webc", {
 		outputFileExtension: "html",
 
-		isIncrementalMatch: function (incrementalFilePath) {
-			// Eleventy layouts don’t appear directly in the WebC component graph, so we use the `eleventy.layouts` map here
-			if(incremental.isTemplateUsingLayout(this.inputPath, incrementalFilePath)) {
-				return true;
-			}
-
-			let {page, setup} = incremental.get(this.inputPath);
-
-			if(page && setup) {
-				let components = page.getComponents(setup);
-				if(components.includes(incrementalFilePath)) {
-					return true;
-				}
-			}
-
-			return false;
-		},
-
 		compileOptions: {
-			cache: true,
-			getCacheKey: function(contents, inputPath) {
-				// if global components change, recompile!
-				return contents + inputPath + componentsMapKey;
-			},
 			permalink: function(contents, inputPath) {
 				return (data) => {
 					return moduleScript.evaluateScript("permalink", contents, {
@@ -101,7 +76,10 @@ module.exports = function(eleventyConfig, options = {}) {
 		},
 
 		compile: async function(inputContent, inputPath) {
-			let page = incremental.add(inputContent, inputPath);
+			let page = new _WebC();
+
+			page.setBundlerMode(true);
+			page.setContent(inputContent, inputPath);
 
 			if(componentsMap) {
 				page.defineComponents(componentsMap);
@@ -113,11 +91,11 @@ module.exports = function(eleventyConfig, options = {}) {
 			}
 
 			// Support both casings (I prefer getCss, but yeah)
-			page.setHelper("getCss", (url, bucket) => getCss(url, bucket));
-			page.setHelper("getCSS", (url, bucket) => getCss(url, bucket));
+			page.setHelper("getCss", (url, bucket) => BundleAssetsToContent.getAssetKey("css", bucket));
+			page.setHelper("getCSS", (url, bucket) => BundleAssetsToContent.getAssetKey("css", bucket));
 
-			page.setHelper("getJs", (url, bucket) => getJs(url, bucket));
-			page.setHelper("getJS", (url, bucket) => getJs(url, bucket));
+			page.setHelper("getJs", (url, bucket) => BundleAssetsToContent.getAssetKey("js", bucket));
+			page.setHelper("getJS", (url, bucket) => BundleAssetsToContent.getAssetKey("js", bucket));
 
 			page.setTransform("11ty", async function(content) {
 				let syntax = this["11ty:type"];
@@ -131,21 +109,22 @@ module.exports = function(eleventyConfig, options = {}) {
 			});
 
 			return async (data) => {
-				let setupObject = { data };
+				let setupObject = {
+					data,
+				};
+
 				if(data.webc?.components) {
-					let WebC = incremental.webc;
-					setupObject.components = WebC.getComponentsMap(relativePath(data.page.inputPath, data.webc.components));
+					setupObject.components = _WebC.getComponentsMap(relativePath(data.page.inputPath, data.webc.components));
 				}
 
 				if(options.before && typeof options.before === "function") {
 					await options.before(page);
 				}
 
-				let setup = await page.setup(setupObject);
-				incremental.addSetup(inputPath, setup);
+				let { html, css, js, buckets, components } = await page.compile(setupObject);
 
-				let { ast, serializer } = setup;
-				let { html, css, js, buckets } = await serializer.compile(ast);
+				// 2.0.0-canary.19+
+				this.addDependencies(inputPath, components);
 
 				cssManager.addToPage(data.page.url, css, "default");
 
@@ -163,7 +142,14 @@ module.exports = function(eleventyConfig, options = {}) {
 					}
 				}
 
-				return html;
+				// Always do a two pass render for assets to catch any CSS/JS that were compiled *in* the same template.
+				// https://github.com/11ty/eleventy-plugin-webc/issues/33
+				// This unlocks use of bundled asset code anywhere in the WebC component tree (not just Eleventy Layouts)
+				let bundler = new BundleAssetsToContent(html);
+				bundler.setAssetManager("css", cssManager);
+				bundler.setAssetManager("js", jsManager);
+
+				return bundler.replaceAll(data.page.url);
 			};
 		}
 	});

package/src/incremental.js

@@ -1,60 +0,0 @@
-class WebCIncremental {
-	constructor() {
-		this.pages = {};
-		this.setups = {};
-	}
-
-	setWebC(cls) {
-		this.webc = cls;
-	}
-
-	setLayouts(layouts) {
-		this.layouts = layouts;
-	}
-
-	isTemplateUsingLayout(templateFilePath, layoutFilePath) {
-		if(this.layouts && this.layouts[layoutFilePath] && this.layouts[layoutFilePath].includes(templateFilePath)) {
-			return true;
-		}
-		return false;
-	}
-
-	add(inputContent, inputPath) {
-		let WebC = this.webc;
-		let page = new WebC();
-
-		// Explicitly disable bundler mode for layouts
-		if(this.layouts && this.layouts[inputPath]) {
-			page.setBundlerMode(false);
-		} else {
-			page.setBundlerMode(true);
-		}
-
-		page.setContent(inputContent, inputPath);
-
-		this.pages[inputPath] = page;
-
-		return page;
-	}
-
-	addSetup(inputPath, setup) {
-		this.setups[inputPath] = setup;
-	}
-
-	get(inputPath) {
-		let setup = this.setups[inputPath];
-		let components = setup.serializer.components;
-
-		if(setup && components) {
-			setup.serializer.restorePreparsedComponents(components);
-		}
-
-		return {
-			page: this.pages[inputPath],
-			setup,
-			components,
-		}
-	}
-}
-
-module.exports = WebCIncremental;