Add a sanity check to ensure that CommandLineAction is initialized in the expected order. (In the future the order will be relaxed.)

pgonzal · pgonzal · commit 0b1da2e53b6e · 2018-04-16T18:25:08.000-07:00
diff --git a/common/reviews/api/ts-command-line.api.ts b/common/reviews/api/ts-command-line.api.ts
@@ -14,6 +14,8 @@ class CommandLineAction extends CommandLineParameterProvider {
   // @internal
   _execute(): Promise<void>;
   // @internal
+  protected _getArgumentParser(): argparse.ArgumentParser;
+  // @internal
   _processParsedData(data: ICommandLineParserData): void;
   protected abstract onDefineParameters(): void;
   protected abstract onExecute(): Promise<void>;
@@ -72,7 +74,7 @@ class CommandLineParameterProvider {
   // @internal
   constructor();
   // @internal
-  protected _argumentParser: argparse.ArgumentParser;
+  protected abstract _getArgumentParser(): argparse.ArgumentParser;
   // @internal (undocumented)
   protected _processParsedData(data: ICommandLineParserData): void;
   defineChoiceParameter(definition: ICommandLineChoiceDefinition): CommandLineChoiceParameter;
@@ -92,6 +94,8 @@ class CommandLineParameterProvider {
 // @public
 class CommandLineParser extends CommandLineParameterProvider {
   constructor(options: ICommandLineParserOptions);
+  // @internal
+  protected _getArgumentParser(): argparse.ArgumentParser;
   addAction(action: CommandLineAction): void;
   execute(args?: string[]): Promise<boolean>;
   executeWithoutErrorHandling(args?: string[]): Promise<void>;
diff --git a/libraries/ts-command-line/src/CommandLineAction.ts b/libraries/ts-command-line/src/CommandLineAction.ts
@@ -41,9 +41,12 @@ export abstract class CommandLineAction extends CommandLineParameterProvider {
    */
   public options: ICommandLineActionOptions;
 
+  private _argumentParser: argparse.ArgumentParser | undefined;
+
   constructor(options: ICommandLineActionOptions) {
     super();
     this.options = options;
+    this._argumentParser = undefined;
   }
 
   /**
@@ -75,6 +78,19 @@ export abstract class CommandLineAction extends CommandLineParameterProvider {
     return this.onExecute();
   }
 
+  /**
+   * {@inheritdoc CommandLineParameterProvider._getArgumentParser}
+   * @internal
+   */
+  protected _getArgumentParser(): argparse.ArgumentParser { // override
+    if (!this._argumentParser) {
+      // We will improve this in the future
+      throw new Error('The CommandLineAction must be added to a CommandLineParser before it can be used');
+    }
+
+    return this._argumentParser;
+  }
+
   /**
    * {@inheritdoc CommandLineParameterProvider.onDefineParameters}
    */
diff --git a/libraries/ts-command-line/src/CommandLineParameterProvider.ts b/libraries/ts-command-line/src/CommandLineParameterProvider.ts
@@ -42,12 +42,6 @@ export interface ICommandLineParserData {
 export abstract class CommandLineParameterProvider {
   private static _keyCounter: number = 0;
 
-  /**
-   * NOTE: THIS IS INTERNAL.  IN THE FUTURE, WE MAY REPLACE "argparse" WITH A DIFFERENT ENGINE.
-   * @internal
-   */
-  protected _argumentParser: argparse.ArgumentParser;
-
   private _parameters: CommandLineParameter<any>[];
   private _parametersByLongName: Map<string, CommandLineParameter<any>>;
 
@@ -169,7 +163,7 @@ export abstract class CommandLineParameterProvider {
    * Generates the command-line help text.
    */
   public renderHelpText(): string {
-    return this._argumentParser.formatHelp();
+    return this._getArgumentParser().formatHelp();
   }
 
   /**
@@ -178,6 +172,12 @@ export abstract class CommandLineParameterProvider {
    */
   protected abstract onDefineParameters(): void;
 
+  /**
+   * Retrieves the argparse object.
+   * @internal
+   */
+  protected abstract _getArgumentParser(): argparse.ArgumentParser;
+
   /** @internal */
   protected _processParsedData(data: ICommandLineParserData): void {
     // Fill in the values for the parameters
@@ -237,7 +237,7 @@ export abstract class CommandLineParameterProvider {
         break;
     }
 
-    this._argumentParser.addArgument(names, argparseOptions);
+    this._getArgumentParser().addArgument(names, argparseOptions);
 
     this._parameters.push(parameter);
     this._parametersByLongName.set(parameter.longName, parameter);
diff --git a/libraries/ts-command-line/src/CommandLineParser.ts b/libraries/ts-command-line/src/CommandLineParser.ts
@@ -47,6 +47,7 @@ export abstract class CommandLineParser extends CommandLineParameterProvider {
    */
   public selectedAction: CommandLineAction;
 
+  private _argumentParser: argparse.ArgumentParser;
   private _actionsSubParser: argparse.SubParser;
   private _options: ICommandLineParserOptions;
   private _actions: CommandLineAction[];
@@ -144,6 +145,14 @@ export abstract class CommandLineParser extends CommandLineParameterProvider {
     }
   }
 
+  /**
+   * {@inheritdoc CommandLineParameterProvider._getArgumentParser}
+   * @internal
+   */
+  protected _getArgumentParser(): argparse.ArgumentParser { // override
+    return this._argumentParser;
+  }
+
   /**
    * This hook allows the subclass to perform additional operations before or after
    * the chosen action is executed.
