gunshi 0.14.0 → 0.14.3

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

@@ -246,14 +246,17 @@ async function showValidationErrors(ctx, error) {
 async function resolveCommand(sub, entry, options) {
 	const omitted = !sub;
 	if (typeof entry === "function") return [void 0, { run: entry }];
-	else if (omitted) return typeof entry === "object" ? [entry.name, await resolveLazyCommand(entry)] : [void 0, void 0];
+	else if (omitted) return typeof entry === "object" ? [resolveEntryName(entry), await resolveLazyCommand(entry)] : [void 0, void 0];
 	else {
-		if (options.subCommands == null) return [sub, void 0];
+		if (options.subCommands == null || options.subCommands.size === 0) return [resolveEntryName(entry), await resolveLazyCommand(entry)];
 		const cmd = options.subCommands?.get(sub);
 		if (cmd == null) return [sub, void 0];
 		return [sub, await resolveLazyCommand(cmd, sub)];
 	}
 }
+function resolveEntryName(entry) {
+	return entry.name || "(anonymous)";
+}
 
 //#endregion
 export { DefaultTranslation, cli };

package/lib/definition.d.ts

@@ -1,4 +1,21 @@
-import "./types.d-CftFdhAF.js";
-import { ArgOptionSchema, ArgOptions, ArgValues, define } from "./definition.d-CFbYyc6i.js";
+import { ArgOptions } from 'args-tokens';
+export { ArgOptionSchema, ArgOptions, ArgValues } from 'args-tokens';
+import { C as Command } from './types.d-Dw5e-IT1.js';
 
-export { ArgOptionSchema, ArgOptions, ArgValues, define };
+/**
+* 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 };

package/lib/generator.d.ts

@@ -1,8 +1,13 @@
-import { Command, CommandOptions } from "./types.d-CftFdhAF.js";
-import { ArgOptions } from "args-tokens";
+import { ArgOptions } from 'args-tokens';
+import { C as Command, a as CommandOptions } from './types.d-Dw5e-IT1.js';
 
-//#region lib/.tsdown-types-es/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.
+*/
 declare function generate<Options extends ArgOptions = ArgOptions>(command: string | null, entry: Command<Options>, opts?: CommandOptions<Options>): Promise<string>;
 
-//#endregion
-export { generate };
+export { generate };

package/lib/generator.js

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

package/lib/index.d.ts

@@ -1,12 +1,18 @@
-import { Command, CommandBuiltinKeys, CommandBuiltinOptionsKeys, CommandBuiltinResourceKeys, CommandContext, CommandEnvironment, CommandOptionKeys, CommandOptions, CommandResource, CommandResourceFetcher, CommandRunner, Commandable, DEFAULT_LOCALE, GenerateNamespacedKey, LazyCommand, RemovedIndex, TranslationAdapter, TranslationAdapterFactory, TranslationAdapterFactoryOptions } from "./types.d-CftFdhAF.js";
-import { define } from "./definition.d-CFbYyc6i.js";
-import { ArgOptionSchema, ArgOptions, ArgOptions as ArgOptions$1, ArgValues, parseArgs, resolveArgs } from "args-tokens";
+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';
 
-//#region lib/.tsdown-types-es/cli.d.ts
-declare function cli<Options extends ArgOptions$1 = ArgOptions$1>(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 = ArgOptions>(args: string[], entry: Command<Options> | CommandRunner<Options>, opts?: CommandOptions<Options>): Promise<string | undefined>;
 
-//#endregion
-//#region lib/.tsdown-types-es/translation.d.ts
 declare class DefaultTranslation implements TranslationAdapter {
 	#private;
 	constructor(options: TranslationAdapterFactoryOptions);
@@ -16,5 +22,4 @@ declare class DefaultTranslation implements TranslationAdapter {
 	translate(locale: string, key: string, values?: Record<string, unknown>): string | undefined;
 }
 
-//#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 };
+export { Command, CommandOptions, CommandRunner, DefaultTranslation, TranslationAdapter, TranslationAdapterFactoryOptions, cli };

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-DsMmOiVc.js";
+import { DefaultTranslation, cli } from "./cli-BlZyQHmk.js";
 import { parseArgs, resolveArgs } from "args-tokens";
 
 export { DEFAULT_LOCALE, DefaultTranslation, cli, define, parseArgs, resolveArgs };

package/lib/renderer.d.ts

@@ -0,0 +1,26 @@
+import { ArgOptions } from 'args-tokens';
+import { i as CommandContext } from './types.d-Dw5e-IT1.js';
+
+/**
+* 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>;
+
+/**
+* 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>;
+
+/**
+* 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 };

package/lib/renderer.js

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

package/lib/{types.d-CftFdhAF.d.ts → types.d-Dw5e-IT1.d.ts}

@@ -1,24 +1,84 @@
-import { ArgOptions, ArgToken, ArgValues } from "args-tokens";
+import { ArgOptions, ArgValues, ArgToken } from 'args-tokens';
 
-//#region lib/.tsdown-types-es/constants.d.ts
+/**
+* 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,
+  };
+}
 
-//#endregion
-//#region lib/.tsdown-types-es/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}`;
-type CommandBuiltinOptionsKeys = keyof (typeof import("./constants.ts"))["COMMON_OPTIONS"];
-type CommandBuiltinResourceKeys = (typeof import("./constants.ts"))["COMMAND_BUILTIN_RESOURCE_KEYS"][number];
+/**
+* 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.
@@ -83,6 +143,9 @@ interface CommandEnvironment<Options extends ArgOptions = ArgOptions> {
 	*/
 	renderValidationErrors: ((ctx: CommandContext<Options>, error: AggregateError) => Promise<string>) | null | undefined;
 }
+/**
+* Command options.
+*/
 interface CommandOptions<Options extends ArgOptions = ArgOptions> {
 	/**
 	* Current working directory.
@@ -142,6 +205,10 @@ interface CommandOptions<Options extends ArgOptions = ArgOptions> {
 	*/
 	translationAdapterFactory?: TranslationAdapterFactory;
 }
+/**
+* Command context.
+* Command context is the context of the command execution.
+*/
 interface CommandContext<
 	Options extends ArgOptions = ArgOptions,
 	Values = ArgValues<Options>
@@ -218,6 +285,9 @@ interface CommandContext<
 		Key = CommandBuiltinKeys | O | T
 	>(key: Key, values?: Record<string, unknown>) => string;
 }
+/**
+* Command interface.
+*/
 interface Command<Options extends ArgOptions = ArgOptions> {
 	/**
 	* Command name.
@@ -248,6 +318,9 @@ interface Command<Options extends ArgOptions = ArgOptions> {
 	*/
 	resource?: CommandResourceFetcher<Options>;
 }
+/**
+* Command resource.
+*/
 type CommandResource<Options extends ArgOptions = ArgOptions> = {
 	/**
 	* Command description.
@@ -260,11 +333,22 @@ type CommandResource<Options extends ArgOptions = ArgOptions> = {
 } & { [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.
@@ -275,6 +359,11 @@ interface TranslationAdapterFactoryOptions {
 	*/
 	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.
@@ -304,9 +393,20 @@ interface TranslationAdapter<MessageResource = string> {
 	*/
 	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 };
+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 };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "gunshi",
   "description": "Modern javascript command-line library",
-  "version": "0.14.0",
+  "version": "0.14.3",
   "author": {
     "name": "kazuya kawaguchi",
     "email": "kawakazu80@gmail.com"
@@ -48,10 +48,10 @@
       "default": "./lib/definition.js"
     },
     "./renderer": {
-      "types": "./lib/renderer/index.d.ts",
-      "import": "./lib/renderer/index.js",
-      "require": "./lib/renderer/index.js",
-      "default": "./lib/renderer/index.js"
+      "types": "./lib/renderer.d.ts",
+      "import": "./lib/renderer.js",
+      "require": "./lib/renderer.js",
+      "default": "./lib/renderer.js"
     },
     "./generator": {
       "types": "./lib/generator.d.ts",
@@ -59,8 +59,7 @@
       "require": "./lib/generator.js",
       "default": "./lib/generator.js"
     },
-    "./package.json": "./package.json",
-    "./*": "./*"
+    "./package.json": "./package.json"
   },
   "types": "lib/index.d.ts",
   "typesVersions": {
@@ -77,18 +76,18 @@
   "devDependencies": {
     "@eslint/markdown": "^6.3.0",
     "@intlify/core": "next",
-    "@kazupon/eslint-config": "^0.26.1",
+    "@kazupon/eslint-config": "^0.27.0",
     "@kazupon/prettier-config": "^0.1.1",
-    "@types/node": "^22.13.14",
-    "@vitest/eslint-plugin": "^1.1.38",
+    "@types/node": "^22.14.0",
+    "@vitest/eslint-plugin": "^1.1.42",
     "bumpp": "^10.1.0",
-    "deno": "^2.2.6",
-    "eslint": "^9.23.0",
-    "eslint-config-prettier": "^10.1.1",
-    "eslint-import-resolver-typescript": "^4.2.7",
+    "deno": "^2.2.8",
+    "eslint": "^9.24.0",
+    "eslint-config-prettier": "^10.1.2",
+    "eslint-import-resolver-typescript": "^4.3.2",
     "eslint-plugin-import": "^2.31.0",
     "eslint-plugin-jsonc": "^2.20.0",
-    "eslint-plugin-module-interop": "^0.3.0",
+    "eslint-plugin-module-interop": "^0.3.1",
     "eslint-plugin-promise": "^7.2.1",
     "eslint-plugin-regexp": "^2.7.0",
     "eslint-plugin-unicorn": "^58.0.0",
@@ -98,21 +97,22 @@
     "eslint-plugin-yml": "^1.17.0",
     "gh-changelogen": "^0.2.8",
     "jsr": "^0.13.4",
-    "knip": "^5.46.3",
+    "knip": "^5.50.2",
     "lint-staged": "^15.5.0",
     "messageformat": "4.0.0-10",
     "pkg-pr-new": "^0.0.42",
     "prettier": "^3.5.3",
-    "tsdown": "^0.7.0",
-    "typedoc": "^0.28.1",
-    "typedoc-plugin-markdown": "^4.6.0",
+    "publint": "^0.3.11",
+    "tsdown": "0.6.10",
+    "typedoc": "^0.28.2",
+    "typedoc-plugin-markdown": "^4.6.2",
     "typedoc-vitepress-theme": "^1.1.2",
-    "typescript": "^5.8.2",
-    "typescript-eslint": "^8.28.0",
+    "typescript": "^5.8.3",
+    "typescript-eslint": "^8.29.1",
     "vitepress": "^1.6.3",
-    "vitepress-plugin-group-icons": "^1.3.8",
+    "vitepress-plugin-group-icons": "^1.4.1",
     "vitepress-plugin-llms": "^0.0.22",
-    "vitest": "^3.0.9",
+    "vitest": "^3.1.1",
     "vue": "^3.5.13"
   },
   "prettier": "@kazupon/prettier-config",

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

@@ -1,8 +0,0 @@
-import { Command } from "./types.d-CftFdhAF.js";
-import { ArgOptionSchema, ArgOptions, ArgOptions as ArgOptions$1, ArgValues as ArgValues$1 } from "args-tokens";
-
-//#region lib/.tsdown-types-es/definition.d.ts
-declare function define<Options extends ArgOptions = ArgOptions>(definition: Command<Options>): Command<Options>;
-
-//#endregion
-export { ArgOptionSchema, ArgOptions$1 as ArgOptions, ArgValues$1 as ArgValues, define };

package/lib/renderer/index.d.ts

@@ -1,16 +0,0 @@
-import { CommandContext } from "../types.d-CftFdhAF.js";
-import { ArgOptions } from "args-tokens";
-
-//#region lib/.tsdown-types-es/renderer/header.d.ts
-declare function renderHeader<Options extends ArgOptions = ArgOptions>(ctx: Readonly<CommandContext<Options>>): Promise<string>;
-
-//#endregion
-//#region lib/.tsdown-types-es/renderer/usage.d.ts
-declare function renderUsage<Options extends ArgOptions = ArgOptions>(ctx: Readonly<CommandContext<Options>>): Promise<string>;
-
-//#endregion
-//#region lib/.tsdown-types-es/renderer/validation.d.ts
-declare function renderValidationErrors<Options extends ArgOptions = ArgOptions>(_ctx: CommandContext<Options>, error: AggregateError): Promise<string>;
-
-//#endregion
-export { renderHeader, renderUsage, renderValidationErrors };

package/lib/renderer/index.js

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