@kanso-labs/unplugin-style-dictionary 0.7.0 → 0.9.0

package/dist/index.js

@@ -11,6 +11,14 @@ import { createUnplugin } from "unplugin";
 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 });
@@ -22,6 +30,45 @@ 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 looksLikeConfig(value) {
+	if (typeof value !== "object" || value === null) return false;
+	return [
+		"include",
+		"platforms",
+		"source",
+		"tokens"
+	].some((key) => key in value);
+}
+function nodeModulesNegations(paths) {
+	const negations = /* @__PURE__ */ new Set();
+	for (const file of paths) {
+		const normalised = file.replace(/\\/g, "/");
+		if (normalised.includes("/node_modules/")) negations.add(`!${normalised}`);
+	}
+	return Array.from(negations);
+}
+function paint(code, value, allowed) {
+	return allowed ? `\u001B[${code}m${value}\u001B[0m` : value;
+}
+async function patternsMatchingNothing(patterns) {
+	const barren = [];
+	for (const pattern of patterns) {
+		if (!GLOB_CHARACTERS.test(pattern)) {
+			if (!fs.existsSync(pattern)) barren.push(pattern);
+			continue;
+		}
+		try {
+			if ((await glob([pattern], { absolute: true })).length === 0) barren.push(pattern);
+		} catch {}
+	}
+	return barren;
+}
 function unwrapDefault(value) {
 	return typeof value === "object" && value !== null && "default" in value ? value.default ?? value : value;
 }
@@ -88,6 +135,9 @@ const IMPORTED_CONFIG_EXTENSIONS = [
 	".mjs",
 	".ts"
 ];
+function describeConfig(item, index) {
+	return item.file ? `The configuration ${item.file}` : `The configuration at position ${index + 1}`;
+}
 function isImportedConfig(file) {
 	return IMPORTED_CONFIG_EXTENSIONS.some((extension) => file.endsWith(extension));
 }
@@ -123,16 +173,36 @@ 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, platforms: platformsOption, 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 platformsFor = (context) => {
+		if (platformsOption === void 0) return void 0;
+		if (Array.isArray(platformsOption)) return platformsOption;
+		return context === void 0 ? platformsOption.build : platformsOption.watch;
+	};
 	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;
 	let watchRebuild = false;
 	let hasCompiled = false;
