@gunshi/plugin-renderer 0.27.5 → 0.28.0

package/lib/index.d.ts

@@ -67,9 +67,9 @@ type CommandBuiltinKeys = GenerateNamespacedKey<BuiltinResourceKeys>;
  * Command i18n option keys.
  * The command i18n option keys are used by the i18n plugin for translation.
  */
-type CommandArgKeys<A extends Args$1, C = {}, K$1 extends string = GenerateNamespacedKey<Extract<KeyOfArgs<RemovedIndex<A>>, string>, typeof ARG_PREFIX>> = C extends {
+type CommandArgKeys<A extends Args$1, C = {}, K extends string = GenerateNamespacedKey<Extract<KeyOfArgs<RemovedIndex<A>>, string>, typeof ARG_PREFIX>> = C extends {
   name: infer N;
-} ? (N extends string ? GenerateNamespacedKey<K$1, N> : K$1) : K$1;
+} ? (N extends string ? GenerateNamespacedKey<K, N> : K) : K;
 /**
  * Resolve translation keys for command context.
  */
@@ -112,7 +112,7 @@ interface UsageRendererExtension<G extends GunshiParams<any> = DefaultGunshiPara
   // for CommandContext
   E extends Record<string, string> = {},
   // for extended resources
-  K$1 = ResolveTranslationKeys<A, C, E>>(key: K$1, values?: Record<string, unknown>) => Promise<string>;
+  K = ResolveTranslationKeys<A, C, E>>(key: K, values?: Record<string, unknown>) => Promise<string>;
   /**
    * Load commands
    *

package/lib/index.js

@@ -1,6 +1,6 @@
 import { ANONYMOUS_COMMAND_NAME, plugin } from "@gunshi/plugin";
 
-//#region ../../node_modules/.pnpm/args-tokens@0.23.0/node_modules/args-tokens/lib/utils-1LQrGCWG.js
+//#region ../../node_modules/.pnpm/args-tokens@0.23.1/node_modules/args-tokens/lib/utils-CxvkckUD.js
 /**
 * Entry point of utils.
 *
@@ -50,7 +50,8 @@ async function resolveLazyCommand(cmd, name, needRunResolving = false) {
 			args: cmd.args,
 			examples: cmd.examples,
 			internal: cmd.internal,
-			entry: cmd.entry
+			entry: cmd.entry,
+			subCommands: cmd.subCommands
 		};
 		if ("resource" in cmd && cmd.resource) baseCommand.resource = cmd.resource;
 		command = Object.assign(create(), baseCommand);
@@ -66,6 +67,7 @@ async function resolveLazyCommand(cmd, name, needRunResolving = false) {
 				command.examples = loaded.examples;
 				command.internal = loaded.internal;
 				command.entry = loaded.entry;
+				command.subCommands = loaded.subCommands || cmd.subCommands;
 				if ("resource" in loaded && loaded.resource) command.resource = loaded.resource;
 			} else throw new TypeError(`Cannot resolve command: ${cmd.name || name}`);
 		}
@@ -201,7 +203,7 @@ function resolveKey(key, name) {
 * @param examples - The examples to resolve, which can be a string or a {@linkcode CommandExamplesFetcher | function} that returns a string.
 * @returns A resolved string of examples.
 */
