@gunshi/shared 0.27.0-beta.2 → 0.27.0-beta.4

package/lib/index.d.ts

@@ -1,7 +1,4 @@
-import en_US_default from "@gunshi/resources/en-US";
-
 //#region ../../node_modules/.pnpm/args-tokens@0.23.0/node_modules/args-tokens/lib/parser-C6MbpZjd.d.ts
-
 //#region src/parser.d.ts
 /**
  * Entry point of argument parser.
@@ -487,8 +484,8 @@ type IsFunction<T> = T extends ((...args: any[]) => any) ? true : false;
  *
  * @internal
  */
-type ExtractOptionValue<A extends ArgSchema> = A['type'] extends 'string' ? ResolveOptionValue<A, string> : A['type'] extends 'boolean' ? ResolveOptionValue<A, boolean> : A['type'] extends 'number' ? ResolveOptionValue<A, number> : A['type'] extends 'positional' ? ResolveOptionValue<A, string> : A['type'] extends 'enum' ? A['choices'] extends string[] | readonly string[] ? ResolveOptionValue<A, A['choices'][number]> : never : A['type'] extends 'custom' ? IsFunction<A['parse']> extends true ? ResolveOptionValue<A, ReturnType<NonNullable<A['parse']>>> : never : ResolveOptionValue<A, string | boolean | number>;
-type ResolveOptionValue<A extends ArgSchema, T> = A['multiple'] extends true ? T[] : T;
+type ExtractOptionValue<A$1 extends ArgSchema> = A$1['type'] extends 'string' ? ResolveOptionValue<A$1, string> : A$1['type'] extends 'boolean' ? ResolveOptionValue<A$1, boolean> : A$1['type'] extends 'number' ? ResolveOptionValue<A$1, number> : A$1['type'] extends 'positional' ? ResolveOptionValue<A$1, string> : A$1['type'] extends 'enum' ? A$1['choices'] extends string[] | readonly string[] ? ResolveOptionValue<A$1, A$1['choices'][number]> : never : A$1['type'] extends 'custom' ? IsFunction<A$1['parse']> extends true ? ResolveOptionValue<A$1, ReturnType<NonNullable<A$1['parse']>>> : never : ResolveOptionValue<A$1, string | boolean | number>;
+type ResolveOptionValue<A$1 extends ArgSchema, T> = A$1['multiple'] extends true ? T[] : T;
 /**
  * Resolved argument values.
  *
@@ -497,7 +494,7 @@ type ResolveOptionValue<A extends ArgSchema, T> = A['multiple'] extends true ? T
  *
  * @internal
  */
-type ResolveArgValues<A extends Args, V extends Record<keyof A, unknown>> = { -readonly [Arg in keyof A]?: V[Arg] } & FilterArgs<A, V, 'default'> & FilterArgs<A, V, 'required'> & FilterPositionalArgs<A, V> extends infer P ? { [K in keyof P]: P[K] } : never;
+type ResolveArgValues<A$1 extends Args, V extends Record<keyof A$1, unknown>> = { -readonly [Arg in keyof A$1]?: V[Arg] } & FilterArgs<A$1, V, 'default'> & FilterArgs<A$1, V, 'required'> & FilterPositionalArgs<A$1, V> extends infer P ? { [K in keyof P]: P[K] } : never;
 /**
  * Filters the arguments based on their default values.
  *
@@ -507,7 +504,7 @@ type ResolveArgValues<A extends Args, V extends Record<keyof A, unknown>> = { -r
  *
  * @internal
  */
-type FilterArgs<A extends Args, V extends Record<keyof A, unknown>, K extends keyof ArgSchema> = { [Arg in keyof A as A[Arg][K] extends {} ? Arg : never]: V[Arg] };
+type FilterArgs<A$1 extends Args, V extends Record<keyof A$1, unknown>, K$1 extends keyof ArgSchema> = { [Arg in keyof A$1 as A$1[Arg][K$1] extends {} ? Arg : never]: V[Arg] };
 /**
  * Filters positional arguments from the argument schema.
  *
@@ -516,7 +513,7 @@ type FilterArgs<A extends Args, V extends Record<keyof A, unknown>, K extends ke
  *
  * @internal
  */
