@h3ravel/console 11.7.1 → 11.9.0

package/dist/index.cjs

@@ -47,14 +47,15 @@ let tsdown = require("tsdown");
 tsdown = __toESM(tsdown);
 
 //#region src/Commands/BuildCommand.ts
-var BuildCommand = class extends __h3ravel_core.ConsoleCommand {
+var BuildCommand = class BuildCommand extends __h3ravel_core.ConsoleCommand {
 	/**
 	* The name and signature of the console command.
 	*
 	* @var string
 	*/
-	signature = `build:
-        {--m|minify=false : Minify your bundle output}
+	signature = `build
+        {--m|minify : Minify your bundle output}
+        {--d|dev : Build for dev but don't watch for changes}
     `;
 	/**
 	* The console command description.
@@ -70,11 +71,33 @@ var BuildCommand = class extends __h3ravel_core.ConsoleCommand {
 		}
 	}
 	async fire() {
-		const outDir$1 = env("DIST_DIR", "dist");
-		const pm = (await (0, preferred_pm.default)(base_path()))?.name ?? "pnpm";
+		const outDir$1 = this.option("dev") ? ".h3ravel/serve" : env("DIST_DIR", "dist");
 		const minify = this.option("minify");
+		const verbosity = this.getVerbosity();
+		const debug = verbosity > 0;
+		this.newLine();
+		await BuildCommand.build({
+			outDir: outDir$1,
+			minify,
+			verbosity,
+			debug,
+			mute: false
+		});
+		this.newLine();
+	}
+	/**
+	* build
+	*/
+	static async build({ debug, minify, mute, verbosity, outDir: outDir$1 } = {
+		mute: false,
+		debug: false,
+		minify: false,
+		verbosity: 0,
+		outDir: "dist"
+	}) {
+		const pm = (await (0, preferred_pm.default)(base_path()))?.name ?? "pnpm";
 		const ENV_VARS = {
-			EXTENDED_DEBUG: Number(this.option("verbose", 0)) > 0 ? "true" : "false",
+			EXTENDED_DEBUG: debug ? "true" : "false",
 			CLI_BUILD: "true",
 			NODE_ENV: "production",
 			DIST_DIR: outDir$1,
@@ -84,12 +107,24 @@ var BuildCommand = class extends __h3ravel_core.ConsoleCommand {
 				"info",
 				"warn",
 				"error"
-			][Number(this.option("verbose", 0))]
+			][verbosity]
 		};
 		const silent = ENV_VARS.LOG_LEVEL === "silent" ? "--silent" : null;
-		__h3ravel_shared.Logger.log([["\n INFO ", "bgBlue"], [" Creating Production Bundle", "white"]], "");
-		console.log("");
-		await __h3ravel_shared.TaskManager.taskRunner(__h3ravel_shared.Logger.log([[" SUCCESS ", "bgGreen"], [" Production Bundle Created", "white"]], "", false), async () => {
+		if (mute) return await (0, execa.execa)(pm, [
+			"tsdown",
+			silent,
+			"--config-loader",
+			"unconfig",
+			"-c",
+			"tsdown.default.config.ts"
+		].filter((e) => e !== null), {
+			stdout: "inherit",
+			stderr: "inherit",
+			cwd: base_path(),
+			env: Object.assign({}, process.env, ENV_VARS)
+		});
+		const type = outDir$1 === "dist" ? "Production" : "Development";
+		return await __h3ravel_shared.TaskManager.advancedTaskRunner([[`Creating ${type} Bundle`, "STARTED"], [`${type} Bundle Created`, "COMPLETED"]], async () => {
 			await (0, execa.execa)(pm, [
 				"tsdown",
 				silent,
@@ -103,7 +138,6 @@ var BuildCommand = class extends __h3ravel_core.ConsoleCommand {
 				cwd: base_path(),
 				env: Object.assign({}, process.env, ENV_VARS)
 			});
-			console.log("");
 		});
 	}
 };
@@ -112,6 +146,39 @@ var BuildCommand = class extends __h3ravel_core.ConsoleCommand {
 //#region src/Commands/Command.ts
 var Command = class extends __h3ravel_core.ConsoleCommand {};
 
+//#endregion
+//#region src/Commands/HelpCommand.ts
+var HelpCommand = class extends Command {
+	/**
+	* The name and signature of the console command.
+	*
+	* @var string
+	*/
+	signature = `help
+        {command_name=help : The command name}
+        {--format=txt : The output format}
+    `;
+	/**
+	* The console command description.
+	*
+	* @var string
+	*/
+	description = "Display help for a command";
+	async handle() {
+		const cmd = this.argument("command_name");
+		if (!cmd) {
+			this.program.outputHelp();
+			return;
+		}
+		const target = this.program.commands.find((c) => c.name() === cmd);
+		if (!target) {
+			this.error(`ERROR: Unknown command: ${__h3ravel_shared.Logger.log(cmd, ["italic", "grey"], false)}.`);
+			process.exit(1);
+		}
+		target.outputHelp();
+	}
+};
+
 //#endregion
 //#region src/logo.ts
 const logo = String.raw`
@@ -148,7 +215,7 @@ const altLogo = String.raw`
 
 //#endregion
 //#region src/Commands/ListCommand.ts
-var ListCommand = class extends Command {
+var ListCommand = class ListCommand extends Command {
 	/**
 	* The name and signature of the console command.
 	*
@@ -169,21 +236,11 @@ var ListCommand = class extends Command {
 		}].concat(this.program.options).map((e) => {
 			return __h3ravel_shared.Logger.describe(__h3ravel_shared.Logger.log("  " + [e.short, e.long].filter((e$1) => !!e$1).join(", "), "green", false), e.description, 25, false).join("");
 		});
-		const grouped = this.program.commands.map((e) => {
+		/** Get the program commands */
+		const commands = this.program.commands.map((e) => {
 			return __h3ravel_shared.Logger.describe(__h3ravel_shared.Logger.log("  " + e.name(), "green", false), e.description(), 25, false).join("");
-		}).reduce((acc, cmd) => {
-			/** strip colors before checking prefix */
-			const clean = cmd.replace(/\x1b\[\d+m/g, "");
-			const prefix = clean.includes(":") ? clean.split(":")[0].trim() : "__root__";
-			acc[prefix] ??= [];
-			/** keep original with colors */
-			acc[prefix].push(cmd);
-			return acc;
-		}, {});
-		const list = Object.entries(grouped).map(([group, cmds]) => {
-			const label = group === "__root__" ? "" : group;
-			return [__h3ravel_shared.Logger.log(label, "yellow", false), cmds.join("\n")].join("\n");
 		});
+		const list = ListCommand.groupItems(commands);
 		/** Ootput the app version */
 		__h3ravel_shared.Logger.log([["H3ravel Framework", "white"], [this.kernel.modulePackage.version, "green"]], " ");
 		console.log("");
@@ -200,6 +257,29 @@ var ListCommand = class extends Command {
 		__h3ravel_shared.Logger.log("Available Commands:", "yellow");
 		console.log(list.join("\n\n").trim());
 	}
+	/**
+	* Group Commands based on thier names
+	* 
+	* @param commands 
+	* @returns 
+	*/
+	static groupItems(commands, fmtd = false) {
+		const grouped = commands.reduce((acc, cmd) => {
+			/** strip colors before checking prefix */
+			const clean = cmd.replace(/\x1b\[\d+m/g, "");
+			const prefix = clean.includes(":") ? clean.split(":")[0].trim() : "__root__";
+			acc[prefix] ??= [];
+			/** keep original with colors */
+			acc[prefix].push(cmd);
+			return acc;
+		}, {});
+		return Object.entries(grouped).map(([group, cmds]) => {
+			const label = group === "__root__" ? "" : group;
+			let out = [__h3ravel_shared.Logger.log(label, "yellow", false), cmds.join("\n")].join("\n");
+			if (fmtd) out += "\n";
+			return out;
+		});
+	}
 };
 
 //#endregion
@@ -375,13 +455,28 @@ var Signature = class Signature {
 			* Trim the string
 			*/
 			description = description.trim();
-			/**
-			* Parse name modifiers (?, *, ?*)
-			*/
 			let name = namePart;
+			let flags;
+			let choices = [];
 			let required = /[^a-zA-Z0-9_|-]/.test(name);
 			let multiple = false;
 			let placeholder;
+			let defaultValue;
+			/**
+			* Parse the command name
+			*/
+			if (name.includes("=")) {
+				const [rawName, rawDefault] = name.split("=");
+				name = rawName.trim();
+				const hold = rawName.trim().split("|");
+				const holder = (hold.at(1) ?? hold.at(0)).replace("--", "");
+				defaultValue = rawDefault.trim();
+				placeholder = defaultValue ? `[${holder}]` : `<${holder}>`;
+				required = false;
+			}
+			/**
+			* Parse name modifiers (?, *, ?*)
+			*/
 			if (name.endsWith("?*")) {
 				required = false;
 				multiple = true;
@@ -398,8 +493,6 @@ var Signature = class Signature {
 			* Check if it's a flag option (starts with --)
 			*/
 			const isFlag = name.startsWith("--");
-			let flags;
-			let defaultValue;
 			if (isFlag) {
 				/**
 				* Parse flags and default values
@@ -421,8 +514,14 @@ var Signature = class Signature {
 					} else flags.push(part);
 				}
 			}
+			const desc = description.match(/^([^:]+?)\s*:\s*\[?([\w\s,]+)\]?$/);
+			if (match) {
+				description = desc?.[1].trim() ?? description;
+				choices = desc?.[2].split(",").map((s) => s.trim()).filter(Boolean) ?? choices;
+			}
 			options.push({
 				name: isFlag ? flags[flags.length - 1] : name,
+				choices,
 				required,
 				multiple,
 				description,
@@ -447,7 +546,7 @@ var Signature = class Signature {
 	static parseSignature(signature, commandClass) {
 		const lines = signature.split("\n").map((l) => l.trim()).filter((l) => l.length > 0);
 		const isHidden = ["#", "^"].includes(lines[0][0]) || /:[#^]/.test(lines[0]);
-		const baseCommand = lines[0].replace(/[^\w=:-]/g, "");
+		const baseCommand = lines[0].split("{")[0].trim().replace(/[^\w:-]/g, "");
 		const description = commandClass.getDescription();
 		const isNamespaceCommand = baseCommand.endsWith(":");
 		/**
@@ -609,10 +708,11 @@ var Musket = class Musket {
 	async build() {
 		this.loadBaseCommands();
 		await this.loadDiscoveredCommands();
-		return this.initialize();
+		return await this.initialize();
 	}
 	loadBaseCommands() {
 		[
+			new HelpCommand(this.app, this.kernel),
 			new MakeCommand(this.app, this.kernel),
 			new ListCommand(this.app, this.kernel),
 			new PostinstallCommand(this.app, this.kernel),
@@ -639,32 +739,63 @@ var Musket = class Musket {
 	addCommand(command) {
 		this.commands.push(Signature.parseSignature(command.getSignature(), command));
 	}
-	initialize() {
+	async initialize() {
+		if (process.argv.includes("--help") || process.argv.includes("-h")) {
+			await this.rebuild("help");
+			Object.keys(require.cache).forEach((key) => delete require.cache[key]);
+		}
 		/** Init the Musket Version */
 		const cliVersion = __h3ravel_shared.Logger.parse([["Musket CLI:", "white"], [this.kernel.consolePackage.version, "green"]], " ", false);
 		/** Init the App Version */
 		const localVersion = __h3ravel_shared.Logger.parse([["H3ravel Framework:", "white"], [this.kernel.modulePackage.version, "green"]], " ", false);
 		const additional = {
-			quiet: ["-q, --quiet", "Do not output any message"],
+			quiet: ["-q, --quiet", "Do not output any message except errors and warnings"],
 			silent: ["--silent", "Do not output any message"],
 			verbose: ["-v, --verbose <number>", "Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug"],
-			lock: ["--lock", "Locked and loaded, do not ask any interactive question"]
+			noInteraction: ["-n, --no-interaction", "Do not ask any interactive question"]
 		};
-		/** Init Commander */
-		commander.program.name("musket").version(`${cliVersion}\n${localVersion}`).description(altLogo).addOption(new commander.Option(additional.quiet[0], additional.quiet[1]).implies({ silent: true })).addOption(new commander.Option(additional.silent[0], additional.silent[1]).implies({ quiet: true })).addOption(new commander.Option(additional.verbose[0], additional.verbose[1]).choices([
+		/** 
+		* Init Commander
+		*/
+		commander.program.name("musket").version(`${cliVersion}\n${localVersion}`).description(altLogo).configureHelp({ showGlobalOptions: true }).addOption(new commander.Option(additional.quiet[0], additional.quiet[1])).addOption(new commander.Option(additional.silent[0], additional.silent[1]).implies({ quiet: true })).addOption(new commander.Option(additional.verbose[0], additional.verbose[1]).choices([
 			"1",
 			"2",
 			"3"
-		])).addOption(new commander.Option(additional.lock[0], additional.lock[1])).action(async () => {
+		])).addOption(new commander.Option(additional.noInteraction[0], additional.noInteraction[1])).action(async () => {
 			const instance = new ListCommand(this.app, this.kernel);
 			instance.setInput(commander.program.opts(), commander.program.args, commander.program.registeredArguments, {}, commander.program);
-			instance.handle();
+			await this.handle(instance);
 		});
-		/** Create the init Command */
+		/**
+		* Format the help command display
+		*/
+		commander.program.configureHelp({
+			styleTitle: (str) => __h3ravel_shared.Logger.log(str, "yellow", false),
+			styleOptionTerm: (str) => __h3ravel_shared.Logger.log(str, "green", false),
+			styleArgumentTerm: (str) => __h3ravel_shared.Logger.log(str, "green", false),
+			styleSubcommandTerm: (str) => __h3ravel_shared.Logger.log(str, "green", false),
+			formatItemList(heading, items) {
+				if (items.length < 1) return [];
+				if (!heading.includes("Commands:")) return items;
+				const c = (str) => str.replace(/[^A-Za-z0-9-,]/g, "").replace("32m", "");
+				let flags = items.filter((e) => c(e).startsWith("--") || c(e).includes(",--"));
+				if (flags.length > 0) flags = [__h3ravel_shared.Logger.log("\n" + heading + "\n", "yellow", false)].concat(flags);
+				const list = items.filter((e) => !c(e).startsWith("--") && !c(e).includes(",--"));
+				if (list.length < 1) return flags;
+				const _heading = c(heading).includes("Arguments") ? heading : "Available Commands:";
+				return flags.concat(__h3ravel_shared.Logger.log(`\n${_heading}`, "yellow", false), ListCommand.groupItems(list, true));
+			},
+			showGlobalOptions: true
+		});
+		/** 
+		* Create the init Command
+		*/
 		commander.program.command("init").description("Initialize H3ravel.").action(async () => {
 			__h3ravel_shared.Logger.success("Initialized: H3ravel has been initialized!");
 		});
-		/** Loop through all the available commands */
+		/** 
+		* Loop through all the available commands
+		*/
 		for (let i = 0; i < this.commands.length; i++) {
 			const command = this.commands[i];
 			const instance = command.commandClass;
@@ -672,13 +803,9 @@ var Musket = class Musket {
 				/**
 				* Initialize the base command
 				*/
-				const cmd = command.isHidden ? commander.program : commander.program.command(command.baseCommand).description(command.description ?? "").addOption(new commander.Option(additional.quiet[0], additional.quiet[1]).implies({ silent: true })).addOption(new commander.Option(additional.silent[0], additional.silent[1]).implies({ quiet: true })).addOption(new commander.Option(additional.verbose[0], additional.verbose[1]).choices([
-					"1",
-					"2",
-					"3"
-				])).addOption(new commander.Option(additional.lock[0], additional.lock[1])).action(async () => {
+				const cmd = command.isHidden ? commander.program : commander.program.command(command.baseCommand).description(command.description ?? "").action(async () => {
 					instance.setInput(cmd.opts(), cmd.args, cmd.registeredArguments, command, commander.program);
-					await instance.handle();
+					await this.handle(instance);
 				});
 				/**
 				* Add options to the base command if it has any
@@ -690,13 +817,9 @@ var Musket = class Musket {
 				* Initialize the sub commands
 				*/
 				command.subCommands.filter((v, i$1, a) => !v.shared && a.findIndex((t) => t.name === v.name) === i$1).forEach((sub) => {
-					const cmd$1 = commander.program.command(`${command.baseCommand}:${sub.name}`).description(sub.description || "").addOption(new commander.Option(additional.quiet[0], additional.quiet[1]).implies({ silent: true })).addOption(new commander.Option(additional.silent[0], additional.silent[1]).implies({ quiet: true })).addOption(new commander.Option(additional.verbose[0], additional.verbose[1]).choices([
-						"1",
-						"2",
-						"3"
-					])).addOption(new commander.Option(additional.lock[0], additional.lock[1])).action(async () => {
+					const cmd$1 = commander.program.command(`${command.baseCommand}:${sub.name}`).description(sub.description || "").action(async () => {
 						instance.setInput(cmd$1.opts(), cmd$1.args, cmd$1.registeredArguments, sub, commander.program);
-						await instance.handle();
+						await this.handle(instance);
 					});
 					/**
 					* Add the shared arguments here
@@ -727,20 +850,23 @@ var Musket = class Musket {
 				});
 				cmd.action(async () => {
 					instance.setInput(cmd.opts(), cmd.args, cmd.registeredArguments, command, commander.program);
-					await instance.handle();
+					await this.handle(instance);
 				});
 			}
 		}
 		/** Rebuild the app on every command except fire so we wont need TS */
 		commander.program.hook("preAction", async (_, cmd) => {
-			if (cmd.name() !== "fire") await (0, tsdown.build)({
-				...TsdownConfig_default,
-				watch: false,
-				plugins: []
-			});
+			this.rebuild(cmd.name());
 		});
 		return commander.program;
 	}
+	async rebuild(name) {
+		if (name !== "fire" && name !== "build") await (0, tsdown.build)({
+			...TsdownConfig_default,
+			watch: false,
+			plugins: []
+		});
+	}
 	makeOption(opt, cmd, parse, parent) {
 		const description = opt.description?.replace(/\[(\w+)\]/g, (_, k) => parent?.[k] ?? `[${k}]`) ?? "";
 		const type = opt.name.replaceAll("-", "");
@@ -748,17 +874,38 @@ var Musket = class Musket {
 			let flags = opt.flags?.map((f) => f.length === 1 ? `-${f}` : `--${f.replace(/^-+/, "")}`).join(", ") ?? void 0;
 			if (opt.required && !opt.placeholder) flags += ` <${type}>`;
 			else if (opt.placeholder) flags += " " + opt.placeholder;
-			cmd.option(flags || "", description, opt.defaultValue);
+			let optn = new commander.Option(flags || "", description).default(opt.defaultValue);
+			if (opt.choices && opt.choices.length) optn = optn.choices(opt.choices ?? []);
+			cmd.addOption(optn);
 		} else {
 			let flags = opt.flags?.join(", ") ?? "";
 			if (opt.required && !opt.placeholder) flags += ` <${type}>`;
 			else if (opt.placeholder) flags += " " + opt.placeholder;
-			cmd.option(flags, description, opt.defaultValue);
+			let optn = new commander.Option(flags, description).default(opt.defaultValue);
+			if (opt.choices && opt.choices.length) optn = optn.choices(opt.choices ?? []);
+			cmd.addOption(optn);
 		}
-		else cmd.argument(opt.required ? `<${opt.name}>` : `[${opt.name}]`, description, opt.defaultValue);
+		else {
+			let name = opt.placeholder;
+			if (!name) name = opt.required ? `<${opt.name}>` : `[${opt.name}]`;
+			let arg = new commander.Argument(name, description);
+			if (opt.choices && opt.choices.length) arg = arg.choices(opt.choices ?? []);
+			if (opt.defaultValue) arg.default(opt.defaultValue);
+			cmd.addArgument(arg);
+		}
+	}
+	async handle(cmd) {
+		await new __h3ravel_core.ContainerResolver(this.app).resolveMethodParams(cmd, "handle");
 	}
 	static async parse(kernel) {
-		return (await new Musket(kernel.app, kernel).build()).parseAsync();
+		return (await new Musket(kernel.app, kernel).build()).exitOverride(() => {
+			__h3ravel_shared.Logger.log("Unknown command or argument.", "white");
+			__h3ravel_shared.Logger.log([
+				["Run", "white"],
+				["`musket --help`", ["grey", "italic"]],
+				["to see available commands.", "white"]
+			], " ");
+		}).parseAsync(process.argv).catch((e) => e);
 	}
 };
 
@@ -829,6 +976,7 @@ var ConsoleServiceProvider = class extends __h3ravel_core.ServiceProvider {
 exports.BuildCommand = BuildCommand;
 exports.Command = Command;
 exports.ConsoleServiceProvider = ConsoleServiceProvider;
+exports.HelpCommand = HelpCommand;
 exports.Kernel = Kernel;
 exports.ListCommand = ListCommand;
 exports.MakeCommand = MakeCommand;