@11ty/eleventy-plugin-webc 0.6.0 → 0.8.0

package/eleventyWebcPlugin.js

@@ -15,7 +15,7 @@ module.exports = function(eleventyConfig, options = {}) {
 	}, options.filters);
 
 	options = Object.assign({
-		components: false, // glob for no-import global components
+		components: "_components/**/*.webc", // glob for no-import global components
 		useTransform: false, // global transform
 		transformData: {}, // extra global data for transforms specifically
 	}, options);
@@ -25,7 +25,12 @@ module.exports = function(eleventyConfig, options = {}) {
 	if(options.components) {
 		eleventyConfig.addWatchTarget(options.components);
 
-		// TODO add to eleventy ignores (if not in _includes folder)
+		// 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);
 	}
 
 	templatePlugin(eleventyConfig, options);

package/package.json

@@ -1,10 +1,10 @@
 {
 	"name": "@11ty/eleventy-plugin-webc",
-	"version": "0.6.0",
+	"version": "0.8.0",
 	"description": "WebC support for Eleventy adds for Single File Web Components",
 	"main": "eleventyWebcPlugin.js",
 	"scripts": {
-		"test": "npx ava"
+		"test": "npx ava --no-worker-threads"
 	},
 	"publishConfig": {
 		"access": "public"
@@ -14,7 +14,7 @@
 		"node": ">=14.18"
 	},
 	"11ty": {
-		"compatibility": ">=2.0.0-canary.16"
+		"compatibility": ">=2.0.0-canary.17"
 	},
 	"funding": {
 		"type": "opencollective",
@@ -38,8 +38,8 @@
 		]
 	},
 	"dependencies": {
-		"@11ty/eleventy": "^2.0.0-canary.16",
-		"@11ty/webc": "^0.6.0"
+		"@11ty/eleventy": "^2.0.0-canary.18",
+		"@11ty/webc": "^0.8.0"
 	},
 	"devDependencies": {
 		"ava": "^5.0.1"

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

@@ -1,10 +1,11 @@
 const path = require("path");
 
 const { EleventyRenderPlugin } = require("@11ty/eleventy");
-const EleventyRenderManager = EleventyRenderPlugin.RenderManager;
+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
@@ -22,19 +23,20 @@ function relativePath(inputPath, newGlob) {
 module.exports = function(eleventyConfig, options = {}) {
 	eleventyConfig.addTemplateFormats("webc");
 
-	let renderManager = new EleventyRenderManager();
 	let cssManager = new CodeManager();
 	let jsManager = new CodeManager();
 	let incremental = new WebCIncremental();
 	let componentsMap = false; // cache the glob search
 	let componentsMapKey;
+	let moduleScript;
 
 	eleventyConfig.on("eleventy.before", async () => {
 		cssManager.reset();
 		jsManager.reset();
 
 		// For ESM in CJS
-		let { WebC } = await import("@11ty/webc");
+		let { WebC, ModuleScript } = await import("@11ty/webc");
+		moduleScript = ModuleScript;
 		incremental.setWebC(WebC);
 
 		if(options.components) {
@@ -43,18 +45,21 @@ module.exports = function(eleventyConfig, options = {}) {
 		}
 	});
 
-	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));
 	}
 
@@ -67,11 +72,12 @@ module.exports = function(eleventyConfig, options = {}) {
 
 		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)) {
+			if(incremental.isFileUsingLayout(this.inputPath, incrementalFilePath)) {
 				return true;
 			}
 
 			let {page, setup} = incremental.get(this.inputPath);
+
 			if(page && setup) {
 				let components = page.getComponents(setup);
 				if(components.includes(incrementalFilePath)) {
@@ -87,6 +93,14 @@ module.exports = function(eleventyConfig, options = {}) {
 			getCacheKey: function(contents, inputPath) {
 				// if global components change, recompile!
 				return contents + inputPath + componentsMapKey;
+			},
+			permalink: function(contents, inputPath) {
+				return (data) => {
+					return moduleScript.evaluateScript("permalink", contents, {
+						...this,
+						...data,
+					});
+				}
 			}
 		},
 
@@ -103,28 +117,36 @@ 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"];
 				if(syntax) {
-					let fn = await renderManager.compile(content, syntax);
-					return renderManager.render(fn, this, {});
+					let fn = await CompileString(content, syntax, {
+						templateConfig: eleventyConfig
+					});
+					return fn(this);
 				}
 				return content;
 			});
 
 			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));
 				}
 
+				if(options.before && typeof options.before === "function") {
+					await options.before(page);
+				}
+
 				let setup = await page.setup(setupObject);
 				incremental.addSetup(inputPath, setup);
 
@@ -147,7 +169,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

@@ -12,7 +12,7 @@ class WebCIncremental {
 		this.layouts = layouts;
 	}
 
-	isTemplateUsingLayout(templateFilePath, layoutFilePath) {
+	isFileUsingLayout(templateFilePath, layoutFilePath) {
 		if(this.layouts && this.layouts[layoutFilePath] && this.layouts[layoutFilePath].includes(templateFilePath)) {
 			return true;
 		}
@@ -23,15 +23,7 @@ class WebCIncremental {
 		let WebC = this.webc;
 		let page = new WebC();
 
-		// Explicitly disable bundler mode for layouts
-		if(this.layouts && this.layouts[inputPath]) {
-			page.setBundlerMode(false);
-			page.setReprocessingMode(false);
-		} else {
-			page.setBundlerMode(true);
-			page.setReprocessingMode(true);
-		}
-
+		page.setBundlerMode(true);
 		page.setContent(inputContent, inputPath);
 
 		this.pages[inputPath] = page;