@rushstack/ts-command-line 4.10.10 → 4.12.0

package/lib/providers/CommandLineAction.d.ts

@@ -1,5 +1,6 @@
 import * as argparse from 'argparse';
 import { CommandLineParameterProvider, ICommandLineParserData } from './CommandLineParameterProvider';
+import type { ICommandLineParserOptions } from './CommandLineParser';
 /**
  * Options for the CommandLineAction constructor.
  * @public
@@ -53,7 +54,7 @@ export declare abstract class CommandLineAction extends CommandLineParameterProv
      * This is called internally by CommandLineParser.execute()
      * @internal
      */
-    _processParsedData(data: ICommandLineParserData): void;
+    _processParsedData(parserOptions: ICommandLineParserOptions, data: ICommandLineParserData): void;
     /**
      * Invoked by CommandLineParser.onExecute().
      * @internal

package/lib/providers/CommandLineAction.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"CommandLineAction.d.ts","sourceRoot":"","sources":["../../src/providers/CommandLineAction.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,QAAQ,MAAM,UAAU,CAAC;AACrC,OAAO,EAAE,4BAA4B,EAAE,sBAAsB,EAAE,MAAM,gCAAgC,CAAC;AAEtG;;;GAGG;AACH,MAAM,WAAW,yBAAyB;IACxC;;;OAGG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,aAAa,EAAE,MAAM,CAAC;CACvB;AAED;;;;;;;;;;;;GAYG;AACH,8BAAsB,iBAAkB,SAAQ,4BAA4B;IAE1E,OAAO,CAAC,MAAM,CAAC,iBAAiB,CAA8C;IAE9E,yDAAyD;IACzD,SAAgB,UAAU,EAAE,MAAM,CAAC;IAEnC,sDAAsD;IACtD,SAAgB,OAAO,EAAE,MAAM,CAAC;IAEhC,4DAA4D;IAC5D,SAAgB,aAAa,EAAE,MAAM,CAAC;IAEtC,OAAO,CAAC,eAAe,CAAsC;gBAE1C,OAAO,EAAE,yBAAyB;IAiBrD;;;OAGG;IACI,YAAY,CAAC,gBAAgB,EAAE,QAAQ,CAAC,SAAS,GAAG,IAAI;IAS/D;;;OAGG;IACI,kBAAkB,CAAC,IAAI,EAAE,sBAAsB,GAAG,IAAI;IAI7D;;;OAGG;IACI,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC;IAIhC;;;OAGG;IACH,SAAS,CAAC,kBAAkB,IAAI,QAAQ,CAAC,cAAc;IAUvD;;OAEG;IACH,SAAS,CAAC,QAAQ,CAAC,kBAAkB,IAAI,IAAI;IAE7C;;OAEG;IACH,SAAS,CAAC,QAAQ,CAAC,SAAS,IAAI,OAAO,CAAC,IAAI,CAAC;CAC9C"}
+{"version":3,"file":"CommandLineAction.d.ts","sourceRoot":"","sources":["../../src/providers/CommandLineAction.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,QAAQ,MAAM,UAAU,CAAC;AAErC,OAAO,EAAE,4BAA4B,EAAE,sBAAsB,EAAE,MAAM,gCAAgC,CAAC;AACtG,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,qBAAqB,CAAC;AAErE;;;GAGG;AACH,MAAM,WAAW,yBAAyB;IACxC;;;OAGG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,aAAa,EAAE,MAAM,CAAC;CACvB;AAED;;;;;;;;;;;;GAYG;AACH,8BAAsB,iBAAkB,SAAQ,4BAA4B;IAE1E,OAAO,CAAC,MAAM,CAAC,iBAAiB,CAA8C;IAE9E,yDAAyD;IACzD,SAAgB,UAAU,EAAE,MAAM,CAAC;IAEnC,sDAAsD;IACtD,SAAgB,OAAO,EAAE,MAAM,CAAC;IAEhC,4DAA4D;IAC5D,SAAgB,aAAa,EAAE,MAAM,CAAC;IAEtC,OAAO,CAAC,eAAe,CAAsC;gBAE1C,OAAO,EAAE,yBAAyB;IAiBrD;;;OAGG;IACI,YAAY,CAAC,gBAAgB,EAAE,QAAQ,CAAC,SAAS,GAAG,IAAI;IAS/D;;;OAGG;IACI,kBAAkB,CAAC,aAAa,EAAE,yBAAyB,EAAE,IAAI,EAAE,sBAAsB,GAAG,IAAI;IAIvG;;;OAGG;IACI,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC;IAIhC;;;OAGG;IACH,SAAS,CAAC,kBAAkB,IAAI,QAAQ,CAAC,cAAc;IAUvD;;OAEG;IACH,SAAS,CAAC,QAAQ,CAAC,kBAAkB,IAAI,IAAI;IAE7C;;OAEG;IACH,SAAS,CAAC,QAAQ,CAAC,SAAS,IAAI,OAAO,CAAC,IAAI,CAAC;CAC9C"}

package/lib/providers/CommandLineAction.js

@@ -44,8 +44,8 @@ class CommandLineAction extends CommandLineParameterProvider_1.CommandLineParame
      * This is called internally by CommandLineParser.execute()
      * @internal
      */
