@gunshi/plugin-renderer 0.27.0-beta.3 → 0.27.0-beta.4

package/lib/index.d.ts

@@ -42,7 +42,7 @@ type RemovedIndex<T> = RemoveIndexSignature<{ [K in keyof T]: T[K] }>;
 /**
  * Resolve a key on {@link Args}.
  */
-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];
+type KeyOfArgs<A$1 extends Args$1> = keyof A$1 | { [K in keyof A$1]: A$1[K]['type'] extends 'boolean' ? A$1[K]['negatable'] extends true ? `no-${Extract<K, string>}` : never : never }[keyof A$1];
 /**
  * Generate a namespaced key.
  */
@@ -67,19 +67,19 @@ 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 extends string = GenerateNamespacedKey<Extract<KeyOfArgs<RemovedIndex<A>>, string>, typeof ARG_PREFIX>> = C extends {
+type CommandArgKeys<A$1 extends Args$1, C = {}, K$1 extends string = GenerateNamespacedKey<Extract<KeyOfArgs<RemovedIndex<A$1>>, string>, typeof ARG_PREFIX>> = C extends {
   name: infer N;
-} ? (N extends string ? GenerateNamespacedKey<K, N> : K) : K;
+} ? (N extends string ? GenerateNamespacedKey<K$1, N> : K$1) : K$1;
 /**
  * Resolve translation keys for command context.
  */
-type ResolveTranslationKeys<A extends Args$1, C = {},
+type ResolveTranslationKeys<A$1 extends Args$1, C = {},
 // for CommandContext
-E extends Record<string, string> = {},
+E$1 extends Record<string, string> = {},
 // for extended resources
-R extends string = keyof RemovedIndex<E>, T extends string = (C extends {
+R extends string = keyof RemovedIndex<E$1>, T extends string = (C extends {
   name: infer N;
-} ? N extends string ? GenerateNamespacedKey<R, N> : R : R | CommandBuiltinKeys), O = CommandArgKeys<A, C>> = CommandBuiltinKeys | O | T;
+} ? N extends string ? GenerateNamespacedKey<R, N> : R : R | CommandBuiltinKeys), O = CommandArgKeys<A$1, C>> = CommandBuiltinKeys | O | T;
 //#endregion
 //#region src/types.d.ts
 /**
@@ -108,11 +108,11 @@ interface UsageRendererExtension<G extends GunshiParams<any> = DefaultGunshiPara
    * @param values - An optional record of values to interpolate into the translation string.
    * @returns The resolved translation string with interpolated values if provided.
    */
-  text: <A extends Args = G['args'], C = {},
+  text: <A$1 extends Args = G['args'], C = {},
   // for CommandContext
-  E extends Record<string, string> = {},
+  E$1 extends Record<string, string> = {},
   // for extended resources
