@gunshi/plugin-renderer 0.35.0 → 0.35.2

package/lib/index.d.ts

@@ -35,6 +35,9 @@ type CommonArgType = {
 };
 declare const COMMON_ARGS: CommonArgType;
 declare const COMMAND_BUILTIN_RESOURCE_KEYS: readonly ["USAGE", "COMMAND", "SUBCOMMAND", "COMMANDS", "ARGUMENTS", "OPTIONS", "EXAMPLES", "FORMORE", "NEGATABLE", "DEFAULT", "CHOICES"];
+declare const ARG_ERROR_RESOURCE_KEYS: readonly ["err:arg:required-option", "err:arg:required-positional", "err:arg:invalid-type", "err:arg:invalid-choice", "err:arg:custom-parse", "err:arg:unknown-option"];
+declare const COMMAND_ERROR_RESOURCE_KEYS: readonly ["err:cmd:not-found"];
+declare const SUGGESTION_ERROR_RESOURCE_KEYS: readonly ["err:suggestion:did-you-mean"];
 //#endregion
 //#region ../plugin-i18n/src/types.d.ts
 
@@ -75,13 +78,25 @@ type CommandBuiltinArgsKeys = keyof typeof COMMON_ARGS;
  */
 type CommandBuiltinResourceKeys = (typeof COMMAND_BUILTIN_RESOURCE_KEYS)[number];
 /**
- * Built-in resource keys.
+ * Args validation error resource keys.
  */
-type BuiltinResourceKeys = CommandBuiltinArgsKeys | CommandBuiltinResourceKeys;
+type ArgErrorResourceKeys = (typeof ARG_ERROR_RESOURCE_KEYS)[number];
+/**
+ * Command validation error resource keys.
+ */
+type CommandErrorResourceKeys = (typeof COMMAND_ERROR_RESOURCE_KEYS)[number];
+/**
+ * Suggestion error resource keys.
+ */
+type SuggestionErrorResourceKeys = (typeof SUGGESTION_ERROR_RESOURCE_KEYS)[number];
+/**
+ * Error resource keys.
+ */
+type ErrorResourceKeys = ArgErrorResourceKeys | CommandErrorResourceKeys | SuggestionErrorResourceKeys;
 /**
  * Command built-in keys.
  */
-type CommandBuiltinKeys = GenerateNamespacedKey<BuiltinResourceKeys>;
+type CommandBuiltinKeys = GenerateNamespacedKey<CommandBuiltinArgsKeys | CommandBuiltinResourceKeys>;
 /**
  * Command i18n option keys.
  * The command i18n option keys are used by the i18n plugin for translation.
@@ -98,7 +113,7 @@ E extends Record<string, string> = {},
 // for extended resources
 R extends string = keyof RemovedIndex<E>, 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, C>> = ErrorResourceKeys | CommandBuiltinKeys | O | T;
 //#endregion
 //#region ../shared/src/localization.d.ts
 
@@ -173,11 +188,11 @@ declare function renderUsage<G extends GunshiParams = DefaultGunshiParams>(ctx:
 /**
  * Render the validation errors.
  *
- * @param _ctx - A {@link CommandContext | command context}
+ * @param ctx - A {@link CommandContext | command context}
  * @param error - An {@link AggregateError} of option in `args-token` validation
  * @returns A rendered validation error.
  */
-declare function renderValidationErrors<G extends GunshiParams = DefaultGunshiParams>(_ctx: CommandContext<G>, error: AggregateError): Promise<string>;
+declare function renderValidationErrors<G extends GunshiParams = DefaultGunshiParams>(ctx: CommandContext<G>, error: AggregateError): Promise<string>;
 //#endregion
 //#region src/index.d.ts
 /**

package/lib/index.js

@@ -1,5 +1,5 @@
-import { ANONYMOUS_COMMAND_NAME, plugin } from "@gunshi/plugin";
-//#region ../../node_modules/.pnpm/args-tokens@0.27.0/node_modules/args-tokens/lib/utils.js
+import { ANONYMOUS_COMMAND_NAME, ArgsValidationErrorKeys, isArgsValidationError, isCommandNotFoundError, plugin } from "@gunshi/plugin";
+//#region ../../node_modules/.pnpm/args-tokens@0.28.0/node_modules/args-tokens/lib/utils.js
 /**
 * Entry point of utils.
 *
@@ -108,6 +108,7 @@ function deepFreeze(obj, ignores = []) {
 */
 const BUILD_IN_PREFIX_AND_KEY_SEPARATOR = `_:`;
 const ARG_PREFIX_AND_KEY_SEPARATOR = `arg:`;
