gunshi 0.35.0 → 0.35.2

package/lib/generator.js

@@ -1,5 +1,5 @@
-import { t as create } from "./utils-DNVHO9MQ.js";
-import { t as cli } from "./cli-DoX4INTi.js";
+import { create } from "./utils.js";
+import { t as cli } from "./cli-DnXk5aCq.js";
 //#region src/generator.ts
 /**
 * The entry for usage generator.

package/lib/index.d.ts

@@ -1,8 +1,8 @@
-import { a as resolveArgs, i as Args, n as ArgSchema, o as ArgToken, r as ArgValues, s as parseArgs } from "./resolver-mxPNDBm_.js";
-import { A as Plugin, C as NormalizeToGunshiParams, D as SubCommandable, E as RenderingOptions, F as PluginWithExtension, I as PluginWithoutExtension, L as plugin, M as PluginExtension, N as PluginFunction, O as ValidationErrorsDecorator, P as PluginOptions, R as PluginContext, S as MergeGunshiExtensions, T as RendererDecorator, _ as ExtractArgs, a as CommandContext, b as GunshiParamsConstraint, c as CommandDecorator, d as CommandLoader, f as CommandRunner, g as ExtractArgExplicitlyProvided, h as ExtendContext, i as CommandCallMode, j as PluginDependency, k as OnPluginExtension, l as CommandEnvironment, m as DefaultGunshiParams, n as CliOptions, o as CommandContextCore, p as Commandable, r as Command, s as CommandContextExtension, t as Awaitable, u as CommandExamplesFetcher, v as ExtractExtensions, w as Prettify, x as LazyCommand, y as GunshiParams } from "./types-DZ0S_FSe.js";
+import { a as ArgsValidationError, c as isArgsValidationError, d as parseArgs, i as Args, l as resolveArgs, n as ArgSchema, o as ArgsValidationErrorCode, r as ArgValues, s as ArgsValidationErrorKeys, u as ArgToken } from "./resolver-CgkhQ6Tt.js";
+import { A as Plugin, C as NormalizeToGunshiParams, D as SubCommandable, E as RenderingOptions, F as PluginWithExtension, I as PluginWithoutExtension, L as plugin, M as PluginExtension, N as PluginFunction, O as ValidationErrorsDecorator, P as PluginOptions, R as PluginContext, S as MergeGunshiExtensions, T as RendererDecorator, _ as ExtractArgs, a as CommandContext, b as GunshiParamsConstraint, c as CommandDecorator, d as CommandLoader, f as CommandRunner, g as ExtractArgExplicitlyProvided, h as ExtendContext, i as CommandCallMode, j as PluginDependency, k as OnPluginExtension, l as CommandEnvironment, m as DefaultGunshiParams, n as CliOptions, o as CommandContextCore, p as Commandable, r as Command, s as CommandContextExtension, t as Awaitable, u as CommandExamplesFetcher, v as ExtractExtensions, w as Prettify, x as LazyCommand, y as GunshiParams } from "./types-CD5eRJFK.js";
 import { CommandContextParams, createCommandContext } from "./context.js";
 import { define, defineWithTypes, lazy, lazyWithTypes } from "./definition.js";
-import { t as ANONYMOUS_COMMAND_NAME } from "./constants-BkgP86Yw.js";
+import { a as hasPriorityValidationError, i as CommandNotFoundErrorOptions, n as CommandNotFoundErrorCode, o as isCommandNotFoundError, r as CommandNotFoundErrorKeys, s as ANONYMOUS_COMMAND_NAME, t as CommandNotFoundError } from "./error-6srXBX7u.js";
 
 //#region ../plugin-i18n/src/types.d.ts
 /**
@@ -186,4 +186,4 @@ declare function cli(args: string[], entry: SubCommandable, options?: CliOptions
 */
 
 //#endregion
