@gunshi/plugin-i18n 1.0.0-beta.0 → 1.0.0-beta.2

package/lib/index.d.ts

@@ -1,7 +1,5 @@
 import { Args, Awaitable, Command, CommandContext, DefaultGunshiParams, ExtendContext, ExtractArgs, ExtractExtensions, GunshiParams, GunshiParamsConstraint, PluginWithExtension, Prettify } from "@gunshi/plugin";
-
 //#region ../../node_modules/.pnpm/args-tokens@1.0.0-beta.1/node_modules/args-tokens/lib/resolver.d.ts
-
 //#region src/resolver.d.ts
 /**
  * An argument schema definition for command-line argument parsing.
@@ -563,7 +561,6 @@ interface Args$1 {
 }
 //#endregion
 //#region ../gunshi/src/types.d.ts
-
 /**
  * Extend command context type. This type is used to extend the command context with additional properties at {@linkcode CommandContext.extensions}.
  *
@@ -630,26 +627,20 @@ 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", "err:arg:unexpected-value", "err:arg:missing-value", "err:arg:conflict", "err:arg:invalid-default"];
+declare const ARG_ERROR_HINT_RESOURCE_KEYS: readonly ["err:arg:missing-value:hint"];
 declare const COMMAND_ERROR_RESOURCE_KEYS: readonly ["err:cmd:not-found", "err:cmd:ambiguous", "err:cmd:inconsistent-options", "err:cmd:lazy-schema-mismatch"];
 declare const SUGGESTION_ERROR_RESOURCE_KEYS: readonly ["err:suggestion:did-you-mean"];
-//#endregion
-//#region ../gunshi/src/index.d.ts
-
 //#endregion
 //#region ../shared/src/types.d.ts
-type RemoveIndexSignature<T> = { [K in keyof T as string extends K ? never : number extends K ? never : K]: T[K] };
-/**
- * Make all properties in T deeply writeable (not readonly)
- */
-
+type RemoveIndexSignature<T> = { [K in keyof T as string extends K ? never : number extends K ? never : K]: T[K]; };
 /**
  * Remove index signature from object or record type.
  */
-type RemovedIndex<T> = RemoveIndexSignature<{ [K in keyof T]: T[K] }>;
+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 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.
  */
@@ -666,6 +657,10 @@ type CommandBuiltinResourceKeys = (typeof COMMAND_BUILTIN_RESOURCE_KEYS)[number]
  * Args validation error resource keys.
  */
 type ArgErrorResourceKeys = (typeof ARG_ERROR_RESOURCE_KEYS)[number];
+/**
+ * Resource keys of the hints that follow an args validation error.
+ */
+type ArgErrorHintResourceKeys = (typeof ARG_ERROR_HINT_RESOURCE_KEYS)[number];
 /**
  * Command validation error resource keys.
  */
