Preserve option typings when adding arguments to Command (#49)

commander-js · Oct 15, 2023 · a6f71e5 · a6f71e5
1 parent 1c29b98
commit a6f71e5
Show file tree

Hide file tree

Showing 2 changed files with 31 additions and 6 deletions.
diff --git a/index.d.ts b/index.d.ts
@@ -549,21 +549,21 @@ export class CommanderError extends Error {
      * @returns `this` command for chaining
      */
     argument<S extends string, T>(
-        flags: S, description: string, fn: (value: string, previous: T) => T): Command<[...Args, InferArgument<S, undefined, T>]>;
+        flags: S, description: string, fn: (value: string, previous: T) => T): Command<[...Args, InferArgument<S, undefined, T>], Opts>;
     argument<S extends string, T>(
-        flags: S, description: string, fn: (value: string, previous: T) => T, defaultValue: T): Command<[...Args, InferArgument<S, T, T>]>;
+        flags: S, description: string, fn: (value: string, previous: T) => T, defaultValue: T): Command<[...Args, InferArgument<S, T, T>], Opts>;
     argument<S extends string>(
-        usage: S, description?: string): Command<[...Args, InferArgument<S, undefined>]>;
+        usage: S, description?: string): Command<[...Args, InferArgument<S, undefined>], Opts>;
     argument<S extends string, DefaultT>(
-        usage: S, description: string, defaultValue: DefaultT): Command<[...Args, InferArgument<S, DefaultT>]>;
+        usage: S, description: string, defaultValue: DefaultT): Command<[...Args, InferArgument<S, DefaultT>], Opts>;
 
     /**
      * Define argument syntax for command, adding a prepared argument.
      *
      * @returns `this` command for chaining
      */
     addArgument<Usage extends string, DefaultT, CoerceT, ArgRequired extends boolean|undefined, ChoicesT>(
-      arg: Argument<Usage, DefaultT, CoerceT, ArgRequired, ChoicesT>): Command<[...Args, InferArgument<Usage, DefaultT, CoerceT, ArgRequired, ChoicesT>]>;
+      arg: Argument<Usage, DefaultT, CoerceT, ArgRequired, ChoicesT>): Command<[...Args, InferArgument<Usage, DefaultT, CoerceT, ArgRequired, ChoicesT>], Opts>;
 
 
     /**
@@ -578,7 +578,7 @@ export class CommanderError extends Error {
      *
      * @returns `this` command for chaining
      */
-    arguments<Names extends string>(args: Names): Command<[...Args, ...InferArguments<Names>]>;
+    arguments<Names extends string>(args: Names): Command<[...Args, ...InferArguments<Names>], Opts>;
 
 
     /**

diff --git a/tests/arguments.test-d.ts b/tests/arguments.test-d.ts
@@ -385,3 +385,28 @@ expectType<('C')>(
     .parse()
     .processedArgs[0]
 )
+
+// adding argument preserves options
+expectType<({ example?: true })>(
+  program
+    .option('--example')
+    .argument('<arg>', 'arg description')
+    .parse()
+    .opts()
+)
+
+expectType<({ example?: true })>(
+  program
+    .option('--example')
+    .arguments('<arg1> [arg2]')
+    .parse()
+    .opts()
+)
+
+expectType<({ example?: true })>(
+  program
+    .option('--example')
+    .addArgument(new Argument('<arg>'))
+    .parse()
+    .opts()
+)