gunshi 0.14.3 → 0.14.5

package/lib/{cli-BlZyQHmk.js → cli-JT5dcEoE.js}

@@ -1,4 +1,4 @@
-import { BUILT_IN_PREFIX, COMMAND_OPTIONS_DEFAULT, COMMON_OPTIONS, DEFAULT_LOCALE, NOOP, create, deepFreeze, log, mapResourceWithBuiltinKey, renderHeader, renderUsage, renderValidationErrors, resolveLazyCommand, resolveOptionKey } from "./renderer-B2JVfepJ.js";
+import { BUILT_IN_PREFIX, COMMAND_OPTIONS_DEFAULT, COMMON_OPTIONS, DEFAULT_LOCALE$1 as DEFAULT_LOCALE, NOOP, create, deepFreeze, log, mapResourceWithBuiltinKey, renderHeader, renderUsage, renderValidationErrors, resolveLazyCommand, resolveOptionKey } from "./renderer-DGPRTLmr.js";
 import { parseArgs, resolveArgs } from "args-tokens";
 
 //#region src/locales/en-US.json
@@ -210,7 +210,7 @@ function resolveArgOptions(options) {
 }
 function resolveCommandOptions(options, entry) {
 	const subCommands = new Map(options.subCommands);
-	if (typeof entry === "object" && entry.name) subCommands.set(entry.name, entry);
+	if (typeof entry === "object" && entry.name && options.subCommands) subCommands.set(entry.name, entry);
 	const resolvedOptions = Object.assign(create(), COMMAND_OPTIONS_DEFAULT, options, { subCommands });
 	return resolvedOptions;
 }

package/lib/definition.d-TBObezo_.d.ts

@@ -0,0 +1,13 @@
+import { Command } from "./types.d-GVRYnEFw.js";
+import { ArgOptionSchema, ArgOptions, ArgOptions as ArgOptions$1, ArgValues as ArgValues$1 } from "args-tokens";
+
+//#region src/definition.d.ts
+/**
+ * Define a {@link Command | command} with type inference
+ * @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
+export { ArgOptionSchema, ArgOptions$1 as ArgOptions, ArgValues$1 as ArgValues, define as define$1 };

package/lib/definition.d.ts

@@ -1,21 +1,4 @@
-import { ArgOptions } from 'args-tokens';
-export { ArgOptionSchema, ArgOptions, ArgValues } from 'args-tokens';
-import { C as Command } from './types.d-Dw5e-IT1.js';
+import "./types.d-GVRYnEFw.js";
+import { ArgOptionSchema, ArgOptions, ArgValues, define$1 as define } from "./definition.d-TBObezo_.js";
 
-/**
-* The entry for command deifinition.
-* @example
-* ```js
-* import { define } from 'gunshi/definition'
-* ```
-* @module
-*/
-
-/**
-* Define a {@link Command | command} with type inference
-* @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>;
-
-export { define };
+export { ArgOptionSchema, ArgOptions, ArgValues, define };

package/lib/definition.js

@@ -1,3 +1,3 @@
-import { define } from "./definition-by5EpPkZ.js";
+import { define } from "./definition-BAm6f1St.js";
 
 export { define };

package/lib/generator.d.ts

@@ -1,13 +1,15 @@
-import { ArgOptions } from 'args-tokens';
-import { C as Command, a as CommandOptions } from './types.d-Dw5e-IT1.js';
+import { Command, CommandOptions } from "./types.d-GVRYnEFw.js";
+import { ArgOptions } from "args-tokens";
 
+//#region src/generator.d.ts
 /**
-* Generate the command usage.
-* @param command - usage generate command, if you want to generate the usage of the default command where there are target commands and sub-commands, specify `null`.
-* @param entry - A {@link Command | entry command}
-* @param opts - A {@link CommandOptions | command options}
-* @returns A rendered usage.
-*/
+ * Generate the command usage.
+ * @param command - usage generate command, if you want to generate the usage of the default command where there are target commands and sub-commands, specify `null`.
+ * @param entry - A {@link Command | entry command}
+ * @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>;
 
