@kanso-labs/unplugin-style-dictionary 0.6.2 → 0.8.0

package/dist/index.js

@@ -1,23 +1,24 @@
+import { matchesWatchedFile } from "./watch-filter.js";
 import JSON5 from "json5";
 import fs from "node:fs";
 import path from "node:path";
 import { pathToFileURL } from "node:url";
 import zlib from "node:zlib";
-import picomatch from "picomatch";
 import StyleDictionary from "style-dictionary";
 import { glob } from "tinyglobby";
 import { createUnplugin } from "unplugin";
 //#region src/index.ts
-function matchesWatchedFile(file, patterns) {
-	const normalizedFile = file.replace(/\\/g, "/");
-	return patterns.some((pattern) => {
-		const normalizedPattern = pattern.replace(/\\/g, "/");
-		return normalizedPattern === normalizedFile || picomatch.isMatch(normalizedFile, normalizedPattern);
-	});
-}
 function asError(error) {
 	return error instanceof Error ? error : new Error(errorMessage(error));
 }
+function colourAllowed(stream) {
+	if (process.env.NO_COLOR) return false;
+	const forced = process.env.FORCE_COLOR;
+	if (forced === "0") return false;
+	if (forced !== void 0 && forced !== "") return true;
+	if (process.env.TERM === "dumb") return false;
+	return stream.isTTY === true;
+}
 function discardTemporaryFile(temporary) {
 	try {
 		fs.rmSync(temporary, { force: true });
@@ -29,6 +30,15 @@ function errorMessage(error) {
 function isConfig(value) {
 	return typeof value === "object" && value !== null;
 }
+function isMessageChannel(value) {
+	return typeof value === "function";
+}
+function isThenable(value) {
+	return typeof value === "object" && value !== null && "then" in value && typeof value.then === "function";
+}
+function paint(code, value, allowed) {
+	return allowed ? `\u001B[${code}m${value}\u001B[0m` : value;
+}
 function unwrapDefault(value) {
 	return typeof value === "object" && value !== null && "default" in value ? value.default ?? value : value;
 }
@@ -130,11 +140,25 @@ function statOrNull(file) {
 }
 const unpluginFactory = (options = {}, meta) => {
 	const isWebpack = meta.framework === "webpack";
-	const { cache = true, failOnError = "build", logLevel, report = true, root: rootOption, silent = false } = options;
+	const { cache = true, errorOverlay = true, failOnError = "build", logLevel, onBuildEnd, onBuildError, onBuildStart, report = true, root: rootOption, silent = false } = options;
 	const level = logLevel ?? (silent ? "silent" : void 0);
 	const quiet = level === "silent" || level === "warn";
 	const verbosity = level === void 0 ? void 0 : level === "verbose" ? "verbose" : level === "silent" ? "silent" : "default";
 	const failsTheBuild = (context) => failOnError === true || (context === void 0 ? failOnError === "build" : failOnError === "serve");
+	let hostCommand = "build";
+	let hostMode;
+	let isWatching = false;
+	const configContext = () => ({
+		command: hostCommand,
+		mode: hostMode ?? (hostCommand === "serve" ? "development" : "production"),
+		watch: isWatching
+	});
+	const adoptWatchMode = (context) => {
+		const hookMeta = "meta" in context ? context.meta : void 0;
+		if (typeof hookMeta !== "object" || hookMeta === null) return;
+		const watching = "watchMode" in hookMeta ? hookMeta.watchMode : void 0;
+		if (typeof watching === "boolean") isWatching = watching;
+	};
 	let root = rootOption ? path.resolve(process.cwd(), rootOption) : process.cwd();
 	const generatedDestinations = /* @__PURE__ */ new Set();
 	let cachedPatterns;
@@ -156,15 +180,52 @@ const unpluginFactory = (options = {}, meta) => {
 		return Array.from(paths);
 	};
 	const isWatchedSource = (file, patterns) => !generatedDestinations.has(file.replace(/\\/g, "/")) && matchesWatchedFile(file, patterns);
+	const stdoutColour = colourAllowed(process.stdout);
+	const stderrColour = colourAllowed(process.stderr);
+	let host;
+	const adoptHost = (context) => {
+		if (host) return;
+		const warn = "warn" in context ? context.warn : void 0;
+		if (!isMessageChannel(warn)) return;
+		const info = "info" in context ? context.info : void 0;
+		host = {
+			error: (message) => {
+				warn.call(context, message);
+			},
+			info: isMessageChannel(info) ? (message) => {
+				info.call(context, message);
+			} : void 0
+		};
+	};
 	const log = (message, type = "info") => {
 		const prefix = "[unplugin-style-dictionary]";
 		if (type === "error") {
-			console.error(`\x1b[31m${prefix} ${message}\x1b[0m`);
+			if (host) {
+				host.error(`${prefix} ${message}`);
+				return;
+			}
+			console.error(paint("31", `${prefix} ${message}`, stderrColour));
 			return;
 		}
 		if (quiet) return;
-		if (type === "success") console.log(`\x1b[32m${prefix} ${message}\x1b[0m`);
-		else console.log(`\x1b[36m${prefix} ${message}\x1b[0m`);
+		if (host?.info) {
+			host.info(`${prefix} ${message}`);
+			return;
+		}
+		console.log(paint(type === "success" ? "32" : "36", `${prefix} ${message}`, stdoutColour));
+	};
+	const callHook = (name, hook, ...args) => {
+		let result;
+		try {
+			result = hook(...args);
+		} catch (err) {
+			log(`The ${name} hook threw: ${errorMessage(err)}`, "error");
+			return;
+		}
+		if (!isThenable(result)) return;
+		Promise.resolve(result).catch((err) => {
+			log(`The ${name} hook rejected: ${errorMessage(err)}`, "error");
+		});
 	};
 	const resolveConfigs = async () => {
 		let rawConfig = options.config;
@@ -184,7 +245,7 @@ const unpluginFactory = (options = {}, meta) => {
 			log("No configuration specified and no default config file found. Style Dictionary will not compile.", "error");
 			return [];
 		}
-		if (typeof rawConfig === "function") rawConfig = await rawConfig();
+		if (typeof rawConfig === "function") rawConfig = await rawConfig(configContext());
 		return (Array.isArray(rawConfig) ? rawConfig : [rawConfig]).map((conf) => {
 			if (typeof conf === "string") {
 				const fullPath = path.resolve(root, conf);
@@ -314,7 +375,7 @@ const unpluginFactory = (options = {}, meta) => {
 			const displayPath = path.relative(root, filePath).replace(/\\/g, "/");
 			const dir = path.dirname(displayPath);
 			const base = path.basename(displayPath);
-			const coloredPath = dir === "." ? `\x1b[32m${base}\x1b[0m` : `\x1b[90m${dir}/\x1b[0m\x1b[32m${base}\x1b[0m`;
+			const coloredPath = dir === "." ? paint("32", base, stdoutColour) : paint("90", `${dir}/`, stdoutColour) + paint("32", base, stdoutColour);
 			try {
 				const sizeStr = `${(fs.statSync(filePath).size / 1024).toFixed(2)} kB`;
 				const content = fs.readFileSync(filePath);
@@ -333,7 +394,7 @@ const unpluginFactory = (options = {}, meta) => {
 			for (const info of fileInfos) {
 				const pathPadding = " ".repeat(Math.max(2, longestPathLength - info.relativeDisplayPath.length + 2));
 				const sizePadded = info.sizeStr.padStart(longestSizeLength);
-				console.log(`${info.coloredPath}${pathPadding}\x1b[90m${sizePadded} │ gzip: ${info.gzipSizeStr}\x1b[0m`);
+				console.log(info.coloredPath + pathPadding + paint("90", `${sizePadded} │ gzip: ${info.gzipSizeStr}`, stdoutColour));
 			}
 		}
 	};
@@ -343,6 +404,7 @@ const unpluginFactory = (options = {}, meta) => {
 		let skipped = 0;
 		try {
 			if (!context) log("Compiling design tokens...", "info");
+			if (onBuildStart) callHook("onBuildStart", onBuildStart);
 			for (const item of resolvedConfigs) {
 				const declared = cache ? await readConfigObject(item, false) : null;
 				if (declared && await isUpToDate(item, declared)) {
@@ -373,10 +435,17 @@ const unpluginFactory = (options = {}, meta) => {
 		} catch (err) {
 			const duration = Date.now() - startTime;
 			log(`Compilation failed after ${duration}ms: ${errorMessage(err)}`, "error");
+			notifyBuildOutcome?.(asError(err));
+			if (onBuildError) callHook("onBuildError", onBuildError, err);
 			if (failsTheBuild(context)) throw err;
 			return;
 		}
+		notifyBuildOutcome?.(null);
 		const duration = Date.now() - startTime;
+		if (onBuildEnd) {
+			const files = Array.from(generatedFiles).sort((left, right) => left.localeCompare(right));
+			callHook("onBuildEnd", onBuildEnd, files, duration);
+		}
 		const everythingSkipped = skipped === resolvedConfigs.length;
 		if (context) {
 			log(everythingSkipped ? `Design tokens already up to date after change in ${context} (${duration}ms)` : `Rebuilt design tokens due to change in ${context} (${duration}ms)`, "success");
@@ -418,6 +487,7 @@ const unpluginFactory = (options = {}, meta) => {
 	let inFlight;
 	let waiting = [];
 	let refreshServerWatchList;
+	let notifyBuildOutcome;
 	const drain = async () => {
 		while (pendingReason !== void 0) {
 			const reason = pendingReason;
@@ -437,7 +507,10 @@ const unpluginFactory = (options = {}, meta) => {
 				}
 			} catch (err) {
 				failure = { error: err };
-				if (!compiling) log(`Rebuild failed: ${errorMessage(err)}`, "error");
+				if (!compiling) {
+					log(`Rebuild failed: ${errorMessage(err)}`, "error");
+					notifyBuildOutcome?.(asError(err));
+				}
 			}
 			for (const settle of resolvers) settle(failure);
 		}
@@ -460,6 +533,8 @@ const unpluginFactory = (options = {}, meta) => {
 	};
 	return {
 		async buildStart() {
+			adoptHost(this);
+			adoptWatchMode(this);
 			const resolved = await resolveConfigs();
 			if (resolved.length === 0) return;
 			const { paths } = await getWatchTargets(resolved);
@@ -476,8 +551,19 @@ const unpluginFactory = (options = {}, meta) => {
 		vite: {
 			configResolved(config) {
 				if (rootOption === void 0) root = config.root || process.cwd();
+				hostCommand = config.command;
+				hostMode = config.mode;
+				host = {
+					error: (message) => {
+						config.logger.error(message);
+					},
+					info: (message) => {
+						config.logger.info(message);
+					}
+				};
 			},
 			async configureServer(server) {
+				isWatching = true;
 				const resolved = await resolveConfigs();
 				if (resolved.length === 0) return;
 				let targets = await getWatchTargets(resolved);
@@ -486,6 +572,29 @@ const unpluginFactory = (options = {}, meta) => {
 					targets = await getWatchTargets(rebuilt);
 					server.watcher.add(targets.paths);
 				};
+				if (errorOverlay) {
+					let overlayShowing = false;
+					notifyBuildOutcome = (error) => {
+						if (error) {
+							overlayShowing = true;
+							server.hot.send({
+								err: {
+									message: error.message,
+									plugin: "unplugin-style-dictionary",
+									stack: error.stack ?? ""
+								},
+								type: "error"
+							});
+							return;
+						}
+						if (!overlayShowing) return;
+						overlayShowing = false;
+						server.hot.send({
+							type: "update",
+							updates: []
+						});
+					};
+				}
 				server.watcher.on("all", (_event, file) => {
 					if (!isWatchedSource(file, targets.patterns)) return;
 					schedule(path.basename(file)).catch(() => {});
@@ -493,6 +602,8 @@ const unpluginFactory = (options = {}, meta) => {
 			}
 		},
 		async watchChange(id) {
+			adoptHost(this);
+			adoptWatchMode(this);
 			watchRebuild = true;
 			if (cachedPatterns && !isWatchedSource(id, cachedPatterns)) return;
 			const resolved = await resolveConfigs();
@@ -504,7 +615,25 @@ const unpluginFactory = (options = {}, meta) => {
 		},
 		webpack(compiler) {
 			if (rootOption === void 0) root = compiler.options.context ?? process.cwd();
+			hostMode = compiler.options.mode;
+			const pending = [];
+			host = { error: (message) => {
+				pending.push(message);
+			} };
+			compiler.hooks.compilation.tap("unplugin-style-dictionary", (compilation) => {
+				for (const message of pending.splice(0)) {
+					const reported = new Error(message);
+					reported.name = "UnpluginStyleDictionaryWarning";
+					compilation.warnings.push(reported);
+				}
+			});
+			const drainToConsole = () => {
+				for (const message of pending.splice(0)) console.error(paint("31", message, stderrColour));
+			};
+			compiler.hooks.failed.tap("unplugin-style-dictionary", drainToConsole);
+			compiler.hooks.done.tap("unplugin-style-dictionary", drainToConsole);
 			compiler.hooks.beforeCompile.tapPromise("unplugin-style-dictionary", async () => {
+				isWatching = compiler.watchMode;
 				const resolved = await resolveConfigs();
 				if (resolved.length === 0) return;
 				await compileOnceAcrossInstances(resolved);
@@ -515,6 +644,6 @@ const unpluginFactory = (options = {}, meta) => {
 };
 const unplugin = /* #__PURE__ */ createUnplugin(unpluginFactory);
 //#endregion
-export { unplugin as default, unplugin, matchesWatchedFile, unpluginFactory };
+export { unplugin as default, unplugin };
 
 //# sourceMappingURL=index.js.map