@gunshi/bone 0.27.0 → 0.27.2

package/lib/index.d.ts

@@ -484,8 +484,8 @@ type IsFunction<T> = T 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> = A$1['multiple'] extends true ? T[] : T;
+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> = A$1['multiple'] extends true
  *
  * @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.
  *
@@ -682,11 +682,11 @@ type PluginFunction<G extends GunshiParams = DefaultGunshiParams> = (ctx: Readon
  *
  * @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>;
 };
 //#endregion
 //#region ../gunshi/src/types.d.ts
@@ -923,7 +923,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.
    */
@@ -1110,7 +1110,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
    */
@@ -1118,7 +1118,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
    */
@@ -1237,6 +1237,38 @@ type LazyCommand<G extends GunshiParamsConstraint = DefaultGunshiParams, D exten
  * @typeParam G - A type extending {@linkcode GunshiParams} to specify the shape of command.
  */
 type Commandable<G extends GunshiParamsConstraint = DefaultGunshiParams> = Command<G> | LazyCommand<G, {}>;
+/**
+ * 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.
  *
@@ -1320,8 +1352,8 @@ type ValidationErrorsDecorator<G extends GunshiParamsConstraint = DefaultGunshiP
  * @param options - A {@link CliOptions | CLI options}
  * @returns A rendered usage or undefined. if you will use {@linkcode CliOptions.usageSilent} option, it will return rendered usage string.
  */
-declare function cli<A$1 extends Args = Args, G extends GunshiParams = {
-  args: A$1;
+declare function cli<A extends Args = Args, G extends GunshiParams = {
+  args: A;
   extensions: {};
 }>(args: string[], entry: Command<G> | CommandRunner<G> | LazyCommand<G>, options?: CliOptions<G>): Promise<string | undefined>;
 /**
@@ -1334,9 +1366,9 @@ declare function cli<A$1 extends Args = Args, G extends GunshiParams = {
  * @param options - A {@link CliOptions | CLI options}
  * @returns A rendered usage or undefined. if you will use {@link CliOptions.usageSilent} option, it will return rendered usage string.
  */
-declare function cli<E$1 extends ExtendContext = ExtendContext, G extends GunshiParams = {
+declare function cli<E extends ExtendContext = ExtendContext, G extends GunshiParams = {
   args: Args;
-  extensions: E$1;
+  extensions: E;
 }>(args: string[], entry: Command<G> | CommandRunner<G> | LazyCommand<G>, options?: CliOptions<G>): Promise<string | undefined>;
 /**
  * Run the command.
@@ -1350,4 +1382,4 @@ declare function cli<E$1 extends ExtendContext = ExtendContext, G extends Gunshi
  */
 declare function cli<G extends GunshiParams = DefaultGunshiParams>(args: string[], entry: Command<G> | CommandRunner<G> | LazyCommand<G>, options?: CliOptions<G>): Promise<string | undefined>;
 //#endregion
-export { type ArgSchema, type ArgToken, type ArgValues, type Args, Awaitable, CliOptions, Command, CommandCallMode, CommandContext, CommandContextCore, CommandContextExtension, CommandDecorator, CommandEnvironment, CommandExamplesFetcher, CommandLoader, CommandRunner, Commandable, DefaultGunshiParams, ExtendContext, ExtractArgExplicitlyProvided, ExtractArgs, ExtractExtensions, GunshiParams, GunshiParamsConstraint, LazyCommand, NormalizeToGunshiParams, Prettify, RendererDecorator, RenderingOptions, ValidationErrorsDecorator, cli };
+export { type ArgSchema, type ArgToken, type ArgValues, type Args, Awaitable, CliOptions, Command, CommandCallMode, CommandContext, CommandContextCore, CommandContextExtension, CommandDecorator, CommandEnvironment, CommandExamplesFetcher, CommandLoader, CommandRunner, Commandable, DefaultGunshiParams, ExtendContext, ExtractArgExplicitlyProvided, ExtractArgs, ExtractExtensions, GunshiParams, GunshiParamsConstraint, LazyCommand, NormalizeToGunshiParams, Prettify, RendererDecorator, RenderingOptions, SubCommandable, ValidationErrorsDecorator, cli };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@gunshi/bone",
   "description": "gunshi minimum",
-  "version": "0.27.0",
+  "version": "0.27.2",
   "author": {
     "name": "kazuya kawaguchi",
     "email": "kawakazu80@gmail.com"
@@ -56,10 +56,10 @@
     "jsr-exports-lint": "^0.4.1",
     "publint": "^0.3.16",
     "tsdown": "0.15.12",
-    "@gunshi/definition": "0.27.0",
-    "@gunshi/plugin-global": "0.27.0",
-    "gunshi": "0.27.0",
-    "@gunshi/plugin-renderer": "0.27.0"
+    "@gunshi/plugin-global": "0.27.2",
+    "@gunshi/definition": "0.27.2",
+    "@gunshi/plugin-renderer": "0.27.2",
+    "gunshi": "0.27.2"
   },
   "scripts": {
     "build": "tsdown",