-export { generate };
+//#endregion
+export { generate };

package/lib/generator.js

@@ -1,5 +1,5 @@
-import { create } from "./renderer-B2JVfepJ.js";
-import { cli } from "./cli-BlZyQHmk.js";
+import { create } from "./renderer-DGPRTLmr.js";
+import { cli } from "./cli-JT5dcEoE.js";
 
 //#region src/generator.ts
 async function generate(command, entry, opts = {}) {

package/lib/index.d.ts

@@ -1,25 +1,27 @@
-import { ArgOptions } from 'args-tokens';
-export { ArgOptionSchema, ArgOptions, ArgValues, parseArgs, resolveArgs } from 'args-tokens';
-import { C as Command, b as CommandRunner, a as CommandOptions, T as TranslationAdapter, c as TranslationAdapterFactoryOptions } from './types.d-Dw5e-IT1.js';
-export { f as CommandBuiltinKeys, d as CommandBuiltinOptionsKeys, e as CommandBuiltinResourceKeys, i as CommandContext, h as CommandEnvironment, g as CommandOptionKeys, j as CommandResource, k as CommandResourceFetcher, m as Commandable, D as DEFAULT_LOCALE, G as GenerateNamespacedKey, L as LazyCommand, R as RemovedIndex, l as TranslationAdapterFactory } from './types.d-Dw5e-IT1.js';
-export { define } from './definition.js';
+import { Command, CommandBuiltinKeys, CommandBuiltinOptionsKeys, CommandBuiltinResourceKeys, CommandContext, CommandEnvironment, CommandOptionKeys, CommandOptions, CommandResource, CommandResourceFetcher, CommandRunner, Commandable, DEFAULT_LOCALE, GenerateNamespacedKey, LazyCommand, RemovedIndex, TranslationAdapter, TranslationAdapterFactory, TranslationAdapterFactoryOptions } from "./types.d-GVRYnEFw.js";
+import { define$1 as define } from "./definition.d-TBObezo_.js";
+import { ArgOptionSchema, ArgOptions, ArgOptions as ArgOptions$1, ArgValues, parseArgs, resolveArgs } from "args-tokens";
 
+//#region src/cli.d.ts
 /**
-* Run the command.
-* @param args Command line arguments
-* @param entry A {@link Command | entry command} or an {@link CommandRunner | inline command runner}
-* @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 = ArgOptions>(args: string[], entry: Command<Options> | CommandRunner<Options>, opts?: CommandOptions<Options>): Promise<string | undefined>;
+ * Run the command.
+ * @param args Command line arguments
+ * @param entry A {@link Command | entry command} or an {@link CommandRunner | inline command runner}
+ * @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;
 }
 
-export { Command, CommandOptions, CommandRunner, DefaultTranslation, TranslationAdapter, TranslationAdapterFactoryOptions, cli };
+//#endregion
+export { ArgOptionSchema, ArgOptions, ArgValues, Command, CommandBuiltinKeys, CommandBuiltinOptionsKeys, CommandBuiltinResourceKeys, CommandContext, CommandEnvironment, CommandOptionKeys, CommandOptions, CommandResource, CommandResourceFetcher, CommandRunner, Commandable, DEFAULT_LOCALE, DefaultTranslation, GenerateNamespacedKey, LazyCommand, RemovedIndex, TranslationAdapter, TranslationAdapterFactory, TranslationAdapterFactoryOptions, cli, define, parseArgs, resolveArgs };

package/lib/index.js

@@ -1,6 +1,6 @@
-import { define } from "./definition-by5EpPkZ.js";
-import { DEFAULT_LOCALE } from "./renderer-B2JVfepJ.js";
-import { DefaultTranslation, cli } from "./cli-BlZyQHmk.js";
+import { define } from "./definition-BAm6f1St.js";
+import { DEFAULT_LOCALE$1 as DEFAULT_LOCALE } from "./renderer-DGPRTLmr.js";
+import { DefaultTranslation, cli } from "./cli-JT5dcEoE.js";
 import { parseArgs, resolveArgs } from "args-tokens";
 
 export { DEFAULT_LOCALE, DefaultTranslation, cli, define, parseArgs, resolveArgs };

package/lib/{renderer-B2JVfepJ.js → renderer-DGPRTLmr.js}

@@ -266,4 +266,4 @@ function renderValidationErrors(_ctx, error) {
 }
 
 //#endregion
-export { BUILT_IN_PREFIX, COMMAND_OPTIONS_DEFAULT, COMMON_OPTIONS, DEFAULT_LOCALE, NOOP, create, deepFreeze, log, mapResourceWithBuiltinKey, renderHeader, renderUsage, renderValidationErrors, resolveLazyCommand, resolveOptionKey };
+export { BUILT_IN_PREFIX, COMMAND_OPTIONS_DEFAULT, COMMON_OPTIONS, DEFAULT_LOCALE as DEFAULT_LOCALE$1, NOOP, create, deepFreeze, log, mapResourceWithBuiltinKey, renderHeader, renderUsage, renderValidationErrors, resolveLazyCommand, resolveOptionKey };

package/lib/renderer.d.ts

@@ -1,26 +1,32 @@
-import { ArgOptions } from 'args-tokens';
-import { i as CommandContext } from './types.d-Dw5e-IT1.js';
+import { CommandContext } from "./types.d-GVRYnEFw.js";
+import { ArgOptions } from "args-tokens";
 
+//#region src/renderer/header.d.ts
 /**
-* Render the header.
-* @param ctx A {@link CommandContext | command context}
-* @returns A rendered header.
-*/
+ * Render the header.
+ * @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
+//#region src/renderer/usage.d.ts
 /**
-* Render the usage.
-* @param ctx A {@link CommandContext | command context}
-* @returns A rendered usage.
-*/
+ * Render the usage.
+ * @param ctx A {@link CommandContext | command context}
+ * @returns A rendered usage.
+ */
 declare function renderUsage<Options extends ArgOptions = ArgOptions>(ctx: Readonly<CommandContext<Options>>): Promise<string>;
 
+//#endregion
+//#region src/renderer/validation.d.ts
 /**
-* Render the validation errors.
-* @param ctx A {@link CommandContext | command context}
-* @param error An {@link AggregateError} of option in `args-token` validation
-* @returns A rendered validation error.
-*/
+ * Render the validation errors.
+ * @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<Options extends ArgOptions = ArgOptions>(_ctx: CommandContext<Options>, error: AggregateError): Promise<string>;
 
-export { renderHeader, renderUsage, renderValidationErrors };
+//#endregion
+export { renderHeader, renderUsage, renderValidationErrors };

package/lib/renderer.js

@@ -1,3 +1,3 @@
-import { renderHeader, renderUsage, renderValidationErrors } from "./renderer-B2JVfepJ.js";
+import { renderHeader, renderUsage, renderValidationErrors } from "./renderer-DGPRTLmr.js";
 
 export { renderHeader, renderUsage, renderValidationErrors };

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

@@ -0,0 +1,396 @@
+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"];
+
+//#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];
+}>;
+/**
+ * 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<keyof 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[];
+    /**
+     * 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<keyof 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, LazyCommand, RemovedIndex, TranslationAdapter, TranslationAdapterFactory, TranslationAdapterFactoryOptions };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "gunshi",
   "description": "Modern javascript command-line library",
-  "version": "0.14.3",
+  "version": "0.14.5",
   "author": {
     "name": "kazuya kawaguchi",
     "email": "kawakazu80@gmail.com"
@@ -76,7 +76,7 @@
   "devDependencies": {
     "@eslint/markdown": "^6.3.0",
     "@intlify/core": "next",
-    "@kazupon/eslint-config": "^0.27.0",
+    "@kazupon/eslint-config": "^0.29.0",
     "@kazupon/prettier-config": "^0.1.1",
     "@types/node": "^22.14.0",
     "@vitest/eslint-plugin": "^1.1.42",
@@ -103,7 +103,8 @@
     "pkg-pr-new": "^0.0.42",
     "prettier": "^3.5.3",
     "publint": "^0.3.11",
-    "tsdown": "0.6.10",
+    "tsdown": "^0.9.1",
+    "tsdown-jsr-exports-lint": "^0.1.4",
     "typedoc": "^0.28.2",
     "typedoc-plugin-markdown": "^4.6.2",
     "typedoc-vitepress-theme": "^1.1.2",
@@ -111,7 +112,7 @@
     "typescript-eslint": "^8.29.1",
     "vitepress": "^1.6.3",
     "vitepress-plugin-group-icons": "^1.4.1",
-    "vitepress-plugin-llms": "^0.0.22",
+    "vitepress-plugin-llms": "^1.0.0",
     "vitest": "^3.1.1",
     "vue": "^3.5.13"
   },

package/lib/types.d-Dw5e-IT1.d.ts

@@ -1,412 +0,0 @@
-import { ArgOptions, ArgValues, ArgToken } from 'args-tokens';
-
-/**
-* 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"];
-
-declare const __constants_ts_BUILT_IN_KEY_SEPARATOR: typeof BUILT_IN_KEY_SEPARATOR;
-declare const __constants_ts_BUILT_IN_PREFIX: typeof BUILT_IN_PREFIX;
-declare const __constants_ts_COMMAND_BUILTIN_RESOURCE_KEYS: typeof COMMAND_BUILTIN_RESOURCE_KEYS;
-declare const __constants_ts_COMMAND_OPTIONS_DEFAULT: typeof COMMAND_OPTIONS_DEFAULT;
-declare const __constants_ts_COMMON_OPTIONS: typeof COMMON_OPTIONS;
-declare const __constants_ts_DEFAULT_LOCALE: typeof DEFAULT_LOCALE;
-declare const __constants_ts_NOOP: typeof NOOP;
-declare const __constants_ts_OPTION_PREFIX: typeof OPTION_PREFIX;
-declare namespace __constants_ts {
-  export {
-    __constants_ts_BUILT_IN_KEY_SEPARATOR as BUILT_IN_KEY_SEPARATOR,
-    __constants_ts_BUILT_IN_PREFIX as BUILT_IN_PREFIX,
-    __constants_ts_COMMAND_BUILTIN_RESOURCE_KEYS as COMMAND_BUILTIN_RESOURCE_KEYS,
-    __constants_ts_COMMAND_OPTIONS_DEFAULT as COMMAND_OPTIONS_DEFAULT,
-    __constants_ts_COMMON_OPTIONS as COMMON_OPTIONS,
-    __constants_ts_DEFAULT_LOCALE as DEFAULT_LOCALE,
-    __constants_ts_NOOP as NOOP,
-    __constants_ts_OPTION_PREFIX as OPTION_PREFIX,
-  };
-}
-
-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] }>;
-/**
-* 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_ts)["COMMON_OPTIONS"];
-/**
-* Command i18n built-in resource keys.
-*/
-type CommandBuiltinResourceKeys = (typeof __constants_ts)["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<keyof 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[];
-	/**
-	* 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<keyof 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>;
-
-export { DEFAULT_LOCALE as D };
-export type { Command as C, GenerateNamespacedKey as G, LazyCommand as L, RemovedIndex as R, TranslationAdapter as T, CommandOptions as a, CommandRunner as b, TranslationAdapterFactoryOptions as c, CommandBuiltinOptionsKeys as d, CommandBuiltinResourceKeys as e, CommandBuiltinKeys as f, CommandOptionKeys as g, CommandEnvironment as h, CommandContext as i, CommandResource as j, CommandResourceFetcher as k, TranslationAdapterFactory as l, Commandable as m };