@clerc/plugin-help 1.0.0-beta.15 → 1.0.0-beta.16

package/dist/index.d.ts

@@ -1,21 +1,24 @@
 import { Plugin } from "@clerc/core";
 
 //#region ../parser/src/types.d.ts
-type FlagDefaultValue<T = unknown> = T | ((() => T) & {
+interface FlagDefaultValueFunction<T> {
+  (): T;
   display?: string;
-});
+}
+type FlagDefaultValue<T = unknown> = T | FlagDefaultValueFunction<T>;
 /**
 * Defines how a string input is converted to the target type T.
 *
 * @template T The target type.
 */
-type FlagTypeFunction<T = unknown> = ((value: string) => T) & {
+interface FlagTypeFunction<T = unknown> {
+  (value: string): T;
   /**
   * Optional display name for the type, useful in help output.
   * If provided, this will be shown instead of the function name.
   */
   display?: string;
-};
+}
 type FlagType<T = unknown> = FlagTypeFunction<T> | readonly [FlagTypeFunction<T>];
 //#endregion
 //#region src/types.d.ts

package/dist/index.js

@@ -69,6 +69,7 @@ var HelpRenderer = class {
 		return [
 			this.renderHeader(),
 			this.renderUsage(),
+			this.renderParameters(),
 			this.renderCommands(),
 			this.renderGlobalFlags(),
 			this.renderCommandFlags(),
@@ -83,7 +84,7 @@ var HelpRenderer = class {
 	renderHeader() {
 		const { _name, _version, _description } = this._cli;
 		const command = this._command;
-		const description = command?.description ?? _description;
+		const description = command ? command.description : _description;
 		const formattedCommandName = command?.name ? ` ${yc.cyan(command.name)}` : "";
 		const headerLine = command ? `${yc.green(_name)}${formattedCommandName}` : `${yc.green(_name)} ${yc.yellow(formatVersion(_version))}`;
 		const alias = command?.alias ? `Alias${toArray(command.alias).length > 1 ? "es" : ""}: ${toArray(command.alias).map((a) => yc.cyan(a)).join(", ")}` : void 0;
@@ -95,7 +96,7 @@ var HelpRenderer = class {
 		let usage = `$ ${_scriptName}`;
 		if (command) {
 			if (command.name) usage += ` ${command.name}`;
-			if (command.parameters) usage += ` ${command.parameters.join(" ")}`;
+			if (command.parameters) usage += ` ${command.parameters.map((p) => typeof p === "string" ? p : p.key).join(" ")}`;
 		} else usage += this._cli._commands.has("") ? " [command]" : " <command>";
 		if (command?.flags && !objectIsEmpty(command.flags) || !objectIsEmpty(this._globalFlags)) usage += " [flags]";
 		return {
@@ -103,6 +104,23 @@ var HelpRenderer = class {
 			body: [yc.magenta(usage)]
 		};
 	}
+	renderParameters() {
+		const command = this._command;
+		if (!command?.parameters || command.parameters.length === 0) return;
+		return {
+			title: "Parameters",
+			body: splitTable(command.parameters.map((parameter) => {
+				const key = typeof parameter === "string" ? parameter : parameter.key;
+				const constraint = typeof parameter === "string" ? void 0 : parameter.constraint;
+				const description = typeof parameter === "string" ? void 0 : parameter.description;
+				return [
+					yc.blue(key),
+					constraint?.display ? yc.gray(constraint.display) : void 0,
+					description
+				].filter(isTruthy);
+			}))
+		};
+	}
 	getSubcommands(parentCommandName) {
 		const subcommands = /* @__PURE__ */ new Map();
 		if (!parentCommandName) return subcommands;
@@ -132,7 +150,7 @@ var HelpRenderer = class {
 			if (command.__isAlias || command.help?.show === false) continue;
 			const group = command.help?.group;
 			validateGroup(group, this._commandGroups, "command", command.name);
-			const item = [`${yc.cyan(formatCommandName(command.name.slice(prefix.length)))}${command.alias ? ` (${toArray(command.alias).join(", ")})` : ""}`, command.description];
+			const item = [`${yc.cyan(formatCommandName(command.name.slice(prefix.length)))}${command.alias ? ` (${toArray(command.alias).join(", ")})` : ""}`, command.description].filter(isTruthy);
 			if (command.name === "") rootCommand = item;
 			else if (group && group !== DEFAULT_GROUP_KEY) {
 				const groupItems = groupedCommands.get(group) ?? [];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@clerc/plugin-help",
-  "version": "1.0.0-beta.15",
+  "version": "1.0.0-beta.16",
   "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-beta.15",
-    "@clerc/utils": "1.0.0-beta.15",
-    "@clerc/core": "1.0.0-beta.15"
+    "@clerc/core": "1.0.0-beta.16",
+    "@clerc/parser": "1.0.0-beta.16",
+    "@clerc/utils": "1.0.0-beta.16"
   },
   "peerDependencies": {
     "@clerc/core": "*"