@gunshi/plugin-renderer 0.27.0-alpha.5 → 0.27.0-alpha.7

package/lib/index.d.ts

@@ -1,7 +1,50 @@
 import { Command, CommandContext, DefaultGunshiParams, GunshiParams, PluginWithExtension } from "@gunshi/plugin";
-import { Args } from "args-tokens";
+import { Args, Args as Args$1 } from "args-tokens";
 
 //#region rolldown:runtime
+
+//#endregion
+//#region ../gunshi/src/types.d.ts
+/**
+ * Extend command context type. This type is used to extend the command context with additional properties at {@link CommandContext.extensions}.
+ * @since v0.27.0
+ */
+type ExtendContext = Record<string, unknown>;
+/**
+ * Gunshi unified parameter type.
+ * This type combines both argument definitions and command context extensions.
+ * @since v0.27.0
+ */
+interface GunshiParams$1<P extends {
+  args?: Args;
+  extensions?: ExtendContext;
+} = {
+  args: Args;
+  extensions: {};
+}> {
+  /**
+   * Command argument definitions
+   */
+  args: P extends {
+    args: infer A extends Args;
+  } ? A : Args;
+  /**
+   * Command context extensions
+   */
+  extensions: P extends {
+    extensions: infer E extends ExtendContext;
+  } ? E : {};
+}
+/**
+ * Default Gunshi parameters
+ * @since v0.27.0
+ */
+type DefaultGunshiParams$1 = GunshiParams$1;
+/**
+ * Generic constraint for command-related types.
+ * This type constraint allows both GunshiParams and objects with extensions.
+ * @since v0.27.0
+ */
 declare namespace constants_d_exports {
   export { ARG_NEGATABLE_PREFIX, ARG_PREFIX, ARG_PREFIX_AND_KEY_SEPARATOR, BUILD_IN_PREFIX_AND_KEY_SEPARATOR, BUILT_IN_KEY_SEPARATOR, BUILT_IN_PREFIX, COMMAND_BUILTIN_RESOURCE_KEYS, COMMON_ARGS, PLUGIN_PREFIX };
 }