-export { ANONYMOUS_COMMAND_NAME, ArgSchema, ArgToken, ArgValues, Args, Awaitable, CliOptions, Command, CommandCallMode, CommandContext, CommandContextCore, CommandContextExtension, type CommandContextParams, CommandDecorator, CommandEnvironment, CommandExamplesFetcher, CommandLoader, CommandRunner, Commandable, DefaultGunshiParams, DefaultTranslation, ExtendContext, ExtractArgExplicitlyProvided, ExtractArgs, ExtractExtensions, GunshiParams, GunshiParamsConstraint, LazyCommand, MergeGunshiExtensions, NormalizeToGunshiParams, type OnPluginExtension, type Plugin, type PluginContext, type PluginDependency, type PluginExtension, type PluginFunction, type PluginOptions, type PluginWithExtension, type PluginWithoutExtension, Prettify, RendererDecorator, RenderingOptions, SubCommandable, ValidationErrorsDecorator, cli, createCommandContext, define, defineWithTypes, lazy, lazyWithTypes, parseArgs, plugin, resolveArgs };
+export { ANONYMOUS_COMMAND_NAME, ArgSchema, ArgToken, ArgValues, Args, ArgsValidationError, type ArgsValidationErrorCode, ArgsValidationErrorKeys, Awaitable, CliOptions, Command, CommandCallMode, CommandContext, CommandContextCore, CommandContextExtension, type CommandContextParams, CommandDecorator, CommandEnvironment, CommandExamplesFetcher, CommandLoader, CommandNotFoundError, type CommandNotFoundErrorCode, CommandNotFoundErrorKeys, type CommandNotFoundErrorOptions, CommandRunner, Commandable, DefaultGunshiParams, DefaultTranslation, ExtendContext, ExtractArgExplicitlyProvided, ExtractArgs, ExtractExtensions, GunshiParams, GunshiParamsConstraint, LazyCommand, MergeGunshiExtensions, NormalizeToGunshiParams, type OnPluginExtension, type Plugin, type PluginContext, type PluginDependency, type PluginExtension, type PluginFunction, type PluginOptions, type PluginWithExtension, type PluginWithoutExtension, Prettify, RendererDecorator, RenderingOptions, SubCommandable, ValidationErrorsDecorator, cli, createCommandContext, define, defineWithTypes, hasPriorityValidationError, isArgsValidationError, isCommandNotFoundError, lazy, lazyWithTypes, parseArgs, plugin, resolveArgs };

package/lib/index.js

@@ -1,9 +1,9 @@
-import { t as ANONYMOUS_COMMAND_NAME } from "./constants-CQq1R_68.js";
-import { createCommandContext } from "./context.js";
-import { t as plugin } from "./core-CFEvRYOJ.js";
-import { a as namespacedId } from "./src-B4uHG_qb.js";
-import { n as resolveArgs, r as parseArgs } from "./core-xgWIcbHL.js";
-import { t as cli } from "./cli-DoX4INTi.js";
+import { n as ANONYMOUS_COMMAND_NAME, t as createCommandContext } from "./context-CAPhwgJJ.js";
+import { a as parseArgs, i as resolveArgs, n as ArgsValidationErrorKeys, r as isArgsValidationError, t as ArgsValidationError } from "./resolver-UFOtObbe.js";
+import { i as isCommandNotFoundError, n as CommandNotFoundErrorKeys, r as hasPriorityValidationError, t as CommandNotFoundError } from "./error-xSnOOdnr.js";
+import { t as plugin } from "./plugin-DhJZVIbl.js";
+import { a as namespacedId } from "./src-DbfZvEe0.js";
+import { t as cli } from "./cli-DnXk5aCq.js";
 import { define, defineWithTypes, lazy, lazyWithTypes } from "./definition.js";
 //#region ../plugin-i18n/src/translation.ts
 /**
@@ -89,4 +89,4 @@ namespacedId("i18n");
 * @license MIT
 */
 //#endregion
-export { ANONYMOUS_COMMAND_NAME, DefaultTranslation, cli, createCommandContext, define, defineWithTypes, lazy, lazyWithTypes, parseArgs, plugin, resolveArgs };
+export { ANONYMOUS_COMMAND_NAME, ArgsValidationError, ArgsValidationErrorKeys, CommandNotFoundError, CommandNotFoundErrorKeys, DefaultTranslation, cli, createCommandContext, define, defineWithTypes, hasPriorityValidationError, isArgsValidationError, isCommandNotFoundError, lazy, lazyWithTypes, parseArgs, plugin, resolveArgs };

package/lib/{core-CFEvRYOJ.js → plugin-DhJZVIbl.js}

