gunshi 0.13.0 → 0.14.3

package/lib/{cli-D_4MqIMP.js → cli-BlZyQHmk.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 } from "./renderer-DAUAIZxV.js";
+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 { parseArgs, resolveArgs } from "args-tokens";
 
 //#region src/locales/en-US.json
@@ -60,7 +60,7 @@ var DefaultTranslation = class {
 //#endregion
 //#region src/context.ts
 const BUILT_IN_PREFIX_CODE = BUILT_IN_PREFIX.codePointAt(0);
-async function createCommandContext({ options, values, positionals, args, command, commandOptions, omitted = false }) {
+async function createCommandContext({ options, values, positionals, args, tokens, command, commandOptions, omitted = false }) {
 	/**
 	* normailize the options schema and values, to avoid prototype pollution
 	*/
@@ -122,6 +122,7 @@ async function createCommandContext({ options, values, positionals, args, comman
 		values,
 		positionals,
 		_: args,
+		tokens,
 		log: commandOptions.usageSilent ? NOOP : log,
 		loadCommands,
 		translate
@@ -134,7 +135,7 @@ async function createCommandContext({ options, values, positionals, args, comman
 		return [key, description];
 	});
 	const defaultCommandResource = loadedOptionsResources.reduce((res, [key, value]) => {
-		res[key] = value;
+		res[resolveOptionKey(key)] = value;
 		return res;
 	}, create());
 	defaultCommandResource.description = command.description || "";
@@ -181,6 +182,7 @@ async function cli(args, entry, opts = {}) {
 		values,
 		positionals,
 		args,
+		tokens,
 		omitted,
 		command,
 		commandOptions: resolvedCommandOptions
@@ -244,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-by5EpPkZ.js

@@ -0,0 +1,8 @@
+
+//#region src/definition.ts
+function define(definition) {
+	return definition;
+}
+
+//#endregion
+export { define };

package/lib/definition.d.ts

@@ -0,0 +1,21 @@
+import { ArgOptions } from 'args-tokens';
+export { ArgOptionSchema, ArgOptions, ArgValues } from 'args-tokens';
+import { C as Command } from './types.d-Dw5e-IT1.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 };

package/lib/definition.js

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

package/lib/generator.d.ts

@@ -1,5 +1,5 @@
 import { ArgOptions } from 'args-tokens';
-import { C as Command, a as CommandOptions } from './types.d-DqtZy3HN.js';
+import { C as Command, a as CommandOptions } from './types.d-Dw5e-IT1.js';
 
 /**
 * Generate the command usage.

package/lib/generator.js

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

package/lib/index.d.ts

@@ -1,7 +1,8 @@
 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-DqtZy3HN.js';
-export { f as CommandBuiltinKeys, d as CommandBuiltinOptionsKeys, e as CommandBuiltinResourceKeys, h as CommandContext, g as CommandEnvironment, i as CommandResource, j as CommandResourceFetcher, l as Commandable, D as DEFAULT_LOCALE, G as GenerateNamespacedKey, L as LazyCommand, k as TranslationAdapterFactory } from './types.d-DqtZy3HN.js';
+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';
 
 /**
 * Run the command.

package/lib/index.js

@@ -1,5 +1,6 @@
-import { DEFAULT_LOCALE } from "./renderer-DAUAIZxV.js";
-import { DefaultTranslation, cli } from "./cli-D_4MqIMP.js";
+import { define } from "./definition-by5EpPkZ.js";
+import { DEFAULT_LOCALE } from "./renderer-B2JVfepJ.js";
+import { DefaultTranslation, cli } from "./cli-BlZyQHmk.js";
 import { parseArgs, resolveArgs } from "args-tokens";
 
-export { DEFAULT_LOCALE, DefaultTranslation, cli, parseArgs, resolveArgs };
+export { DEFAULT_LOCALE, DefaultTranslation, cli, define, parseArgs, resolveArgs };

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

@@ -2,6 +2,7 @@
 //#region src/constants.ts
 const DEFAULT_LOCALE = "en-US";
 const BUILT_IN_PREFIX = "_";
+const OPTION_PREFIX = "Option";
 const BUILT_IN_KEY_SEPARATOR = ":";
 const NOOP = () => {};
 const COMMON_OPTIONS = {
@@ -42,6 +43,9 @@ async function resolveLazyCommand(cmd, name) {
 function resolveBuiltInKey(key) {
 	return `${BUILT_IN_PREFIX}${BUILT_IN_KEY_SEPARATOR}${key}`;
 }
+function resolveOptionKey(key) {
+	return `${OPTION_PREFIX}${BUILT_IN_KEY_SEPARATOR}${key}`;
+}
 function mapResourceWithBuiltinKey(resource) {
 	return Object.entries(resource).reduce((acc, [key, value]) => {
 		acc[resolveBuiltInKey(key)] = value;
@@ -244,7 +248,7 @@ async function generateOptionsUsage(ctx, optionsPairs) {
 	const optionsMaxLength = Math.max(...Object.entries(optionsPairs).map(([_, value]) => value.length));
 	const optionSchemaMaxLength = ctx.env.usageOptionType ? Math.max(...Object.entries(optionsPairs).map(([key, _]) => ctx.options[key].type.length)) : 0;
 	const usages = await Promise.all(Object.entries(optionsPairs).map(([key, value]) => {
-		const rawDesc = ctx.translate(key);
+		const rawDesc = ctx.translate(resolveOptionKey(key));
 		const optionsSchema = ctx.env.usageOptionType ? `[${ctx.options[key].type}] ` : "";
 		const desc = `${optionsSchema ? optionsSchema.padEnd(optionSchemaMaxLength + 3) : ""}${rawDesc}`;
 		const option = `${value.padEnd(optionsMaxLength + ctx.env.middleMargin)}${desc}`;
@@ -262,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 };
+export { BUILT_IN_PREFIX, COMMAND_OPTIONS_DEFAULT, COMMON_OPTIONS, DEFAULT_LOCALE, NOOP, create, deepFreeze, log, mapResourceWithBuiltinKey, renderHeader, renderUsage, renderValidationErrors, resolveLazyCommand, resolveOptionKey };

package/lib/{renderer/index.d.ts → renderer.d.ts}

@@ -1,5 +1,5 @@
 import { ArgOptions } from 'args-tokens';
-import { h as CommandContext } from '../types.d-DqtZy3HN.js';
+import { i as CommandContext } from './types.d-Dw5e-IT1.js';
 
 /**
 * Render the header.

package/lib/renderer.js

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

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

@@ -1,10 +1,11 @@
-import { ArgOptions, ArgValues } from 'args-tokens';
+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 = {
@@ -30,6 +31,7 @@ declare const __constants_ts_COMMAND_OPTIONS_DEFAULT: typeof COMMAND_OPTIONS_DEF
 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,
@@ -39,13 +41,19 @@ declare namespace __constants_ts {
     __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] };
 /**
-* Define a promise type that can be await from T.
+* Remove index signature from object or record type.
+*/
+type RemovedIndex<T> = RemoveIndexSignature<{ [K in keyof T] : T[K] }>;
+/**
+* Generate a namespaced key.
 */
-type Awaitable<T> = T | Promise<T>;
 type GenerateNamespacedKey<
 	Key extends string,
 	Prefixed extends string = typeof BUILT_IN_PREFIX
@@ -64,6 +72,11 @@ type CommandBuiltinResourceKeys = (typeof __constants_ts)["COMMAND_BUILTIN_RESOU
 */
 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> {
@@ -240,6 +253,10 @@ interface CommandContext<
 	*/
 	_: 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;
@@ -264,7 +281,8 @@ interface CommandContext<
 	*/
 	translate: <
 		T extends string = CommandBuiltinKeys,
-		Key = CommandBuiltinKeys | keyof Options | T
+		O = CommandOptionKeys<Options>,
+		Key = CommandBuiltinKeys | O | T
 	>(key: Key, values?: Record<string, unknown>) => string;
 }
 /**
@@ -312,7 +330,7 @@ type CommandResource<Options extends ArgOptions = ArgOptions> = {
 	* Examples usage.
 	*/
 	examples: string
-} & { [Option in keyof Options] : string } & {
+} & { [Option in GenerateNamespacedKey<keyof RemovedIndex<Options>, typeof OPTION_PREFIX>] : string } & {
 	[key: string]: string
 };
 /**
@@ -391,4 +409,4 @@ type LazyCommand<Options extends ArgOptions = ArgOptions> = () => Awaitable<Comm
 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, TranslationAdapter as T, CommandOptions as a, CommandRunner as b, TranslationAdapterFactoryOptions as c, CommandBuiltinOptionsKeys as d, CommandBuiltinResourceKeys as e, CommandBuiltinKeys as f, CommandEnvironment as g, CommandContext as h, CommandResource as i, CommandResourceFetcher as j, TranslationAdapterFactory as k, Commandable as l };
+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.13.0",
+  "version": "0.14.3",
   "author": {
     "name": "kazuya kawaguchi",
     "email": "kawakazu80@gmail.com"
@@ -41,11 +41,17 @@
       "require": "./lib/index.js",
       "default": "./lib/index.js"
     },
+    "./definition": {
+      "types": "./lib/definition.d.ts",
+      "import": "./lib/definition.js",
+      "require": "./lib/definition.js",
+      "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",
@@ -53,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": {
@@ -71,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",
@@ -92,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.6.10",
-    "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/renderer/index.js

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