@clerc/plugin-help 1.0.0-beta.11 → 1.0.0-beta.13

package/dist/index.js

@@ -1,4 +1,4 @@
-import { definePlugin, resolveCommand } from "@clerc/core";
+import { NoSuchCommandError, definePlugin, resolveCommand } from "@clerc/core";
 import stringWidth from "string-width";
 import textTable from "text-table";
 import * as yc from "yoctocolors";
@@ -18,6 +18,10 @@ function formatFlagType(type) {
 	const innerType = type[0];
 	return `Array<${innerType.displayName ?? innerType.name}>`;
 }
+function formatCommandName(name) {
+	if (name === "") return "(root)";
+	return name;
+}
 
 //#endregion
 //#region src/formatters.ts
@@ -92,23 +96,48 @@ var HelpRenderer = class {
 			body: [yc.magenta(usage)]
 		};
 	}
+	getSubcommands(parentCommandName) {
+		const subcommands = /* @__PURE__ */ new Map();
+		if (!parentCommandName) return subcommands;
+		const prefix = `${parentCommandName} `;
+		for (const [name, command] of this._cli._commands) if (name.startsWith(prefix) && name !== parentCommandName) {
+			const subcommandName = name.slice(prefix.length);
+			subcommands.set(subcommandName, command);
+		}
+		return subcommands;
+	}
 	renderCommands() {
 		const commands = this._cli._commands;
-		if (this._command || commands.size === 0) return;
+		let commandsToShow;
+		let title = "Commands";
+		let prefix = "";
+		if (this._command) {
+			prefix = this._command.name ? `${this._command.name} ` : "";
+			title = "Subcommands";
+			commandsToShow = this.getSubcommands(this._command.name);
+			if (commandsToShow.size === 0) return;
+		} else commandsToShow = commands;
+		if (commandsToShow.size === 0) return;
 		const groupedCommands = /* @__PURE__ */ new Map();
 		const defaultCommands = [];
-		for (const command of commands.values()) {
+		let rootCommand = [];
+		for (const command of commandsToShow.values()) {
 			if (command.__isAlias || command.help?.show === false) continue;
 			const group = command.help?.group;
 			validateGroup(group, this._commandGroups, "command", command.name);
-			const item = [`${yc.cyan(command.name)}${command.alias ? ` (${toArray(command.alias).join(", ")})` : ""}`, command.description];
-			if (group && group !== DEFAULT_GROUP_KEY) {
+			const item = [`${yc.cyan(formatCommandName(command.name.slice(prefix.length)))}${command.alias ? ` (${toArray(command.alias).join(", ")})` : ""}`, command.description];
+			if (command.name === "") rootCommand = item;
+			else if (group && group !== DEFAULT_GROUP_KEY) {
 				const groupItems = groupedCommands.get(group) ?? [];
 				groupItems.push(item);
 				groupedCommands.set(group, groupItems);
 			} else defaultCommands.push(item);
 		}
 		const body = [];
+		const defaultGroup = [];
+		if (rootCommand.length > 0) defaultGroup.push(rootCommand);
+		if (defaultCommands.length > 0) defaultGroup.push(...defaultCommands);
+		if (defaultGroup.length > 0) body.push(...splitTable(defaultGroup));
 		for (const [key, name] of this._commandGroups) {
 			const items = groupedCommands.get(key);
 			if (items && items.length > 0) {
@@ -117,13 +146,8 @@ var HelpRenderer = class {
 				body.push(...splitTable(items).map(withIndent));
 			}
 		}
-		if (defaultCommands.length > 0) if (body.length > 0) {
-			body.push("");
-			body.push(`${yc.dim("Other")}`);
-			body.push(...splitTable(defaultCommands).map(withIndent));
-		} else body.push(...splitTable(defaultCommands));
 		return {
-			title: "Commands",
+			title,
 			body
 		};
 	}
@@ -152,6 +176,7 @@ var HelpRenderer = class {
 			} else defaultFlags.push(item);
 		}
 		const body = [];
+		if (defaultFlags.length > 0) body.push(...splitTable(defaultFlags));
 		for (const [key, name] of groupMap) {
 			const items = groupedFlags.get(key);
 			if (items && items.length > 0) {
@@ -160,11 +185,6 @@ var HelpRenderer = class {
 				body.push(...splitTable(items).map(withIndent));
 			}
 		}
-		if (defaultFlags.length > 0) if (body.length > 0) {
-			body.push("");
-			body.push(`${yc.dim("Other")}`);
-			body.push(...splitTable(defaultFlags).map(withIndent));
-		} else body.push(...splitTable(defaultFlags));
 		return body;
 	}
 	renderCommandFlags() {
@@ -238,10 +258,7 @@ const helpPlugin = ({ command = true, flag = true, showHelpWhenNoCommandSpecifie
 		let command$1;
 		if (commandName.length > 0) {
 			[command$1] = resolveCommand(cli._commands, commandName);
-			if (!command$1) {
-				console.error(`Command "${commandName.join(" ")}" not found.`);
-				return;
-			}
+			if (!command$1) throw new NoSuchCommandError(commandName.join(" "));
 		}
 		printHelp(new HelpRenderer(mergedFormatters, cli, cli._globalFlags, command$1, command$1 ? command$1.help?.notes : effectiveNotes, command$1 ? command$1.help?.examples : effectiveExamples, groups).render());
 	});
@@ -251,10 +268,13 @@ const helpPlugin = ({ command = true, flag = true, showHelpWhenNoCommandSpecifie
 		default: false
 	});
 	cli.interceptor({
-		enforce: "pre",
+		enforce: "post",
 		handler: async (ctx, next) => {
-			if (ctx.flags.help) printHelp(new HelpRenderer(mergedFormatters, cli, cli._globalFlags, ctx.command, ctx.command ? ctx.command.help?.notes : effectiveNotes, ctx.command ? ctx.command.help?.examples : effectiveExamples, groups).render());
-			else if (showHelpWhenNoCommandSpecified && !ctx.command && ctx.rawParsed.parameters.length === 0) printHelp(new HelpRenderer(mergedFormatters, cli, cli._globalFlags, void 0, effectiveNotes, effectiveExamples, groups).render());
+			if (ctx.flags.help) {
+				const command$1 = ctx.command;
+				if (!command$1 && ctx.rawParsed.parameters.length > 0) await next();
+				printHelp(new HelpRenderer(mergedFormatters, cli, cli._globalFlags, command$1, command$1 ? command$1.help?.notes : effectiveNotes, command$1 ? command$1.help?.examples : effectiveExamples, groups).render());
+			} else if (showHelpWhenNoCommandSpecified && !ctx.command && ctx.rawParsed.parameters.length === 0) printHelp(new HelpRenderer(mergedFormatters, cli, cli._globalFlags, void 0, effectiveNotes, effectiveExamples, groups).render());
 			else await next();
 		}
 	});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@clerc/plugin-help",
-  "version": "1.0.0-beta.11",
+  "version": "1.0.0-beta.13",
   "author": "Ray <i@mk1.io> (https://github.com/so1ve)",
   "type": "module",
   "description": "Clerc plugin help",
@@ -51,9 +51,10 @@
     "yoctocolors": "^2.1.2"
   },
   "devDependencies": {
-    "@clerc/parser": "1.0.0-beta.11",
-    "@clerc/core": "1.0.0-beta.11",
-    "@clerc/utils": "1.0.0-beta.11"
+    "kons": "^0.7.1",
+    "@clerc/core": "1.0.0-beta.13",
+    "@clerc/parser": "1.0.0-beta.13",
+    "@clerc/utils": "1.0.0-beta.13"
   },
   "peerDependencies": {
     "@clerc/core": "*"