@@ -1,3 +1,4 @@
+import "./error-xSnOOdnr.js";
 //#region src/plugin/core.ts
 /**
 * @author kazuya kawaguchi (a.k.a. kazupon)
@@ -49,4 +50,10 @@ function plugin(options = {}) {
 	});
 }
 //#endregion
+//#region src/plugin.ts
+/**
+* @author kazuya kawaguchi (a.k.a. kazupon)
+* @license MIT
+*/
+//#endregion
 export { plugin as t };

package/lib/plugin.d.ts

@@ -1,7 +1,7 @@
-import { i as Args, n as ArgSchema, o as ArgToken, r as ArgValues } from "./resolver-mxPNDBm_.js";
-import { A as Plugin, C as NormalizeToGunshiParams, F as PluginWithExtension, I as PluginWithoutExtension, L as plugin, M as PluginExtension, N as PluginFunction, O as ValidationErrorsDecorator, P as PluginOptions, R as PluginContext, S as MergeGunshiExtensions, T as RendererDecorator, _ as ExtractArgs, a as CommandContext, b as GunshiParamsConstraint, c as CommandDecorator, f as CommandRunner, h as ExtendContext, j as PluginDependency, k as OnPluginExtension, m as DefaultGunshiParams, o as CommandContextCore, r as Command, s as CommandContextExtension, t as Awaitable, u as CommandExamplesFetcher, v as ExtractExtensions, w as Prettify, x as LazyCommand, y as GunshiParams } from "./types-DZ0S_FSe.js";
+import { a as ArgsValidationError, c as isArgsValidationError, i as Args, n as ArgSchema, o as ArgsValidationErrorCode, r as ArgValues, s as ArgsValidationErrorKeys, u as ArgToken } from "./resolver-CgkhQ6Tt.js";
+import { A as Plugin, C as NormalizeToGunshiParams, F as PluginWithExtension, I as PluginWithoutExtension, L as plugin, M as PluginExtension, N as PluginFunction, O as ValidationErrorsDecorator, P as PluginOptions, R as PluginContext, S as MergeGunshiExtensions, T as RendererDecorator, _ as ExtractArgs, a as CommandContext, b as GunshiParamsConstraint, c as CommandDecorator, f as CommandRunner, h as ExtendContext, j as PluginDependency, k as OnPluginExtension, m as DefaultGunshiParams, o as CommandContextCore, r as Command, s as CommandContextExtension, t as Awaitable, u as CommandExamplesFetcher, v as ExtractExtensions, w as Prettify, x as LazyCommand, y as GunshiParams } from "./types-CD5eRJFK.js";
 import { CommandContextParams, createCommandContext } from "./context.js";
-import { n as CLI_OPTIONS_DEFAULT, t as ANONYMOUS_COMMAND_NAME } from "./constants-BkgP86Yw.js";
+import { a as hasPriorityValidationError, c as CLI_OPTIONS_DEFAULT, i as CommandNotFoundErrorOptions, n as CommandNotFoundErrorCode, o as isCommandNotFoundError, r as CommandNotFoundErrorKeys, s as ANONYMOUS_COMMAND_NAME, t as CommandNotFoundError } from "./error-6srXBX7u.js";
 
 //#region src/plugin.d.ts
 /**
@@ -10,4 +10,4 @@ import { n as CLI_OPTIONS_DEFAULT, t as ANONYMOUS_COMMAND_NAME } from "./constan
 */
 
 //#endregion
