gunshi 0.27.5 → 0.28.0

package/lib/bone.d.ts

@@ -1,4 +1,4 @@
-import { A as SubCommandable, C as GunshiParams, D as Prettify, E as NormalizeToGunshiParams, O as RendererDecorator, S as ExtractExtensions, T as LazyCommand, _ as Commandable, a as Awaitable, b as ExtractArgExplicitlyProvided, c as CommandCallMode, d as CommandContextExtension, f as CommandDecorator, g as CommandRunner, h as CommandLoader, i as Args, j as ValidationErrorsDecorator, k as RenderingOptions, l as CommandContext, m as CommandExamplesFetcher, n as ArgToken, o as CliOptions, p as CommandEnvironment, r as ArgValues, s as Command, t as ArgSchema, u as CommandContextCore, v as DefaultGunshiParams, w as GunshiParamsConstraint, x as ExtractArgs, y as ExtendContext } from "./types-Bh6G4DvQ.js";
+import { A as SubCommandable, C as GunshiParams, D as Prettify, E as NormalizeToGunshiParams, O as RendererDecorator, S as ExtractExtensions, T as LazyCommand, _ as Commandable, a as Awaitable, b as ExtractArgExplicitlyProvided, c as CommandCallMode, d as CommandContextExtension, f as CommandDecorator, g as CommandRunner, h as CommandLoader, i as Args, j as ValidationErrorsDecorator, k as RenderingOptions, l as CommandContext, m as CommandExamplesFetcher, n as ArgToken, o as CliOptions, p as CommandEnvironment, r as ArgValues, s as Command, t as ArgSchema, u as CommandContextCore, v as DefaultGunshiParams, w as GunshiParamsConstraint, x as ExtractArgs, y as ExtendContext } from "./types-DSyU38G8.js";
 
 //#region src/cli/bone.d.ts
 /**

package/lib/bone.js

@@ -1,6 +1,4 @@
-import "./context-DRQZ3doU.js";
-import "./utils-DA31tfdY.js";
-import { t as cliCore } from "./core-D15eimMG.js";
+import { t as cliCore } from "./core-C9P_Gd_f.js";
 
 //#region src/cli/bone.ts
 /**

package/lib/{cli-BtnhCdFu.js → cli-l4AYjN-O.js}

@@ -1,6 +1,6 @@
-import { t as cliCore } from "./core-D15eimMG.js";
-import { t as plugin } from "./plugin-vBhmK2n3.js";
-import { a as namespacedId, s as COMMON_ARGS, t as renderer } from "./src-BXKp6yTi.js";
+import { t as cliCore } from "./core-C9P_Gd_f.js";
+import { t as plugin } from "./core-eN5xmB3s.js";
+import { a as namespacedId, s as COMMON_ARGS, t as renderer } from "./src-CfO5ab2f.js";
 
 //#region ../plugin-global/src/types.ts
 /**

package/lib/{plugin-DvvZ2zsE.d.ts → constants-Cqazor4w.d.ts}

@@ -1,4 +1,4 @@
-import { o as CliOptions, v as DefaultGunshiParams } from "./types-Bh6G4DvQ.js";
+import { o as CliOptions, v as DefaultGunshiParams } from "./types-DSyU38G8.js";
 
 //#region src/constants.d.ts
 /**

package/lib/constants-WviiKqbt.js

@@ -0,0 +1,26 @@
+//#region src/constants.ts
+const ANONYMOUS_COMMAND_NAME = "(anonymous)";
+/**
+* A no-operation function.
+*/
+const NOOP = () => {};
+const CLI_OPTIONS_DEFAULT = {
+	name: void 0,
+	description: void 0,
+	version: void 0,
+	cwd: void 0,
+	usageSilent: false,
+	subCommands: void 0,
+	leftMargin: 2,
+	middleMargin: 10,
+	usageOptionType: false,
+	usageOptionValue: true,
+	renderHeader: void 0,
+	renderUsage: void 0,
+	renderValidationErrors: void 0,
+	plugins: void 0,
+	fallbackToEntry: false
+};
+
+//#endregion
+export { CLI_OPTIONS_DEFAULT as n, NOOP as r, ANONYMOUS_COMMAND_NAME as t };

package/lib/{context-DRQZ3doU.js → context-CHDIbgwd.js}

@@ -1,30 +1,6 @@
-import { a as log, n as deepFreeze, r as isLazyCommand, t as create } from "./utils-DA31tfdY.js";
+import { a as log, i as isLazyCommand, n as deepFreeze, t as create } from "./utils-DNS9AIR_.js";
+import { n as CLI_OPTIONS_DEFAULT, r as NOOP, t as ANONYMOUS_COMMAND_NAME } from "./constants-WviiKqbt.js";
 
-//#region src/constants.ts
-const ANONYMOUS_COMMAND_NAME = "(anonymous)";
-/**
-* A no-operation function.
-*/
-const NOOP = () => {};
-const CLI_OPTIONS_DEFAULT = {
-	name: void 0,
-	description: void 0,
-	version: void 0,
-	cwd: void 0,
-	usageSilent: false,
-	subCommands: void 0,
-	leftMargin: 2,
-	middleMargin: 10,
-	usageOptionType: false,
-	usageOptionValue: true,
-	renderHeader: void 0,
-	renderUsage: void 0,
-	renderValidationErrors: void 0,
-	plugins: void 0,
-	fallbackToEntry: false
-};
-
-//#endregion
 //#region src/context.ts
 /**
 * The entry for gunshi context.
@@ -47,7 +23,7 @@ const CLI_OPTIONS_DEFAULT = {
 * @param param - A {@link CommandContextParams | parameters} to create a command context.
 * @returns A {@link CommandContext | command context}, which is readonly.
 */