+const ERROR_PREFIX_AND_KEY_SEPARATOR = `err:`;
 const COMMON_ARGS = {
 	help: {
 		type: "boolean",
@@ -136,7 +137,15 @@ var en_US_default = {
 	DEFAULT: "default",
 	CHOICES: "choices",
 	help: "Display this help message",
-	version: "Display this version"
+	version: "Display this version",
+	"err:arg:required-option": "Optional argument {$displayName} is required",
+	"err:arg:required-positional": "Positional argument {$name} is required",
+	"err:arg:invalid-type": "Invalid value for {$displayName}: expected {$expected}",
+	"err:arg:invalid-choice": "Invalid value for {$displayName}: expected one of {$choices}",
+	"err:arg:custom-parse": "Invalid value for {$displayName}: {$reason}",
+	"err:arg:unknown-option": "Unknown option: {$rawName}",
+	"err:cmd:not-found": "Command not found: {$commandName}",
+	"err:suggestion:did-you-mean": "Did you mean {$name}?"
 };
 //#endregion
 //#region ../shared/src/utils.ts
@@ -245,7 +254,8 @@ function makeShortLongOptionPair(schema, name, toKebab) {
 function localizable(ctx, cmd, translate) {
 	async function localize(key, values) {
 		if (translate) return translate(key, values);
-		if (key.startsWith(BUILD_IN_PREFIX_AND_KEY_SEPARATOR)) return en_US_default[key.slice(BUILD_IN_PREFIX_AND_KEY_SEPARATOR.length)] || key;
+		if (key.startsWith(BUILD_IN_PREFIX_AND_KEY_SEPARATOR)) return resolveAndFormatResource(key.slice(BUILD_IN_PREFIX_AND_KEY_SEPARATOR.length), key, values);
+		if (key.startsWith(ERROR_PREFIX_AND_KEY_SEPARATOR)) return resolveAndFormatResource(key, key, values);
 		const namaspacedArgKey = resolveKey(ARG_PREFIX_AND_KEY_SEPARATOR, ctx.name);
 		if (key.startsWith(namaspacedArgKey)) {
 			let argKey = key.slice(namaspacedArgKey.length);
@@ -264,6 +274,21 @@ function localizable(ctx, cmd, translate) {
 	}
 	return localize;
 }
+function resolveAndFormatResource(resourceKey, fallbackKey, values) {
+	return formatResource(en_US_default[resourceKey], values) || fallbackKey;
+}
+/**
+* Format a resource message by replacing placeholder values.
+*
+* @param resource - Resource message template
+* @param values - Placeholder values
+* @returns Formatted resource message
+*/
+function formatResource(resource, values = Object.create(null)) {
+	return resource?.replaceAll(/\{\$(\w+)\}/g, (_, name) => {
+		return values[name] == null ? "" : String(values[name]);
+	});
+}
 //#endregion
 //#region ../shared/src/index.ts
 /**
@@ -626,17 +651,50 @@ function isRequiredSinglePositionalArg(arg) {
 * @author kazuya kawaguchi (a.k.a. kazupon)
 * @license MIT
 */
+const i18nPluginId$1 = namespacedId("i18n");
 /**
 * Render the validation errors.
 *
-* @param _ctx - A {@link CommandContext | command context}
+* @param ctx - A {@link CommandContext | command context}
 * @param error - An {@link AggregateError} of option in `args-token` validation
 * @returns A rendered validation error.
 */
-function renderValidationErrors(_ctx, error) {
+async function renderValidationErrors(ctx, error) {
 	const messages = [];
-	for (const err of error.errors) messages.push(err.message);
-	return Promise.resolve(messages.join("\n"));
+	for (const err of error.errors) messages.push(await renderValidationError(ctx, err));
+	return messages.join("\n");
+}
+async function renderValidationError(ctx, error) {
+	if (isCommandNotFoundError(error) && error.code) {
+		const message = await localize(ctx, error.code, error.values);
+		if (message && message !== error.code) return message;
+	}
+	if (isArgsValidationError(error) && error.code) {
+		const values = await resolveValidationValues(ctx, error);
+		const message = await localize(ctx, error.code, values);
+		if (message && message !== error.code) return message;
+	}
+	return error.message;
+}
+async function resolveValidationValues(ctx, error) {
+	if (error.code !== ArgsValidationErrorKeys.customParse) return error.values;
+	const { reasonKey, reasonValues } = error.values;
+	if (typeof reasonKey !== "string") return error.values;
+	const key = resolveKey(reasonKey, ctx.name);
+	const localizedReason = await localize(ctx, key, toRecord(reasonValues));
+	if (!localizedReason || localizedReason === key) return error.values;
+	return {
+		...error.values,
+		reason: localizedReason
+	};
+}
+async function localize(ctx, key, values) {
+	const i18n = ctx.extensions?.[i18nPluginId$1];
+	if (i18n?.translate) return i18n.translate(key, values);
+	return key;
+}
+function toRecord(value) {
+	return value != null && typeof value === "object" ? value : Object.create(null);
 }
 //#endregion
 //#region src/index.ts

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@gunshi/plugin-renderer",
   "description": "usage renderer plugin for gunshi",
-  "version": "0.35.0",
+  "version": "0.35.2",
   "author": {
     "name": "kazuya kawaguchi",
     "email": "kawakazu80@gmail.com"
@@ -53,10 +53,10 @@
     }
   },
   "dependencies": {
-    "@gunshi/plugin": "0.35.0"
+    "@gunshi/plugin": "0.35.2"
   },
   "peerDependencies": {
-    "@gunshi/plugin-i18n": "0.35.0"
+    "@gunshi/plugin-i18n": "0.35.2"
   },
   "devDependencies": {
     "deno": "^2.7.14",
@@ -64,7 +64,7 @@
     "jsr-exports-lint": "^0.4.2",
     "publint": "^0.3.20",
     "tsdown": "0.21.0",
-    "@gunshi/shared": "0.35.0"
+    "@gunshi/shared": "0.35.2"
   },
   "scripts": {
     "build": "tsdown",