feat(default): support default sub command (unjs#153)

fu050409 · Jul 5, 2024 · 274cd07 · 274cd07
1 parent 53cd585
commit 274cd07
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 1 deletion.
diff --git a/src/command.ts b/src/command.ts
@@ -33,6 +33,15 @@ export async function runCommand<T extends ArgsDef = ArgsDef>(
     await cmd.setup(context);
   }
 
+  // Checkout default sub command
+  const defaultSubCommand = await resolveValue(cmd.default);
+  if (defaultSubCommand && cmd.run) {
+    throw new CLIError(
+      `Command has a handler specified and a default sub command.`,
+      "E_DUPLICATE_COMMAND",
+    );
+  }
+
   // Handle sub command
   let result: unknown;
   try {
@@ -41,7 +50,8 @@ export async function runCommand<T extends ArgsDef = ArgsDef>(
       const subCommandArgIndex = opts.rawArgs.findIndex(
         (arg) => !arg.startsWith("-"),
       );
-      const subCommandName = opts.rawArgs[subCommandArgIndex];
+      const subCommandName =
+        opts.rawArgs[subCommandArgIndex] || defaultSubCommand;
       if (subCommandName) {
         if (!subCommands[subCommandName]) {
           throw new CLIError(

diff --git a/src/types.ts b/src/types.ts
@@ -90,6 +90,7 @@ export type SubCommandsDef = Record<string, Resolvable<CommandDef<any>>>;
 export type CommandDef<T extends ArgsDef = ArgsDef> = {
   meta?: Resolvable<CommandMeta>;
   args?: Resolvable<T>;
+  default?: Resolvable<keyof ArgsDef | string>;
   subCommands?: Resolvable<SubCommandsDef>;
   setup?: (context: CommandContext<T>) => any | Promise<any>;
   cleanup?: (context: CommandContext<T>) => any | Promise<any>;