@@ -677,7 +672,7 @@ type SuggestionErrorResourceKeys = (typeof SUGGESTION_ERROR_RESOURCE_KEYS)[numbe
 /**
  * Error resource keys.
  */
-type ErrorResourceKeys = ArgErrorResourceKeys | CommandErrorResourceKeys | SuggestionErrorResourceKeys;
+type ErrorResourceKeys = ArgErrorResourceKeys | ArgErrorHintResourceKeys | CommandErrorResourceKeys | SuggestionErrorResourceKeys;
 /**
  * Built-in resource keys.
  */
@@ -700,16 +695,11 @@ type CommandArgKeys<A extends Args$1, C = {}, K extends string = GenerateNamespa
 /**
  * Resolve translation keys for command context.
  */
-type ResolveTranslationKeys<A extends Args$1, C = {},
-// for CommandContext
-E extends Record<string, string> = {},
-// for extended resources
-R extends string = keyof RemovedIndex<E>, T extends string = (C extends {
+type ResolveTranslationKeys<A extends Args$1, C = {} // for CommandContext
+, 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>> = ErrorResourceKeys | CommandBuiltinKeys | O | T;
-//#endregion
-//#region ../shared/src/localization.d.ts
-
+} ? N extends string ? GenerateNamespacedKey<R, N> : R : R | CommandBuiltinKeys, O = CommandArgKeys<A, C>> = ErrorResourceKeys | CommandBuiltinKeys | O | T;
 //#endregion
 //#region ../shared/src/utils.d.ts
 /**
@@ -747,10 +737,7 @@ declare function resolveArgKey<A extends Args$1 = DefaultGunshiParams$1['args'],
  * @param name - The command name.
  * @returns Prefixed non-built-in key.
  */
-declare function resolveKey<T extends Record<string, string> = {}, K extends string = (keyof T extends string ? keyof T : string)>(key: K, name?: string): string;
-//#endregion
-//#region ../shared/src/index.d.ts
-
+declare function resolveKey<T extends Record<string, string> = {}, K extends string = keyof T extends string ? keyof T : string>(key: K, name?: string): string;
 //#endregion
 //#region src/types.d.ts
 /**
@@ -785,11 +772,9 @@ interface I18nExtension<G extends GunshiParams<any> = DefaultGunshiParams> {
    *   - For custom keys: returns an empty string ('')
    *   - For built-in keys (prefixed with '_:'): returns the key itself
    */
-  translate: <A extends Args = G['args'], C = {},
-  // for CommandContext
-  E extends Record<string, string> = {},
-  // for extended resources
-  K = ResolveTranslationKeys<A, C, E>>(key: K, values?: Record<string, unknown>) => string;
+  translate: <A extends Args = G['args'], C = {} // for CommandContext
+  , E extends Record<string, string> = {} // for extended resources
+  , K = ResolveTranslationKeys<A, C, E>>(key: K, values?: Record<string, unknown>) => string;
   /**
    * Load command resources.
    *
@@ -892,7 +877,7 @@ type CommandResource<G extends GunshiParamsConstraint = DefaultGunshiParams> = {
    * Command description.
    */
   description: string;
-} & { [Arg in GenerateNamespacedKey<KeyOfArgs<RemovedIndex<ExtractArgs<G>>>, typeof ARG_PREFIX>]?: string } & {
+} & { [Arg in GenerateNamespacedKey<KeyOfArgs<RemovedIndex<ExtractArgs<G>>>, typeof ARG_PREFIX>]?: string; } & {
   [key: string]: string;
 };
 /**
@@ -927,7 +912,7 @@ type I18nCommandDefinitionResult<G extends GunshiParamsConstraint = DefaultGunsh
   resource: CommandResourceFetcher<G>;
 } : {
   resource?: CommandResourceFetcher<G> | undefined;
-}) & { [K in Exclude<keyof I18nCommand<G>, keyof C | 'resource'>]?: I18nCommand<G>[K] }>;
+}) & { [K in Exclude<keyof I18nCommand<G>, keyof C | 'resource'>]?: I18nCommand<G>[K]; }>;
 /**
  * The result type of the {@linkcode withI18nResource} function
  *
@@ -935,7 +920,7 @@ type I18nCommandDefinitionResult<G extends GunshiParamsConstraint = DefaultGunsh
  */
 type WithI18nResourceResult<G extends GunshiParamsConstraint = DefaultGunshiParams, C extends Command<G> = Command<G>> = Prettify<C & {
   resource: CommandResourceFetcher<G>;
-} & { [K in Exclude<keyof I18nCommand<G>, keyof C | 'resource'>]?: I18nCommand<G>[K] }>;
+} & { [K in Exclude<keyof I18nCommand<G>, keyof C | 'resource'>]?: I18nCommand<G>[K]; }>;
 /**
  * Define an i18n-aware {@link I18nCommand | command}.
  *

package/lib/index.js

@@ -34,13 +34,14 @@ var en_US_default = {
 	help: "Display this help message",
 	version: "Display this version",
 	"err:arg:required-option": "Optional argument {$displayName} is required",
-	"err:arg:required-positional": "Positional argument {$name} is required",
+	"err:arg:required-positional": "Positional argument {$displayName} 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:arg:unexpected-value": "Optional argument {$displayName} does not take a value",
 	"err:arg:missing-value": "Optional argument {$displayName} requires a value",
+	"err:arg:missing-value:hint": "(to pass '{$next}' as its value, write '{$suggestion}')",
 	"err:arg:conflict": "{$displayName} conflicts with {$conflictDisplayName}",
 	"err:arg:invalid-default": "Invalid default for {$displayName}: {$actual} is not one of {$choices}",
 	"err:cmd:not-found": "Command not found: {$commandName}",

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@gunshi/plugin-i18n",
   "description": "internationalization plugin for gunshi",
-  "version": "1.0.0-beta.0",
+  "version": "1.0.0-beta.2",
   "author": {
     "name": "kazuya kawaguchi",
     "email": "kawakazu80@gmail.com"
@@ -53,10 +53,10 @@
     }
   },
   "dependencies": {
-    "@gunshi/plugin": "1.0.0-beta.0"
+    "@gunshi/plugin": "1.0.0-beta.2"
   },
   "peerDependencies": {
-    "@gunshi/plugin-global": "1.0.0-beta.0"
+    "@gunshi/plugin-global": "1.0.0-beta.2"
   },
   "peerDependenciesMeta": {
     "@gunshi/plugin-global": {
@@ -64,19 +64,19 @@
     }
   },
   "devDependencies": {
+    "@gunshi/bone": "1.0.0-beta.2",
+    "@gunshi/plugin-global": "1.0.0-beta.2",
+    "@gunshi/plugin-renderer": "1.0.0-beta.2",
+    "@gunshi/resources": "1.0.0-beta.2",
+    "@gunshi/shared": "1.0.0-beta.2",
     "@intlify/core-base": "12.0.0-alpha.4",
     "deno": "^2.7.14",
+    "gunshi": "1.0.0-beta.2",
     "jsr": "^0.14.3",
     "jsr-exports-lint": "^0.4.2",
     "messageformat": "4.0.0",
     "publint": "^0.3.20",
-    "tsdown": "0.21.0",
-    "@gunshi/bone": "1.0.0-beta.0",
-    "@gunshi/plugin-global": "1.0.0-beta.0",
-    "@gunshi/plugin-renderer": "1.0.0-beta.0",
-    "@gunshi/shared": "1.0.0-beta.0",
-    "@gunshi/resources": "1.0.0-beta.0",
-    "gunshi": "1.0.0-beta.0"
+    "tsdown": "0.22.14"
   },
   "scripts": {
     "build": "tsdown",