gunshi 0.16.0 → 0.18.0

package/lib/{cli-B7eqtqBF.js → cli-8GpxrUOM.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 { COMMAND_OPTIONS_DEFAULT, COMMON_OPTIONS, create, resolveLazyCommand } from "./utils-6RnUrIMZ.js";
+import { createCommandContext } from "./context-DSuCy-i-.js";
+import { renderHeader, renderUsage, renderValidationErrors } from "./renderer-BgAkL9Re.js";
 import { parseArgs, resolveArgs } from "args-tokens";
 
 //#region src/cli.ts
@@ -15,13 +15,10 @@ async function cli(args, entry, opts = {}) {
 	const tokens = parseArgs(args);
 	const subCommand = getSubCommand(tokens);
 	const resolvedCommandOptions = resolveCommandOptions(opts, entry);
-	const [name, command] = await resolveCommand(subCommand, entry, resolvedCommandOptions);
+	const [name, command] = await resolveCommand(subCommand, entry, resolvedCommandOptions, true);
 	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,
@@ -50,6 +47,7 @@ async function cli(args, entry, opts = {}) {
 		await showValidationErrors(ctx, error);
 		return;
 	}
+	if (!command.run) throw new Error(`'run' not found on Command \`${name || ""}\``);
 	await command.run(ctx);
 }
 function resolveArgOptions(options) {
@@ -90,15 +88,15 @@ async function showValidationErrors(ctx, error) {
 	const render = ctx.env.renderValidationErrors || renderValidationErrors;
 	ctx.log(await render(ctx, error));
 }
-async function resolveCommand(sub, entry, options) {
+async function resolveCommand(sub, entry, options, needRunResolving = false) {
 	const omitted = !sub;
 	if (typeof entry === "function") return [void 0, { run: entry }];
-	else if (omitted) return typeof entry === "object" ? [resolveEntryName(entry), await resolveLazyCommand(entry)] : [void 0, void 0];
+	else if (omitted) return typeof entry === "object" ? [resolveEntryName(entry), await resolveLazyCommand(entry, "", needRunResolving)] : [void 0, void 0];
 	else {
-		if (options.subCommands == null || options.subCommands.size === 0) return [resolveEntryName(entry), await resolveLazyCommand(entry)];
+		if (options.subCommands == null || options.subCommands.size === 0) return [resolveEntryName(entry), await resolveLazyCommand(entry, "", needRunResolving)];
 		const cmd = options.subCommands?.get(sub);
 		if (cmd == null) return [sub, void 0];
-		return [sub, await resolveLazyCommand(cmd, sub)];
+		return [sub, await resolveLazyCommand(cmd, sub, needRunResolving)];
 	}
 }
 function resolveEntryName(entry) {

package/lib/{context-BROXRnNP.js → context-DSuCy-i-.js}

@@ -1,4 +1,4 @@
-import { BUILT_IN_PREFIX, COMMAND_OPTIONS_DEFAULT, DEFAULT_LOCALE$1 as DEFAULT_LOCALE, NOOP, create, deepFreeze, log, mapResourceWithBuiltinKey, resolveLazyCommand, resolveOptionKey } from "./utils-BYPzZy9X.js";
+import { BUILT_IN_PREFIX, COMMAND_OPTIONS_DEFAULT, DEFAULT_LOCALE$1 as DEFAULT_LOCALE, NOOP, create, deepFreeze, log, mapResourceWithBuiltinKey, resolveLazyCommand, resolveOptionKey } from "./utils-6RnUrIMZ.js";
 
 //#region src/locales/en-US.json
 var COMMAND = "COMMAND";
@@ -9,6 +9,8 @@ var OPTIONS = "OPTIONS";
 var EXAMPLES = "EXAMPLES";
 var FORMORE = "For more info, run any command with the `--help` flag:";
 var NEGATABLE = "Negatable of";
+var DEFAULT = "default";
+var CHOICES = "choices";
 var help = "Display this help message";
 var version = "Display this version";
 var en_US_default = {
@@ -20,6 +22,8 @@ var en_US_default = {
 	EXAMPLES,
 	FORMORE,
 	NEGATABLE,
+	DEFAULT,
+	CHOICES,
 	help,
 	version
 };

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-BqXvgR9J.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/context.js

@@ -1,4 +1,4 @@
-import "./utils-BYPzZy9X.js";
-import { createCommandContext } from "./context-BROXRnNP.js";
+import "./utils-6RnUrIMZ.js";
+import { createCommandContext } from "./context-DSuCy-i-.js";
 
 export { createCommandContext };

package/lib/definition-DZJeZYb2.js

@@ -0,0 +1,28 @@
+//#region src/definition.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
+*/
+function define(definition) {
+	return definition;
+}
+/**
+* Define a {@link LazyCommand | lazy command} with command loader, which is attached with command definition as usage metadata.
+* @param loader A {@link CommandLoader | command loader}
+* @param definition A {@link Command | command} definition
+* @returns A {@link LazyCommand | lazy command} loader
+*/
+function lazy(loader, definition) {
+	if (definition != null) {
+		loader.commandName = definition.name;
+		loader.description = definition.description;
+		loader.options = definition.options;
+		loader.examples = definition.examples;
+		loader.resource = definition.resource;
+	}
+	return loader;
+}
+
+//#endregion
+export { define, lazy };

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

@@ -0,0 +1,21 @@
+import { Command, CommandLoader, LazyCommand } from "./types.d-BqXvgR9J.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>; /**
+                                                                                                                  * Define a {@link LazyCommand | lazy command} with command loader, which is attached with command definition as usage metadata.
+                                                                                                                  * @param loader A {@link CommandLoader | command loader}
+                                                                                                                  * @param definition A {@link Command | command} definition
+                                                                                                                  * @returns A {@link LazyCommand | lazy command} loader
+                                                                                                                  */
+
+declare function lazy<Options extends ArgOptions = ArgOptions>(loader: CommandLoader<Options>, definition?: Command<Options>): LazyCommand<Options>;
+
+//#endregion
+export { ArgOptionSchema, ArgOptions$1 as ArgOptions, ArgValues$1 as ArgValues, define as define$1, lazy as lazy$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";
-
-export { ArgOptionSchema, ArgOptions, ArgValues, define };
+import "./types.d-BqXvgR9J.js";
+import { ArgOptionSchema, ArgOptions, ArgValues, define$1 as define, lazy$1 as lazy } from "./definition.d-DaKM6lt0.js";
+export { ArgOptionSchema, ArgOptions, ArgValues, define, lazy };

package/lib/definition.js

@@ -1,3 +1,3 @@
-import { define } from "./definition-VzcnM0si.js";
+import { define, lazy } from "./definition-DZJeZYb2.js";
 
-export { define };
+export { define, lazy };

package/lib/generator.d.ts

@@ -1,4 +1,4 @@
-import { Command, CommandOptions } from "./types.d-aDzUZTqM.js";
+import { Command, CommandOptions } from "./types.d-BqXvgR9J.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 { create } from "./utils-6RnUrIMZ.js";
+import "./context-DSuCy-i-.js";
+import "./renderer-BgAkL9Re.js";
+import { cli } from "./cli-8GpxrUOM.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, CommandLoader, CommandOptionKeys, CommandOptions, CommandResource, CommandResourceFetcher, CommandRunner, Commandable, DEFAULT_LOCALE, GenerateNamespacedKey, KeyOfArgOptions, LazyCommand, RemovedIndex, TranslationAdapter, TranslationAdapterFactory, TranslationAdapterFactoryOptions } from "./types.d-BqXvgR9J.js";
+import { define$1 as define, lazy$1 as lazy } from "./definition.d-DaKM6lt0.js";
 import { ArgOptionSchema, ArgOptions, ArgOptions as ArgOptions$1, ArgValues, parseArgs, resolveArgs } from "args-tokens";
 
 //#region src/cli.d.ts
@@ -10,18 +10,19 @@ 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
-export { ArgOptionSchema, ArgOptions, ArgValues, Command, CommandBuiltinKeys, CommandBuiltinOptionsKeys, CommandBuiltinResourceKeys, CommandContext, CommandEnvironment, CommandOptionKeys, CommandOptions, CommandResource, CommandResourceFetcher, CommandRunner, Commandable, DEFAULT_LOCALE, DefaultTranslation, GenerateNamespacedKey, KeyOfArgOptions, LazyCommand, RemovedIndex, TranslationAdapter, TranslationAdapterFactory, TranslationAdapterFactoryOptions, cli, define, parseArgs, resolveArgs };
+export { ArgOptionSchema, ArgOptions, ArgValues, Command, CommandBuiltinKeys, CommandBuiltinOptionsKeys, CommandBuiltinResourceKeys, CommandContext, CommandEnvironment, CommandLoader, CommandOptionKeys, CommandOptions, CommandResource, CommandResourceFetcher, CommandRunner, Commandable, DEFAULT_LOCALE, DefaultTranslation, GenerateNamespacedKey, KeyOfArgOptions, LazyCommand, RemovedIndex, TranslationAdapter, TranslationAdapterFactory, TranslationAdapterFactoryOptions, cli, define, lazy, parseArgs, resolveArgs };

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 { DEFAULT_LOCALE$1 as DEFAULT_LOCALE } from "./utils-6RnUrIMZ.js";
+import { DefaultTranslation } from "./context-DSuCy-i-.js";
+import { define, lazy } from "./definition-DZJeZYb2.js";
+import "./renderer-BgAkL9Re.js";
+import { cli } from "./cli-8GpxrUOM.js";
 import { parseArgs, resolveArgs } from "args-tokens";
 
-export { DEFAULT_LOCALE, DefaultTranslation, cli, define, parseArgs, resolveArgs };
+export { DEFAULT_LOCALE, DefaultTranslation, cli, define, lazy, parseArgs, resolveArgs };

package/lib/locales/en-US.json

@@ -7,6 +7,8 @@
   "EXAMPLES": "EXAMPLES",
   "FORMORE": "For more info, run any command with the `--help` flag:",
   "NEGATABLE": "Negatable of",
+  "DEFAULT": "default",
+  "CHOICES": "choices",
   "help": "Display this help message",
   "version": "Display this version"
 }

package/lib/locales/ja-JP.json

@@ -7,6 +7,8 @@
   "EXAMPLES": "例",
   "FORMORE": "詳細は、コマンドと`--help`フラグを実行してください:",
   "NEGATABLE": "否定可能な",
+  "DEFAULT": "デフォルト",
+  "CHOICES": "選択肢",
   "help": "このヘルプメッセージを表示",
   "version": "このバージョンを表示"
 }

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

@@ -1,4 +1,4 @@
-import { create, resolveBuiltInKey, resolveOptionKey } from "./utils-BYPzZy9X.js";
+import { COMMON_OPTIONS, create, resolveBuiltInKey, resolveOptionKey } from "./utils-6RnUrIMZ.js";
 
 //#region src/renderer/header.ts
 /**
@@ -13,6 +13,7 @@ function renderHeader(ctx) {
 
 //#endregion
 //#region src/renderer/usage.ts
+const COMMON_OPTIONS_KEYS = Object.keys(COMMON_OPTIONS);
 /**
 * Render the usage.
 * @param ctx A {@link CommandContext | command context}
@@ -181,7 +182,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 && !COMMON_OPTIONS_KEYS.includes(name)) acc[`no-${name}`] = `--no-${name}`;
 		return acc;
 	}, create());
 }
@@ -189,6 +190,20 @@ const resolveNegatableKey = (key) => key.split("no-")[1];
 function resolveNegatableType(key, ctx) {
 	return ctx.options[key.startsWith("no-") ? resolveNegatableKey(key) : key].type;
 }
+function generateDefaultDisplayValue(ctx, schema) {
+	return `${ctx.translate(resolveBuiltInKey("DEFAULT"))}: ${schema.default}`;
+}
+function resolveDisplayValue(ctx, key) {
+	if (COMMON_OPTIONS_KEYS.includes(key)) return "";
+	const schema = ctx.options[key];
+	if ((schema.type === "boolean" || schema.type === "number" || schema.type === "string") && schema.default !== void 0) return `(${generateDefaultDisplayValue(ctx, schema)})`;
+	if (schema.type === "enum") {
+		const _default = schema.default !== void 0 ? generateDefaultDisplayValue(ctx, schema) : "";
+		const choices = `${ctx.translate(resolveBuiltInKey("CHOICES"))}: ${schema.choices.join(" | ")}`;
+		return `(${_default ? `${_default}, ${choices}` : choices})`;
+	}
+	return "";
+}
 /**
 * Generate options usage
 * @param ctx A {@link CommandContext | command context}
@@ -207,8 +222,9 @@ async function generateOptionsUsage(ctx, optionsPairs) {
 			rawDesc = `${ctx.translate(resolveBuiltInKey("NEGATABLE"))} ${optionKey}`;
 		}
 		const optionsSchema = ctx.env.usageOptionType ? `[${resolveNegatableType(key, ctx)}] ` : "";
+		const valueDesc = key.startsWith("no-") ? "" : resolveDisplayValue(ctx, key);
 		const desc = `${optionsSchema ? optionsSchema.padEnd(optionSchemaMaxLength + 3) : ""}${rawDesc}`;
-		const option = `${value.padEnd(optionsMaxLength + ctx.env.middleMargin)}${desc}`;
+		const option = `${value.padEnd(optionsMaxLength + ctx.env.middleMargin)}${desc}${valueDesc ? ` ${valueDesc}` : ""}`;
 		return `${option.padStart(ctx.env.leftMargin + option.length)}`;
 	}));
 	return usages.join("\n");

package/lib/renderer.d.ts

@@ -1,4 +1,4 @@
-import { CommandContext } from "./types.d-aDzUZTqM.js";
+import { CommandContext } from "./types.d-BqXvgR9J.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 "./utils-6RnUrIMZ.js";
+import { renderHeader, renderUsage, renderValidationErrors } from "./renderer-BgAkL9Re.js";
 
 export { renderHeader, renderUsage, renderValidationErrors };