-async function createCommandContext({ args = {}, explicit = {}, values = {}, positionals = [], rest = [], argv = [], tokens = [], command = {}, extensions = {}, cliOptions = {}, callMode = "entry", omitted = false, validationError = void 0 }) {
+async function createCommandContext({ args = {}, explicit = {}, values = {}, positionals = [], rest = [], argv = [], tokens = [], command = {}, extensions = {}, cliOptions = {}, callMode = "entry", commandPath = [], omitted = false, validationError = void 0 }) {
 	/**
 	* normailize the options schema and values, to avoid prototype pollution
 	*/
@@ -76,6 +52,7 @@ async function createCommandContext({ args = {}, explicit = {}, values = {}, pos
 		description: command.description,
 		omitted,
 		callMode,
+		commandPath,
 		env,
 		args: _args,
 		explicit,
@@ -113,4 +90,4 @@ function getCommandName(cmd) {
 }
 
 //#endregion
-export { NOOP as i, ANONYMOUS_COMMAND_NAME as n, CLI_OPTIONS_DEFAULT as r, createCommandContext as t };
+export { createCommandContext as t };

package/lib/context.d.ts

@@ -1,3 +1,102 @@
-import "./types-Bh6G4DvQ.js";
-import { n as ExtractExtensions, r as createCommandContext, t as CommandContextParams } from "./context-DZzjf_Et.js";
+import { C as GunshiParams, T as LazyCommand, b as ExtractArgExplicitlyProvided, c as CommandCallMode, d as CommandContextExtension, i as Args, l as CommandContext, n as ArgToken, o as CliOptions, r as ArgValues, s as Command, v as DefaultGunshiParams, w as GunshiParamsConstraint, x as ExtractArgs, y as ExtendContext } from "./types-DSyU38G8.js";
+
+//#region src/context.d.ts
+
+/**
+ * Extract extension return types from extensions record
+ *
+ * @internal
+ */
+type ExtractExtensions<E extends Record<string, CommandContextExtension>> = { [K in keyof E]: E[K] extends CommandContextExtension<infer T> ? T : never };
+/**
+ * Parameters of {@link createCommandContext}
+ */
+interface CommandContextParams<G extends GunshiParams | {
+  args: Args;
+} | {
+  extensions: ExtendContext;
+}, V extends ArgValues<ExtractArgs<G>>, C extends Command<G> | LazyCommand<G> = Command<G>, E extends Record<string, CommandContextExtension> = Record<string, CommandContextExtension>> {
+  /**
+   * An arguments of target command
+   */
+  args?: ExtractArgs<G>;
+  /**
+   * Explicitly provided arguments
+   */
+  explicit?: ExtractArgExplicitlyProvided<G>;
+  /**
+   * A values of target command
+   */
+  values?: V;
+  /**
+   * 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
+   */
+  argv?: string[];
+  /**
+   * Argument tokens that are parsed by the `parseArgs` function
+   */
+  tokens?: ArgToken[];
+  /**
+   * Whether the command is omitted
+   */
+  omitted?: boolean;
+  /**
+   * Command call mode.
+   */
+  callMode?: CommandCallMode;
+  /**
+   * The path of nested sub-commands resolved to reach the current command.
+   */
+  commandPath?: string[];
+  /**
+   * A target command
+   */
+  command?: C;
+  /**
+   * Plugin extensions to apply as the command context extension.
+   */
+  extensions?: E;
+  /**
+   * A command options, which is spicialized from `cli` function
+   */
+  cliOptions?: CliOptions<G>;
+  /**
+   * Validation error from argument parsing.
+   */
+  validationError?: AggregateError;
+}
+/**
+ * Create a command context.
+ *
+ * @param param - A {@link CommandContextParams | parameters} to create a command context.
+ * @returns A {@link CommandContext | command context}, which is readonly.
+ */
+declare function createCommandContext<G extends GunshiParamsConstraint = DefaultGunshiParams, V extends ArgValues<ExtractArgs<G>> = ArgValues<ExtractArgs<G>>, C extends Command<G> | LazyCommand<G> = Command<G>, E extends Record<string, CommandContextExtension> = {}>({
+  args,
+  explicit,
+  values,
+  positionals,
+  rest,
+  argv,
+  tokens,
+  command,
+  extensions,
+  cliOptions,
+  callMode,
+  commandPath,
+  omitted,
+  validationError
+}: CommandContextParams<G, V, C, E>): Promise<{} extends ExtractExtensions<E> ? Readonly<CommandContext<G>> : Readonly<CommandContext<GunshiParams<{
+  args: ExtractArgs<G>;
+  extensions: ExtractExtensions<E>;
+}>>>>;
+//#endregion
 export { CommandContextParams, ExtractExtensions, createCommandContext };

package/lib/context.js

@@ -1,4 +1,3 @@
-import { t as createCommandContext } from "./context-DRQZ3doU.js";
-import "./utils-DA31tfdY.js";
+import { t as createCommandContext } from "./context-CHDIbgwd.js";
 
 export { createCommandContext };