@clerc/plugin-help 1.0.1 → 1.0.3

package/dist/index.d.ts

@@ -1,26 +1,6 @@
 import { Plugin } from "@clerc/core";
+import { FlagDefaultValue, TypeValue } from "@clerc/parser";
 
-//#region ../parser/src/types.d.ts
-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.
-*/
-interface TypeFunction<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 TypeValue<T = unknown> = TypeFunction<T> | readonly [TypeFunction<T>];
-//#endregion
 //#region src/types.d.ts
 interface Formatters {
   formatTypeValue: (type: TypeValue) => string;

package/dist/index.js

@@ -1,17 +1,9 @@
 import { DOUBLE_DASH, NoSuchCommandError, definePlugin, normalizeFlagValue, normalizeParameterValue, resolveCommand } from "@clerc/core";
+import { formatFlagName, formatVersion, isTruthy, objectIsEmpty, toArray } from "@clerc/utils";
 import * as tint from "@uttr/tint";
 import stringWidth from "string-width";
 import textTable from "text-table";
 
-//#region ../utils/src/index.ts
-const toArray = (a) => Array.isArray(a) ? a : [a];
-const kebabCase = (s) => s.replace(/([A-Z])/g, (_, c) => `-${c.toLowerCase()}`);
-const formatFlagName = (n) => n.length <= 1 ? `-${n}` : `--${kebabCase(n)}`;
-const formatVersion = (v) => v.length === 0 ? "" : v.startsWith("v") ? v : `v${v}`;
-const isTruthy = Boolean;
-const objectIsEmpty = (obj) => Object.keys(obj).length === 0;
-
-//#endregion
 //#region src/utils.ts
 function formatTypeValue(type) {
 	if (typeof type === "function") return type.display ?? type.name;
@@ -61,18 +53,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;
 		}
 	}
@@ -276,11 +268,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,
@@ -309,24 +300,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) {
@@ -338,8 +317,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;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@clerc/plugin-help",
-  "version": "1.0.1",
+  "version": "1.0.3",
   "author": "Ray <i@mk1.io> (https://github.com/so1ve)",
   "type": "module",
   "description": "Clerc plugin help",
@@ -45,16 +45,16 @@
     "access": "public"
   },
   "dependencies": {
-    "@types/text-table": "^0.2.5",
     "@uttr/tint": "^0.1.3",
     "string-width": "^8.1.0",
-    "text-table": "^0.2.0"
+    "text-table": "^0.2.0",
+    "@clerc/utils": "1.0.3"
   },
   "devDependencies": {
+    "@types/text-table": "^0.2.5",
     "kons": "^0.7.1",
-    "@clerc/core": "1.0.1",
-    "@clerc/utils": "1.0.1",
-    "@clerc/parser": "1.0.1"
+    "@clerc/core": "1.0.3",
+    "@clerc/parser": "1.0.3"
   },
   "peerDependencies": {
     "@clerc/core": "*"