-type FilterPositionalArgs<A extends Args, V extends Record<keyof A, unknown>> = { [Arg in keyof A as A[Arg]['type'] extends 'positional' ? Arg : never]: V[Arg] };
+type FilterPositionalArgs<A$1 extends Args, V extends Record<keyof A$1, unknown>> = { [Arg in keyof A$1 as A$1[Arg]['type'] extends 'positional' ? Arg : never]: V[Arg] };
 /**
  * An arguments for {@link resolveArgs | resolve arguments}.
  */
@@ -529,7 +526,7 @@ type FilterPositionalArgs<A extends Args, V extends Record<keyof A, unknown>> =
  *
  * @typeParam A - {@link Args | Arguments}, which is an object that defines the command line arguments.
  */
-type ArgExplicitlyProvided<A extends Args> = { [K in keyof A]: boolean };
+type ArgExplicitlyProvided<A$1 extends Args> = { [K in keyof A$1]: boolean };
 /**
  * Resolve command line arguments.
  *
@@ -585,7 +582,7 @@ type ExtendContext = Record<string, unknown>;
  *
  * @since v0.27.0
  */
-interface GunshiParams<P extends {
+interface GunshiParams<P$1 extends {
   args?: Args;
   extensions?: ExtendContext;
 } = {
@@ -595,13 +592,13 @@ interface GunshiParams<P extends {
   /**
    * Command argument definitions.
    */
-  args: P extends {
+  args: P$1 extends {
     args: infer A extends Args;
   } ? A : Args;
   /**
    * Command context extensions.
    */
-  extensions: P extends {
+  extensions: P$1 extends {
     extensions: infer E extends ExtendContext;
   } ? E : {};
 }
@@ -1026,7 +1023,7 @@ declare function isLazyCommand<G extends GunshiParamsConstraint = DefaultGunshiP
  * @param needRunResolving - Whether to run the resolving function of the lazy command.
  * @returns A resolved {@link Command}
  */
-declare function resolveLazyCommand<G extends GunshiParamsConstraint = DefaultGunshiParams>(cmd: Commandable<G>, name?: string | undefined, needRunResolving?: boolean): Promise<Command<G>>;
+declare function resolveLazyCommand<G extends GunshiParamsConstraint = DefaultGunshiParams>(cmd: Commandable<G>, name?: string, needRunResolving?: boolean): Promise<Command<G>>;
 /**
  * Create an object with the specified prototype. A shorthand for `Object.create`.
  *
@@ -1091,7 +1088,7 @@ type RemovedIndex<T> = RemoveIndexSignature<{ [K in keyof T]: T[K] }>;
 /**
  * Resolve a key on {@link Args}.
  */
-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$1 extends Args> = 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.
  */
@@ -1116,28 +1113,28 @@ 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, C = {}, K extends string = GenerateNamespacedKey<Extract<KeyOfArgs<RemovedIndex<A>>, string>, typeof ARG_PREFIX>> = C extends {
+type CommandArgKeys<A$1 extends Args, 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, C = {},
+type ResolveTranslationKeys<A$1 extends Args, 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;
 /**
  * Translation function interface
  */
-interface Translation<A extends Args, C = {},
+interface Translation<A$1 extends 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>): string;
 }
 //#endregion
 //#region src/localization.d.ts
@@ -1148,10 +1145,10 @@ K = ResolveTranslationKeys<A, C, E>> {
  * @typeParam C - Additional context type for command localization.
  * @typeParam E - Extended resource keys type.
  */
-interface Localization<A extends Args, C = {},
+interface Localization<A$1 extends Args, C = {},
 // for CommandContext
-E extends Record<string, string> = {}> {
-  <K = ResolveTranslationKeys<A, C, E>>(key: K, values?: Record<string, unknown>): string;
+E$1 extends Record<string, string> = {}> {
+  <K$1 = ResolveTranslationKeys<A$1, C, E$1>>(key: K$1, values?: Record<string, unknown>): Promise<string>;
 }
 /**
  * Create a localizable function for a command.
@@ -1167,11 +1164,29 @@ E extends Record<string, string> = {}> {
  * @param translate - Translation function
  * @returns Localizable function
  */
-declare function localizable<A extends Args, C = {},
+declare function localizable<A$1 extends Args, C = {},
 // for CommandContext
-E extends Record<string, string> = {},
+E$1 extends Record<string, string> = {},
 // for extended resources
-K = ResolveTranslationKeys<A, C, E>>(ctx: CommandContext, cmd: Command, translate?: Translation<A, C, E, K>): Localization<A, C, E>;
+K$1 = ResolveTranslationKeys<A$1, C, E$1>>(ctx: CommandContext, cmd: Command, translate?: Translation<A$1, C, E$1, K$1>): Localization<A$1, C, E$1>;
+//#endregion
+//#region ../resources/locales/en-US.d.ts
+declare let COMMAND: string;
+declare let COMMANDS: string;
+declare let SUBCOMMAND: string;
+declare let USAGE: string;
+declare let ARGUMENTS: string;
+declare let OPTIONS: string;
+declare let EXAMPLES: string;
+declare let FORMORE: string;
+declare let NEGATABLE: string;
+declare let DEFAULT: string;
+declare let CHOICES: string;
+declare let help: string;
+declare let version: string;
+declare namespace __json_default_export {
+  export { COMMAND, COMMANDS, SUBCOMMAND, USAGE, ARGUMENTS, OPTIONS, EXAMPLES, FORMORE, NEGATABLE, DEFAULT, CHOICES, help, version };
+}
 //#endregion
 //#region src/utils.d.ts
 /**
@@ -1184,7 +1199,7 @@ K = ResolveTranslationKeys<A, C, E>>(ctx: CommandContext, cmd: Command, translat
  * @param key - The built-in key to resolve.
  * @returns Prefixed built-in key.
  */
-declare function resolveBuiltInKey<K extends string = CommandBuiltinResourceKeys>(key: K): GenerateNamespacedKey<K>;
+declare function resolveBuiltInKey<K$1 extends string = CommandBuiltinResourceKeys>(key: K$1): GenerateNamespacedKey<K$1>;
 /**
  * Resolve a namespaced key for argument resources.
  *
@@ -1197,7 +1212,7 @@ declare function resolveBuiltInKey<K extends string = CommandBuiltinResourceKeys
  * @param name - The command name.
  * @returns Prefixed argument key.
  */
-declare function resolveArgKey<A extends Args = DefaultGunshiParams['args'], K extends string = KeyOfArgs<RemovedIndex<A>>>(key: K, name?: string): string;
+declare function resolveArgKey<A$1 extends Args = DefaultGunshiParams['args'], K$1 extends string = KeyOfArgs<RemovedIndex<A$1>>>(key: K$1, name?: string): string;
 /**
  * Resolve a namespaced key for non-built-in resources.
  *
@@ -1209,7 +1224,7 @@ declare function resolveArgKey<A extends Args = DefaultGunshiParams['args'], K e
  * @param name - The command name.
  * @returns Prefixed non-built-in key.
  */
-declare function resolveKey<T extends Record<string, string> = {}, K = (keyof T extends string ? keyof T : string)>(key: K, name?: string): string;
+declare function resolveKey<T extends Record<string, string> = {}, K$1 extends string = (keyof T extends string ? keyof T : string)>(key: K$1, name?: string): string;
 /**
  * Resolve command examples.
  *
@@ -1228,7 +1243,7 @@ declare function resolveExamples<G extends GunshiParamsConstraint = DefaultGunsh
  * @param id - A plugin id to generate a namespaced key.
  * @returns A namespaced key for the plugin.
  */
-declare function namespacedId<K extends string>(id: K): GenerateNamespacedKey<K, typeof PLUGIN_PREFIX>;
+declare function namespacedId<K$1 extends string>(id: K$1): GenerateNamespacedKey<K$1, typeof PLUGIN_PREFIX>;
 /**
  * Generate a short and long option pair for command arguments.
  *
@@ -1239,4 +1254,4 @@ declare function namespacedId<K extends string>(id: K): GenerateNamespacedKey<K,
  */
 declare function makeShortLongOptionPair(schema: ArgSchema, name: string, toKebab?: boolean): string;
 //#endregion
-export { ARG_NEGATABLE_PREFIX, ARG_PREFIX, ARG_PREFIX_AND_KEY_SEPARATOR, BUILD_IN_PREFIX_AND_KEY_SEPARATOR, BUILT_IN_KEY_SEPARATOR, BUILT_IN_PREFIX, BuiltinResourceKeys, COMMAND_BUILTIN_RESOURCE_KEYS, COMMON_ARGS, CommandArgKeys, CommandBuiltinArgsKeys, CommandBuiltinKeys, CommandBuiltinResourceKeys, DeepWriteable, en_US_default as DefaultResource, GenerateNamespacedKey, KeyOfArgs, Localization, PLUGIN_PREFIX, RemovedIndex, ResolveTranslationKeys, Translation, create, deepFreeze, isLazyCommand, kebabnize, localizable, log, makeShortLongOptionPair, namespacedId, resolveArgKey, resolveBuiltInKey, resolveExamples, resolveKey, resolveLazyCommand };
+export { ARG_NEGATABLE_PREFIX, ARG_PREFIX, ARG_PREFIX_AND_KEY_SEPARATOR, BUILD_IN_PREFIX_AND_KEY_SEPARATOR, BUILT_IN_KEY_SEPARATOR, BUILT_IN_PREFIX, BuiltinResourceKeys, COMMAND_BUILTIN_RESOURCE_KEYS, COMMON_ARGS, CommandArgKeys, CommandBuiltinArgsKeys, CommandBuiltinKeys, CommandBuiltinResourceKeys, DeepWriteable, __json_default_export as DefaultResource, GenerateNamespacedKey, KeyOfArgs, Localization, PLUGIN_PREFIX, RemovedIndex, ResolveTranslationKeys, Translation, create, deepFreeze, isLazyCommand, kebabnize, localizable, log, makeShortLongOptionPair, namespacedId, resolveArgKey, resolveBuiltInKey, resolveExamples, resolveKey, resolveLazyCommand };

package/lib/index.js

@@ -146,38 +146,30 @@ const COMMAND_BUILTIN_RESOURCE_KEYS = [
 
 //#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 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 "_:".
@@ -259,6 +251,10 @@ function makeShortLongOptionPair(schema, name, toKebab) {
 //#endregion
 //#region 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.
@@ -286,7 +282,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);

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@gunshi/shared",
   "description": "shared utils for gunshi",
-  "version": "0.27.0-beta.2",
+  "version": "0.27.0-beta.4",
   "author": {
     "name": "kazuya kawaguchi",
     "email": "kawakazu80@gmail.com"
@@ -50,13 +50,13 @@
     }
   },
   "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.6",
-    "@gunshi/resources": "0.27.0-beta.2",
-    "gunshi": "0.27.0-beta.2"
+    "publint": "^0.3.15",
+    "tsdown": "0.15.12",
+    "@gunshi/resources": "0.27.0-beta.4",
+    "gunshi": "0.27.0-beta.4"
   },
   "scripts": {
     "build": "tsdown",