gunshi 0.16.0 → 0.17.0

package/lib/{cli-B7eqtqBF.js → cli-D2dWSSRj.js}

@@ -1,6 +1,6 @@
 import { COMMAND_OPTIONS_DEFAULT, COMMON_OPTIONS, create, resolveLazyCommand } from "./utils-BYPzZy9X.js";
 import { createCommandContext } from "./context-BROXRnNP.js";
-import { renderHeader, renderUsage, renderValidationErrors } from "./renderer-BNorS8VG.js";
+import { renderHeader, renderUsage, renderValidationErrors } from "./renderer-pNEj3FtQ.js";
 import { parseArgs, resolveArgs } from "args-tokens";
 
 //#region src/cli.ts
@@ -18,10 +18,7 @@ async function cli(args, entry, opts = {}) {
 	const [name, command] = await resolveCommand(subCommand, entry, resolvedCommandOptions);
 	if (!command) throw new Error(`Command not found: ${name || ""}`);
 	const options = resolveArgOptions(command.options);
-	const { values, positionals, rest, error } = resolveArgs(options, tokens, {
-		optionGrouping: true,
-		allowNegative: true
-	});
+	const { values, positionals, rest, error } = resolveArgs(options, tokens, { optionGrouping: true });
 	const omitted = !subCommand;
 	const ctx = await createCommandContext({
 		options,

package/lib/context.d.ts

@@ -1,54 +1,63 @@
-import { Command, CommandContext, CommandOptions } from "./types.d-aDzUZTqM.js";
+import { Command, CommandContext, CommandOptions } from "./types.d-DomXJWKH.js";
 import { ArgOptions, ArgToken, ArgValues } from "args-tokens";
 
 //#region src/context.d.ts
 /**
 * Parameters of {@link createCommandContext}
 */
+
 interface CommandContextParams<Options extends ArgOptions, Values> {
-    /**
-     * An options of target command
-     */
-    options: Options;
-    /**
-     * A values of target command
-     */
-    values: Values;
-    /**
-     * A positionals arguments, which passed to the target command
-     */
-    positionals: string[];
-    /**
-     * A rest arguments, which passed to the target command
-     */
-    rest: string[];
-    /**
-     * Original command line arguments
-     */
-    args: string[];
-    /**
-     * Argument tokens that are parsed by the `parseArgs` function
-     */
-    tokens: ArgToken[];
-    /**
-     * Whether the command is omitted
-     */
-    omitted: boolean;
-    /**
-     * A target {@link Command | command}
-     */
-    command: Command<Options>;
-    /**
-     * A command options, which is spicialized from `cli` function
-     */
-    commandOptions: CommandOptions<Options>;
-}
-/**
-* Create a {@link CommandContext | command context}
-* @param param A {@link CommandContextParams | parameters} to create a {@link CommandContext | command context}
-* @returns A {@link CommandContext | command context}, which is readonly
-*/
-declare function createCommandContext<Options extends ArgOptions = ArgOptions, Values extends ArgValues<Options> = ArgValues<Options>>({ options, values, positionals, rest, args, tokens, command, commandOptions, omitted }: CommandContextParams<Options, Values>): Promise<Readonly<CommandContext<Options, Values>>>;
+  /**
+   * An options of target command
+   */
+  options: Options;
+  /**
+   * A values of target command
+   */
+  values: Values;
+  /**
+   * A positionals arguments, which passed to the target command
+   */
+  positionals: string[];
+  /**
+   * A rest arguments, which passed to the target command
+   */
+  rest: string[];
+  /**
+   * Original command line arguments
+   */
+  args: string[];
+  /**
+   * Argument tokens that are parsed by the `parseArgs` function
+   */
+  tokens: ArgToken[];
+  /**
+   * Whether the command is omitted
+   */
+  omitted: boolean;
+  /**
+   * A target {@link Command | command}
+   */
+  command: Command<Options>;
+  /**
+   * A command options, which is spicialized from `cli` function
+   */
+  commandOptions: CommandOptions<Options>;
+} /**
+  * Create a {@link CommandContext | command context}
+  * @param param A {@link CommandContextParams | parameters} to create a {@link CommandContext | command context}
+  * @returns A {@link CommandContext | command context}, which is readonly
+  */
 
-//#endregion
+declare function createCommandContext<Options extends ArgOptions = ArgOptions, Values extends ArgValues<Options> = ArgValues<Options>>({
+  options,
+  values,
+  positionals,
+  rest,
+  args,
+  tokens,
+  command,
+  commandOptions,
+  omitted
+}: CommandContextParams<Options, Values>): Promise<Readonly<CommandContext<Options, Values>>>; //#endregion
 export { createCommandContext };

package/lib/{definition.d-DllW_uD3.d.ts → definition.d-wYlroF3H.d.ts}

@@ -1,4 +1,4 @@
-import { Command } from "./types.d-aDzUZTqM.js";
+import { Command } from "./types.d-DomXJWKH.js";
 import { ArgOptionSchema, ArgOptions, ArgOptions as ArgOptions$1, ArgValues as ArgValues$1 } from "args-tokens";
 
 //#region src/definition.d.ts
@@ -7,7 +7,6 @@ import { ArgOptionSchema, ArgOptions, ArgOptions as ArgOptions$1, ArgValues as A
 * @param definition A {@link Command | command} definition
 * @returns A {@link Command | command} definition with type inference
 */
-declare function define<Options extends ArgOptions = ArgOptions>(definition: Command<Options>): Command<Options>;
 
-//#endregion
+declare function define<Options extends ArgOptions = ArgOptions>(definition: Command<Options>): Command<Options>; //#endregion
 export { ArgOptionSchema, ArgOptions$1 as ArgOptions, ArgValues$1 as ArgValues, define as define$1 };

package/lib/definition.d.ts

@@ -1,4 +1,3 @@
-import "./types.d-aDzUZTqM.js";
-import { ArgOptionSchema, ArgOptions, ArgValues, define$1 as define } from "./definition.d-DllW_uD3.js";
-
+import "./types.d-DomXJWKH.js";
+import { ArgOptionSchema, ArgOptions, ArgValues, define$1 as define } from "./definition.d-wYlroF3H.js";
 export { ArgOptionSchema, ArgOptions, ArgValues, define };

package/lib/generator.d.ts

@@ -1,4 +1,4 @@
-import { Command, CommandOptions } from "./types.d-aDzUZTqM.js";
+import { Command, CommandOptions } from "./types.d-DomXJWKH.js";
 import { ArgOptions } from "args-tokens";
 
 //#region src/generator.d.ts
@@ -9,6 +9,7 @@ import { ArgOptions } from "args-tokens";
 * @param opts - A {@link CommandOptions | command options}
 * @returns A rendered usage.
 */
+
 declare function generate<Options extends ArgOptions = ArgOptions>(command: string | null, entry: Command<Options>, opts?: CommandOptions<Options>): Promise<string>;
 
 //#endregion

package/lib/generator.js

@@ -1,7 +1,7 @@
 import { create } from "./utils-BYPzZy9X.js";
 import "./context-BROXRnNP.js";
-import "./renderer-BNorS8VG.js";
-import { cli } from "./cli-B7eqtqBF.js";
+import "./renderer-pNEj3FtQ.js";
+import { cli } from "./cli-D2dWSSRj.js";
 
 //#region src/generator.ts
 /**

package/lib/index.d.ts

@@ -1,5 +1,5 @@
-import { Command, CommandBuiltinKeys, CommandBuiltinOptionsKeys, CommandBuiltinResourceKeys, CommandContext, CommandEnvironment, CommandOptionKeys, CommandOptions, CommandResource, CommandResourceFetcher, CommandRunner, Commandable, DEFAULT_LOCALE, GenerateNamespacedKey, KeyOfArgOptions, LazyCommand, RemovedIndex, TranslationAdapter, TranslationAdapterFactory, TranslationAdapterFactoryOptions } from "./types.d-aDzUZTqM.js";
-import { define$1 as define } from "./definition.d-DllW_uD3.js";
+import { Command, CommandBuiltinKeys, CommandBuiltinOptionsKeys, CommandBuiltinResourceKeys, CommandContext, CommandEnvironment, CommandOptionKeys, CommandOptions, CommandResource, CommandResourceFetcher, CommandRunner, Commandable, DEFAULT_LOCALE, GenerateNamespacedKey, KeyOfArgOptions, LazyCommand, RemovedIndex, TranslationAdapter, TranslationAdapterFactory, TranslationAdapterFactoryOptions } from "./types.d-DomXJWKH.js";
+import { define$1 as define } from "./definition.d-wYlroF3H.js";
 import { ArgOptionSchema, ArgOptions, ArgOptions as ArgOptions$1, ArgValues, parseArgs, resolveArgs } from "args-tokens";
 
 //#region src/cli.d.ts
@@ -10,17 +10,18 @@ import { ArgOptionSchema, ArgOptions, ArgOptions as ArgOptions$1, ArgValues, par
 * @param opts A {@link CommandOptions | command options}
 * @returns A rendered usage or undefined. if you will use {@link CommandOptions.usageSilent} option, it will return rendered usage string.
 */
+
 declare function cli<Options extends ArgOptions$1 = ArgOptions$1>(args: string[], entry: Command<Options> | CommandRunner<Options>, opts?: CommandOptions<Options>): Promise<string | undefined>;
 
 //#endregion
 //#region src/translation.d.ts
 declare class DefaultTranslation implements TranslationAdapter {
-    #private;
-    constructor(options: TranslationAdapterFactoryOptions);
-    getResource(locale: string): Record<string, string> | undefined;
-    setResource(locale: string, resource: Record<string, string>): void;
-    getMessage(locale: string, key: string): string | undefined;
-    translate(locale: string, key: string, values?: Record<string, unknown>): string | undefined;
+  #private;
+  constructor(options: TranslationAdapterFactoryOptions);
+  getResource(locale: string): Record<string, string> | undefined;
+  setResource(locale: string, resource: Record<string, string>): void;
+  getMessage(locale: string, key: string): string | undefined;
+  translate(locale: string, key: string, values?: Record<string, unknown>): string | undefined;
 }
 
 //#endregion

package/lib/index.js

@@ -1,8 +1,8 @@
 import { DEFAULT_LOCALE$1 as DEFAULT_LOCALE } from "./utils-BYPzZy9X.js";
 import { DefaultTranslation } from "./context-BROXRnNP.js";
 import { define } from "./definition-VzcnM0si.js";
-import "./renderer-BNorS8VG.js";
-import { cli } from "./cli-B7eqtqBF.js";
+import "./renderer-pNEj3FtQ.js";
+import { cli } from "./cli-D2dWSSRj.js";
 import { parseArgs, resolveArgs } from "args-tokens";
 
 export { DEFAULT_LOCALE, DefaultTranslation, cli, define, parseArgs, resolveArgs };

package/lib/{renderer-BNorS8VG.js → renderer-pNEj3FtQ.js}

@@ -181,7 +181,7 @@ function getOptionsPairs(ctx) {
 		let key = makeShortLongOptionPair(value, name);
 		if (value.type !== "boolean") key = value.default ? `${key} [${name}]` : `${key} <${name}>`;
 		acc[name] = key;
-		if (value.type === "boolean" && !(name === "help" || name === "version")) acc[`no-${name}`] = `--no-${name}`;
+		if (value.type === "boolean" && value.negatable && !(name === "help" || name === "version")) acc[`no-${name}`] = `--no-${name}`;
 		return acc;
 	}, create());
 }

package/lib/renderer.d.ts

@@ -1,4 +1,4 @@
-import { CommandContext } from "./types.d-aDzUZTqM.js";
+import { CommandContext } from "./types.d-DomXJWKH.js";
 import { ArgOptions } from "args-tokens";
 
 //#region src/renderer/header.d.ts
@@ -7,6 +7,7 @@ import { ArgOptions } from "args-tokens";
 * @param ctx A {@link CommandContext | command context}
 * @returns A rendered header.
 */
+
 declare function renderHeader<Options extends ArgOptions = ArgOptions>(ctx: Readonly<CommandContext<Options>>): Promise<string>;
 
 //#endregion

package/lib/renderer.js

@@ -1,4 +1,4 @@
 import "./utils-BYPzZy9X.js";
-import { renderHeader, renderUsage, renderValidationErrors } from "./renderer-BNorS8VG.js";
+import { renderHeader, renderUsage, renderValidationErrors } from "./renderer-pNEj3FtQ.js";
 
 export { renderHeader, renderUsage, renderValidationErrors };

package/lib/types.d-DomXJWKH.d.ts

@@ -0,0 +1,395 @@
+import { ArgOptions, ArgToken, ArgValues } from "args-tokens";
+
+//#region rolldown:runtime
+declare namespace constants_d_exports {
+  export { BUILT_IN_KEY_SEPARATOR, BUILT_IN_PREFIX, COMMAND_BUILTIN_RESOURCE_KEYS, COMMAND_OPTIONS_DEFAULT, COMMON_OPTIONS, DEFAULT_LOCALE, NOOP, OPTION_PREFIX };
+}
+/**
+* The default locale string, which format is BCP 47 language tag.
+*/
+declare const DEFAULT_LOCALE = "en-US";
+declare const BUILT_IN_PREFIX = "_";
+declare const OPTION_PREFIX = "Option";
+declare const BUILT_IN_KEY_SEPARATOR = ":";
+declare const NOOP: () => void;
+type CommonOptionType = {
+  readonly help: {
+    readonly type: 'boolean';
+    readonly short: 'h';
+    readonly description: string;
+  };
+  readonly version: {
+    readonly type: 'boolean';
+    readonly short: 'v';
+    readonly description: string;
+  };
+};
+declare const COMMON_OPTIONS: CommonOptionType;
+declare const COMMAND_OPTIONS_DEFAULT: CommandOptions<ArgOptions>;
+declare const COMMAND_BUILTIN_RESOURCE_KEYS: readonly ["USAGE", "COMMAND", "SUBCOMMAND", "COMMANDS", "OPTIONS", "EXAMPLES", "FORMORE", "NEGATABLE"];
+
+//#endregion
+//#region src/types.d.ts
+type Awaitable<T> = T | Promise<T>;
+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 KeyOfArgOptions<Options extends ArgOptions> = keyof Options | { [K in keyof Options]: Options[K]['type'] extends 'boolean' ? Options[K]['negatable'] extends true ? `no-${Extract<K, string>}` : never : never }[keyof Options];
+
+/**
+* Generate a namespaced key.
+*/
+type GenerateNamespacedKey<Key extends string, Prefixed extends string = typeof BUILT_IN_PREFIX> = `${Prefixed}${typeof BUILT_IN_KEY_SEPARATOR}${Key}`;
+
+/**
+* Command i18n built-in options keys.
+*/
+type CommandBuiltinOptionsKeys = keyof (typeof constants_d_exports)['COMMON_OPTIONS'];
+
+/**
+* Command i18n built-in resource keys.
+*/
+type CommandBuiltinResourceKeys = (typeof constants_d_exports)['COMMAND_BUILTIN_RESOURCE_KEYS'][number];
+
+/**
+* Command i18n built-in keys.
+* The command i18n built-in keys are used to {@link CommandContext.translate | translate} function.
+*/
+type CommandBuiltinKeys = GenerateNamespacedKey<CommandBuiltinOptionsKeys> | GenerateNamespacedKey<CommandBuiltinResourceKeys> | 'description' | 'examples';
+
+/**
+* Command i18n option keys.
+* The command i18n option keys are used to {@link CommandContext.translate | translate} function.
+*/
+type CommandOptionKeys<Options extends ArgOptions> = GenerateNamespacedKey<KeyOfArgOptions<RemovedIndex<Options>>, typeof OPTION_PREFIX>;
+
+/**
+* Command environment.
+*/
+interface CommandEnvironment<Options extends ArgOptions = ArgOptions> {
+  /**
+   * Current working directory.
+   * @see {@link CommandOptions.cwd}
+   */
+  cwd: string | undefined;
+  /**
+   * Command name.
+   * @see {@link CommandOptions.name}
+   */
+  name: string | undefined;
+  /**
+   * Command description.
+   * @see {@link CommandOptions.description}
+   *
+   */
+  description: string | undefined;
+  /**
+   * Command version.
+   * @see {@link CommandOptions.version}
+   */
+  version: string | undefined;
+  /**
+   * Left margin of the command output.
+   * @default 2
+   * @see {@link CommandOptions.leftMargin}
+   */
+  leftMargin: number;
+  /**
+   * Middle margin of the command output.
+   * @default 10
+   * @see {@link CommandOptions.middleMargin}
+   */
+  middleMargin: number;
+  /**
+   * Whether to display the usage option type.
+   * @default false
+   * @see {@link CommandOptions.usageOptionType}
+   */
+  usageOptionType: boolean;
+  /**
+   * Whether to display the command usage.
+   * @default false
+   * @see {@link}
+   */
+  usageSilent: boolean;
+  /**
+   * Sub commands.
+   * @see {@link CommandOptions.subCommands}
+   */
+  subCommands: Map<string, Command<any> | LazyCommand<any>> | undefined;
+  /**
+   * Render function the command usage.
+   */
+  renderUsage: ((ctx: CommandContext<Options>) => Promise<string>) | null | undefined;
+  /**
+   * Render function the header section in the command usage.
+   */
+  renderHeader: ((ctx: CommandContext<Options>) => Promise<string>) | null | undefined;
+  /**
+   * Render function the validation errors.
+   */
+  renderValidationErrors: ((ctx: CommandContext<Options>, error: AggregateError) => Promise<string>) | null | undefined;
+}
+
+/**
+* Command options.
+*/
+interface CommandOptions<Options extends ArgOptions = ArgOptions> {
+  /**
+   * Current working directory.
+   */
+  cwd?: string;
+  /**
+   * Command program name.
+   */
+  name?: string;
+  /**
+   * Command program description.
+   *
+   */
+  description?: string;
+  /**
+   * Command program version.
+   */
+  version?: string;
+  /**
+   * Command program locale.
+   */
+  locale?: string | Intl.Locale;
+  /**
+   * Sub commands.
+   */
+  subCommands?: Map<string, Command<any> | LazyCommand<any>>;
+  /**
+   * Left margin of the command output.
+   */
+  leftMargin?: number;
+  /**
+   * Middle margin of the command output.
+   */
+  middleMargin?: number;
+  /**
+   * Whether to display the usage option type.
+   */
+  usageOptionType?: boolean;
+  /**
+   * Whether to display the command usage.
+   */
+  usageSilent?: boolean;
+  /**
+   * Render function the command usage.
+   */
+  renderUsage?: ((ctx: Readonly<CommandContext<Options>>) => Promise<string>) | null;
+  /**
+   * Render function the header section in the command usage.
+   */
+  renderHeader?: ((ctx: Readonly<CommandContext<Options>>) => Promise<string>) | null;
+  /**
+   * Render function the validation errors.
+   */
+  renderValidationErrors?: ((ctx: Readonly<CommandContext<Options>>, error: AggregateError) => Promise<string>) | null;
+  /**
+   * Translation adapter factory.
+   */
+  translationAdapterFactory?: TranslationAdapterFactory;
+}
+/**
+* Command context.
+* Command context is the context of the command execution.
+*/
+interface CommandContext<Options extends ArgOptions = ArgOptions, Values = ArgValues<Options>> {
+  /**
+   * Command name, that is the command that is executed.
+   * The command name is same {@link CommandEnvironment.name}.
+   */
+  name: string | undefined;
+  /**
+   * Command description, that is the description of the command that is executed.
+   * The command description is same {@link CommandEnvironment.description}.
+   */
+  description: string | undefined;
+  /**
+   * Command locale, that is the locale of the command that is executed.
+   */
+  locale: Intl.Locale;
+  /**
+   * Command environment, that is the environment of the command that is executed.
+   * The command environment is same {@link CommandEnvironment}.
+   */
+  env: Readonly<CommandEnvironment<Options>>;
+  /**
+   * Command options, that is the options of the command that is executed.
+   * The command options is same {@link Command.options}.
+   */
+  options: Options;
+  /**
+   * Command values, that is the values of the command that is executed.
+   * Resolve values with `resolveArgs` from command arguments and {@link Command.options}.
+   */
+  values: Values;
+  /**
+   * Command positionals arguments, that is the positionals of the command that is executed.
+   * Resolve positionals with `resolveArgs` from command arguments.
+   */
+  positionals: string[];
+  /**
+   * Command rest arguments, that is the remaining argument not resolved by the optional command option delimiter `--`.
+   */
+  rest: string[];
+  /**
+   * Original command line arguments.
+   * This argument is passed from `cli` function.
+   */
+  _: string[];
+  /**
+   * Argument tokens, that is parsed by `parseArgs` function.
+   */
+  tokens: ArgToken[];
+  /**
+   * Whether the currently executing command has been executed with the sub-command name omitted.
+   */
+  omitted: boolean;
+  /**
+   * Output a message.
+   * If {@link CommandEnvironment.usageSilent} is true, the message is not output.
+   * @param message an output message, @see {@link console.log}
+   * @param optionalParams an optional parameters, @see {@link console.log}
+   */
+  log: (message?: any, ...optionalParams: any[]) => void;
+  /**
+   * Load sub-commands.
+   * The loaded commands are cached and returned when called again.
+   * @returns loaded commands.
+   */
+  loadCommands: () => Promise<Command<Options>[]>;
+  /**
+   * Translate function.
+   * @param key the key to be translated
+   * @param values the values to be formatted
+   * @returns A translated string.
+   */
+  translate: <T extends string = CommandBuiltinKeys, O = CommandOptionKeys<Options>, Key = CommandBuiltinKeys | O | T>(key: Key, values?: Record<string, unknown>) => string;
+} /**
+  * Command interface.
+  */
+
+interface Command<Options extends ArgOptions = ArgOptions> {
+  /**
+   * Command name.
+   * It's used to find command line arguments to execute from sub commands, and it's recommended to specify.
+   */
+  name?: string;
+  /**
+   * Command description.
+   * It's used to describe the command in usage and it's recommended to specify.
+   */
+  description?: string;
+  /**
+   * Command options.
+   * Each option can include a description property to describe the option in usage.
+   */
+  options?: Options;
+  /**
+   * Command examples.
+   * examples of how to use the command.
+   */
+  examples?: string;
+  /**
+   * Command runner. it's the command to be executed
+   */
+  run: CommandRunner<Options>;
+  /**
+   * Command resource fetcher.
+   */
+  resource?: CommandResourceFetcher<Options>;
+} /**
+  * Command resource.
+  */
+
+type CommandResource<Options extends ArgOptions = ArgOptions> = {
+  /**
+   * Command description.
+   */
+  description: string;
+  /**
+   * Examples usage.
+   */
+  examples: string;
+} & { [Option in GenerateNamespacedKey<KeyOfArgOptions<RemovedIndex<Options>>, typeof OPTION_PREFIX>]: string } & {
+  [key: string]: string;
+}; /**
+   * Command resource fetcher.
+   * @param ctx A {@link CommandContext | command context}
+   * @returns A fetched {@link CommandResource | command resource}.
+   */
+
+type CommandResourceFetcher<Options extends ArgOptions = ArgOptions, Values = ArgValues<Options>> = (ctx: Readonly<CommandContext<Options, Values>>) => Promise<CommandResource<Options>>; /**
+                                                                                                                                                                                           * Translation adapter factory.
+                                                                                                                                                                                           */
+
+type TranslationAdapterFactory = (options: TranslationAdapterFactoryOptions) => TranslationAdapter; /**
+                                                                                                    * Translation adapter factory options.
+                                                                                                    */
+
+interface TranslationAdapterFactoryOptions {
+  /**
+   * A locale.
+   */
+  locale: string;
+  /**
+   * A fallback locale.
+   */
+  fallbackLocale: string;
+} /**
+  * Translation adapter.
+  * This adapter is used to custom message formatter like {@link https://github.com/intlify/vue-i18n/blob/master/spec/syntax.ebnf | Intlify message format}, {@link https://github.com/tc39/proposal-intl-messageformat | `Intl.MessageFormat` (MF2)}, and etc.
+  * This adapter will support localization with your preferred message format.
+  */
+
+interface TranslationAdapter<MessageResource = string> {
+  /**
+   * Get a resource of locale.
+   * @param locale A Locale at the time of command execution. That is Unicord locale ID (BCP 47)
+   * @returns A resource of locale. if resource not found, return `undefined`.
+   */
+  getResource(locale: string): Record<string, string> | undefined;
+  /**
+   * Set a resource of locale.
+   * @param locale A Locale at the time of command execution. That is Unicord locale ID (BCP 47)
+   * @param resource A resource of locale
+   */
+  setResource(locale: string, resource: Record<string, string>): void;
+  /**
+   * Get a message of locale.
+   * @param locale A Locale at the time of command execution. That is Unicord locale ID (BCP 47)
+   * @param key A key of message resource
+   * @returns A message of locale. if message not found, return `undefined`.
+   */
+  getMessage(locale: string, key: string): MessageResource | undefined;
+  /**
+   * Translate a message.
+   * @param locale A Locale at the time of command execution. That is Unicord locale ID (BCP 47)
+   * @param key A key of message resource
+   * @param values A values to be resolved in the message
+   * @returns A translated message, if message is not translated, return `undefined`.
+   */
+  translate(locale: string, key: string, values?: Record<string, unknown>): string | undefined;
+} /**
+  * Command runner.
+  * @param ctx A {@link CommandContext | command context}
+  */
+
+type CommandRunner<Options extends ArgOptions = ArgOptions> = (ctx: Readonly<CommandContext<Options>>) => Awaitable<void>; /**
+                                                                                                                           * Lazy command interface.
+                                                                                                                           * Lazy command that's not loaded until it is executed.
+                                                                                                                           */
+
+type LazyCommand<Options extends ArgOptions = ArgOptions> = () => Awaitable<Command<Options>>; /**
+                                                                                               * Define a command type.
+                                                                                               */
+
+type Commandable<Options extends ArgOptions> = Command<Options> | LazyCommand<Options>; //#endregion
+export { Command, CommandBuiltinKeys, CommandBuiltinOptionsKeys, CommandBuiltinResourceKeys, CommandContext, CommandEnvironment, CommandOptionKeys, CommandOptions, CommandResource, CommandResourceFetcher, CommandRunner, Commandable, DEFAULT_LOCALE, GenerateNamespacedKey, KeyOfArgOptions, LazyCommand, RemovedIndex, TranslationAdapter, TranslationAdapterFactory, TranslationAdapterFactoryOptions };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "gunshi",
   "description": "Modern javascript command-line library",
-  "version": "0.16.0",
+  "version": "0.17.0",
   "author": {
     "name": "kazuya kawaguchi",
     "email": "kawakazu80@gmail.com"
@@ -77,20 +77,20 @@
     }
   },
   "dependencies": {
-    "args-tokens": "^0.15.1"
+    "args-tokens": "^0.16.0"
   },
   "devDependencies": {
-    "@eslint/markdown": "^6.3.0",
+    "@eslint/markdown": "^6.4.0",
     "@intlify/core": "next",
     "@kazupon/eslint-config": "^0.29.0",
     "@kazupon/prettier-config": "^0.1.1",
-    "@types/node": "^22.14.0",
-    "@vitest/eslint-plugin": "^1.1.42",
+    "@types/node": "^22.15.3",
+    "@vitest/eslint-plugin": "^1.1.43",
     "bumpp": "^10.1.0",
-    "deno": "^2.2.8",
-    "eslint": "^9.24.0",
+    "deno": "^2.2.12",
+    "eslint": "^9.25.1",
     "eslint-config-prettier": "^10.1.2",
-    "eslint-import-resolver-typescript": "^4.3.2",
+    "eslint-import-resolver-typescript": "^4.3.4",
     "eslint-plugin-import": "^2.31.0",
     "eslint-plugin-jsonc": "^2.20.0",
     "eslint-plugin-module-interop": "^0.3.1",
@@ -98,28 +98,28 @@
     "eslint-plugin-regexp": "^2.7.0",
     "eslint-plugin-unicorn": "^58.0.0",
     "eslint-plugin-unused-imports": "^4.1.4",
-    "eslint-plugin-vue": "^10.0.0",
+    "eslint-plugin-vue": "^10.0.1",
     "eslint-plugin-vue-composable": "^1.0.0",
-    "eslint-plugin-yml": "^1.17.0",
+    "eslint-plugin-yml": "^1.18.0",
     "gh-changelogen": "^0.2.8",
     "jsr": "^0.13.4",
     "jsr-exports-lint": "^0.2.0",
-    "knip": "^5.50.2",
-    "lint-staged": "^15.5.0",
+    "knip": "^5.50.5",
+    "lint-staged": "^15.5.1",
     "messageformat": "4.0.0-10",
     "pkg-pr-new": "^0.0.43",
     "prettier": "^3.5.3",
-    "publint": "^0.3.11",
-    "tsdown": "^0.9.6",
-    "typedoc": "^0.28.2",
-    "typedoc-plugin-markdown": "^4.6.2",
+    "publint": "^0.3.12",
+    "tsdown": "^0.10.0",
+    "typedoc": "^0.28.3",
+    "typedoc-plugin-markdown": "^4.6.3",
     "typedoc-vitepress-theme": "^1.1.2",
     "typescript": "^5.8.3",
-    "typescript-eslint": "^8.29.1",
+    "typescript-eslint": "^8.31.1",
     "vitepress": "^1.6.3",
-    "vitepress-plugin-group-icons": "^1.4.1",
-    "vitepress-plugin-llms": "^1.0.0",
-    "vitest": "^3.1.1",
+    "vitepress-plugin-group-icons": "^1.5.2",
+    "vitepress-plugin-llms": "^1.1.1",
+    "vitest": "^3.1.2",
     "vue": "^3.5.13"
   },
   "prettier": "@kazupon/prettier-config",