+	let hostClosed = false;
 	const expandPatterns = async (patterns) => {
 		const paths = /* @__PURE__ */ new Set();
 		const globs = [];
@@ -149,35 +219,88 @@ 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;
-		if (!rawConfig) for (const file of [
-			"sd.config.json",
-			"config.json",
-			"sd.config.js",
-			"sd.config.mjs"
-		]) {
-			const fullPath = path.resolve(root, file);
-			if (fs.existsSync(fullPath)) {
+		if (rawConfig === false) return [];
+		if (!rawConfig) {
+			const defaults = [
+				"sd.config.json",
+				"config.json",
+				"sd.config.js",
+				"sd.config.mjs"
+			];
+			const rejected = [];
+			for (const file of defaults) {
+				const fullPath = path.resolve(root, file);
+				if (!fs.existsSync(fullPath)) continue;
+				if (!looksLikeConfig(await readConfigObject({
+					config: fullPath,
+					file: fullPath
+				}, false))) {
+					rejected.push(file);
+					continue;
+				}
+				if (!announcedDiscovery) {
+					announcedDiscovery = true;
+					log(`Using the configuration it found at ${fullPath}`, "info");
+				}
 				rawConfig = file;
 				break;
 			}
+			if (rejected.length > 0) log(`Ignored ${rejected.join(", ")} in ${root}: nothing there declares platforms, source, include or tokens, so it does not look like a Style Dictionary configuration. Name it with the config option if it is one, or set config to false to stop looking.`, "error");
 		}
 		if (!rawConfig) {
 			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);
@@ -256,9 +379,11 @@ const unpluginFactory = (options = {}, meta) => {
 			return loaded;
 		}
 	};
-	const declaredDestinations = (configObj) => {
+	const declaredDestinations = (configObj, only) => {
 		const destinations = [];
-		for (const platform of Object.values(configObj.platforms ?? {})) {
+		const entries = Object.entries(configObj.platforms ?? {});
+		const selected = only ? entries.filter(([name]) => only.includes(name)) : entries;
+		for (const [, platform] of selected) {
 			const buildPath = platform.buildPath ?? "";
 			const absoluteBuildPath = path.isAbsolute(buildPath) ? buildPath : path.resolve(root, buildPath);
 			for (const file of platform.files ?? []) if (file.destination) destinations.push(path.isAbsolute(file.destination) ? file.destination : path.resolve(absoluteBuildPath, file.destination));
@@ -272,9 +397,9 @@ const unpluginFactory = (options = {}, meta) => {
 			return null;
 		}
 	};
-	const isUpToDate = async (item, configObj) => {
+	const isUpToDate = async (item, configObj, only) => {
 		if (Object.values(configObj.platforms ?? {}).some((platform) => (platform.actions?.length ?? 0) > 0)) return false;
-		const destinations = declaredDestinations(configObj);
+		const destinations = declaredDestinations(configObj, only);
 		if (destinations.length === 0) return false;
 		const extraWatches = options.watch ? Array.isArray(options.watch) ? options.watch : [options.watch] : [];
 		const sources = await expandPatterns([...sourcePatternsOf(configObj), ...extraWatches.map((pattern) => (path.isAbsolute(pattern) ? pattern : path.resolve(root, pattern)).replace(/\\/g, "/"))]);
@@ -307,7 +432,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);
@@ -326,7 +451,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));
 			}
 		}
 	};
@@ -336,9 +461,11 @@ const unpluginFactory = (options = {}, meta) => {
 		let skipped = 0;
 		try {
 			if (!context) log("Compiling design tokens...", "info");
-			for (const item of resolvedConfigs) {
+			if (onBuildStart) callHook("onBuildStart", onBuildStart);
+			for (const [index, item] of resolvedConfigs.entries()) {
 				const declared = cache ? await readConfigObject(item, false) : null;
-				if (declared && await isUpToDate(item, declared)) {
+				const selectedPlatforms = platformsFor(context);
+				if (declared && await isUpToDate(item, declared, selectedPlatforms)) {
 					for (const destination of declaredDestinations(declared)) generatedFiles.add(destination);
 					skipped++;
 					continue;
@@ -348,8 +475,23 @@ const unpluginFactory = (options = {}, meta) => {
 					mutateOriginal: true,
 					verbosity
 				});
+				if (sd.allTokens.length === 0) {
+					const asObject = await readConfigObject(item, false);
+					const barren = asObject ? await patternsMatchingNothing(sourcePatternsOf(asObject)) : [];
+					throw new Error([
+						`${describeConfig(item, index)} resolved no tokens, so its output would be emptied.`,
+						barren.length > 0 ? `These patterns matched no files: ${barren.join(", ")}` : `It declares no source or include patterns that matched anything.`,
+						`Nothing was written. Set failOnError to false to build anyway.`
+					].join(" "));
+				}
 				sd.volume = atomicVolume;
-				await sd.buildAllPlatforms();
+				if (selectedPlatforms === void 0) await sd.buildAllPlatforms();
+				else {
+					const defined = Object.keys(sd.platforms);
+					const unknown = selectedPlatforms.filter((name) => !defined.includes(name));
+					if (unknown.length > 0) throw new Error(`${describeConfig(item, index)} does not define the platform(s) ${unknown.join(", ")}. It defines ${defined.join(", ")}.`);
+					for (const name of selectedPlatforms) await sd.buildPlatform(name);
+				}
 				for (const platform of Object.values(sd.platforms)) {
 					const buildPath = platform.buildPath ?? "";
 					for (const file of platform.files ?? []) if (file.destination) {
@@ -366,10 +508,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");
@@ -411,6 +560,9 @@ const unpluginFactory = (options = {}, meta) => {
 	let inFlight;
 	let waiting = [];
 	let refreshServerWatchList;
+	let announcedDiscovery = false;
+	let startupResolved;
+	let notifyBuildOutcome;
 	const drain = async () => {
 		while (pendingReason !== void 0) {
 			const reason = pendingReason;
@@ -430,12 +582,16 @@ 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);
 		}
 	};
 	const schedule = async (reason) => {
+		if (hostClosed) return;
 		pendingReason = reason;
 		const covered = new Promise((resolve, reject) => {
 			waiting.push((failure) => {
@@ -451,12 +607,19 @@ const unpluginFactory = (options = {}, meta) => {
 		debounceTimer.unref();
 		return covered;
 	};
+	const closeWatcher = () => {
+		hostClosed = true;
+	};
 	return {
 		async buildStart() {
+			adoptHost(this);
+			adoptWatchMode(this);
 			const resolved = await resolveConfigs();
 			if (resolved.length === 0) return;
-			const { paths } = await getWatchTargets(resolved);
-			for (const file of paths) this.addWatchFile(file);
+			if (!hostClosed) {
+				const { paths } = await getWatchTargets(resolved);
+				for (const file of paths) this.addWatchFile(file);
+			}
 			if (isWebpack) return;
 			if (watchRebuild && hasCompiled) {
 				watchRebuild = false;
@@ -466,12 +629,44 @@ const unpluginFactory = (options = {}, meta) => {
 			hasCompiled = true;
 		},
 		name: "unplugin-style-dictionary",
+		rolldown: { closeWatcher },
+		rollup: { closeWatcher },
 		vite: {
-			configResolved(config) {
+			closeWatcher,
+			async 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);
+					}
+				};
+				if (config.command !== "serve") return;
+				isWatching = true;
+				try {
+					startupResolved = await resolveConfigs();
+					if (startupResolved.length === 0) return;
+					const { paths } = await getWatchTargets(startupResolved);
+					const negations = nodeModulesNegations(paths);
+					if (negations.length === 0) return;
+					const existing = config.server.watch?.ignored;
+					config.server.watch = {
+						...config.server.watch,
+						ignored: [...Array.isArray(existing) ? existing : existing === void 0 ? [] : [existing], ...negations]
+					};
+				} catch (err) {
+					log(`Could not read the configuration while preparing the watch list: ${errorMessage(err)}`, "error");
+					startupResolved = void 0;
+				}
 			},
 			async configureServer(server) {
-				const resolved = await resolveConfigs();
+				isWatching = true;
+				const resolved = startupResolved ?? await resolveConfigs();
+				startupResolved = void 0;
 				if (resolved.length === 0) return;
 				let targets = await getWatchTargets(resolved);
 				server.watcher.add(targets.paths);
@@ -479,6 +674,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(() => {});
@@ -486,6 +704,9 @@ const unpluginFactory = (options = {}, meta) => {
 			}
 		},
 		async watchChange(id) {
+			adoptHost(this);
+			adoptWatchMode(this);
+			if (hostClosed) return;
 			watchRebuild = true;
 			if (cachedPatterns && !isWatchedSource(id, cachedPatterns)) return;
 			const resolved = await resolveConfigs();
@@ -497,7 +718,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);