@clerc/plugin-help 1.0.0 → 1.0.2

package/dist/index.js

@@ -61,18 +61,18 @@ var HelpRenderer = class {
 	get _globalFlagGroups() {
 		return groupDefinitionsToMap(this._getGroups().globalFlags);
 	}
-	constructor(_formatters, _cli, _globalFlags, _getGroups, _getExamples, _notes) {
+	constructor(_formatters, _cli, _globalFlags, _getGroups, _examples, _notes) {
 		this._formatters = _formatters;
 		this._cli = _cli;
 		this._globalFlags = _globalFlags;
 		this._getGroups = _getGroups;
-		this._getExamples = _getExamples;
+		this._examples = _examples;
 		this._notes = _notes;
 	}
 	setCommand(command) {
 		if (command) {
 			this._command = command;
-			this._getExamples = () => command?.help?.examples;
+			this._examples = command?.help?.examples;
 			this._notes = command?.help?.notes;
 		}
 	}
@@ -97,11 +97,10 @@ var HelpRenderer = class {
 		return this.renderSections(sections);
 	}
 	renderHeader() {
-		const { _name, _version, _description } = this._cli;
+		const { _scriptName, _version, _description } = this._cli;
 		const command = this._command;
 		const description = command ? command.description : _description;
-		const formattedCommandName = command?.name ? ` ${tint.bold(command.name)}` : "";
-		const headerLine = command ? `${tint.dim(_name)}${formattedCommandName}` : `${tint.bold(_name)} ${formatVersion(_version)}`;
+		const headerLine = `${!command || command.name === "" ? tint.bold(_scriptName) : tint.dim(_scriptName)}${command?.name ? ` ${tint.bold(command.name)}` : ""}${command ? "" : ` ${formatVersion(_version)}`}`;
 		const alias = command?.alias ? `Alias${toArray(command.alias).length > 1 ? "es" : ""}: ${toArray(command.alias).map((a) => tint.bold(a)).join(", ")}` : void 0;
 		return { body: [`${headerLine}${description ? ` ${DELIMITER} ${description}` : ""}`, alias] };
 	}
@@ -192,7 +191,7 @@ var HelpRenderer = class {
 		const prefix = `${parentCommandName} `;
 		const body = this.buildGroupedCommandsBody(subcommands, prefix);
 		if (body.length === 0) return null;
-		const sections = [{ body: `${this._cli._name} ${tint.bold(parentCommandName)} not found` }, {
+		const sections = [{ body: `${this._cli._scriptName} ${tint.bold(parentCommandName)} not found` }, {
 			title: "Available Subcommands",
 			body
 		}];
@@ -277,11 +276,10 @@ var HelpRenderer = class {
 		};
 	}
 	renderExamples() {
-		const examples = this._getExamples();
-		if (!examples?.length) return;
+		if (!this._examples?.length) return;
 		return {
 			title: "Examples",
-			body: splitTable(examples.map(([command, description]) => {
+			body: splitTable(this._examples.map(([command, description]) => {
 				return [
 					command,
 					DELIMITER,
@@ -310,24 +308,12 @@ const helpPlugin = ({ command = true, flag = true, showHelpWhenNoCommandSpecifie
 		...defaultFormatters,
 		...formatters
 	};
-	const generalHelpNotes = [
-		"If no command is specified, show help for the CLI.",
-		"If a command is specified, show help for the command.",
-		flag && "-h is an alias for --help."
-	].filter(isTruthy);
-	const getGeneralHelpExamples = () => [
-		command && [`$ ${cli._scriptName} help`, "Show help"],
-		command && [`$ ${cli._scriptName} help <command>`, "Show help for a specific command"],
-		flag && [`$ ${cli._scriptName} <command> --help`, "Show help for a specific command"]
-	].filter(isTruthy);
-	const effectiveNotes = notes ?? generalHelpNotes;
-	const getEffectiveExamples = () => examples ?? getGeneralHelpExamples();
 	function printHelp(s) {
 		if (header) console.log(header);
 		console.log(s);
 		if (footer) console.log(footer);
 	}
-	const renderer = new HelpRenderer(mergedFormatters, cli, cli._globalFlags, () => groups, getEffectiveExamples, effectiveNotes);
+	const renderer = new HelpRenderer(mergedFormatters, cli, cli._globalFlags, () => groups, examples, notes);
 	function tryPrintSubcommandsHelp(commandName) {
 		const subcommandsOutput = renderer.renderAvailableSubcommands(commandName);
 		if (subcommandsOutput) {
@@ -339,8 +325,16 @@ const helpPlugin = ({ command = true, flag = true, showHelpWhenNoCommandSpecifie
 	if (command) cli.command("help", "Show help", {
 		parameters: ["[command...]"],
 		help: {
-			notes: generalHelpNotes,
-			examples: getGeneralHelpExamples()
+			notes: [
+				"If no command is specified, show help for the CLI.",
+				"If a command is specified, show help for the command.",
+				flag && "-h is an alias for --help."
+			].filter(isTruthy),
+			examples: [
+				command && [`$ ${cli._scriptName} help`, "Show help"],
+				command && [`$ ${cli._scriptName} help <command>`, "Show help for a specific command"],
+				flag && [`$ ${cli._scriptName} <command> --help`, "Show help for a specific command"]
+			].filter(isTruthy)
 		}
 	}).on("help", (ctx) => {
 		const commandName = ctx.parameters.command;
@@ -372,8 +366,10 @@ const helpPlugin = ({ command = true, flag = true, showHelpWhenNoCommandSpecifie
 				}
 				renderer.setCommand(command$1);
 				printHelp(renderer.render());
-			} else if (showHelpWhenNoCommandSpecified && !ctx.command && ctx.rawParsed.parameters.length === 0) printHelp(renderer.render());
-			else await next();
+			} else if (showHelpWhenNoCommandSpecified && !ctx.command && ctx.rawParsed.parameters.length === 0) {
+				console.log("No command specified. Showing help:\n");
+				printHelp(renderer.render());
+			} else await next();
 		}
 	});
 } });

package/package.json

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