@schalkneethling/miyagi-core 4.3.0 → 4.4.0

package/lib/init/args.js

@@ -6,101 +6,169 @@
 import yargs from "yargs";
 import { hideBin } from "yargs/helpers";
 import pkgJson from "../../package.json" with { type: "json" };
+import { EXIT_CODES, MiyagiError } from "../errors.js";
 
-export default yargs(hideBin(process.argv))
-	.command("start", "Starts the miyagi server", {
-		verbose: {
+/**
+ * @param {object} handlers
+ * @param {string[]} [argv]
+ * @returns {object}
+ */
+export default function createCli(handlers, argv = process.argv) {
+	let result;
+
+	const commandHandler = (handler) => async (args) => {
+		result = await handler(args);
+		return result;
+	};
+
+	const cli = yargs(hideBin(argv))
+		.scriptName("miyagi")
+		.option("verbose", {
+			alias: "v",
 			description:
 				"Logging additional information — helpful mainly in case of errors.",
 			type: "boolean",
+			global: true,
+		})
+		.command(
+			"start",
+			"Starts the miyagi server",
+			(builder) =>
+				builder
+					.option("watch-report", {
+						description: "Enable watch report output on startup.",
+						type: "boolean",
+					})
+					.option("watch-report-format", {
+						description: "Set watch report format.",
+						type: "string",
+						choices: ["pretty", "summary", "json"],
+					})
+					.option("watch-report-no-color", {
+						description: "Disable colors in watch report output.",
+						type: "boolean",
+					}),
+			commandHandler(handlers.start),
+		)
+		.command(
+			"build",
+			"Creates a static build of all your components",
+			(builder) =>
+				builder.option("folder", {
+					description: "The folder where your static build files will be saved",
+					type: "string",
+				}),
+			commandHandler(handlers.build),
+		)
+		.command(
+			"new <component>",
+			"Creates a new component folder (including template, CSS, JS, documentation, mocks, and schema files)",
+			(builder) =>
+				builder
+					.positional("component", {
+						description: "The component path to create",
+						type: "string",
+					})
+					.option("skip", {
+						description:
+							"files that will not be created\n(space separated list of tpl, css, js, docs, mocks, schema)",
+						type: "array",
+					})
+					.option("only", {
+						description:
+							"tells miyagi to only created the passes file types\n(space separated list of tpl, css, js, docs, mocks, schema)",
+						type: "array",
+					}),
+			commandHandler(handlers.new),
+		)
+		.command(
+			"mocks <component>",
+			"Creates a mock data file with dummy content based on the schema file",
+			(builder) =>
+				builder.positional("component", {
+					description: "The component path to generate mock data for",
+					type: "string",
+				}),
+			commandHandler(handlers.mocks),
+		)
+		.command(
+			"lint [component]",
+			"Validates if the component's mock data matches its JSON schema",
+			(builder) =>
+				builder.positional("component", {
+					description: "Optional component path to lint",
+					type: "string",
+				}),
+			commandHandler(handlers.lint),
+		)
+		.command(
+			"drupal-assets",
+			"Resolves Drupal *.libraries.yml dependencies and updates component $assets in mock files",
+			(builder) =>
+				builder
+					.option("engine", {
+						alias: "e",
+						description: "Engine to use for asset resolution",
+						type: "string",
+						choices: ["drupal"],
+						default: "drupal",
+					})
+					.option("config", {
+						description: "Path to .miyagi-assets.js config file",
+						type: "string",
+						default: ".miyagi-assets.js",
+					})
+					.option("libraries", {
+						alias: "l",
+						description: "Path to *.libraries.yml (overrides config)",
+						type: "string",
+					})
+					.option("components", {
+						alias: "c",
+						description: "Library names to process (space-separated)",
+						type: "array",
+					})
+					.option("ignore-prefixes", {
+						description:
+							'Dependency prefixes to skip (e.g. "core" to ignore core/jquery)',
+						type: "array",
+					})
+					.option("dry-run", {
+						description: "Print resolved $assets without writing files",
+						type: "boolean",
+						default: false,
+					}),
+			commandHandler(handlers.drupalAssets),
+		)
+		.command(
+			"doctor",
+			"Checks your miyagi environment and config for common setup issues",
+			() => {},
+			commandHandler(handlers.doctor),
+		)
+		.help()
+		.version(pkgJson.version)
+		.alias("help", "h")
+		.strictCommands()
+		.demandCommand()
+		.exitProcess(false)
+		.fail((message, error) => {
+			if (error) {
+				throw error;
+			}
+
+			throw new MiyagiError(message || "CLI parsing failed.", {
+				code: EXIT_CODES.CLI_USAGE_ERROR,
+			});
+		})
+		.epilogue(
+			"Please check https://docs.miyagi.dev/configuration/options/ for all options",
+		);
+
+	return {
+		cli,
+		getResult() {
+			return result;
 		},
-		"watch-report": {
-			description: "Enable watch report output on startup.",
-			type: "boolean",
-		},
-		"watch-report-format": {
-			description: "Set watch report format.",
-			type: "string",
-			choices: ["pretty", "summary", "json"],
-		},
-		"watch-report-no-color": {
-			description: "Disable colors in watch report output.",
-			type: "boolean",
-		},
-	})
-	.command("build", "Creates a static build of all your components", {
-		folder: {
-			description: "The folder where your static build files will be saved",
-			type: "string",
-		},
-	})
-	.command(
-		"new",
-		"Creates a new component folder (including template, CSS, JS, documentation, mocks, and schema files)",
-		{
-			skip: {
-				description:
-					"files that will not be created\n(space separated list of tpl, css, js, docs, mocks, schema)",
-				type: "array",
-			},
-			only: {
-				description:
-					"tells miyagi to only created the passes file types\n(space separated list of tpl, css, js, docs, mocks, schema)",
-				type: "array",
-			},
-		},
-	)
-	.command(
-		"mocks",
-		"Creates a mock data file with dummy content based on the schema file",
-	)
-	.command(
-		"lint",
-		"Validates if the component's mock data matches its JSON schema",
-	)
-	.command(
-		"drupal-assets",
-		"Resolves Drupal *.libraries.yml dependencies and updates component $assets in mock files",
-		{
-			engine: {
-				alias: "e",
-				description: "Engine to use for asset resolution",
-				type: "string",
-				choices: ["drupal"],
-				default: "drupal",
-			},
-			config: {
-				description: "Path to .miyagi-assets.js config file",
-				type: "string",
-				default: ".miyagi-assets.js",
-			},
-			libraries: {
-				alias: "l",
-				description: "Path to *.libraries.yml (overrides config)",
-				type: "string",
-			},
-			components: {
-				alias: "c",
-				description: "Library names to process (space-separated)",
-				type: "array",
-			},
-			"ignore-prefixes": {
-				description:
-					'Dependency prefixes to skip (e.g. "core" to ignore core/jquery)',
-				type: "array",
-			},
-			"dry-run": {
-				description: "Print resolved $assets without writing files",
-				type: "boolean",
-				default: false,
-			},
-		},
-	)
-	.help()
-	.version(pkgJson.version)
-	.alias("help", "h")
-	.alias("verbose", "v")
-	.demandCommand()
-	.epilogue(
-		"Please check https://docs.miyagi.dev/configuration/options/ for all options",
-	);
+	};
+}

package/lib/init/engines.js

@@ -7,6 +7,7 @@ import fs from "fs";
 import { t } from "../i18n/index.js";
 import log from "../logger.js";
 import * as helpers from "../helpers.js";
+import { EXIT_CODES, MiyagiError } from "../errors.js";
 import TwingCache from "./twing/cache.js";
 import * as twingFunctions from "./twing/functions.js";
 
@@ -41,8 +42,12 @@ async function setUserEngine() {
 	const { engine } = global.config;
 
 	if (!engine.render) {
-		log("error", "No render function has beend defined.");
-		process.exit(1);
+		const message = "No render function has beend defined.";
+		log("error", message);
+		throw new MiyagiError(message, {
+			code: EXIT_CODES.CONFIG_ERROR,
+			logged: true,
+		});
 	}
 
 	try {
@@ -51,8 +56,12 @@ async function setUserEngine() {
 			async (name, context, cb) => await engine.render({ name, context, cb }),
 		);
 	} catch (e) {
-		log("error", t("settingEngineFailed"), e);
-		process.exit(1);
+		const message = t("settingEngineFailed");
+		log("error", message, e);
+		throw new MiyagiError(message, {
+			code: EXIT_CODES.CONFIG_ERROR,
+			logged: true,
+		});
 	}
 }
 

package/lib/init/index.js

@@ -12,6 +12,7 @@ import appConfig from "../default-config.js";
 import { t } from "../i18n/index.js";
 import build from "../build/index.js";
 import log from "../logger.js";
+import { EXIT_CODES } from "../errors.js";
 import setEngines from "./engines.js";
 import setRouter from "./router.js";
 import setState from "../state/index.js";
@@ -50,15 +51,24 @@ export default async function init(mergedConfig) {
 	setViews();
 
 	if (global.config.isBuild) {
-		return build()
-			.then((message) => {
-				log("success", message);
-				process.exit(0);
-			})
-			.catch((error) => {
-				log("error", error);
-				process.exit(1);
-			});
+		try {
+			const message = await build();
+			log("success", message);
+			return {
+				success: true,
+				code: EXIT_CODES.SUCCESS,
+				shouldExit: true,
+				message,
+			};
+		} catch (error) {
+			log("error", error);
+			return {
+				success: false,
+				code: EXIT_CODES.GENERAL_ERROR,
+				shouldExit: true,
+				message: String(error),
+			};
+		}
 	}
 
 	const { server, port: actualPort } = await startServer(
@@ -69,7 +79,13 @@ export default async function init(mergedConfig) {
 
 	log("success", `${t("serverStarted").replace("{{port}}", actualPort)}\n`);
 
-	return server;
+	return {
+		success: true,
+		code: EXIT_CODES.SUCCESS,
+		shouldExit: false,
+		server,
+		port: actualPort,
+	};
 }
 
 /**

package/lib/init/watcher.js

@@ -161,18 +161,21 @@ function printWatchReport(report, watchConfig) {
 		`  ${colorize("grey", "Diagnostics:", useColors)} sources=${report.meta.sourceCount
 		}, ignores=${report.meta.ignoreCount}`,
 	);
-	console.info(`  ${colorize("grey", "Resolved sources:", useColors)}`);
 
-	for (const source of report.sources) {
-		const stateLabel = source.exists ? "exists" : "missing";
-		const stateColor = source.exists ? "green" : "yellow";
-		console.info(
-			`    - ${source.id} (${source.type}) ${source.resolvedPath} [${colorize(
-				stateColor,
-				stateLabel,
-				useColors,
-			)}]`,
-		);
+	if (watchConfig?.debug?.logResolvedSources) {
+		console.info(`  ${colorize("grey", "Resolved sources:", useColors)}`);
+
+		for (const source of report.sources) {
+			const stateLabel = source.exists ? "exists" : "missing";
+			const stateColor = source.exists ? "green" : "yellow";
+			console.info(
+				`    - ${source.id} (${source.type}) ${source.resolvedPath} [${colorize(
+					stateColor,
+					stateLabel,
+					useColors,
+				)}]`,
+			);
+		}
 	}
 
 	console.info(`  ${colorize("grey", "Ignored patterns:", useColors)}`);
@@ -628,6 +631,7 @@ export default function Watcher(server) {
 
 		isProcessing = true;
 		try {
+			log("info", t("updatingStarted"));
 			const events = snapshotPendingEvents(pendingByPath);
 			pendingByPath.clear();
 			await handleFileChange(events);
@@ -713,7 +717,6 @@ export default function Watcher(server) {
 				log("info", `watch:event=${eventType} path=${changedPath}`);
 			}
 
-			log("info", t("updatingStarted"));
 			enqueueEvent(eventType, changedPath);
 		});
 

package/lib/state/helpers.js

@@ -7,6 +7,7 @@ import path from "path";
 import log from "../logger.js";
 import { t } from "../i18n/index.js";
 import { readdir } from "node:fs/promises";
+import { EXIT_CODES, MiyagiError } from "../errors.js";
 
 /**
  * @param {string|null} dir - the directory in which to look for files
@@ -25,17 +26,21 @@ async function getFiles(dir, ignores, configPath, type, check) {
 		});
 	} catch (error) {
 		if (error.code === "ENOENT") {
-			log(
-				"error",
-				t("srcFolderNotFound")
-					.replaceAll("{{directory}}", dir)
-					.replaceAll("{{type}}", type)
-					.replaceAll("{{config}}", configPath),
-			);
-			process.exit(1);
+			const message = t("srcFolderNotFound")
+				.replaceAll("{{directory}}", dir)
+				.replaceAll("{{type}}", type)
+				.replaceAll("{{config}}", configPath);
+			log("error", message);
+			throw new MiyagiError(message, {
+				code: EXIT_CODES.CONFIG_ERROR,
+				logged: true,
+			});
 		} else {
 			log("error", error.toString(), error);
-			process.exit(1);
+			throw new MiyagiError(error.toString(), {
+				code: EXIT_CODES.GENERAL_ERROR,
+				logged: true,
+			});
 		}
 	}
 

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@schalkneethling/miyagi-core",
-	"version": "4.3.0",
+	"version": "4.4.0",
 	"description": "miyagi is a component development tool for JavaScript template engines.",
 	"main": "index.js",
 	"author": "Schalk Neethling <schalkneethling@duck.com>, Michael Großklaus <mail@mgrossklaus.de> (https://www.mgrossklaus.de)",
@@ -53,7 +53,7 @@
 	"devDependencies": {
 		"@eslint/js": "^9.39.2",
 		"@rollup/plugin-node-resolve": "^16.0.3",
-		"@rollup/plugin-terser": "^0.4.4",
+		"@rollup/plugin-terser": "^1.0.0",
 		"@types/js-yaml": "^4.0.9",
 		"@types/node": "^25.3.3",
 		"@types/yargs": "^17.0.35",
@@ -61,7 +61,7 @@
 		"cssnano": "^7.1.2",
 		"eslint": "^9.39.0",
 		"eslint-plugin-jsdoc": "^62.5.4",
-		"globals": "^15.15.0",
+		"globals": "^17.4.0",
 		"gulp": "^5.0.1",
 		"gulp-postcss": "^10.0.0",
 		"postcss": "^8.5.6",