Add Command.options to TypeScript (#1827)

Make options and commands readonly to discourage direct manipulation. Co-authored-by: Cynthia <cynthia@cynthia.dev> Co-authored-by: Marcelo Shima <marceloshima@gmail.com> Co-authored-by: Dmitry Maganov <vonagam@gmail.com>
tj · Nov 29, 2022 · 04fc0fd · 04fc0fd
1 parent e0f6173
commit 04fc0fd
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 2 deletions.
diff --git a/typings/index.d.ts b/typings/index.d.ts
@@ -277,7 +277,8 @@ export interface OptionValues {
 export class Command {
   args: string[];
   processedArgs: any[];
-  commands: Command[];
+  readonly commands: readonly Command[];
+  readonly options: readonly Option[];
   parent: Command | null;
 
   constructor(name?: string);

diff --git a/typings/index.test-d.ts b/typings/index.test-d.ts
@@ -28,7 +28,8 @@ expectType<commander.Argument>(commander.createArgument('<foo>'));
 expectType<string[]>(program.args);
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 expectType<any[]>(program.processedArgs);
-expectType<commander.Command[]>(program.commands);
+expectType<readonly commander.Command[]>(program.commands);
+expectType<readonly commander.Option[]>(program.options);
 expectType<commander.Command | null>(program.parent);
 
 // version