@gunshi/plugin 0.27.0 → 0.27.4

package/lib/index.d.ts

@@ -473,10 +473,10 @@ interface Args {
  *
  * @typeParam T - {@link Args | Arguments} which is an object that defines the command line arguments.
  */
-type ArgValues<T$1> = T$1 extends Args ? ResolveArgValues<T$1, { [Arg in keyof T$1]: ExtractOptionValue<T$1[Arg]> }> : {
+type ArgValues<T> = T extends Args ? ResolveArgValues<T, { [Arg in keyof T]: ExtractOptionValue<T[Arg]> }> : {
   [option: string]: string | boolean | number | (string | boolean | number)[] | undefined;
 };
-type IsFunction<T$1> = T$1 extends ((...args: any[]) => any) ? true : false;
+type IsFunction<T> = T extends ((...args: any[]) => any) ? true : false;
 /**
  * Extracts the value type from the argument schema.
  *
@@ -484,8 +484,8 @@ type IsFunction<T$1> = T$1 extends ((...args: any[]) => any) ? true : false;
  *
  * @internal
  */
-type ExtractOptionValue<A$1 extends ArgSchema> = A$1['type'] extends 'string' ? ResolveOptionValue<A$1, string> : A$1['type'] extends 'boolean' ? ResolveOptionValue<A$1, boolean> : A$1['type'] extends 'number' ? ResolveOptionValue<A$1, number> : A$1['type'] extends 'positional' ? ResolveOptionValue<A$1, string> : A$1['type'] extends 'enum' ? A$1['choices'] extends string[] | readonly string[] ? ResolveOptionValue<A$1, A$1['choices'][number]> : never : A$1['type'] extends 'custom' ? IsFunction<A$1['parse']> extends true ? ResolveOptionValue<A$1, ReturnType<NonNullable<A$1['parse']>>> : never : ResolveOptionValue<A$1, string | boolean | number>;
-type ResolveOptionValue<A$1 extends ArgSchema, T$1> = A$1['multiple'] extends true ? T$1[] : T$1;
+type ExtractOptionValue<A extends ArgSchema> = A['type'] extends 'string' ? ResolveOptionValue<A, string> : A['type'] extends 'boolean' ? ResolveOptionValue<A, boolean> : A['type'] extends 'number' ? ResolveOptionValue<A, number> : A['type'] extends 'positional' ? ResolveOptionValue<A, string> : A['type'] extends 'enum' ? A['choices'] extends string[] | readonly string[] ? ResolveOptionValue<A, A['choices'][number]> : never : A['type'] extends 'custom' ? IsFunction<A['parse']> extends true ? ResolveOptionValue<A, ReturnType<NonNullable<A['parse']>>> : never : ResolveOptionValue<A, string | boolean | number>;
+type ResolveOptionValue<A extends ArgSchema, T> = A['multiple'] extends true ? T[] : T;
 /**
  * Resolved argument values.
  *
@@ -494,7 +494,7 @@ type ResolveOptionValue<A$1 extends ArgSchema, T$1> = A$1['multiple'] extends tr
  *
  * @internal
  */
-type ResolveArgValues<A$1 extends Args, V extends Record<keyof A$1, unknown>> = { -readonly [Arg in keyof A$1]?: V[Arg] } & FilterArgs<A$1, V, 'default'> & FilterArgs<A$1, V, 'required'> & FilterPositionalArgs<A$1, V> extends infer P ? { [K in keyof P]: P[K] } : never;
+type ResolveArgValues<A extends Args, V extends Record<keyof A, unknown>> = { -readonly [Arg in keyof A]?: V[Arg] } & FilterArgs<A, V, 'default'> & FilterArgs<A, V, 'required'> & FilterPositionalArgs<A, V> extends infer P ? { [K in keyof P]: P[K] } : never;
 /**
  * Filters the arguments based on their default values.
  *
@@ -504,7 +504,7 @@ type ResolveArgValues<A$1 extends Args, V extends Record<keyof A$1, unknown>> =
  *
  * @internal
  */
-type FilterArgs<A$1 extends Args, V extends Record<keyof A$1, unknown>, K$1 extends keyof ArgSchema> = { [Arg in keyof A$1 as A$1[Arg][K$1] extends {} ? Arg : never]: V[Arg] };
+type FilterArgs<A extends Args, V extends Record<keyof A, unknown>, K$1 extends keyof ArgSchema> = { [Arg in keyof A as A[Arg][K$1] extends {} ? Arg : never]: V[Arg] };
 /**
  * Filters positional arguments from the argument schema.
  *
@@ -513,7 +513,7 @@ type FilterArgs<A$1 extends Args, V extends Record<keyof A$1, unknown>, K$1 exte
  *
  * @internal
  */
-type FilterPositionalArgs<A$1 extends Args, V extends Record<keyof A$1, unknown>> = { [Arg in keyof A$1 as A$1[Arg]['type'] extends 'positional' ? Arg : never]: V[Arg] };
+type FilterPositionalArgs<A extends Args, V extends Record<keyof A, unknown>> = { [Arg in keyof A as A[Arg]['type'] extends 'positional' ? Arg : never]: V[Arg] };
 /**
  * An arguments for {@link resolveArgs | resolve arguments}.
  */
@@ -526,7 +526,7 @@ type FilterPositionalArgs<A$1 extends Args, V extends Record<keyof A$1, unknown>
  *
  * @typeParam A - {@link Args | Arguments}, which is an object that defines the command line arguments.
  */
-type ArgExplicitlyProvided<A$1 extends Args> = { [K in keyof A$1]: boolean };
+type ArgExplicitlyProvided<A extends Args> = { [K in keyof A]: boolean };
 /**
  * Resolve command line arguments.
  *
@@ -648,18 +648,18 @@ interface PluginContext<G extends GunshiParamsConstraint = DefaultGunshiParams>
 }
 //#endregion
 //#region ../gunshi/src/plugin/core.d.ts
-type ProcessDependency<D, A$1 extends ExtendContext> = D extends string ? D extends keyof A$1 ? { [K in D]: A$1[K] } : {} : D extends {
+type ProcessDependency<D, A extends ExtendContext> = D extends string ? D extends keyof A ? { [K in D]: A[K] } : {} : D extends {
   id: infer ID;
   optional?: any;
-} ? ID extends string ? ID extends keyof A$1 ? D extends {
+} ? ID extends string ? ID extends keyof A ? D extends {
   optional: true;
-} ? { [K in ID]: A$1[K] | undefined } : { [K in ID]: A$1[K] } : {} : never : never;
+} ? { [K in ID]: A[K] | undefined } : { [K in ID]: A[K] } : {} : never : never;
 /**
  * Helper type to infer dependency extensions with optional support
  *
  * @internal
  */
-type InferDependencyExtensions<D extends ReadonlyArray<PluginDependency | string>, A$1 extends ExtendContext> = D extends readonly [] ? {} : D extends readonly [infer First, ...infer Rest] ? ProcessDependency<First, A$1> & (Rest extends ReadonlyArray<PluginDependency | string> ? InferDependencyExtensions<Rest, A$1> : {}) : {};
+type InferDependencyExtensions<D extends ReadonlyArray<PluginDependency | string>, A extends ExtendContext> = D extends readonly [] ? {} : D extends readonly [infer First, ...infer Rest] ? ProcessDependency<First, A> & (Rest extends ReadonlyArray<PluginDependency | string> ? InferDependencyExtensions<Rest, A> : {}) : {};
 /**
  * Plugin dependency definition
  *
@@ -696,7 +696,7 @@ type PluginFunction<G extends GunshiParams = DefaultGunshiParams> = (ctx: Readon
  *
  * @since v0.27.0
  */
-type PluginExtension<T$1 = Record<string, unknown>, G extends GunshiParams = DefaultGunshiParams> = (ctx: CommandContextCore<G>, cmd: Command<G>) => Awaitable<T$1>;
+type PluginExtension<T = Record<string, unknown>, G extends GunshiParams = DefaultGunshiParams> = (ctx: CommandContextCore<G>, cmd: Command<G>) => Awaitable<T>;
 /**
  * Plugin extension callback, which is called when the plugin is extended with `extension` option.
  *
@@ -765,11 +765,11 @@ ResolvedDepExt extends GunshiParams = GunshiParams<{
  *
  * @since v0.27.0
  */
-type Plugin<E$1 extends GunshiParams['extensions'] = DefaultGunshiParams['extensions']> = PluginFunction & {
+type Plugin<E extends GunshiParams['extensions'] = DefaultGunshiParams['extensions']> = PluginFunction & {
   id: string;
   name?: string;
   dependencies?: (PluginDependency | string)[];
-  extension?: CommandContextExtension<E$1>;
+  extension?: CommandContextExtension<E>;
 };
 /**
  * Plugin return type with extension, which includes the plugin ID, name, dependencies, and extension.
@@ -778,7 +778,7 @@ type Plugin<E$1 extends GunshiParams['extensions'] = DefaultGunshiParams['extens
  *
  * @typeParam E - A type extending {@link GunshiParams} to specify the shape of {@linkcode CommandContext}'s extensions.
  */
-interface PluginWithExtension<E$1 extends GunshiParams['extensions'] = DefaultGunshiParams['extensions']> extends Plugin<E$1> {
+interface PluginWithExtension<E extends GunshiParams['extensions'] = DefaultGunshiParams['extensions']> extends Plugin<E> {
   /**
    * Plugin identifier
    */
@@ -794,7 +794,7 @@ interface PluginWithExtension<E$1 extends GunshiParams['extensions'] = DefaultGu
   /**
    * Plugin extension
    */
-  extension: CommandContextExtension<E$1>;
+  extension: CommandContextExtension<E>;
 }
 /**
  * Plugin return type without extension, which includes the plugin ID, name, and dependencies, but no extension.
@@ -803,7 +803,7 @@ interface PluginWithExtension<E$1 extends GunshiParams['extensions'] = DefaultGu
  *
  * @typeParam E - A type extending {@link GunshiParams} to specify the shape of {@linkcode CommandContext}'s extensions.
  */
-interface PluginWithoutExtension<E$1 extends GunshiParams['extensions'] = DefaultGunshiParams['extensions']> extends Plugin<E$1> {
+interface PluginWithoutExtension<E extends GunshiParams['extensions'] = DefaultGunshiParams['extensions']> extends Plugin<E> {
   /**
    * Plugin identifier
    */
@@ -899,13 +899,13 @@ ResolvedDepExtensions extends GunshiParams = GunshiParams<{
  *
  * @typeParam T - The type of the value that can be awaited.
  */
-type Awaitable<T$1> = T$1 | Promise<T$1>;
+type Awaitable<T> = T | Promise<T>;
 /**
  * Prettify a type by flattening its structure.
  *
  * @typeParam T - The type to be prettified.
  */
-type Prettify<T$1> = { [K in keyof T$1]: T$1[K] } & {};
+type Prettify<T> = { [K in keyof T]: T[K] } & {};
 /**
  * Extend command context type. This type is used to extend the command context with additional properties at {@linkcode CommandContext.extensions}.
  *
@@ -1127,7 +1127,7 @@ interface CliOptions<G extends GunshiParamsConstraint = DefaultGunshiParams> {
   /**
    * Sub commands.
    */
-  subCommands?: Record<string, Command<any> | LazyCommand<any>> | Map<string, Command<any> | LazyCommand<any>>;
+  subCommands?: Record<string, SubCommandable> | Map<string, SubCommandable>;
   /**
    * Left margin of the command output.
    */
@@ -1314,7 +1314,7 @@ type CommandContextCore<G extends GunshiParamsConstraint = DefaultGunshiParams>
  *
  * @since v0.27.0
  */
-interface CommandContextExtension<E$1 extends GunshiParams['extensions'] = DefaultGunshiParams['extensions']> {
+interface CommandContextExtension<E extends GunshiParams['extensions'] = DefaultGunshiParams['extensions']> {
   /**
    * Plugin identifier
    */
@@ -1322,7 +1322,7 @@ interface CommandContextExtension<E$1 extends GunshiParams['extensions'] = Defau
   /**
    * Plugin extension factory
    */
-  readonly factory: (ctx: CommandContextCore, cmd: Command) => Awaitable<E$1>;
+  readonly factory: (ctx: CommandContextCore, cmd: Command) => Awaitable<E>;
   /**
    * Plugin extension factory after hook
    */
@@ -1435,6 +1435,60 @@ type LazyCommand<G extends GunshiParamsConstraint = DefaultGunshiParams, D exten
 } : {
   commandName?: string;
 }) & Omit<D, 'name' | 'run'> & Partial<Omit<Command<G>, keyof D | 'run' | 'name'>>;
+/**
+ * Sub-command entry type for use in subCommands.
+ *
+ * This type uses a loose structural match to bypass TypeScript's contravariance issues
+ * with function parameters, allowing any Command or LazyCommand to be used as a sub-command.
+ *
+ * @since v0.27.1
+ */
+interface SubCommandable {
+  /**
+   * see {@link Command.name}
+   */
+  name?: string;
+  /**
+   * see {@link Command.description}
+   */
+  description?: string;
+  /**
+   * see {@link Command.args}
+   */
+  args?: Args | Record<string, any>;
+  /**
+   * see {@link Command.examples}
+   */
+  examples?: string | ((...args: any[]) => any);
+  /**
+   * see {@link Command.run}
+   */
+  run?: (...args: any[]) => any;
+  /**
+   * see {@link Command.toKebab}
+   */
+  toKebab?: boolean;
+  /**
+   * see {@link Command.internal}
+   */
+  internal?: boolean;
+  /**
+   * see {@link Command.entry}
+   */
+  entry?: boolean;
+  /**
+   * see {@link Command.rendering}
+   */
+  rendering?: any;
+  /**
+   * see {@link LazyCommand.commandName}
+   */
+  commandName?: string;
+  /**
+   * Index signature to allow additional properties
+   */
+  [key: string]: any;
+}
 /**
  * Command examples fetcher.
  *
@@ -1480,7 +1534,7 @@ type CommandDecorator<G extends GunshiParamsConstraint = DefaultGunshiParams> =
  *
  * @since v0.27.0
  */
-type RendererDecorator<T$1, G extends GunshiParamsConstraint = DefaultGunshiParams> = (baseRenderer: (ctx: Readonly<CommandContext<G>>) => Promise<T$1>, ctx: Readonly<CommandContext<G>>) => Promise<T$1>;
+type RendererDecorator<T, G extends GunshiParamsConstraint = DefaultGunshiParams> = (baseRenderer: (ctx: Readonly<CommandContext<G>>) => Promise<T>, ctx: Readonly<CommandContext<G>>) => Promise<T>;
 /**
  * Validation errors renderer decorator type.
  * A function that wraps a validation errors renderer to add or modify its behavior.
@@ -1506,7 +1560,7 @@ declare const CLI_OPTIONS_DEFAULT: CliOptions<DefaultGunshiParams>;
  *
  * @internal
  */
-type ExtractExtensions$1<E$1 extends Record<string, CommandContextExtension>> = { [K in keyof E$1]: E$1[K] extends CommandContextExtension<infer T> ? T : never };
+type ExtractExtensions$1<E extends Record<string, CommandContextExtension>> = { [K in keyof E]: E[K] extends CommandContextExtension<infer T> ? T : never };
 /**
  * Parameters of {@link createCommandContext}
  */
@@ -1514,7 +1568,7 @@ interface CommandContextParams<G extends GunshiParams | {
   args: Args;
 } | {
   extensions: ExtendContext;
-}, V extends ArgValues<ExtractArgs<G>>, C extends Command<G> | LazyCommand<G> = Command<G>, E$1 extends Record<string, CommandContextExtension> = Record<string, CommandContextExtension>> {
+}, 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
    */
@@ -1558,7 +1612,7 @@ interface CommandContextParams<G extends GunshiParams | {
   /**
    * Plugin extensions to apply as the command context extension.
    */
-  extensions?: E$1;
+  extensions?: E;
   /**
    * A command options, which is spicialized from `cli` function
    */
@@ -1574,7 +1628,7 @@ interface CommandContextParams<G extends GunshiParams | {
  * @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$1 extends Record<string, CommandContextExtension> = {}>({
+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,
@@ -1588,9 +1642,9 @@ declare function createCommandContext<G extends GunshiParamsConstraint = Default
   callMode,
   omitted,
   validationError
-}: CommandContextParams<G, V, C, E$1>): Promise<{} extends ExtractExtensions$1<E$1> ? Readonly<CommandContext<G>> : Readonly<CommandContext<GunshiParams<{
+}: CommandContextParams<G, V, C, E>): Promise<{} extends ExtractExtensions$1<E> ? Readonly<CommandContext<G>> : Readonly<CommandContext<GunshiParams<{
   args: ExtractArgs<G>;
-  extensions: ExtractExtensions$1<E$1>;
+  extensions: ExtractExtensions$1<E>;
 }>>>>;
 //#endregion
 export { ANONYMOUS_COMMAND_NAME, type ArgSchema, type ArgToken, type ArgValues, type Args, Awaitable, CLI_OPTIONS_DEFAULT, Command, CommandContext, CommandContextCore, CommandContextExtension, CommandContextParams, CommandDecorator, CommandExamplesFetcher, CommandRunner, DefaultGunshiParams, ExtendContext, ExtractArgs, ExtractExtensions, GunshiParams, GunshiParamsConstraint, LazyCommand, NormalizeToGunshiParams, OnPluginExtension, Plugin, PluginContext, PluginDependency, PluginExtension, PluginFunction, PluginOptions, PluginWithExtension, PluginWithoutExtension, Prettify, RendererDecorator, ValidationErrorsDecorator, createCommandContext, plugin };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@gunshi/plugin",
   "description": "plugin development kit for gunshi",
-  "version": "0.27.0",
+  "version": "0.27.4",
   "author": {
     "name": "kazuya kawaguchi",
     "email": "kawakazu80@gmail.com"
@@ -56,7 +56,7 @@
     "jsr-exports-lint": "^0.4.1",
     "publint": "^0.3.16",
     "tsdown": "0.15.12",
-    "gunshi": "0.27.0"
+    "gunshi": "0.27.4"
   },
   "scripts": {
     "build": "tsdown",