-  K = ResolveTranslationKeys<A, C, E>>(key: K, values?: Record<string, unknown>) => string;
+  K$1 = ResolveTranslationKeys<A$1, C, E$1>>(key: K$1, values?: Record<string, unknown>) => Promise<string>;
   /**
    * Load commands
    *

package/lib/index.js

@@ -127,38 +127,30 @@ const COMMON_ARGS = {
 
 //#endregion
 //#region ../resources/locales/en-US.json
-var COMMAND = "COMMAND";
-var COMMANDS = "COMMANDS";
-var SUBCOMMAND = "SUBCOMMAND";
-var USAGE = "USAGE";
-var ARGUMENTS = "ARGUMENTS";
-var OPTIONS = "OPTIONS";
-var EXAMPLES = "EXAMPLES";
-var FORMORE = "For more info, run any command with the `--help` flag";
 var NEGATABLE = "Negatable of";
-var DEFAULT = "default";
-var CHOICES = "choices";
-var help = "Display this help message";
-var version = "Display this version";
 var en_US_default = {
-	COMMAND,
-	COMMANDS,
-	SUBCOMMAND,
-	USAGE,
-	ARGUMENTS,
-	OPTIONS,
-	EXAMPLES,
-	FORMORE,
+	COMMAND: "COMMAND",
+	COMMANDS: "COMMANDS",
+	SUBCOMMAND: "SUBCOMMAND",
+	USAGE: "USAGE",
+	ARGUMENTS: "ARGUMENTS",
+	OPTIONS: "OPTIONS",
+	EXAMPLES: "EXAMPLES",
+	FORMORE: "For more info, run any command with the `--help` flag",
 	NEGATABLE,
-	DEFAULT,
-	CHOICES,
-	help,
-	version
+	DEFAULT: "default",
+	CHOICES: "choices",
+	help: "Display this help message",
+	version: "Display this version"
 };
 
 //#endregion
 //#region ../shared/src/utils.ts
 /**
+* @author kazuya kawaguchi (a.k.a. kazupon)
+* @license MIT
+*/
+/**
 * Resolve a namespaced key for built-in resources.
 *
 * Built-in keys are prefixed with "_:".
@@ -240,6 +232,10 @@ function makeShortLongOptionPair(schema, name, toKebab) {
 //#endregion
 //#region ../shared/src/localization.ts
 /**
+* @author kazuya kawaguchi (a.k.a. kazupon)
+* @license MIT
+*/
+/**
 * Create a localizable function for a command.
 *
 * This function will resolve the translation key based on the command context and the provided translation function.
@@ -267,7 +263,7 @@ function localizable(ctx, cmd, translate) {
 			}
 			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 || "";
+			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);
@@ -292,12 +288,20 @@ function renderHeader(ctx) {
 //#endregion
 //#region src/types.ts
 /**
+* @author kazuya kawaguchi (a.k.a. kazupon)
+* @license MIT
+*/
+/**
 * The unique identifier for usage renderer plugin.
 */
 const pluginId = namespacedId("renderer");
 
 //#endregion
 //#region src/usage.ts
+/**
+* @author kazuya kawaguchi (a.k.a. kazupon)
+* @license MIT
+*/
 const COMMON_ARGS_KEYS = Object.keys(COMMON_ARGS);
 /**
 * Render the usage.
@@ -607,6 +611,35 @@ function renderValidationErrors(_ctx, error) {
 
 //#endregion
 //#region src/index.ts
+/**
+* The entry point of usage renderer plugin
+*
+* @example
+* ```js
+* import renderer from '@gunshi/plugin-renderer'
+* import { cli } from 'gunshi'
+*
+* const entry = (ctx) => {
+*   // ...
+* }
+*
+* await cli(process.argv.slice(2), entry, {
+*   // ...
+*
+*   plugins: [
+*     renderer()
+*   ],
+*
+*   // ...
+* })
+* ```
+*
+* @module
+*/
+/**
+* @author kazuya kawaguchi (a.k.a. kazupon)
+* @license MIT
+*/
 const i18nPluginId = namespacedId("i18n");
 const dependencies = [{
 	id: i18nPluginId,
@@ -622,7 +655,7 @@ function renderer() {
 		id: pluginId,
 		name: "usage renderer",
 		dependencies,
-		extension: async (ctx, cmd) => {
+		extension: (ctx, cmd) => {
 			const i18n = ctx.extensions[i18nPluginId];
 			let cachedCommands;
 			async function loadCommands() {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@gunshi/plugin-renderer",
   "description": "usage renderer plugin for gunshi",
-  "version": "0.27.0-beta.3",
+  "version": "0.27.0-beta.4",
   "author": {
     "name": "kazuya kawaguchi",
     "email": "kawakazu80@gmail.com"
@@ -53,20 +53,20 @@
     }
   },
   "dependencies": {
-    "@gunshi/plugin": "0.27.0-beta.3"
+    "@gunshi/plugin": "0.27.0-beta.4"
   },
   "peerDependencies": {
-    "@gunshi/plugin-i18n": "0.27.0-beta.3"
+    "@gunshi/plugin-i18n": "0.27.0-beta.4"
   },
   "devDependencies": {
-    "deno": "^2.5.4",
+    "deno": "^2.5.6",
     "jsr": "^0.13.5",
     "jsr-exports-lint": "^0.4.1",
-    "publint": "^0.3.14",
-    "tsdown": "0.15.9",
-    "typedoc": "^0.28.13",
+    "publint": "^0.3.15",
+    "tsdown": "0.15.12",
+    "typedoc": "^0.28.15",
     "typedoc-plugin-markdown": "^4.9.0",
-    "@gunshi/shared": "0.27.0-beta.3"
+    "@gunshi/shared": "0.27.0-beta.4"
   },
   "scripts": {
     "build": "tsdown",