feat(plugin-help): display subcommands

Author: so1ve

packages/plugin-help/src/renderer.ts

@@ -1,4 +1,9 @@
-import type { Clerc, ClercFlagsDefinition, Command } from "@clerc/core";
+import type {
+	Clerc,
+	ClercFlagsDefinition,
+	Command,
+	CommandsMap,
+} from "@clerc/core";
 import {
 	formatFlagName,
 	formatVersion,
@@ -165,9 +170,46 @@ export class HelpRenderer {
 		};
 	}
 
+	private getSubcommands(parentCommandName: string): CommandsMap {
+		const subcommands = new Map<string, Command>();
+
+		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;
+	}
+
 	private renderCommands() {
 		const commands = this._cli._commands;
-		if (this._command || commands.size === 0) {
+
+		// If a command is selected, show its subcommands
+		let commandsToShow: CommandsMap;
+		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;
 		}
 
@@ -176,15 +218,17 @@ export class HelpRenderer {
 		const defaultCommands: string[][] = [];
 		let rootCommand: string[] = [];
 
-		for (const command of commands.values()) {
+		for (const command of commandsToShow.values()) {
 			if ((command as any).__isAlias || command.help?.show === false) {
 				continue;
 			}
 
 			const group = command.help?.group;
 			validateGroup(group, this._commandGroups, "command", command.name);
 
-			const commandName = yc.cyan(formatCommandName(command.name));
+			const commandName = yc.cyan(
+				formatCommandName(command.name.slice(prefix.length)),
+			);
 			const aliases = command.alias
 				? ` (${toArray(command.alias).join(", ")})`
 				: "";
@@ -233,7 +277,7 @@ export class HelpRenderer {
 		}
 
 		return {
-			title: "Commands",
+			title,
 			body,
 		};
 	}

packages/plugin-help/test/__snapshots__/plugin-help.test.ts.snap

@@ -1,5 +1,32 @@
 // Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
 
+exports[`plugin-help > grouping > should display subcommands 1`] = `
+[
+  [
+    "test parent - Parent command
+
+Usage
+  $ test parent [flags]
+
+Subcommands
+  child1  First child command
+  child2  Second child command
+
+Global Flags
+  --help, -h  Boolean  Show help  [default: false]",
+  ],
+  [
+    "test - Parent command
+
+Usage
+  $ test [flags]
+
+Global Flags
+  --help, -h  Boolean  Show help  [default: false]",
+  ],
+]
+`;
+
 exports[`plugin-help > grouping > should group command flags 1`] = `
 [
   [

packages/plugin-help/test/plugin-help.test.ts

@@ -163,5 +163,23 @@ describe("plugin-help", () => {
 
 			expect(getConsoleMock("log").mock.calls).toMatchSnapshot();
 		});
+
+		it("should display subcommands", () => {
+			TestBaseCli()
+				.use(helpPlugin())
+				.command("parent", "Parent command")
+				.command("parent child1", "First child command")
+				.command("parent child2", "Second child command")
+				.parse(["parent", "--help"]);
+
+			TestBaseCli()
+				.use(helpPlugin())
+				.command("", "Parent command")
+				.command("child1", "First child command")
+				.command("child2", "Second child command")
+				.parse(["--help"]);
+
+			expect(getConsoleMock("log").mock.calls).toMatchSnapshot();
+		});
 	});
 });