-async function resolveExamples(ctx, examples) {
+async function resolveExamples$1(ctx, examples) {
 	return typeof examples === "string" ? examples : typeof examples === "function" ? await examples(ctx) : "";
 }
 /**
@@ -266,7 +268,7 @@ function localizable(ctx, cmd, translate) {
 			return negatable && schema.type === "boolean" && schema.negatable ? `${NEGATABLE} ${makeShortLongOptionPair(schema, argKey, ctx.toKebab)}` : schema.description || "";
 		}
 		if (key === resolveKey("description", ctx.name)) return "";
-		else if (key === resolveKey("examples", ctx.name)) return await resolveExamples(ctx, cmd.examples);
+		else if (key === resolveKey("examples", ctx.name)) return await resolveExamples$1(ctx, cmd.examples);
 		else return key;
 	}
 	return localize;
@@ -311,7 +313,7 @@ const COMMON_ARGS_KEYS = Object.keys(COMMON_ARGS);
 */
 async function renderUsage(ctx) {
 	const messages = [];
-	if (!ctx.omitted) {
+	if (ctx.callMode === "subCommand") {
 		const description = await resolveDescription(ctx);
 		if (description) messages.push(description, "");
 	}
@@ -355,7 +357,7 @@ async function renderOptionalArgsSection(ctx) {
 */
 async function renderExamplesSection(ctx) {
 	const messages = [];
-	const resolvedExamples = await resolveExamples$1(ctx);
+	const resolvedExamples = await resolveExamples(ctx);
 	if (resolvedExamples) {
 		const examples = resolvedExamples.split("\n").map((example) => example.padStart(ctx.env.leftMargin + example.length));
 		messages.push(`${await ctx.extensions[pluginId].text(resolveBuiltInKey("EXAMPLES"))}:`, ...examples);
@@ -405,10 +407,11 @@ async function renderCommandsSection(ctx) {
 		return `${command.padStart(ctx.env.leftMargin + command.length)}`;
 	}));
 	messages.push(...commandsStr, "", `${await ctx.extensions[pluginId].text(resolveBuiltInKey("FORMORE"))}:`);
+	const basePath = ctx.commandPath && ctx.commandPath.length > 0 ? `${ctx.env.name} ${ctx.commandPath.join(" ")}` : ctx.env.name;
 	messages.push(...loadedCommands.map((cmd) => {
 		let commandStr = cmd.entry ? "" : cmd.name || "";
 		if (commandStr) commandStr += " ";
-		const commandHelp = `${ctx.env.name} ${commandStr}--help`;
+		const commandHelp = `${basePath} ${commandStr}--help`;
 		return `${commandHelp.padStart(ctx.env.leftMargin + commandHelp.length)}`;
 	}));
 	return messages;
@@ -443,6 +446,7 @@ async function resolveEntry(ctx) {
 * @returns The sub command name
 */
 async function resolveSubCommand(ctx) {
+	if (ctx.commandPath && ctx.commandPath.length > 0) return ctx.commandPath.join(" ");
 	return ctx.name || await ctx.extensions[pluginId].text(resolveBuiltInKey("SUBCOMMAND"));
 }
 /**
@@ -460,11 +464,11 @@ async function resolveDescription(ctx) {
 * @param ctx - A {@link CommandContext | command context}
 * @returns resolved command examples, if not resolved, return empty string
 */
-async function resolveExamples$1(ctx) {
+async function resolveExamples(ctx) {
 	const ret = await ctx.extensions[pluginId].text(resolveKey("examples", ctx.name));
 	if (ret) return ret;
 	const command = ctx.env.subCommands?.get(ctx.name || "");
-	return await resolveExamples(ctx, command?.examples);
+	return await resolveExamples$1(ctx, command?.examples);
 }
 /**
 * Check if the command has sub commands
@@ -666,7 +670,7 @@ function renderer() {
 			async function loadCommands() {
 				if (cachedCommands) return cachedCommands;
 				const subCommands = [...ctx.env.subCommands || []];
-				cachedCommands = (await Promise.all(subCommands.map(async ([name, cmd$1]) => await resolveLazyCommand(cmd$1, name)))).filter((cmd$1) => !cmd$1.internal).filter(Boolean);
+				cachedCommands = (await Promise.all(subCommands.map(async ([name, cmd]) => await resolveLazyCommand(cmd, name)))).filter((cmd) => !cmd.internal).filter(Boolean);
 				cachedCommands.sort((a, b) => {
 					if (a.entry && !b.entry) return -1;
 					if (!a.entry && b.entry) return 1;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@gunshi/plugin-renderer",
   "description": "usage renderer plugin for gunshi",
-  "version": "0.27.5",
+  "version": "0.28.0",
   "author": {
     "name": "kazuya kawaguchi",
     "email": "kawakazu80@gmail.com"
@@ -53,10 +53,10 @@
     }
   },
   "dependencies": {
-    "@gunshi/plugin": "0.27.5"
+    "@gunshi/plugin": "0.28.0"
   },
   "peerDependencies": {
-    "@gunshi/plugin-i18n": "0.27.5"
+    "@gunshi/plugin-i18n": "0.28.0"
   },
   "devDependencies": {
     "deno": "^2.6.3",
@@ -66,7 +66,7 @@
     "tsdown": "0.15.12",
     "typedoc": "^0.28.15",
     "typedoc-plugin-markdown": "^4.9.0",
-    "@gunshi/shared": "0.27.5"
+    "@gunshi/shared": "0.28.0"
   },
   "scripts": {
     "build": "tsdown",