fix: fix generic type issues (#38)

unjs · Jun 18, 2023 · 1b57ba3 · 1b57ba3
1 parent d181698
commit 1b57ba3
Show file tree

Hide file tree

Showing 5 changed files with 28 additions and 16 deletions.
diff --git a/src/args.ts b/src/args.ts
@@ -3,7 +3,10 @@ import { parseRawArgs } from "./_parser";
 import type { Arg, ArgsDef, ParsedArgs } from "./types";
 import { CLIError, toArray } from "./_utils";
 
-export function parseArgs(rawArgs: string[], argsDef: ArgsDef): ParsedArgs {
+export function parseArgs<T extends ArgsDef = ArgsDef>(
+  rawArgs: string[],
+  argsDef: ArgsDef
+): ParsedArgs<T> {
   const parseOptions = {
     boolean: [] as string[],
     string: [] as string[],
@@ -58,7 +61,7 @@ export function parseArgs(rawArgs: string[], argsDef: ArgsDef): ParsedArgs {
     }
   }
 
-  return parsedArgsProxy;
+  return parsedArgsProxy as ParsedArgs<T>;
 }
 
 export function resolveArgs(argsDef: ArgsDef): Arg[] {

diff --git a/src/command.ts b/src/command.ts
@@ -13,14 +13,14 @@ export interface RunCommandOptions {
   showUsage?: boolean;
 }
 
-export async function runCommand(
-  cmd: CommandDef,
+export async function runCommand<T extends ArgsDef = ArgsDef>(
+  cmd: CommandDef<T>,
   opts: RunCommandOptions
 ): Promise<void> {
   const cmdArgs = await resolveValue(cmd.args || {});
-  const parsedArgs = parseArgs(opts.rawArgs, cmdArgs);
+  const parsedArgs = parseArgs<T>(opts.rawArgs, cmdArgs);
 
-  const context: CommandContext = {
+  const context: CommandContext<T> = {
     rawArgs: opts.rawArgs,
     args: parsedArgs,
     cmd,
@@ -64,11 +64,11 @@ export async function runCommand(
   }
 }
 
-export async function resolveSubCommand(
-  cmd: CommandDef,
+export async function resolveSubCommand<T extends ArgsDef = ArgsDef>(
+  cmd: CommandDef<T>,
   rawArgs: string[],
-  parent?: CommandDef
-): Promise<[CommandDef, CommandDef?]> {
+  parent?: CommandDef<T>
+): Promise<[CommandDef<T>, CommandDef<T>?]> {
   const subCommands = await resolveValue(cmd.subCommands);
   if (subCommands && Object.keys(subCommands).length > 0) {
     const subCommandArgIndex = rawArgs.findIndex((arg) => !arg.startsWith("-"));

diff --git a/src/main.ts b/src/main.ts
@@ -1,5 +1,5 @@
 import { bgRed } from "colorette";
-import type { CommandDef } from "./types";
+import type { ArgsDef, CommandDef } from "./types";
 import { resolveSubCommand, runCommand } from "./command";
 import { CLIError } from "./_utils";
 import { showUsage } from "./usage";
@@ -8,7 +8,10 @@ export interface RunMainOptions {
   rawArgs?: string[];
 }
 
-export async function runMain(cmd: CommandDef, opts: RunMainOptions = {}) {
+export async function runMain<T extends ArgsDef = ArgsDef>(
+  cmd: CommandDef<T>,
+  opts: RunMainOptions = {}
+) {
   const rawArgs = opts.rawArgs || process.argv.slice(2);
   try {
     if (rawArgs.includes("--help") || rawArgs.includes("-h")) {

diff --git a/src/types.ts b/src/types.ts
@@ -62,7 +62,7 @@ export type CommandDef<T extends ArgsDef = ArgsDef> = {
 export type CommandContext<T extends ArgsDef = ArgsDef> = {
   rawArgs: string[];
   args: ParsedArgs<T>;
-  cmd: CommandDef;
+  cmd: CommandDef<T>;
   subCommand?: CommandDef<T>;
 };
 

diff --git a/src/usage.ts b/src/usage.ts
@@ -1,16 +1,22 @@
 import { formatLineColumns, resolveValue } from "./_utils";
-import type { CommandDef } from "./types";
+import type { ArgsDef, CommandDef } from "./types";
 import { resolveArgs } from "./args";
 
-export async function showUsage(cmd: CommandDef, parent?: CommandDef) {
+export async function showUsage<T extends ArgsDef = ArgsDef>(
+  cmd: CommandDef<T>,
+  parent?: CommandDef<T>
+) {
   try {
     console.log((await renderUsage(cmd, parent)) + "\n");
   } catch (error) {
     console.error(error);
   }
 }
 
-export async function renderUsage(cmd: CommandDef, parent?: CommandDef) {
+export async function renderUsage<T extends ArgsDef = ArgsDef>(
+  cmd: CommandDef<T>,
+  parent?: CommandDef<T>
+) {
   const cmdMeta = await resolveValue(cmd.meta || {});
   const cmdArgs = resolveArgs(await resolveValue(cmd.args || {}));
   const parentMeta = await resolveValue(parent?.meta || {});