-export { ANONYMOUS_COMMAND_NAME, type ArgSchema, type ArgToken, type ArgValues, type Args, type Awaitable, CLI_OPTIONS_DEFAULT, type Command, type CommandContext, type CommandContextCore, type CommandContextExtension, type CommandContextParams, type CommandDecorator, type CommandExamplesFetcher, type CommandRunner, type DefaultGunshiParams, type ExtendContext, type ExtractArgs, type ExtractExtensions, type GunshiParams, type GunshiParamsConstraint, type LazyCommand, type MergeGunshiExtensions, type NormalizeToGunshiParams, type OnPluginExtension, type Plugin, type PluginContext, type PluginDependency, type PluginExtension, type PluginFunction, type PluginOptions, type PluginWithExtension, type PluginWithoutExtension, type Prettify, type RendererDecorator, type ValidationErrorsDecorator, createCommandContext, plugin };
+export { ANONYMOUS_COMMAND_NAME, type ArgSchema, type ArgToken, type ArgValues, type Args, ArgsValidationError, type ArgsValidationErrorCode, ArgsValidationErrorKeys, type Awaitable, CLI_OPTIONS_DEFAULT, type Command, type CommandContext, type CommandContextCore, type CommandContextExtension, type CommandContextParams, type CommandDecorator, type CommandExamplesFetcher, CommandNotFoundError, type CommandNotFoundErrorCode, CommandNotFoundErrorKeys, type CommandNotFoundErrorOptions, type CommandRunner, type DefaultGunshiParams, type ExtendContext, type ExtractArgs, type ExtractExtensions, type GunshiParams, type GunshiParamsConstraint, type LazyCommand, type MergeGunshiExtensions, type NormalizeToGunshiParams, type OnPluginExtension, type Plugin, type PluginContext, type PluginDependency, type PluginExtension, type PluginFunction, type PluginOptions, type PluginWithExtension, type PluginWithoutExtension, type Prettify, type RendererDecorator, type ValidationErrorsDecorator, createCommandContext, hasPriorityValidationError, isArgsValidationError, isCommandNotFoundError, plugin };

package/lib/plugin.js

@@ -1,10 +1,5 @@
-import { n as CLI_OPTIONS_DEFAULT, t as ANONYMOUS_COMMAND_NAME } from "./constants-CQq1R_68.js";
-import { createCommandContext } from "./context.js";
-import { t as plugin } from "./core-CFEvRYOJ.js";
-//#region src/plugin.ts
-/**
-* @author kazuya kawaguchi (a.k.a. kazupon)
-* @license MIT
-*/
-//#endregion
-export { ANONYMOUS_COMMAND_NAME, CLI_OPTIONS_DEFAULT, createCommandContext, plugin };
+import { n as ANONYMOUS_COMMAND_NAME, r as CLI_OPTIONS_DEFAULT, t as createCommandContext } from "./context-CAPhwgJJ.js";
+import { n as ArgsValidationErrorKeys, r as isArgsValidationError, t as ArgsValidationError } from "./resolver-UFOtObbe.js";
+import { i as isCommandNotFoundError, n as CommandNotFoundErrorKeys, r as hasPriorityValidationError, t as CommandNotFoundError } from "./error-xSnOOdnr.js";
+import { t as plugin } from "./plugin-DhJZVIbl.js";
+export { ANONYMOUS_COMMAND_NAME, ArgsValidationError, ArgsValidationErrorKeys, CLI_OPTIONS_DEFAULT, CommandNotFoundError, CommandNotFoundErrorKeys, createCommandContext, hasPriorityValidationError, isArgsValidationError, isCommandNotFoundError, plugin };

package/lib/renderer.d.ts

@@ -1,4 +1,4 @@
-import { a as CommandContext, m as DefaultGunshiParams, y as GunshiParams } from "./types-DZ0S_FSe.js";
+import { a as CommandContext, m as DefaultGunshiParams, y as GunshiParams } from "./types-CD5eRJFK.js";
 
 //#region ../plugin-renderer/src/header.d.ts
 /**
@@ -27,11 +27,11 @@ declare function renderUsage<G extends GunshiParams = DefaultGunshiParams>(ctx:
 /**
  * Render the validation errors.
  *
- * @param _ctx - A {@link CommandContext | command context}
+ * @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<G extends GunshiParams = DefaultGunshiParams>(_ctx: CommandContext<G>, error: AggregateError): Promise<string>;
+declare function renderValidationErrors<G extends GunshiParams = DefaultGunshiParams>(ctx: CommandContext<G>, error: AggregateError): Promise<string>;
 //#endregion
 //#region src/renderer.d.ts
 /**

package/lib/renderer.js

@@ -1,4 +1,4 @@
-import { i as renderHeader, n as renderValidationErrors, r as renderUsage } from "./src-B4uHG_qb.js";
+import { i as renderHeader, n as renderValidationErrors, r as renderUsage } from "./src-DbfZvEe0.js";
 //#region src/renderer.ts
 /**
 * @author kazuya kawaguchi (a.k.a. kazupon)

package/lib/{resolver-mxPNDBm_.d.ts → resolver-CgkhQ6Tt.d.ts}

@@ -1,4 +1,4 @@
-//#region ../../node_modules/.pnpm/args-tokens@0.27.0/node_modules/args-tokens/lib/parser-DT7Ztcch.d.ts
+//#region ../../node_modules/.pnpm/args-tokens@0.28.0/node_modules/args-tokens/lib/parser-DT7Ztcch.d.ts
 //#region src/parser.d.ts
 /**
  * Entry point of argument parser.
@@ -88,7 +88,7 @@ declare function parseArgs(args: string[], options?: ParserOptions): ArgToken[];
  * @returns Whether `arg` is a short option.
  */
 //#endregion