package/lib/types.d-aDzUZTqM.d.ts

@@ -1,403 +0,0 @@
-import { ArgOptions, ArgToken, ArgValues } from "args-tokens";
-
-//#region rolldown:runtime
-
-
-
-//#endregion
-//#region src/constants.d.ts
-
-declare namespace constants_d_exports {
-  export { BUILT_IN_KEY_SEPARATOR, BUILT_IN_PREFIX, COMMAND_BUILTIN_RESOURCE_KEYS, COMMAND_OPTIONS_DEFAULT, COMMON_OPTIONS, DEFAULT_LOCALE, NOOP, OPTION_PREFIX, }
-}
-/**
-* The default locale string, which format is BCP 47 language tag.
-*/
-declare const DEFAULT_LOCALE = "en-US";
-declare const BUILT_IN_PREFIX = "_";
-declare const OPTION_PREFIX = "Option";
-declare const BUILT_IN_KEY_SEPARATOR = ":";
-declare const NOOP: () => void;
-type CommonOptionType = {
-    readonly help: {
-        readonly type: 'boolean';
-        readonly short: 'h';
-        readonly description: string;
-    };
-    readonly version: {
-        readonly type: 'boolean';
-        readonly short: 'v';
-        readonly description: string;
-    };
-};
-declare const COMMON_OPTIONS: CommonOptionType;
-declare const COMMAND_OPTIONS_DEFAULT: CommandOptions<ArgOptions>;
-declare const COMMAND_BUILTIN_RESOURCE_KEYS: readonly ["USAGE", "COMMAND", "SUBCOMMAND", "COMMANDS", "OPTIONS", "EXAMPLES", "FORMORE", "NEGATABLE"];
-
-//#endregion
-//#region src/types.d.ts
-type Awaitable<T> = T | Promise<T>;
-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 KeyOfArgOptions<Options extends ArgOptions> = keyof Options | {
-    [K in keyof Options]: Options[K]['type'] extends 'boolean' ? `no-${Extract<K, string>}` : never;
-}[keyof Options];
-/**
-* Generate a namespaced key.
-*/
-type GenerateNamespacedKey<Key extends string, Prefixed extends string = typeof BUILT_IN_PREFIX> = `${Prefixed}${typeof BUILT_IN_KEY_SEPARATOR}${Key}`;
-/**
-* Command i18n built-in options keys.
-*/
-type CommandBuiltinOptionsKeys = keyof (typeof constants_d_exports)['COMMON_OPTIONS'];
-/**
-* Command i18n built-in resource keys.
-*/
-type CommandBuiltinResourceKeys = (typeof constants_d_exports)['COMMAND_BUILTIN_RESOURCE_KEYS'][number];
-/**
-* Command i18n built-in keys.
-* The command i18n built-in keys are used to {@link CommandContext.translate | translate} function.
-*/
-type CommandBuiltinKeys = GenerateNamespacedKey<CommandBuiltinOptionsKeys> | GenerateNamespacedKey<CommandBuiltinResourceKeys> | 'description' | 'examples';
-/**
-* Command i18n option keys.
-* The command i18n option keys are used to {@link CommandContext.translate | translate} function.
-*/
-type CommandOptionKeys<Options extends ArgOptions> = GenerateNamespacedKey<KeyOfArgOptions<RemovedIndex<Options>>, typeof OPTION_PREFIX>;
-/**
-* Command environment.
-*/
-interface CommandEnvironment<Options extends ArgOptions = ArgOptions> {
-    /**
-     * Current working directory.
-     * @see {@link CommandOptions.cwd}
-     */
-    cwd: string | undefined;
-    /**
-     * Command name.
-     * @see {@link CommandOptions.name}
-     */
-    name: string | undefined;
-    /**
-     * Command description.
-     * @see {@link CommandOptions.description}
-     *
-     */
-    description: string | undefined;
-    /**
-     * Command version.
-     * @see {@link CommandOptions.version}
-     */
-    version: string | undefined;
-    /**
-     * Left margin of the command output.
-     * @default 2
-     * @see {@link CommandOptions.leftMargin}
-     */
-    leftMargin: number;
-    /**
-     * Middle margin of the command output.
-     * @default 10
-     * @see {@link CommandOptions.middleMargin}
-     */
-    middleMargin: number;
-    /**
-     * Whether to display the usage option type.
-     * @default false
-     * @see {@link CommandOptions.usageOptionType}
-     */
-    usageOptionType: boolean;
-    /**
-     * Whether to display the command usage.
-     * @default false
-     * @see {@link}
-     */
-    usageSilent: boolean;
-    /**
-     * Sub commands.
-     * @see {@link CommandOptions.subCommands}
-     */
-    subCommands: Map<string, Command<any> | LazyCommand<any>> | undefined;
-    /**
-     * Render function the command usage.
-     */
-    renderUsage: ((ctx: CommandContext<Options>) => Promise<string>) | null | undefined;
-    /**
-     * Render function the header section in the command usage.
-     */
-    renderHeader: ((ctx: CommandContext<Options>) => Promise<string>) | null | undefined;
-    /**
-     * Render function the validation errors.
-     */
-    renderValidationErrors: ((ctx: CommandContext<Options>, error: AggregateError) => Promise<string>) | null | undefined;
-}
-/**
-* Command options.
-*/
-interface CommandOptions<Options extends ArgOptions = ArgOptions> {
-    /**
-     * Current working directory.
-     */
-    cwd?: string;
-    /**
-     * Command program name.
-     */
-    name?: string;
-    /**
-     * Command program description.
-     *
-     */
-    description?: string;
-    /**
-     * Command program version.
-     */
-    version?: string;
-    /**
-     * Command program locale.
-     */
-    locale?: string | Intl.Locale;
-    /**
-     * Sub commands.
-     */
-    subCommands?: Map<string, Command<any> | LazyCommand<any>>;
-    /**
-     * Left margin of the command output.
-     */
-    leftMargin?: number;
-    /**
-     * Middle margin of the command output.
-     */
-    middleMargin?: number;
-    /**
-     * Whether to display the usage option type.
-     */
-    usageOptionType?: boolean;
-    /**
-     * Whether to display the command usage.
-     */
-    usageSilent?: boolean;
-    /**
-     * Render function the command usage.
-     */
-    renderUsage?: ((ctx: Readonly<CommandContext<Options>>) => Promise<string>) | null;
-    /**
-     * Render function the header section in the command usage.
-     */
-    renderHeader?: ((ctx: Readonly<CommandContext<Options>>) => Promise<string>) | null;
-    /**
-     * Render function the validation errors.
-     */
-    renderValidationErrors?: ((ctx: Readonly<CommandContext<Options>>, error: AggregateError) => Promise<string>) | null;
-    /**
-     * Translation adapter factory.
-     */
-    translationAdapterFactory?: TranslationAdapterFactory;
-}
-/**
-* Command context.
-* Command context is the context of the command execution.
-*/
-interface CommandContext<Options extends ArgOptions = ArgOptions, Values = ArgValues<Options>> {
-    /**
-     * Command name, that is the command that is executed.
-     * The command name is same {@link CommandEnvironment.name}.
-     */
-    name: string | undefined;
-    /**
-     * Command description, that is the description of the command that is executed.
-     * The command description is same {@link CommandEnvironment.description}.
-     */
-    description: string | undefined;
-    /**
-     * Command locale, that is the locale of the command that is executed.
-     */
-    locale: Intl.Locale;
-    /**
-     * Command environment, that is the environment of the command that is executed.
-     * The command environment is same {@link CommandEnvironment}.
-     */
-    env: Readonly<CommandEnvironment<Options>>;
-    /**
-     * Command options, that is the options of the command that is executed.
-     * The command options is same {@link Command.options}.
-     */
-    options: Options;
-    /**
-     * Command values, that is the values of the command that is executed.
-     * Resolve values with `resolveArgs` from command arguments and {@link Command.options}.
-     */
-    values: Values;
-    /**
-     * Command positionals arguments, that is the positionals of the command that is executed.
-     * Resolve positionals with `resolveArgs` from command arguments.
-     */
-    positionals: string[];
-    /**
-     * Command rest arguments, that is the remaining argument not resolved by the optional command option delimiter `--`.
-     */
-    rest: string[];
-    /**
-     * Original command line arguments.
-     * This argument is passed from `cli` function.
-     */
-    _: string[];
-    /**
-     * Argument tokens, that is parsed by `parseArgs` function.
-     */
-    tokens: ArgToken[];
-    /**
-     * Whether the currently executing command has been executed with the sub-command name omitted.
-     */
-    omitted: boolean;
-    /**
-     * Output a message.
-     * If {@link CommandEnvironment.usageSilent} is true, the message is not output.
-     * @param message an output message, @see {@link console.log}
-     * @param optionalParams an optional parameters, @see {@link console.log}
-     */
-    log: (message?: any, ...optionalParams: any[]) => void;
-    /**
-     * Load sub-commands.
-     * The loaded commands are cached and returned when called again.
-     * @returns loaded commands.
-     */
-    loadCommands: () => Promise<Command<Options>[]>;
-    /**
-     * Translate function.
-     * @param key the key to be translated
-     * @param values the values to be formatted
-     * @returns A translated string.
-     */
-    translate: <T extends string = CommandBuiltinKeys, O = CommandOptionKeys<Options>, Key = CommandBuiltinKeys | O | T>(key: Key, values?: Record<string, unknown>) => string;
-}
-/**
-* Command interface.
-*/
-interface Command<Options extends ArgOptions = ArgOptions> {
-    /**
-     * Command name.
-     * It's used to find command line arguments to execute from sub commands, and it's recommended to specify.
-     */
-    name?: string;
-    /**
-     * Command description.
-     * It's used to describe the command in usage and it's recommended to specify.
-     */
-    description?: string;
-    /**
-     * Command options.
-     * Each option can include a description property to describe the option in usage.
-     */
-    options?: Options;
-    /**
-     * Command examples.
-     * examples of how to use the command.
-     */
-    examples?: string;
-    /**
-     * Command runner. it's the command to be executed
-     */
-    run: CommandRunner<Options>;
-    /**
-     * Command resource fetcher.
-     */
-    resource?: CommandResourceFetcher<Options>;
-}
-/**
-* Command resource.
-*/
-type CommandResource<Options extends ArgOptions = ArgOptions> = {
-    /**
-     * Command description.
-     */
-    description: string;
-    /**
-     * Examples usage.
-     */
-    examples: string;
-} & {
-    [Option in GenerateNamespacedKey<KeyOfArgOptions<RemovedIndex<Options>>, typeof OPTION_PREFIX>]: string;
-} & {
-    [key: string]: string;
-};
-/**
-* Command resource fetcher.
-* @param ctx A {@link CommandContext | command context}
-* @returns A fetched {@link CommandResource | command resource}.
-*/
-type CommandResourceFetcher<Options extends ArgOptions = ArgOptions, Values = ArgValues<Options>> = (ctx: Readonly<CommandContext<Options, Values>>) => Promise<CommandResource<Options>>;
-/**
-* Translation adapter factory.
-*/
-type TranslationAdapterFactory = (options: TranslationAdapterFactoryOptions) => TranslationAdapter;
-/**
-* Translation adapter factory options.
-*/
-interface TranslationAdapterFactoryOptions {
-    /**
-     * A locale.
-     */
-    locale: string;
-    /**
-     * A fallback locale.
-     */
-    fallbackLocale: string;
-}
-/**
-* Translation adapter.
-* This adapter is used to custom message formatter like {@link https://github.com/intlify/vue-i18n/blob/master/spec/syntax.ebnf | Intlify message format}, {@link https://github.com/tc39/proposal-intl-messageformat | `Intl.MessageFormat` (MF2)}, and etc.
-* This adapter will support localization with your preferred message format.
-*/
-interface TranslationAdapter<MessageResource = string> {
-    /**
-     * Get a resource of locale.
-     * @param locale A Locale at the time of command execution. That is Unicord locale ID (BCP 47)
-     * @returns A resource of locale. if resource not found, return `undefined`.
-     */
-    getResource(locale: string): Record<string, string> | undefined;
-    /**
-     * Set a resource of locale.
-     * @param locale A Locale at the time of command execution. That is Unicord locale ID (BCP 47)
-     * @param resource A resource of locale
-     */
-    setResource(locale: string, resource: Record<string, string>): void;
-    /**
-     * Get a message of locale.
-     * @param locale A Locale at the time of command execution. That is Unicord locale ID (BCP 47)
-     * @param key A key of message resource
-     * @returns A message of locale. if message not found, return `undefined`.
-     */
-    getMessage(locale: string, key: string): MessageResource | undefined;
-    /**
-     * Translate a message.
-     * @param locale A Locale at the time of command execution. That is Unicord locale ID (BCP 47)
-     * @param key A key of message resource
-     * @param values A values to be resolved in the message
-     * @returns A translated message, if message is not translated, return `undefined`.
-     */
-    translate(locale: string, key: string, values?: Record<string, unknown>): string | undefined;
-}
-/**
-* Command runner.
-* @param ctx A {@link CommandContext | command context}
-*/
-type CommandRunner<Options extends ArgOptions = ArgOptions> = (ctx: Readonly<CommandContext<Options>>) => Awaitable<void>;
-/**
-* Lazy command interface.
-* Lazy command that's not loaded until it is executed.
-*/
-type LazyCommand<Options extends ArgOptions = ArgOptions> = () => Awaitable<Command<Options>>;
-/**
-* Define a command type.
-*/
-type Commandable<Options extends ArgOptions> = Command<Options> | LazyCommand<Options>;
-
-//#endregion
-export { Command, CommandBuiltinKeys, CommandBuiltinOptionsKeys, CommandBuiltinResourceKeys, CommandContext, CommandEnvironment, CommandOptionKeys, CommandOptions, CommandResource, CommandResourceFetcher, CommandRunner, Commandable, DEFAULT_LOCALE, GenerateNamespacedKey, KeyOfArgOptions, LazyCommand, RemovedIndex, TranslationAdapter, TranslationAdapterFactory, TranslationAdapterFactoryOptions };