alepha 0.9.4 → 0.10.0

package/command.d.ts

@@ -3,7 +3,7 @@ import { Alepha, AlephaError, Async, Descriptor, KIND, Static, TObject, TSchema
 import * as fs from "node:fs/promises";
 import { glob } from "node:fs/promises";
 import * as _alepha_logger0 from "alepha/logger";
-import * as _sinclair_typebox0 from "@sinclair/typebox";
+import * as typebox0 from "typebox";
 
 //#region src/helpers/Runner.d.ts
 type Task = {
@@ -59,14 +59,14 @@ declare class Runner {
  * within your Alepha application structure.
  */
 declare const $command: {
-  <T extends TObject>(options: CommandDescriptorOptions<T>): CommandDescriptor<T>;
+  <T extends TObject, A extends TSchema>(options: CommandDescriptorOptions<T, A>): CommandDescriptor<T, A>;
   [KIND]: typeof CommandDescriptor;
 };
-interface CommandDescriptorOptions<T extends TObject> {
+interface CommandDescriptorOptions<T extends TObject, A extends TSchema> {
   /**
    * The handler function to execute when the command is matched.
    */
-  handler: (args: CommandHandlerArgs<T>) => Async<void>;
+  handler: (args: CommandHandlerArgs<T, A>) => Async<void>;
   /**
    * The name of the command. If omitted, the property key is used.
    *
@@ -85,18 +85,36 @@ interface CommandDescriptorOptions<T extends TObject> {
    * A TypeBox object schema defining the flags for the command.
    */
   flags?: T;
+  /**
+   * An optional TypeBox schema defining the arguments for the command.
+   *
+   * @example
+   * args: t.string()
+   * my-cli command <arg1: string>
+   *
+   * args: t.optional(t.string())
+   * my-cli command [arg1: string]
+   *
+   * args: t.tuple([t.string(), t.number()])
+   * my-cli command <arg1: string> <arg2: number>
+   *
+   * args: t.tuple([t.string(), t.optional(t.number())])
+   * my-cli command <arg1: string> [arg2: number]
+   */
+  args?: A;
   /**
    * If false, skip summary message at the end of the command execution.
    */
   summary?: boolean;
 }
-declare class CommandDescriptor<T extends TObject = TObject> extends Descriptor<CommandDescriptorOptions<T>> {
+declare class CommandDescriptor<T extends TObject = TObject, A extends TSchema = TSchema> extends Descriptor<CommandDescriptorOptions<T, A>> {
   readonly flags: TObject<{}>;
   readonly aliases: string[];
   get name(): string;
 }
-interface CommandHandlerArgs<T extends TObject> {
+interface CommandHandlerArgs<T extends TObject, A extends TSchema = TSchema> {
   flags: Static<T>;
+  args: A extends TSchema ? Static<A> : undefined;
   run: RunnerMethod;
   glob: typeof glob;
   fs: typeof fs;
@@ -132,7 +150,7 @@ declare class CliProvider {
     help: {
       aliases: string[];
       description: string;
-      schema: _sinclair_typebox0.TBoolean;
+      schema: typebox0.TBoolean;
     };
   };
   protected readonly onReady: _alepha_core1.HookDescriptor<"ready">;
@@ -144,6 +162,10 @@ declare class CliProvider {
     aliases: string[];
     schema: TSchema;
   }[]): Record<string, any>;
+  protected parseCommandArgs(argv: string[], schema?: TSchema): any;
+  protected parseArgumentValue(value: string, schema: TSchema): any;
+  protected generateArgsUsage(schema?: TSchema): string;
+  protected getTypeName(schema: TSchema): string;
   printHelp(command?: CommandDescriptor<any>): void;
   private getMaxCmdLength;
   private getMaxFlagLength;
@@ -160,7 +182,7 @@ declare class CliProvider {
  * @module alepha.command
  */
 declare const AlephaCommand: _alepha_core1.Service<_alepha_core1.Module>;
-declare module "@sinclair/typebox" {
+declare module "typebox" {
   interface StringOptions {
     /**
      * Additional aliases for the flags.
@@ -170,6 +192,8 @@ declare module "@sinclair/typebox" {
     aliases?: string[];
   }
 }
+//# sourceMappingURL=index.d.ts.map
+
 //#endregion
 export { $command, AlephaCommand, CliProvider, CommandDescriptor, CommandDescriptorOptions, CommandError, CommandHandlerArgs, RunOptions, Runner, RunnerMethod, Task };
 //# sourceMappingURL=index.d.ts.map