-    _processParsedData(data) {
-        super._processParsedData(data);
+    _processParsedData(parserOptions, data) {
+        super._processParsedData(parserOptions, data);
     }
     /**
      * Invoked by CommandLineParser.onExecute().

package/lib/providers/CommandLineAction.js.map

@@ -1 +1 @@
-{"version":3,"file":"CommandLineAction.js","sourceRoot":"","sources":["../../src/providers/CommandLineAction.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D;;;AAG3D,iFAAsG;AA0BtG;;;;;;;;;;;;GAYG;AACH,MAAsB,iBAAkB,SAAQ,2DAA4B;IAe1E,YAAmB,OAAkC;QACnD,KAAK,EAAE,CAAC;QAER,IAAI,CAAC,iBAAiB,CAAC,iBAAiB,CAAC,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE;YACjE,MAAM,IAAI,KAAK,CACb,wBAAwB,OAAO,CAAC,UAAU,KAAK;gBAC7C,2FAA2F,CAC9F,CAAC;SACH;QAED,IAAI,CAAC,UAAU,GAAG,OAAO,CAAC,UAAU,CAAC;QACrC,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;QAC/B,IAAI,CAAC,aAAa,GAAG,OAAO,CAAC,aAAa,CAAC;QAE3C,IAAI,CAAC,eAAe,GAAG,SAAS,CAAC;IACnC,CAAC;IAED;;;OAGG;IACI,YAAY,CAAC,gBAAoC;QACtD,IAAI,CAAC,eAAe,GAAG,gBAAgB,CAAC,SAAS,CAAC,IAAI,CAAC,UAAU,EAAE;YACjE,IAAI,EAAE,IAAI,CAAC,OAAO;YAClB,WAAW,EAAE,IAAI,CAAC,aAAa;SAChC,CAAC,CAAC;QAEH,IAAI,CAAC,kBAAkB,EAAE,CAAC;IAC5B,CAAC;IAED;;;OAGG;IACI,kBAAkB,CAAC,IAA4B;QACpD,KAAK,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAAC;IACjC,CAAC;IAED;;;OAGG;IACI,QAAQ;QACb,OAAO,IAAI,CAAC,SAAS,EAAE,CAAC;IAC1B,CAAC;IAED;;;OAGG;IACO,kBAAkB;QAC1B,WAAW;QACX,IAAI,CAAC,IAAI,CAAC,eAAe,EAAE;YACzB,qCAAqC;YACrC,MAAM,IAAI,KAAK,CAAC,kFAAkF,CAAC,CAAC;SACrG;QAED,OAAO,IAAI,CAAC,eAAe,CAAC;IAC9B,CAAC;;AAzEH,8CAoFC;AAnFC,0BAA0B;AACX,mCAAiB,GAAW,kCAAkC,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.\n// See LICENSE in the project root for license information.\n\nimport * as argparse from 'argparse';\nimport { CommandLineParameterProvider, ICommandLineParserData } from './CommandLineParameterProvider';\n\n/**\n * Options for the CommandLineAction constructor.\n * @public\n */\nexport interface ICommandLineActionOptions {\n  /**\n   * The name of the action.  For example, if the tool is called \"example\",\n   * then the \"build\" action might be invoked as: \"example build -q --some-other-option\"\n   */\n  actionName: string;\n\n  /**\n   * A quick summary that is shown on the main help page, which is displayed\n   * by the command \"example --help\"\n   */\n  summary: string;\n\n  /**\n   * A detailed description that is shown on the action help page, which is displayed\n   * by the command \"example build --help\", e.g. for actionName=\"build\".\n   */\n  documentation: string;\n}\n\n/**\n * Represents a sub-command that is part of the CommandLineParser command line.\n * Applications should create subclasses of CommandLineAction corresponding to\n * each action that they want to expose.\n *\n * The action name should be comprised of lower case words separated by hyphens\n * or colons. The name should include an English verb (e.g. \"deploy\"). Use a\n * hyphen to separate words (e.g. \"upload-docs\"). A group of related commands\n * can be prefixed with a colon (e.g. \"docs:generate\", \"docs:deploy\",\n * \"docs:serve\", etc).\n *\n * @public\n */\nexport abstract class CommandLineAction extends CommandLineParameterProvider {\n  // Example: \"do-something\"\n  private static _actionNameRegExp: RegExp = /^[a-z][a-z0-9]*([-:][a-z0-9]+)*$/;\n\n  /** {@inheritDoc ICommandLineActionOptions.actionName} */\n  public readonly actionName: string;\n\n  /** {@inheritDoc ICommandLineActionOptions.summary} */\n  public readonly summary: string;\n\n  /** {@inheritDoc ICommandLineActionOptions.documentation} */\n  public readonly documentation: string;\n\n  private _argumentParser: argparse.ArgumentParser | undefined;\n\n  public constructor(options: ICommandLineActionOptions) {\n    super();\n\n    if (!CommandLineAction._actionNameRegExp.test(options.actionName)) {\n      throw new Error(\n        `Invalid action name \"${options.actionName}\". ` +\n          `The name must be comprised of lower-case words optionally separated by hyphens or colons.`\n      );\n    }\n\n    this.actionName = options.actionName;\n    this.summary = options.summary;\n    this.documentation = options.documentation;\n\n    this._argumentParser = undefined;\n  }\n\n  /**\n   * This is called internally by CommandLineParser.addAction()\n   * @internal\n   */\n  public _buildParser(actionsSubParser: argparse.SubParser): void {\n    this._argumentParser = actionsSubParser.addParser(this.actionName, {\n      help: this.summary,\n      description: this.documentation\n    });\n\n    this.onDefineParameters();\n  }\n\n  /**\n   * This is called internally by CommandLineParser.execute()\n   * @internal\n   */\n  public _processParsedData(data: ICommandLineParserData): void {\n    super._processParsedData(data);\n  }\n\n  /**\n   * Invoked by CommandLineParser.onExecute().\n   * @internal\n   */\n  public _execute(): Promise<void> {\n    return this.onExecute();\n  }\n\n  /**\n   * {@inheritDoc CommandLineParameterProvider._getArgumentParser}\n   * @internal\n   */\n  protected _getArgumentParser(): argparse.ArgumentParser {\n    // override\n    if (!this._argumentParser) {\n      // We will improve this in the future\n      throw new Error('The CommandLineAction must be added to a CommandLineParser before it can be used');\n    }\n\n    return this._argumentParser;\n  }\n\n  /**\n   * {@inheritDoc CommandLineParameterProvider.onDefineParameters}\n   */\n  protected abstract onDefineParameters(): void;\n\n  /**\n   * Your subclass should implement this hook to perform the operation.\n   */\n  protected abstract onExecute(): Promise<void>;\n}\n"]}
+{"version":3,"file":"CommandLineAction.js","sourceRoot":"","sources":["../../src/providers/CommandLineAction.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D;;;AAI3D,iFAAsG;AA2BtG;;;;;;;;;;;;GAYG;AACH,MAAsB,iBAAkB,SAAQ,2DAA4B;IAe1E,YAAmB,OAAkC;QACnD,KAAK,EAAE,CAAC;QAER,IAAI,CAAC,iBAAiB,CAAC,iBAAiB,CAAC,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE;YACjE,MAAM,IAAI,KAAK,CACb,wBAAwB,OAAO,CAAC,UAAU,KAAK;gBAC7C,2FAA2F,CAC9F,CAAC;SACH;QAED,IAAI,CAAC,UAAU,GAAG,OAAO,CAAC,UAAU,CAAC;QACrC,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;QAC/B,IAAI,CAAC,aAAa,GAAG,OAAO,CAAC,aAAa,CAAC;QAE3C,IAAI,CAAC,eAAe,GAAG,SAAS,CAAC;IACnC,CAAC;IAED;;;OAGG;IACI,YAAY,CAAC,gBAAoC;QACtD,IAAI,CAAC,eAAe,GAAG,gBAAgB,CAAC,SAAS,CAAC,IAAI,CAAC,UAAU,EAAE;YACjE,IAAI,EAAE,IAAI,CAAC,OAAO;YAClB,WAAW,EAAE,IAAI,CAAC,aAAa;SAChC,CAAC,CAAC;QAEH,IAAI,CAAC,kBAAkB,EAAE,CAAC;IAC5B,CAAC;IAED;;;OAGG;IACI,kBAAkB,CAAC,aAAwC,EAAE,IAA4B;QAC9F,KAAK,CAAC,kBAAkB,CAAC,aAAa,EAAE,IAAI,CAAC,CAAC;IAChD,CAAC;IAED;;;OAGG;IACI,QAAQ;QACb,OAAO,IAAI,CAAC,SAAS,EAAE,CAAC;IAC1B,CAAC;IAED;;;OAGG;IACO,kBAAkB;QAC1B,WAAW;QACX,IAAI,CAAC,IAAI,CAAC,eAAe,EAAE;YACzB,qCAAqC;YACrC,MAAM,IAAI,KAAK,CAAC,kFAAkF,CAAC,CAAC;SACrG;QAED,OAAO,IAAI,CAAC,eAAe,CAAC;IAC9B,CAAC;;AAzEH,8CAoFC;AAnFC,0BAA0B;AACX,mCAAiB,GAAW,kCAAkC,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.\n// See LICENSE in the project root for license information.\n\nimport * as argparse from 'argparse';\n\nimport { CommandLineParameterProvider, ICommandLineParserData } from './CommandLineParameterProvider';\nimport type { ICommandLineParserOptions } from './CommandLineParser';\n\n/**\n * Options for the CommandLineAction constructor.\n * @public\n */\nexport interface ICommandLineActionOptions {\n  /**\n   * The name of the action.  For example, if the tool is called \"example\",\n   * then the \"build\" action might be invoked as: \"example build -q --some-other-option\"\n   */\n  actionName: string;\n\n  /**\n   * A quick summary that is shown on the main help page, which is displayed\n   * by the command \"example --help\"\n   */\n  summary: string;\n\n  /**\n   * A detailed description that is shown on the action help page, which is displayed\n   * by the command \"example build --help\", e.g. for actionName=\"build\".\n   */\n  documentation: string;\n}\n\n/**\n * Represents a sub-command that is part of the CommandLineParser command line.\n * Applications should create subclasses of CommandLineAction corresponding to\n * each action that they want to expose.\n *\n * The action name should be comprised of lower case words separated by hyphens\n * or colons. The name should include an English verb (e.g. \"deploy\"). Use a\n * hyphen to separate words (e.g. \"upload-docs\"). A group of related commands\n * can be prefixed with a colon (e.g. \"docs:generate\", \"docs:deploy\",\n * \"docs:serve\", etc).\n *\n * @public\n */\nexport abstract class CommandLineAction extends CommandLineParameterProvider {\n  // Example: \"do-something\"\n  private static _actionNameRegExp: RegExp = /^[a-z][a-z0-9]*([-:][a-z0-9]+)*$/;\n\n  /** {@inheritDoc ICommandLineActionOptions.actionName} */\n  public readonly actionName: string;\n\n  /** {@inheritDoc ICommandLineActionOptions.summary} */\n  public readonly summary: string;\n\n  /** {@inheritDoc ICommandLineActionOptions.documentation} */\n  public readonly documentation: string;\n\n  private _argumentParser: argparse.ArgumentParser | undefined;\n\n  public constructor(options: ICommandLineActionOptions) {\n    super();\n\n    if (!CommandLineAction._actionNameRegExp.test(options.actionName)) {\n      throw new Error(\n        `Invalid action name \"${options.actionName}\". ` +\n          `The name must be comprised of lower-case words optionally separated by hyphens or colons.`\n      );\n    }\n\n    this.actionName = options.actionName;\n    this.summary = options.summary;\n    this.documentation = options.documentation;\n\n    this._argumentParser = undefined;\n  }\n\n  /**\n   * This is called internally by CommandLineParser.addAction()\n   * @internal\n   */\n  public _buildParser(actionsSubParser: argparse.SubParser): void {\n    this._argumentParser = actionsSubParser.addParser(this.actionName, {\n      help: this.summary,\n      description: this.documentation\n    });\n\n    this.onDefineParameters();\n  }\n\n  /**\n   * This is called internally by CommandLineParser.execute()\n   * @internal\n   */\n  public _processParsedData(parserOptions: ICommandLineParserOptions, data: ICommandLineParserData): void {\n    super._processParsedData(parserOptions, data);\n  }\n\n  /**\n   * Invoked by CommandLineParser.onExecute().\n   * @internal\n   */\n  public _execute(): Promise<void> {\n    return this.onExecute();\n  }\n\n  /**\n   * {@inheritDoc CommandLineParameterProvider._getArgumentParser}\n   * @internal\n   */\n  protected _getArgumentParser(): argparse.ArgumentParser {\n    // override\n    if (!this._argumentParser) {\n      // We will improve this in the future\n      throw new Error('The CommandLineAction must be added to a CommandLineParser before it can be used');\n    }\n\n    return this._argumentParser;\n  }\n\n  /**\n   * {@inheritDoc CommandLineParameterProvider.onDefineParameters}\n   */\n  protected abstract onDefineParameters(): void;\n\n  /**\n   * Your subclass should implement this hook to perform the operation.\n   */\n  protected abstract onExecute(): Promise<void>;\n}\n"]}

package/lib/providers/CommandLineParameterProvider.d.ts

@@ -1,5 +1,6 @@
 import * as argparse from 'argparse';
-import { ICommandLineChoiceDefinition, ICommandLineChoiceListDefinition, ICommandLineIntegerDefinition, ICommandLineIntegerListDefinition, ICommandLineFlagDefinition, ICommandLineStringDefinition, ICommandLineStringListDefinition, ICommandLineRemainderDefinition } from '../parameters/CommandLineDefinition';
+import type { ICommandLineChoiceDefinition, ICommandLineChoiceListDefinition, ICommandLineIntegerDefinition, ICommandLineIntegerListDefinition, ICommandLineFlagDefinition, ICommandLineStringDefinition, ICommandLineStringListDefinition, ICommandLineRemainderDefinition } from '../parameters/CommandLineDefinition';
+import type { ICommandLineParserOptions } from './CommandLineParser';
 import { CommandLineParameter } from '../parameters/BaseClasses';
 import { CommandLineChoiceParameter } from '../parameters/CommandLineChoiceParameter';
 import { CommandLineChoiceListParameter } from '../parameters/CommandLineChoiceListParameter';
@@ -9,6 +10,23 @@ import { CommandLineFlagParameter } from '../parameters/CommandLineFlagParameter
 import { CommandLineStringParameter } from '../parameters/CommandLineStringParameter';
 import { CommandLineStringListParameter } from '../parameters/CommandLineStringListParameter';
 import { CommandLineRemainder } from '../parameters/CommandLineRemainder';
+/**
+ * The result containing the parsed paramter long name and scope. Returned when calling
+ * {@link CommandLineParameterProvider.parseScopedLongName}.
+ *
+ * @public
+ */
+export interface IScopedLongNameParseResult {
+    /**
+     * The long name parsed from the scoped long name, e.g. "--my-scope:my-parameter" -\> "--my-parameter"
+     */
+    longName: string;
+    /**
+     * The scope parsed from the scoped long name or undefined if no scope was found,
+     * e.g. "--my-scope:my-parameter" -\> "my-scope"
+     */
+    scope: string | undefined;
+}
 /**
  * This is the argparse result data object
  * @internal
@@ -24,9 +42,14 @@ export interface ICommandLineParserData {
  * @public
  */
 export declare abstract class CommandLineParameterProvider {
+    private static readonly _scopeGroupName;
+    private static readonly _longNameGroupName;
+    private static readonly _possiblyScopedLongNameRegex;
     private static _keyCounter;
     private _parameters;
     private _parametersByLongName;
+    private _parameterGroupsByName;
+    private _parametersRegistered;
     private _parametersProcessed;
     private _remainder;
     /** @internal */
@@ -60,7 +83,7 @@ export declare abstract class CommandLineParameterProvider {
      * @remarks
      * This method throws an exception if the parameter is not defined.
      */
-    getChoiceParameter(parameterLongName: string): CommandLineChoiceParameter;
+    getChoiceParameter(parameterLongName: string, parameterScope?: string): CommandLineChoiceParameter;
     /**
      * Defines a command-line parameter whose value must be a string from a fixed set of
      * allowable choices (similar to an enum). The parameter can be specified multiple times to
@@ -78,7 +101,7 @@ export declare abstract class CommandLineParameterProvider {
      * @remarks
      * This method throws an exception if the parameter is not defined.
      */
-    getChoiceListParameter(parameterLongName: string): CommandLineChoiceListParameter;
+    getChoiceListParameter(parameterLongName: string, parameterScope?: string): CommandLineChoiceListParameter;
     /**
      * Defines a command-line switch whose boolean value is true if the switch is provided,
      * and false otherwise.
@@ -95,7 +118,7 @@ export declare abstract class CommandLineParameterProvider {
      * @remarks
      * This method throws an exception if the parameter is not defined.
      */
-    getFlagParameter(parameterLongName: string): CommandLineFlagParameter;
+    getFlagParameter(parameterLongName: string, parameterScope?: string): CommandLineFlagParameter;
     /**
      * Defines a command-line parameter whose argument is an integer.
      *
@@ -111,7 +134,7 @@ export declare abstract class CommandLineParameterProvider {
      * @remarks
      * This method throws an exception if the parameter is not defined.
      */
-    getIntegerParameter(parameterLongName: string): CommandLineIntegerParameter;
+    getIntegerParameter(parameterLongName: string, parameterScope?: string): CommandLineIntegerParameter;
     /**
      * Defines a command-line parameter whose argument is an integer. The parameter can be specified
      * multiple times to build a list.
@@ -128,7 +151,7 @@ export declare abstract class CommandLineParameterProvider {
      * @remarks
      * This method throws an exception if the parameter is not defined.
      */
-    getIntegerListParameter(parameterLongName: string): CommandLineIntegerListParameter;
+    getIntegerListParameter(parameterLongName: string, parameterScope?: string): CommandLineIntegerListParameter;
     /**
      * Defines a command-line parameter whose argument is a single text string.
      *
@@ -144,7 +167,7 @@ export declare abstract class CommandLineParameterProvider {
      * @remarks
      * This method throws an exception if the parameter is not defined.
      */
-    getStringParameter(parameterLongName: string): CommandLineStringParameter;
+    getStringParameter(parameterLongName: string, parameterScope?: string): CommandLineStringParameter;
     /**
      * Defines a command-line parameter whose argument is a single text string.  The parameter can be
      * specified multiple times to build a list.
@@ -177,17 +200,27 @@ export declare abstract class CommandLineParameterProvider {
      * @remarks
      * This method throws an exception if the parameter is not defined.
      */
-    getStringListParameter(parameterLongName: string): CommandLineStringListParameter;
+    getStringListParameter(parameterLongName: string, parameterScope?: string): CommandLineStringListParameter;
     /**
      * Generates the command-line help text.
      */
     renderHelpText(): string;
+    /**
+     * Generates the command-line usage text.
+     */
+    renderUsageText(): string;
     /**
      * Returns a object which maps the long name of each parameter in this.parameters
      * to the stringified form of its value. This is useful for logging telemetry, but
      * it is not the proper way of accessing parameters or their values.
      */
     getParameterStringMap(): Record<string, string>;
+    /**
+     * Returns an object with the parsed scope (if present) and the long name of the parameter.
+     */
+    parseScopedLongName(scopedLongName: string): IScopedLongNameParseResult;
+    /** @internal */
+    _registerDefinedParameters(): void;
     /**
      * The child class should implement this hook to define its command-line parameters,
      * e.g. by calling defineFlagParameter().
@@ -199,9 +232,12 @@ export declare abstract class CommandLineParameterProvider {
      */
     protected abstract _getArgumentParser(): argparse.ArgumentParser;
     /** @internal */
-    protected _processParsedData(data: ICommandLineParserData): void;
+    protected _processParsedData(parserOptions: ICommandLineParserOptions, data: ICommandLineParserData): void;
+    /** @internal */
+    protected _defineParameter(parameter: CommandLineParameter): void;
+    /** @internal */
+    protected _registerParameter(parameter: CommandLineParameter, useScopedLongName: boolean): void;
     private _generateKey;
     private _getParameter;
-    private _defineParameter;
 }
 //# sourceMappingURL=CommandLineParameterProvider.d.ts.map

package/lib/providers/CommandLineParameterProvider.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"CommandLineParameterProvider.d.ts","sourceRoot":"","sources":["../../src/providers/CommandLineParameterProvider.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,QAAQ,MAAM,UAAU,CAAC;AACrC,OAAO,EACL,4BAA4B,EAC5B,gCAAgC,EAChC,6BAA6B,EAC7B,iCAAiC,EACjC,0BAA0B,EAC1B,4BAA4B,EAC5B,gCAAgC,EAChC,+BAA+B,EAChC,MAAM,qCAAqC,CAAC;AAC7C,OAAO,EACL,oBAAoB,EAGrB,MAAM,2BAA2B,CAAC;AACnC,OAAO,EAAE,0BAA0B,EAAE,MAAM,0CAA0C,CAAC;AACtF,OAAO,EAAE,8BAA8B,EAAE,MAAM,8CAA8C,CAAC;AAC9F,OAAO,EAAE,2BAA2B,EAAE,MAAM,2CAA2C,CAAC;AACxF,OAAO,EAAE,+BAA+B,EAAE,MAAM,+CAA+C,CAAC;AAChG,OAAO,EAAE,wBAAwB,EAAE,MAAM,wCAAwC,CAAC;AAClF,OAAO,EAAE,0BAA0B,EAAE,MAAM,0CAA0C,CAAC;AACtF,OAAO,EAAE,8BAA8B,EAAE,MAAM,8CAA8C,CAAC;AAC9F,OAAO,EAAE,oBAAoB,EAAE,MAAM,oCAAoC,CAAC;AAE1E;;;GAGG;AACH,MAAM,WAAW,sBAAsB;IACrC,MAAM,EAAE,MAAM,CAAC;IACf,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB;AAED;;;;;GAKG;AACH,8BAAsB,4BAA4B;IAChD,OAAO,CAAC,MAAM,CAAC,WAAW,CAAa;IAEvC,OAAO,CAAC,WAAW,CAAyB;IAC5C,OAAO,CAAC,qBAAqB,CAAoC;IACjE,OAAO,CAAC,oBAAoB,CAAU;IACtC,OAAO,CAAC,UAAU,CAAmC;IAErD,gBAAgB;;IAQhB;;OAEG;IACH,IAAW,UAAU,IAAI,aAAa,CAAC,oBAAoB,CAAC,CAE3D;IAED;;OAEG;IACH,IAAW,mBAAmB,IAAI,OAAO,CAExC;IAED;;;OAGG;IACH,IAAW,SAAS,IAAI,oBAAoB,GAAG,SAAS,CAEvD;IAED;;;;;;;;;OASG;IACI,qBAAqB,CAAC,UAAU,EAAE,4BAA4B,GAAG,0BAA0B;IAMlG;;;;OAIG;IACI,kBAAkB,CAAC,iBAAiB,EAAE,MAAM,GAAG,0BAA0B;IAIhF;;;;;;;;;;OAUG;IACI,yBAAyB,CAC9B,UAAU,EAAE,gCAAgC,GAC3C,8BAA8B;IAMjC;;;;OAIG;IACI,sBAAsB,CAAC,iBAAiB,EAAE,MAAM,GAAG,8BAA8B;IAIxF;;;;;;;;;OASG;IACI,mBAAmB,CAAC,UAAU,EAAE,0BAA0B,GAAG,wBAAwB;IAM5F;;;;OAIG;IACI,gBAAgB,CAAC,iBAAiB,EAAE,MAAM,GAAG,wBAAwB;IAI5E;;;;;;;;OAQG;IACI,sBAAsB,CAAC,UAAU,EAAE,6BAA6B,GAAG,2BAA2B;IAMrG;;;;OAIG;IACI,mBAAmB,CAAC,iBAAiB,EAAE,MAAM,GAAG,2BAA2B;IAIlF;;;;;;;;;OASG;IACI,0BAA0B,CAC/B,UAAU,EAAE,iCAAiC,GAC5C,+BAA+B;IAMlC;;;;OAIG;IACI,uBAAuB,CAAC,iBAAiB,EAAE,MAAM,GAAG,+BAA+B;IAG1F;;;;;;;;OAQG;IACI,qBAAqB,CAAC,UAAU,EAAE,4BAA4B,GAAG,0BAA0B;IAMlG;;;;OAIG;IACI,kBAAkB,CAAC,iBAAiB,EAAE,MAAM,GAAG,0BAA0B;IAIhF;;;;;;;;;OASG;IACI,yBAAyB,CAC9B,UAAU,EAAE,gCAAgC,GAC3C,8BAA8B;IAMjC;;;;;;;;;;;;;;OAcG;IACI,0BAA0B,CAAC,UAAU,EAAE,+BAA+B,GAAG,oBAAoB;IAiBpG;;;;OAIG;IACI,sBAAsB,CAAC,iBAAiB,EAAE,MAAM,GAAG,8BAA8B;IAIxF;;OAEG;IACI,cAAc,IAAI,MAAM;IAI/B;;;;OAIG;IACI,qBAAqB,IAAI,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC;IAkCtD;;;OAGG;IACH,SAAS,CAAC,QAAQ,CAAC,kBAAkB,IAAI,IAAI;IAE7C;;;OAGG;IACH,SAAS,CAAC,QAAQ,CAAC,kBAAkB,IAAI,QAAQ,CAAC,cAAc;IAEhE,gBAAgB;IAChB,SAAS,CAAC,kBAAkB,CAAC,IAAI,EAAE,sBAAsB,GAAG,IAAI;IAkBhE,OAAO,CAAC,YAAY;IAIpB,OAAO,CAAC,aAAa;IAiBrB,OAAO,CAAC,gBAAgB;CA+EzB"}
+{"version":3,"file":"CommandLineParameterProvider.d.ts","sourceRoot":"","sources":["../../src/providers/CommandLineParameterProvider.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,QAAQ,MAAM,UAAU,CAAC;AAErC,OAAO,KAAK,EACV,4BAA4B,EAC5B,gCAAgC,EAChC,6BAA6B,EAC7B,iCAAiC,EACjC,0BAA0B,EAC1B,4BAA4B,EAC5B,gCAAgC,EAChC,+BAA+B,EAChC,MAAM,qCAAqC,CAAC;AAC7C,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,qBAAqB,CAAC;AACrE,OAAO,EACL,oBAAoB,EAGrB,MAAM,2BAA2B,CAAC;AACnC,OAAO,EAAE,0BAA0B,EAAE,MAAM,0CAA0C,CAAC;AACtF,OAAO,EAAE,8BAA8B,EAAE,MAAM,8CAA8C,CAAC;AAC9F,OAAO,EAAE,2BAA2B,EAAE,MAAM,2CAA2C,CAAC;AACxF,OAAO,EAAE,+BAA+B,EAAE,MAAM,+CAA+C,CAAC;AAChG,OAAO,EAAE,wBAAwB,EAAE,MAAM,wCAAwC,CAAC;AAClF,OAAO,EAAE,0BAA0B,EAAE,MAAM,0CAA0C,CAAC;AACtF,OAAO,EAAE,8BAA8B,EAAE,MAAM,8CAA8C,CAAC;AAC9F,OAAO,EAAE,oBAAoB,EAAE,MAAM,oCAAoC,CAAC;AAG1E;;;;;GAKG;AACH,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,KAAK,EAAE,MAAM,GAAG,SAAS,CAAC;CAC3B;AAED;;;GAGG;AACH,MAAM,WAAW,sBAAsB;IACrC,MAAM,EAAE,MAAM,CAAC;IACf,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB;AAED;;;;;GAKG;AACH,8BAAsB,4BAA4B;IAChD,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,eAAe,CAAmB;IAC1D,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,kBAAkB,CAAsB;IAChE,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,4BAA4B,CAC+B;IACnF,OAAO,CAAC,MAAM,CAAC,WAAW,CAAa;IAEvC,OAAO,CAAC,WAAW,CAAyB;IAC5C,OAAO,CAAC,qBAAqB,CAAsC;IACnE,OAAO,CAAC,sBAAsB,CAAuE;IACrG,OAAO,CAAC,qBAAqB,CAAU;IACvC,OAAO,CAAC,oBAAoB,CAAU;IACtC,OAAO,CAAC,UAAU,CAAmC;IAErD,gBAAgB;;IAUhB;;OAEG;IACH,IAAW,UAAU,IAAI,aAAa,CAAC,oBAAoB,CAAC,CAE3D;IAED;;OAEG;IACH,IAAW,mBAAmB,IAAI,OAAO,CAExC;IAED;;;OAGG;IACH,IAAW,SAAS,IAAI,oBAAoB,GAAG,SAAS,CAEvD;IAED;;;;;;;;;OASG;IACI,qBAAqB,CAAC,UAAU,EAAE,4BAA4B,GAAG,0BAA0B;IAMlG;;;;OAIG;IACI,kBAAkB,CAAC,iBAAiB,EAAE,MAAM,EAAE,cAAc,CAAC,EAAE,MAAM,GAAG,0BAA0B;IAIzG;;;;;;;;;;OAUG;IACI,yBAAyB,CAC9B,UAAU,EAAE,gCAAgC,GAC3C,8BAA8B;IAMjC;;;;OAIG;IACI,sBAAsB,CAC3B,iBAAiB,EAAE,MAAM,EACzB,cAAc,CAAC,EAAE,MAAM,GACtB,8BAA8B;IAIjC;;;;;;;;;OASG;IACI,mBAAmB,CAAC,UAAU,EAAE,0BAA0B,GAAG,wBAAwB;IAM5F;;;;OAIG;IACI,gBAAgB,CAAC,iBAAiB,EAAE,MAAM,EAAE,cAAc,CAAC,EAAE,MAAM,GAAG,wBAAwB;IAIrG;;;;;;;;OAQG;IACI,sBAAsB,CAAC,UAAU,EAAE,6BAA6B,GAAG,2BAA2B;IAMrG;;;;OAIG;IACI,mBAAmB,CACxB,iBAAiB,EAAE,MAAM,EACzB,cAAc,CAAC,EAAE,MAAM,GACtB,2BAA2B;IAI9B;;;;;;;;;OASG;IACI,0BAA0B,CAC/B,UAAU,EAAE,iCAAiC,GAC5C,+BAA+B;IAMlC;;;;OAIG;IACI,uBAAuB,CAC5B,iBAAiB,EAAE,MAAM,EACzB,cAAc,CAAC,EAAE,MAAM,GACtB,+BAA+B;IAIlC;;;;;;;;OAQG;IACI,qBAAqB,CAAC,UAAU,EAAE,4BAA4B,GAAG,0BAA0B;IAMlG;;;;OAIG;IACI,kBAAkB,CAAC,iBAAiB,EAAE,MAAM,EAAE,cAAc,CAAC,EAAE,MAAM,GAAG,0BAA0B;IAIzG;;;;;;;;;OASG;IACI,yBAAyB,CAC9B,UAAU,EAAE,gCAAgC,GAC3C,8BAA8B;IAMjC;;;;;;;;;;;;;;OAcG;IACI,0BAA0B,CAAC,UAAU,EAAE,+BAA+B,GAAG,oBAAoB;IAQpG;;;;OAIG;IACI,sBAAsB,CAC3B,iBAAiB,EAAE,MAAM,EACzB,cAAc,CAAC,EAAE,MAAM,GACtB,8BAA8B;IAIjC;;OAEG;IACI,cAAc,IAAI,MAAM;IAK/B;;OAEG;IACI,eAAe,IAAI,MAAM;IAKhC;;;;OAIG;IACI,qBAAqB,IAAI,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC;IAmCtD;;OAEG;IACI,mBAAmB,CAAC,cAAc,EAAE,MAAM,GAAG,0BAA0B;IAY9E,gBAAgB;IACT,0BAA0B,IAAI,IAAI;IAiCzC;;;OAGG;IACH,SAAS,CAAC,QAAQ,CAAC,kBAAkB,IAAI,IAAI;IAE7C;;;OAGG;IACH,SAAS,CAAC,QAAQ,CAAC,kBAAkB,IAAI,QAAQ,CAAC,cAAc;IAEhE,gBAAgB;IAChB,SAAS,CAAC,kBAAkB,CAAC,aAAa,EAAE,yBAAyB,EAAE,IAAI,EAAE,sBAAsB,GAAG,IAAI;IAsB1G,gBAAgB;IAChB,SAAS,CAAC,gBAAgB,CAAC,SAAS,EAAE,oBAAoB,GAAG,IAAI;IAqBjE,gBAAgB;IAChB,SAAS,CAAC,kBAAkB,CAAC,SAAS,EAAE,oBAAoB,EAAE,iBAAiB,EAAE,OAAO,GAAG,IAAI;IAmG/F,OAAO,CAAC,YAAY;IAIpB,OAAO,CAAC,aAAa;CA8BtB"}

package/lib/providers/CommandLineParameterProvider.js

@@ -3,7 +3,11 @@
 // See LICENSE in the project root for license information.
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];
@@ -32,6 +36,7 @@ const CommandLineFlagParameter_1 = require("../parameters/CommandLineFlagParamet
 const CommandLineStringParameter_1 = require("../parameters/CommandLineStringParameter");
 const CommandLineStringListParameter_1 = require("../parameters/CommandLineStringListParameter");
 const CommandLineRemainder_1 = require("../parameters/CommandLineRemainder");
+const Constants_1 = require("../Constants");
 /**
  * This is the common base class for CommandLineAction and CommandLineParser
  * that provides functionality for defining command-line parameters.
@@ -44,6 +49,8 @@ class CommandLineParameterProvider {
     constructor() {
         this._parameters = [];
         this._parametersByLongName = new Map();
+        this._parameterGroupsByName = new Map();
+        this._parametersRegistered = false;
         this._parametersProcessed = false;
     }
     /**
@@ -85,8 +92,8 @@ class CommandLineParameterProvider {
      * @remarks
      * This method throws an exception if the parameter is not defined.
      */
-    getChoiceParameter(parameterLongName) {
-        return this._getParameter(parameterLongName, BaseClasses_1.CommandLineParameterKind.Choice);
+    getChoiceParameter(parameterLongName, parameterScope) {
+        return this._getParameter(parameterLongName, BaseClasses_1.CommandLineParameterKind.Choice, parameterScope);
     }
     /**
      * Defines a command-line parameter whose value must be a string from a fixed set of
@@ -109,8 +116,8 @@ class CommandLineParameterProvider {
      * @remarks
      * This method throws an exception if the parameter is not defined.
      */
-    getChoiceListParameter(parameterLongName) {
-        return this._getParameter(parameterLongName, BaseClasses_1.CommandLineParameterKind.ChoiceList);
+    getChoiceListParameter(parameterLongName, parameterScope) {
+        return this._getParameter(parameterLongName, BaseClasses_1.CommandLineParameterKind.ChoiceList, parameterScope);
     }
     /**
      * Defines a command-line switch whose boolean value is true if the switch is provided,
@@ -132,8 +139,8 @@ class CommandLineParameterProvider {
      * @remarks
      * This method throws an exception if the parameter is not defined.
      */
-    getFlagParameter(parameterLongName) {
-        return this._getParameter(parameterLongName, BaseClasses_1.CommandLineParameterKind.Flag);
+    getFlagParameter(parameterLongName, parameterScope) {
+        return this._getParameter(parameterLongName, BaseClasses_1.CommandLineParameterKind.Flag, parameterScope);
     }
     /**
      * Defines a command-line parameter whose argument is an integer.
@@ -154,8 +161,8 @@ class CommandLineParameterProvider {
      * @remarks
      * This method throws an exception if the parameter is not defined.
      */
-    getIntegerParameter(parameterLongName) {
-        return this._getParameter(parameterLongName, BaseClasses_1.CommandLineParameterKind.Integer);
+    getIntegerParameter(parameterLongName, parameterScope) {
+        return this._getParameter(parameterLongName, BaseClasses_1.CommandLineParameterKind.Integer, parameterScope);
     }
     /**
      * Defines a command-line parameter whose argument is an integer. The parameter can be specified
@@ -177,8 +184,8 @@ class CommandLineParameterProvider {
      * @remarks
      * This method throws an exception if the parameter is not defined.
      */
-    getIntegerListParameter(parameterLongName) {
-        return this._getParameter(parameterLongName, BaseClasses_1.CommandLineParameterKind.IntegerList);
+    getIntegerListParameter(parameterLongName, parameterScope) {
+        return this._getParameter(parameterLongName, BaseClasses_1.CommandLineParameterKind.IntegerList, parameterScope);
     }
     /**
      * Defines a command-line parameter whose argument is a single text string.
@@ -199,8 +206,8 @@ class CommandLineParameterProvider {
      * @remarks
      * This method throws an exception if the parameter is not defined.
      */
-    getStringParameter(parameterLongName) {
-        return this._getParameter(parameterLongName, BaseClasses_1.CommandLineParameterKind.String);
+    getStringParameter(parameterLongName, parameterScope) {
+        return this._getParameter(parameterLongName, BaseClasses_1.CommandLineParameterKind.String, parameterScope);
     }
     /**
      * Defines a command-line parameter whose argument is a single text string.  The parameter can be
@@ -237,12 +244,6 @@ class CommandLineParameterProvider {
             throw new Error('defineRemainingArguments() has already been called for this provider');
         }
         this._remainder = new CommandLineRemainder_1.CommandLineRemainder(definition);
-        const argparseOptions = {
-            help: this._remainder.description,
-            nargs: argparse.Const.REMAINDER,
-            metavar: '"..."'
-        };
-        this._getArgumentParser().addArgument(argparse.Const.REMAINDER, argparseOptions);
         return this._remainder;
     }
     /**
@@ -250,15 +251,23 @@ class CommandLineParameterProvider {
      * @remarks
      * This method throws an exception if the parameter is not defined.
      */
-    getStringListParameter(parameterLongName) {
-        return this._getParameter(parameterLongName, BaseClasses_1.CommandLineParameterKind.StringList);
+    getStringListParameter(parameterLongName, parameterScope) {
+        return this._getParameter(parameterLongName, BaseClasses_1.CommandLineParameterKind.StringList, parameterScope);
     }
     /**
      * Generates the command-line help text.
      */
     renderHelpText() {
+        this._registerDefinedParameters();
         return this._getArgumentParser().formatHelp();
     }
+    /**
+     * Generates the command-line usage text.
+     */
+    renderUsageText() {
+        this._registerDefinedParameters();
+        return this._getArgumentParser().formatUsage();
+    }
     /**
      * Returns a object which maps the long name of each parameter in this.parameters
      * to the stringified form of its value. This is useful for logging telemetry, but
@@ -267,25 +276,70 @@ class CommandLineParameterProvider {
     getParameterStringMap() {
         const parameterMap = {};
         for (const parameter of this.parameters) {
+            const parameterName = parameter.scopedLongName || parameter.longName;
             switch (parameter.kind) {
                 case BaseClasses_1.CommandLineParameterKind.Flag:
                 case BaseClasses_1.CommandLineParameterKind.Choice:
                 case BaseClasses_1.CommandLineParameterKind.String:
                 case BaseClasses_1.CommandLineParameterKind.Integer:
-                    parameterMap[parameter.longName] = JSON.stringify(parameter.value);
+                    parameterMap[parameterName] = JSON.stringify(parameter.value);
                     break;
                 case BaseClasses_1.CommandLineParameterKind.StringList:
                 case BaseClasses_1.CommandLineParameterKind.IntegerList:
                 case BaseClasses_1.CommandLineParameterKind.ChoiceList:
                     const arrayValue = parameter.values;
-                    parameterMap[parameter.longName] = arrayValue ? arrayValue.join(',') : '';
+                    parameterMap[parameterName] = arrayValue ? arrayValue.join(',') : '';
                     break;
             }
         }
         return parameterMap;
     }
+    /**
+     * Returns an object with the parsed scope (if present) and the long name of the parameter.
+     */
+    parseScopedLongName(scopedLongName) {
+        const result = CommandLineParameterProvider._possiblyScopedLongNameRegex.exec(scopedLongName);
+        if (!result || !result.groups) {
+            throw new Error(`The parameter long name "${scopedLongName}" is not valid.`);
+        }
+        return {
+            longName: `--${result.groups[CommandLineParameterProvider._longNameGroupName]}`,
+            scope: result.groups[CommandLineParameterProvider._scopeGroupName]
+        };
+    }
+    /** @internal */
+    _registerDefinedParameters() {
+        if (this._parametersRegistered) {
+            // We prevent new parameters from being defined after the first call to _registerDefinedParameters,
+            // so we can already ensure that all parameters were registered.
+            return;
+        }
+        this._parametersRegistered = true;
+        for (const longNameParameters of this._parametersByLongName.values()) {
+            const useScopedLongName = longNameParameters.length > 1;
+            for (const parameter of longNameParameters) {
+                if (useScopedLongName && !parameter.parameterScope) {
+                    throw new Error(`The parameter "${parameter.longName}" is defined multiple times with the same long name. ` +
+                        'Parameters with the same long name must define a scope.');
+                }
+                this._registerParameter(parameter, useScopedLongName);
+            }
+        }
+        // Need to add the remainder parameter last
+        if (this._remainder) {
+            const argparseOptions = {
+                help: this._remainder.description,
+                nargs: argparse.Const.REMAINDER,
+                metavar: '"..."'
+            };
+            this._getArgumentParser().addArgument(argparse.Const.REMAINDER, argparseOptions);
+        }
+    }
     /** @internal */
-    _processParsedData(data) {
+    _processParsedData(parserOptions, data) {
+        if (!this._parametersRegistered) {
+            throw new Error('Parameters have not been registered');
+        }
         if (this._parametersProcessed) {
             throw new Error('Command Line Parser Data was already processed');
         }
@@ -299,31 +353,36 @@ class CommandLineParameterProvider {
         }
         this._parametersProcessed = true;
     }
-    _generateKey() {
-        return 'key_' + (CommandLineParameterProvider._keyCounter++).toString();
-    }
-    _getParameter(parameterLongName, expectedKind) {
-        const parameter = this._parametersByLongName.get(parameterLongName);
-        if (!parameter) {
-            throw new Error(`The parameter "${parameterLongName}" is not defined`);
+    /** @internal */
+    _defineParameter(parameter) {
+        if (this._parametersRegistered) {
+            throw new Error('Parameters have already been registered for this provider');
         }
-        if (parameter.kind !== expectedKind) {
-            throw new Error(`The parameter "${parameterLongName}" is of type "${BaseClasses_1.CommandLineParameterKind[parameter.kind]}"` +
-                ` whereas the caller was expecting "${BaseClasses_1.CommandLineParameterKind[expectedKind]}".`);
+        // Generate and set the parser key at definition time
+        parameter._parserKey = this._generateKey();
+        this._parameters.push(parameter);
+        // Collect all parameters with the same long name. We will perform conflict resolution at registration.
+        let longNameParameters = this._parametersByLongName.get(parameter.longName);
+        if (!longNameParameters) {
+            longNameParameters = [];
+            this._parametersByLongName.set(parameter.longName, longNameParameters);
         }
-        return parameter;
+        longNameParameters.push(parameter);
     }
-    _defineParameter(parameter) {
-        if (this._remainder) {
-            throw new Error('defineCommandLineRemainder() was already called for this provider;' +
-                ' no further parameters can be defined');
-        }
+    /** @internal */
+    _registerParameter(parameter, useScopedLongName) {
         const names = [];
         if (parameter.shortName) {
             names.push(parameter.shortName);
         }
-        names.push(parameter.longName);
-        parameter._parserKey = this._generateKey();
+        // Use the original long name unless otherwise requested
+        if (!useScopedLongName) {
+            names.push(parameter.longName);
+        }
+        // Add the scoped long name if it exists
+        if (parameter.scopedLongName) {
+            names.push(parameter.scopedLongName);
+        }
         let finalDescription = parameter.description;
         const supplementaryNotes = [];
         parameter._getSupplementaryNotes(supplementaryNotes);
@@ -371,15 +430,60 @@ class CommandLineParameterProvider {
                 argparseOptions.action = 'append';
                 break;
         }
-        const argumentParser = this._getArgumentParser();
-        argumentParser.addArgument(names, Object.assign({}, argparseOptions));
+        let argumentGroup;
+        if (parameter.parameterGroup) {
+            argumentGroup = this._parameterGroupsByName.get(parameter.parameterGroup);
+            if (!argumentGroup) {
+                let parameterGroupName;
+                if (typeof parameter.parameterGroup === 'string') {
+                    parameterGroupName = parameter.parameterGroup;
+                }
+                else if (parameter.parameterGroup === Constants_1.SCOPING_PARAMETER_GROUP) {
+                    parameterGroupName = 'scoping';
+                }
+                else {
+                    throw new Error('Unexpected parameter group: ' + parameter.parameterGroup);
+                }
+                argumentGroup = this._getArgumentParser().addArgumentGroup({
+                    title: `Optional ${parameterGroupName} arguments`
+                });
+                this._parameterGroupsByName.set(parameter.parameterGroup, argumentGroup);
+            }
+        }
+        else {
+            argumentGroup = this._getArgumentParser();
+        }
+        argumentGroup.addArgument(names, Object.assign({}, argparseOptions));
         if (parameter.undocumentedSynonyms && parameter.undocumentedSynonyms.length > 0) {
-            argumentParser.addArgument(parameter.undocumentedSynonyms, Object.assign(Object.assign({}, argparseOptions), { help: argparse.Const.SUPPRESS }));
+            argumentGroup.addArgument(parameter.undocumentedSynonyms, Object.assign(Object.assign({}, argparseOptions), { help: argparse.Const.SUPPRESS }));
         }
-        this._parameters.push(parameter);
-        this._parametersByLongName.set(parameter.longName, parameter);
+    }
+    _generateKey() {
+        return 'key_' + (CommandLineParameterProvider._keyCounter++).toString();
+    }
+    _getParameter(parameterLongName, expectedKind, parameterScope) {
+        // Support the parameter long name being prefixed with the scope
+        const { scope, longName } = this.parseScopedLongName(parameterLongName);
+        parameterLongName = longName;
+        parameterScope = scope || parameterScope;
+        const parameters = this._parametersByLongName.get(parameterLongName);
+        if (!parameters) {
+            throw new Error(`The parameter "${parameterLongName}" is not defined`);
+        }
+        const parameter = parameters.find((p) => p.parameterScope === parameterScope);
+        if (!parameter) {
+            throw new Error(`The parameter "${parameterLongName}" with scope "${parameterScope}" is not defined.`);
+        }
+        if (parameter.kind !== expectedKind) {
+            throw new Error(`The parameter "${parameterLongName}" is of type "${BaseClasses_1.CommandLineParameterKind[parameter.kind]}"` +
+                ` whereas the caller was expecting "${BaseClasses_1.CommandLineParameterKind[expectedKind]}".`);
+        }
+        return parameter;
     }
 }
 exports.CommandLineParameterProvider = CommandLineParameterProvider;
+CommandLineParameterProvider._scopeGroupName = 'scope';
+CommandLineParameterProvider._longNameGroupName = 'longName';
+CommandLineParameterProvider._possiblyScopedLongNameRegex = /^--((?<scope>[a-z0-9]+(-[a-z0-9]+)*):)?(?<longName>[a-z0-9]+((-[a-z0-9]+)+)?)$/;
 CommandLineParameterProvider._keyCounter = 0;
 //# sourceMappingURL=CommandLineParameterProvider.js.map