@@ -37,7 +80,7 @@ type RemoveIndexSignature<T> = { [K in keyof T as string extends K ? never : num
  * Remove index signature from object or record type.
  */
 type RemovedIndex<T> = RemoveIndexSignature<{ [K in keyof T]: T[K] }>;
-type KeyOfArgs<A extends Args> = keyof A | { [K in keyof A]: A[K]['type'] extends 'boolean' ? A[K]['negatable'] extends true ? `no-${Extract<K, string>}` : never : never }[keyof A];
+type KeyOfArgs<A extends Args$1> = keyof A | { [K in keyof A]: A[K]['type'] extends 'boolean' ? A[K]['negatable'] extends true ? `no-${Extract<K, string>}` : never : never }[keyof A];
 /**
  * Generate a namespaced key.
  */
@@ -63,7 +106,15 @@ type CommandBuiltinKeys = GenerateNamespacedKey<BuiltinResourceKeys> | 'descript
  * Command i18n option keys.
  * The command i18n option keys are used by the i18n plugin for translation.
  */
-type CommandArgKeys<A extends Args> = GenerateNamespacedKey<KeyOfArgs<RemovedIndex<A>>, typeof ARG_PREFIX>;
+type CommandArgKeys<A extends Args$1> = GenerateNamespacedKey<KeyOfArgs<RemovedIndex<A>>, typeof ARG_PREFIX>;
+/**
+ * Translation function interface
+ */
+//#endregion
+//#region ../shared/src/localize.d.ts
+interface Localization<T extends string = CommandBuiltinKeys, G extends GunshiParams$1<any> = DefaultGunshiParams$1> {
+  <O = CommandArgKeys<G['args']>, K = CommandBuiltinKeys | O | T>(key: K, values?: Record<string, unknown>): Promise<string>;
+}
 //#endregion
 //#region src/types.d.ts
 /**
@@ -74,7 +125,7 @@ interface UsageRendererCommandContext<G extends GunshiParams<any> = DefaultGunsh
   /**
    * Render the text message
    */
-  text: <T extends string = CommandBuiltinKeys, O = CommandArgKeys<G['args']>, K = CommandBuiltinKeys | O | T>(key: K, values?: Record<string, unknown>) => Promise<string>;
+  text: Localization<CommandBuiltinKeys, G>;
   /**
    * Load commands
    * @returns A list of commands loaded from the command loader plugin.

package/lib/index.js

@@ -1,6 +1,6 @@
 import { plugin } from "@gunshi/plugin";
 
-//#region ../../node_modules/.pnpm/args-tokens@0.20.1/node_modules/args-tokens/lib/utils-N7UlhLbz.js
+//#region ../../node_modules/.pnpm/args-tokens@0.22.0/node_modules/args-tokens/lib/utils-N7UlhLbz.js
 /**
 * Entry point of utils.
 *
@@ -28,7 +28,9 @@ async function resolveLazyCommand(cmd, name, needRunResolving = false) {
 			name: cmd.commandName,
 			description: cmd.description,
 			args: cmd.args,
-			examples: cmd.examples
+			examples: cmd.examples,
+			internal: cmd.internal,
+			entry: cmd.entry
 		};
 		if ("resource" in cmd && cmd.resource) baseCommand.resource = cmd.resource;
 		command = Object.assign(create(), baseCommand);
@@ -42,6 +44,8 @@ async function resolveLazyCommand(cmd, name, needRunResolving = false) {
 				command.description = loaded.description;
 				command.args = loaded.args;
 				command.examples = loaded.examples;
+				command.internal = loaded.internal;
+				command.entry = loaded.entry;
 				if ("resource" in loaded && loaded.resource) command.resource = loaded.resource;
 			} else throw new TypeError(`Cannot resolve command: ${cmd.name || name}`);
 		}
@@ -133,6 +137,37 @@ async function resolveExamples$1(ctx, examples) {
 function namespacedId(id) {
 	return `${PLUGIN_PREFIX}${BUILT_IN_KEY_SEPARATOR}${id}`;
 }
+function makeShortLongOptionPair(schema, name, toKebab) {
+	const displayName = toKebab || schema.toKebab ? kebabnize(name) : name;
+	let key = `--${displayName}`;
+	if (schema.short) key = `-${schema.short}, ${key}`;
+	return key;
+}
+
+//#endregion
+//#region ../shared/src/localize.ts
+function localizable(ctx, cmd, translate) {
+	async function localize(key, values) {
+		if (translate) return translate(key, values);
+		else if (key.startsWith(BUILD_IN_PREFIX_AND_KEY_SEPARATOR)) {
+			const resKey = key.slice(BUILD_IN_PREFIX_AND_KEY_SEPARATOR.length);
+			return en_US_default[resKey] || key;
+		} else if (key.startsWith(ARG_PREFIX_AND_KEY_SEPARATOR)) {
+			let argKey = key.slice(ARG_PREFIX_AND_KEY_SEPARATOR.length);
+			let negatable = false;
+			if (argKey.startsWith(ARG_NEGATABLE_PREFIX)) {
+				argKey = argKey.slice(ARG_NEGATABLE_PREFIX.length);
+				negatable = true;
+			}
+			const schema = ctx.args[argKey];
+			if (!schema) return argKey;
+			return negatable && schema.type === "boolean" && schema.negatable ? `${en_US_default["NEGATABLE"]} ${makeShortLongOptionPair(schema, argKey, ctx.toKebab)}` : schema.description || "";
+		} else if (key === "description") return "";
+		else if (key === "examples") return await resolveExamples$1(ctx, cmd.examples);
+		else return key;
+	}
+	return localize;
+}
 
 //#endregion
 //#region src/header.ts
@@ -329,12 +364,6 @@ function hasAllDefaultOptions(ctx) {
 async function generateOptionsSymbols(ctx) {
 	return hasOptionalArgs(ctx) ? hasAllDefaultOptions(ctx) ? `[${await ctx.extensions[pluginId].text(resolveBuiltInKey("OPTIONS"))}]` : `<${await ctx.extensions[pluginId].text(resolveBuiltInKey("OPTIONS"))}>` : "";
 }
-function makeShortLongOptionPair(schema, name, toKebab) {
-	const displayName = toKebab || schema.toKebab ? kebabnize(name) : name;
-	let key = `--${displayName}`;
-	if (schema.short) key = `-${schema.short}, ${key}`;
-	return key;
-}
 /**
 * Get optional arguments pairs for usage
 * @param ctx A {@link CommandContext | command context}
@@ -450,29 +479,11 @@ 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)));
-				return cachedCommands;
-			}
-			async function text(key, values = Object.create(null)) {
-				if (i18n) return i18n.translate(key, values);
-				else if (key.startsWith(BUILD_IN_PREFIX_AND_KEY_SEPARATOR)) {
-					const resKey = key.slice(BUILD_IN_PREFIX_AND_KEY_SEPARATOR.length);
-					return en_US_default[resKey] || key;
-				} else if (key.startsWith(ARG_PREFIX_AND_KEY_SEPARATOR)) {
-					let argKey = key.slice(ARG_PREFIX_AND_KEY_SEPARATOR.length);
-					let negatable = false;
-					if (argKey.startsWith(ARG_NEGATABLE_PREFIX)) {
-						argKey = argKey.slice(ARG_NEGATABLE_PREFIX.length);
-						negatable = true;
-					}
-					const schema = ctx.args[argKey];
-					return negatable && schema.type === "boolean" && schema.negatable ? `${en_US_default["NEGATABLE"]} ${makeShortLongOptionPair(schema, argKey, ctx.toKebab)}` : schema.description || "";
-				} else if (key === "description") return "";
-				else if (key === "examples") return await resolveExamples$1(ctx, cmd.examples);
-				else return key;
+				const allCommands = await Promise.all(subCommands.map(async ([name, cmd$1]) => await resolveLazyCommand(cmd$1, name)));
+				return cachedCommands = allCommands.filter((cmd$1) => !cmd$1.internal).filter(Boolean);
 			}
 			return {
-				text,
+				text: localizable(ctx, cmd, i18n?.translate),
 				loadCommands
 			};
 		},

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@gunshi/plugin-renderer",
   "description": "usage renderer plugin for gunshi",
-  "version": "0.27.0-alpha.5",
+  "version": "0.27.0-alpha.7",
   "author": {
     "name": "kazuya kawaguchi",
     "email": "kawakazu80@gmail.com"
@@ -53,10 +53,10 @@
     }
   },
   "dependencies": {
-    "@gunshi/plugin": "0.27.0-alpha.5"
+    "@gunshi/plugin": "0.27.0-alpha.7"
   },
   "peerDependencies": {
-    "@gunshi/plugin-i18n": "0.27.0-alpha.5"
+    "@gunshi/plugin-i18n": "0.27.0-alpha.7"
   },
   "devDependencies": {
     "deno": "^2.4.0",
@@ -66,7 +66,7 @@
     "tsdown": "^0.12.9",
     "typedoc": "^0.28.7",
     "typedoc-plugin-markdown": "^4.7.0",
-    "@gunshi/shared": "0.27.0-alpha.5"
+    "@gunshi/shared": "0.27.0-alpha.7"
   },
   "scripts": {
     "build": "tsdown",