-//#region ../../node_modules/.pnpm/args-tokens@0.27.0/node_modules/args-tokens/lib/resolver.d.ts
+//#region ../../node_modules/.pnpm/args-tokens@0.28.0/node_modules/args-tokens/lib/resolver.d.ts
 //#region src/resolver.d.ts
 /**
  * An argument schema definition for command-line argument parsing.
@@ -509,7 +509,7 @@ interface ArgSchema {
    *
    * @param value - Raw string value from command line
    * @returns Parsed value of any type
-   * @throws Error or subclass when value is invalid
+   * @throws {Error} Error or subclass when value is invalid
    *
    * @example
    * Custom parsing functions:
@@ -541,6 +541,64 @@ interface ArgSchema {
    */
   parse?: (value: string) => any;
 }
+/**
+ * Machine-readable error codes for {@link ArgsValidationError}.
+ *
+ * Each code identifies a validation failure category and is also suitable as an
+ * i18n resource key for localized rendering.
+ */
+declare const ArgsValidationErrorKeys: {
+  readonly requiredOption: "err:arg:required-option";
+  readonly requiredPositional: "err:arg:required-positional";
+  readonly invalidType: "err:arg:invalid-type";
+  readonly invalidChoice: "err:arg:invalid-choice";
+  readonly customParse: "err:arg:custom-parse";
+  readonly unknownOption: "err:arg:unknown-option";
+};
+/**
+ * A machine-readable argument validation error code.
+ *
+ * Each code is one of {@link ArgsValidationErrorKeys} and can also be used as
+ * an i18n resource key.
+ */
+type ArgsValidationErrorCode = (typeof ArgsValidationErrorKeys)[keyof typeof ArgsValidationErrorKeys];
+/**
+ * An error that contains structured metadata for argument validation failures.
+ *
+ * The `message` remains the English fallback message. Renderers can use `code`
+ * and `values` to localize the error, falling back to `message` when localization
+ * is unavailable.
+ */
+declare class ArgsValidationError extends Error {
+  /**
+   * Machine-readable error code for this validation failure.
+   *
+   * This code can also be used as an i18n resource key.
+   */
+  readonly code?: ArgsValidationErrorCode;
+  /**
+   * Interpolation values for `code`.
+   */
+  readonly values: Record<string, unknown>;
+  /**
+   * Create an `ArgsValidationError` instance.
+   *
+   * @param message - fallback error message
+   * @param options - structured validation metadata
+   */
+  constructor(message: string, options?: {
+    code?: ArgsValidationErrorCode;
+    values?: Record<string, unknown>;
+    cause?: unknown;
+  });
+}
+/**
+ * Check whether the given value is an {@link ArgsValidationError}.
+ *
+ * @param error - value to check
+ * @returns `true` when the value is an `ArgsValidationError`
+ */
+declare function isArgsValidationError(error: unknown): error is ArgsValidationError;
 /**
  * An object that contains {@link ArgSchema | argument schema}.
  *
@@ -676,4 +734,4 @@ declare function resolveArgs<A extends Args>(args: A, tokens: ArgToken[], {
  * An error type for {@link ArgResolveError}.
  */
 //#endregion
-export { resolveArgs as a, Args as i, ArgSchema as n, ArgToken as o, ArgValues as r, parseArgs as s, ArgExplicitlyProvided as t };
+export { ArgsValidationError as a, isArgsValidationError as c, parseArgs as d, Args as i, resolveArgs as l, ArgSchema as n, ArgsValidationErrorCode as o, ArgValues as r, ArgsValidationErrorKeys as s, ArgExplicitlyProvided as t, ArgToken as u };