@clerc/plugin-help 1.0.0-beta.20 → 1.0.0-beta.22

package/dist/index.d.ts

@@ -19,11 +19,11 @@ interface TypeFunction<T = unknown> {
   */
   display?: string;
 }
-type FlagType<T = unknown> = TypeFunction<T> | readonly [TypeFunction<T>];
+type TypeValue<T = unknown> = TypeFunction<T> | readonly [TypeFunction<T>];
 //#endregion
 //#region src/types.d.ts
 interface Formatters {
-  formatFlagType: (type: FlagType) => string;
+  formatTypeValue: (type: TypeValue) => string;
   formatFlagDefault: <T>(value: FlagDefaultValue<T>) => string;
 }
 /**

package/dist/index.js

@@ -13,7 +13,7 @@ const objectIsEmpty = (obj) => Object.keys(obj).length === 0;
 
 //#endregion
 //#region src/utils.ts
-function formatFlagType(type) {
+function formatTypeValue(type) {
 	if (typeof type === "function") return type.display ?? type.name;
 	const innerType = type[0];
 	return `Array<${innerType.displayName ?? innerType.name}>`;
@@ -30,7 +30,7 @@ function formatCommandName(name) {
 //#endregion
 //#region src/formatters.ts
 const defaultFormatters = {
-	formatFlagType,
+	formatTypeValue,
 	formatFlagDefault
 };
 
@@ -39,7 +39,7 @@ const defaultFormatters = {
 const DEFAULT_GROUP_KEY = "default";
 const table = (items) => textTable(items, { stringLength: stringWidth });
 const splitTable = (items) => table(items).split("\n");
-const DELIMITER = yc.yellow("-");
+const DELIMITER = "-";
 const INDENT = " ".repeat(2);
 const withIndent = (str) => `${INDENT}${str}`;
 function groupDefinitionsToMap(definitions) {
@@ -61,18 +61,18 @@ var HelpRenderer = class {
 	get _globalFlagGroups() {
 		return groupDefinitionsToMap(this._getGroups().globalFlags);
 	}
-	constructor(_formatters, _cli, _globalFlags, _getGroups, _examples, _notes) {
+	constructor(_formatters, _cli, _globalFlags, _getGroups, _getExamples, _notes) {
 		this._formatters = _formatters;
 		this._cli = _cli;
 		this._globalFlags = _globalFlags;
 		this._getGroups = _getGroups;
-		this._examples = _examples;
+		this._getExamples = _getExamples;
 		this._notes = _notes;
 	}
 	setCommand(command) {
 		if (command) {
 			this._command = command;
-			this._examples = command?.help?.examples;
+			this._getExamples = () => command?.help?.examples;
 			this._notes = command?.help?.notes;
 		}
 	}
@@ -80,7 +80,7 @@ var HelpRenderer = class {
 		return sections.filter(isTruthy).map((section) => {
 			const body = Array.isArray(section.body) ? section.body.filter((s) => s !== void 0).join("\n") : section.body;
 			if (!section.title) return body;
-			return `${yc.bold(section.title)}\n${body.split("\n").map(withIndent).join("\n")}`;
+			return `${yc.underline(yc.bold(section.title))}\n${body.split("\n").map(withIndent).join("\n")}`;
 		}).join("\n\n");
 	}
 	render() {
@@ -100,9 +100,9 @@ var HelpRenderer = class {
 		const { _name, _version, _description } = this._cli;
 		const command = this._command;
 		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;
+		const formattedCommandName = command?.name ? ` ${yc.bold(command.name)}` : "";
+		const headerLine = command ? `${yc.dim(_name)}${formattedCommandName}` : `${yc.bold(_name)} ${formatVersion(_version)}`;
+		const alias = command?.alias ? `Alias${toArray(command.alias).length > 1 ? "es" : ""}: ${toArray(command.alias).map((a) => yc.bold(a)).join(", ")}` : void 0;
 		return { body: [`${headerLine}${description ? ` ${DELIMITER} ${description}` : ""}`, alias] };
 	}
 	renderUsage() {
@@ -112,11 +112,11 @@ var HelpRenderer = class {
 		if (command) {
 			if (command.name) usage += ` ${command.name}`;
 			if (command.parameters) usage += ` ${command.parameters.map((p) => typeof p === "string" ? p : p.key).join(" ")}`;
-		} else usage += this._cli._commands.has("") ? " [command]" : " <command>";
+		} else if (this._cli._commands.size > 0 && !(this._cli._commands.has("") && this._cli._commands.size === 1)) usage += this._cli._commands.has("") ? " [command]" : " <command>";
 		if (command?.flags && !objectIsEmpty(command.flags) || !objectIsEmpty(this._globalFlags)) usage += " [flags]";
 		return {
 			title: "Usage",
-			body: [yc.magenta(usage)]
+			body: [usage]
 		};
 	}
 	renderParameters() {
@@ -129,8 +129,8 @@ var HelpRenderer = class {
 				const type = typeof parameter === "string" ? void 0 : parameter.type;
 				const description = typeof parameter === "string" ? void 0 : parameter.description;
 				return [
-					yc.blue(key),
-					type?.display ? yc.gray(type.display) : void 0,
+					yc.bold(key),
+					type ? this._formatters.formatTypeValue(type) : "string",
 					description
 				].filter(isTruthy);
 			}))
@@ -154,7 +154,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].filter(isTruthy);
+			const item = [`${yc.bold(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) ?? [];
@@ -183,7 +183,7 @@ var HelpRenderer = class {
 		const prefix = `${parentCommandName} `;
 		const body = this.buildGroupedCommandsBody(subcommands, prefix);
 		if (body.length === 0) return "";
-		const sections = [{ body: `${yc.green(this._cli._name)} ${yc.cyan(parentCommandName)} not found` }, {
+		const sections = [{ body: `${this._cli._name} ${yc.bold(parentCommandName)} not found` }, {
 			title: "Available Subcommands",
 			body
 		}];
@@ -211,12 +211,12 @@ var HelpRenderer = class {
 		flag = normalizeFlagValue(flag);
 		const flagName = formatFlagName(name);
 		const aliases = (Array.isArray(flag.alias) ? flag.alias : flag.alias ? [flag.alias] : []).map(formatFlagName).join(", ");
-		const type = this._formatters.formatFlagType(flag.type);
+		const type = this._formatters.formatTypeValue(flag.type);
 		return [
-			yc.blue([flagName, aliases].filter(Boolean).join(", ")),
-			yc.gray(type),
+			yc.bold([flagName, aliases].filter(Boolean).join(", ")),
+			yc.dim(type),
 			flag.description,
-			flag.default !== void 0 && yc.gray(`[default: ${this._formatters.formatFlagDefault(flag.default)}]`)
+			flag.default !== void 0 && yc.dim(`[default: ${yc.bold(this._formatters.formatFlagDefault(flag.default))}]`)
 		].filter(isTruthy);
 	}
 	renderGroupedFlags(flags, groupMap, itemType) {
@@ -267,10 +267,11 @@ var HelpRenderer = class {
 		};
 	}
 	renderExamples() {
-		if (!this._examples?.length) return;
+		const examples = this._getExamples();
+		if (!examples?.length) return;
 		return {
 			title: "Examples",
-			body: splitTable(this._examples.map(([command, description]) => {
+			body: splitTable(examples.map(([command, description]) => {
 				return [
 					command,
 					DELIMITER,
@@ -304,18 +305,18 @@ const helpPlugin = ({ command = true, flag = true, showHelpWhenNoCommandSpecifie
 		"If a command is specified, show help for the command.",
 		flag && "-h is an alias for --help."
 	].filter(isTruthy);
-	const generalHelpExamples = [
+	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 effectiveExamples = examples ?? generalHelpExamples;
+	const getEffectiveExamples = () => examples ?? getGeneralHelpExamples();
 	function printHelp(s) {
 		if (banner) console.log(banner);
 		console.log(s);
 	}
-	const renderer = new HelpRenderer(mergedFormatters, cli, cli._globalFlags, () => groups, effectiveExamples, effectiveNotes);
+	const renderer = new HelpRenderer(mergedFormatters, cli, cli._globalFlags, () => groups, getEffectiveExamples, effectiveNotes);
 	function tryPrintSubcommandsHelp(commandName) {
 		const subcommandsOutput = renderer.renderAvailableSubcommands(commandName);
 		if (subcommandsOutput) {
@@ -328,7 +329,7 @@ const helpPlugin = ({ command = true, flag = true, showHelpWhenNoCommandSpecifie
 		parameters: ["[command...]"],
 		help: {
 			notes: generalHelpNotes,
-			examples: generalHelpExamples
+			examples: getGeneralHelpExamples()
 		}
 	}).on("help", (ctx) => {
 		const commandName = ctx.parameters.command;

package/package.json

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