@gunshi/definition 0.27.0 → 0.27.2

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.
  *
@@ -485,7 +485,7 @@ 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 ResolveOptionValue<A$1 extends ArgSchema, T> = A$1['multiple'] extends true ? T[] : T;
 /**
  * Resolved argument values.
  *
@@ -695,13 +695,13 @@ type Plugin<E$1 extends GunshiParams['extensions'] = DefaultGunshiParams['extens
  *
  * @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}.
  *
@@ -912,7 +912,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.
    */
@@ -1220,6 +1220,38 @@ 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 {
+  /** Command name */
+  name?: string;
+  /** Command description */
+  description?: string;
+  /** Command arguments - accepts any args structure */
+  args?: Args | Record<string, any>;
+  /** Command examples */
+  examples?: string | ((...args: any[]) => any);
+  /** Command runner */
+  run?: (...args: any[]) => any;
+  /** Whether to convert camelCase to kebab-case */
+  toKebab?: boolean;
+  /** Whether this is an internal command */
+  internal?: boolean;
+  /** Whether this is an entry command */
+  entry?: boolean;
+  /** Rendering options */
+  rendering?: any;
+  /** Command name for lazy commands */
+  commandName?: string;
+  /** Index signature to allow additional properties */
+  [key: string]: any;
+}
 /**
  * Command examples fetcher.
  *

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@gunshi/definition",
   "description": "utilities for gunshi command definition",
-  "version": "0.27.0",
+  "version": "0.27.2",
   "author": {
     "name": "kazuya kawaguchi",
     "email": "kawakazu80@gmail.com"
@@ -57,7 +57,7 @@
     "jsr-exports-lint": "^0.4.1",
     "publint": "^0.3.16",
     "tsdown": "0.15.12",
-    "gunshi": "0.27.0"
+    "gunshi": "0.27.2"
   },
   "scripts": {
     "build": "tsdown",