@rushstack/ts-command-line 4.19.5 → 4.20.1

package/dist/ts-command-line.d.ts

@@ -58,10 +58,13 @@ export declare abstract class CommandLineAction extends CommandLineParameterProv
     private _argumentParser;
     constructor(options: ICommandLineActionOptions);
     /* Excluded from this release type: _buildParser */
-    /* Excluded from this release type: _execute */
+    /* Excluded from this release type: _executeAsync */
     /* Excluded from this release type: _getArgumentParser */
     /**
      * Your subclass should implement this hook to perform the operation.
+     *
+     * @remarks
+     * In a future release, this function will be renamed to onExecuteAsync
      */
     protected abstract onExecute(): Promise<void>;
 }
@@ -630,17 +633,25 @@ export declare abstract class CommandLineParser extends CommandLineParameterProv
      * want to be involved with the command-line logic, and will discard the promise without
      * a then() or catch() block.
      *
-     * If your caller wants to trap and handle errors, use {@link CommandLineParser.executeWithoutErrorHandling}
+     * If your caller wants to trap and handle errors, use {@link CommandLineParser.executeWithoutErrorHandlingAsync}
      * instead.
      *
      * @param args - the command-line arguments to be parsed; if omitted, then
      *               the process.argv will be used
      */
+    executeAsync(args?: string[]): Promise<boolean>;
+    /**
+     * @deprecated Use {@link CommandLineParser.executeAsync} instead.
+     */
     execute(args?: string[]): Promise<boolean>;
     /**
-     * This is similar to {@link CommandLineParser.execute}, except that execution errors
+     * This is similar to {@link CommandLineParser.executeAsync}, except that execution errors
      * simply cause the promise to reject.  It is the caller's responsibility to trap
      */
+    executeWithoutErrorHandlingAsync(args?: string[]): Promise<void>;
+    /**
+     * @deprecated Use {@link CommandLineParser.executeWithoutErrorHandlingAsync} instead.
+     */
     executeWithoutErrorHandling(args?: string[]): Promise<void>;
     /* Excluded from this release type: _registerDefinedParameters */
     private _validateDefinitions;
@@ -873,6 +884,8 @@ export declare interface IBaseCommandLineDefinitionWithArgument extends IBaseCom
      * @remarks
      * This option is only used when `ICommandLineParserOptions.enableTabCompletionAction`
      * is enabled.
+     *
+     * In a future release, this will be renamed to `getCompletionsAsync`
      */
     completions?: () => Promise<string[]>;
 }
@@ -1133,7 +1146,7 @@ export declare abstract class ScopedCommandLineAction extends CommandLineAction
      */
     get parameters(): ReadonlyArray<CommandLineParameter>;
     /* Excluded from this release type: _processParsedData */
-    /* Excluded from this release type: _execute */
+    /* Excluded from this release type: _executeAsync */
     /* Excluded from this release type: _registerDefinedParameters */
     /**
      * {@inheritdoc CommandLineParameterProvider.onDefineParameters}

package/lib/parameters/CommandLineDefinition.d.ts

@@ -113,6 +113,8 @@ export interface IBaseCommandLineDefinitionWithArgument extends IBaseCommandLine
      * @remarks
      * This option is only used when `ICommandLineParserOptions.enableTabCompletionAction`
      * is enabled.
+     *
+     * In a future release, this will be renamed to `getCompletionsAsync`
      */
     completions?: () => Promise<string[]>;
 }

package/lib/parameters/CommandLineDefinition.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"CommandLineDefinition.d.ts","sourceRoot":"","sources":["../../src/parameters/CommandLineDefinition.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,cAAc,CAAC;AAE5D;;;;GAIG;AACH,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,OAAO,uBAAuB,CAAC;IAEzD;;;;;OAKG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAE7B;;;;;;;;;;;OAWG;IACH,wCAAwC,CAAC,EAAE,OAAO,CAAC;IAEnD;;;;;;;;OAQG;IACH,oBAAoB,CAAC,EAAE,MAAM,EAAE,CAAC;CACjC;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,sCAAuC,SAAQ,0BAA0B;IACxF;;;;;;;OAOG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;;;;OAKG;IACH,WAAW,CAAC,EAAE,MAAM,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;CACvC;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,4BAA4B,CAAC,OAAO,SAAS,MAAM,GAAG,MAAM,CAC3E,SAAQ,0BAA0B;IAClC;;OAEG;IACH,YAAY,EAAE,OAAO,EAAE,CAAC;IAExB;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IAEvB;;;;;OAKG;IACH,WAAW,CAAC,EAAE,MAAM,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC;CACxC;AAED;;;;;;GAMG;AACH,MAAM,WAAW,gCAAgC,CAAC,OAAO,SAAS,MAAM,GAAG,MAAM,CAC/E,SAAQ,0BAA0B;IAClC;;OAEG;IACH,YAAY,EAAE,OAAO,EAAE,CAAC;IAExB;;;;;OAKG;IACH,WAAW,CAAC,EAAE,MAAM,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC;CACxC;AAED;;;;;GAKG;AACH,MAAM,WAAW,0BAA2B,SAAQ,0BAA0B;CAAG;AAEjF;;;;;;GAMG;AACH,MAAM,WAAW,6BAA8B,SAAQ,sCAAsC;IAC3F;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED;;;;;;GAMG;AACH,MAAM,WAAW,iCAAkC,SAAQ,sCAAsC;CAAG;AAEpG;;;;;;GAMG;AACH,MAAM,WAAW,4BAA6B,SAAQ,sCAAsC;IAC1F;;;;;;;OAOG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED;;;;;;GAMG;AACH,MAAM,WAAW,gCAAiC,SAAQ,sCAAsC;CAAG;AAEnG;;;;;GAKG;AACH,MAAM,WAAW,+BAA+B;IAC9C;;;OAGG;IACH,WAAW,EAAE,MAAM,CAAC;CACrB"}
+{"version":3,"file":"CommandLineDefinition.d.ts","sourceRoot":"","sources":["../../src/parameters/CommandLineDefinition.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,cAAc,CAAC;AAE5D;;;;GAIG;AACH,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,OAAO,uBAAuB,CAAC;IAEzD;;;;;OAKG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAE7B;;;;;;;;;;;OAWG;IACH,wCAAwC,CAAC,EAAE,OAAO,CAAC;IAEnD;;;;;;;;OAQG;IACH,oBAAoB,CAAC,EAAE,MAAM,EAAE,CAAC;CACjC;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,sCAAuC,SAAQ,0BAA0B;IACxF;;;;;;;OAOG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;;;;;;OAOG;IACH,WAAW,CAAC,EAAE,MAAM,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;CACvC;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,4BAA4B,CAAC,OAAO,SAAS,MAAM,GAAG,MAAM,CAC3E,SAAQ,0BAA0B;IAClC;;OAEG;IACH,YAAY,EAAE,OAAO,EAAE,CAAC;IAExB;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IAEvB;;;;;OAKG;IACH,WAAW,CAAC,EAAE,MAAM,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC;CACxC;AAED;;;;;;GAMG;AACH,MAAM,WAAW,gCAAgC,CAAC,OAAO,SAAS,MAAM,GAAG,MAAM,CAC/E,SAAQ,0BAA0B;IAClC;;OAEG;IACH,YAAY,EAAE,OAAO,EAAE,CAAC;IAExB;;;;;OAKG;IACH,WAAW,CAAC,EAAE,MAAM,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC;CACxC;AAED;;;;;GAKG;AACH,MAAM,WAAW,0BAA2B,SAAQ,0BAA0B;CAAG;AAEjF;;;;;;GAMG;AACH,MAAM,WAAW,6BAA8B,SAAQ,sCAAsC;IAC3F;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED;;;;;;GAMG;AACH,MAAM,WAAW,iCAAkC,SAAQ,sCAAsC;CAAG;AAEpG;;;;;;GAMG;AACH,MAAM,WAAW,4BAA6B,SAAQ,sCAAsC;IAC1F;;;;;;;OAOG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED;;;;;;GAMG;AACH,MAAM,WAAW,gCAAiC,SAAQ,sCAAsC;CAAG;AAEnG;;;;;GAKG;AACH,MAAM,WAAW,+BAA+B;IAC9C;;;OAGG;IACH,WAAW,EAAE,MAAM,CAAC;CACrB"}

package/lib/parameters/CommandLineDefinition.js.map

@@ -1 +1 @@
-{"version":3,"file":"CommandLineDefinition.js","sourceRoot":"","sources":["../../src/parameters/CommandLineDefinition.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D","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 type { SCOPING_PARAMETER_GROUP } from '../Constants';\n\n/**\n * For use with CommandLineParser, this interface represents a generic command-line parameter\n *\n * @public\n */\nexport interface IBaseCommandLineDefinition {\n  /**\n   * The long name of the flag including double dashes, e.g. \"--do-something\"\n   */\n  parameterLongName: string;\n\n  /**\n   * An optional short name for the flag including the dash, e.g. \"-d\"\n   */\n  parameterShortName?: string;\n\n  /**\n   * An optional parameter group name, shown when invoking the tool with \"--help\"\n   */\n  parameterGroup?: string | typeof SCOPING_PARAMETER_GROUP;\n\n  /**\n   * An optional parameter scope name, used to add a scope-prefixed parameter synonym,\n   * e.g. \"--scope:do-something\". Scopes provide additional flexibility for parameters\n   * in conflict resolution since when a scope is specified, parameters that have\n   * conflicting long names will be defined using only the scope-prefixed name.\n   */\n  parameterScope?: string;\n\n  /**\n   * Documentation for the parameter that will be shown when invoking the tool with \"--help\"\n   */\n  description: string;\n\n  /**\n   * If true, then an error occurs if the parameter was not included on the command-line.\n   */\n  required?: boolean;\n\n  /**\n   * The name of an environment variable that the parameter value will be read from,\n   * if it was omitted from the command-line.  An error will be reported if the\n   * environment value cannot be parsed.\n   *\n   * @remarks\n   * The environment variable name must consist only of upper-case letters, numbers,\n   * and underscores. It may not start with a number. To disable this validation, set\n   * `{@link IBaseCommandLineDefinition.allowNonStandardEnvironmentVariableNames}`\n   * to `true`.\n   *\n   * Syntax notes for environment variable values:\n   *\n   * - Choice Parameter: The value must match one of the defined choices,\n   *   otherwise a validation error is reported.\n   *   An empty string causes the environment variable to be ignored.\n   *\n   * - Flag Parameter: The value must be `1` for true, or `0` for false,\n   *   otherwise a validation error is reported.\n   *   An empty string causes the environment variable to be ignored.\n   *\n   * - Integer Parameter: The value must be an integer number,\n   *   otherwise a validation error is reported.\n   *   An empty string causes the environment variable to be ignored.\n   *\n   * - String Parameter: Any value is accepted, including an empty string.\n   *\n   * - String List Parameter: If the string starts with `[` (ignoring whitespace)\n   *   then it will be parsed as a JSON array, whose elements must be strings,\n   *   numbers, or boolean values.\n   *   If the string does not start with `[`, then it behaves like an\n   *   ordinary String Parameter:  Any value is accepted, including an empty string.\n   */\n  environmentVariable?: string;\n\n  /**\n   * Allows for the use of environment variable names that do not conform to the standard\n   * described by the Shell and Utilities volume of IEEE Std 1003.1-2001. This disables\n   * the validation that is performed on the provided\n   * {@link IBaseCommandLineDefinition.environmentVariable} value by default.\n   *\n   * @remarks\n   * if this is set to `true`, environment variable discovery will vary based on the\n   * platform in use. For example, Windows environment variable names are case-insensitive,\n   * while on Linux, environment variable names are case-sensitive. It is recommended that\n   * this option be used only when necessary based on environmental constraints.\n   */\n  allowNonStandardEnvironmentVariableNames?: boolean;\n\n  /**\n   * Specifies additional names for this parameter that are accepted but not displayed\n   * in the command line help.\n   *\n   * @remarks\n   * This option can be used in cases where a command-line parameter may have been renamed,\n   * but the developer doesn't want to break backwards compatibility with systems that may\n   * still be using the old name. Only the `parameterLongName` syntax is currently allowed.\n   */\n  undocumentedSynonyms?: string[];\n}\n\n/**\n * The common base interface for parameter types that accept an argument.\n *\n * @remarks\n * An argument is an accompanying command-line token, such as \"123\" in the\n * example \"--max-count 123\".\n * @public\n */\nexport interface IBaseCommandLineDefinitionWithArgument extends IBaseCommandLineDefinition {\n  /**\n   * The name of the argument, which will be shown in the command-line help.\n   *\n   * @remarks\n   * For example, if the parameter name is '--count\" and the argument name is \"NUMBER\",\n   * then the command-line help would display \"--count NUMBER\".  The argument name must\n   * be comprised of upper-case letters, numbers, and underscores.  It should be kept short.\n   */\n  argumentName: string;\n\n  /**\n   * An optional callback that provides a list of custom choices for tab completion.\n   * @remarks\n   * This option is only used when `ICommandLineParserOptions.enableTabCompletionAction`\n   * is enabled.\n   */\n  completions?: () => Promise<string[]>;\n}\n\n/**\n * For use with {@link CommandLineParameterProvider.(defineChoiceParameter:1)} and\n * {@link CommandLineParameterProvider.(defineChoiceParameter:2)}, this interface\n * defines a command line parameter which is constrained to a list of possible\n * options.\n *\n * @public\n */\nexport interface ICommandLineChoiceDefinition<TChoice extends string = string>\n  extends IBaseCommandLineDefinition {\n  /**\n   * A list of strings (which contain no spaces), of possible options which can be selected\n   */\n  alternatives: TChoice[];\n\n  /**\n   * {@inheritDoc ICommandLineStringDefinition.defaultValue}\n   */\n  defaultValue?: TChoice;\n\n  /**\n   * An optional callback that provides a list of custom choices for tab completion.\n   * @remarks\n   * This option is only used when `ICommandLineParserOptions.enableTabCompletionAction`\n   * is enabled.\n   */\n  completions?: () => Promise<TChoice[]>;\n}\n\n/**\n * For use with {@link CommandLineParameterProvider.defineChoiceListParameter},\n * this interface defines a command line parameter which is constrained to a list of possible\n * options. The parameter can be specified multiple times to build a list.\n *\n * @public\n */\nexport interface ICommandLineChoiceListDefinition<TChoice extends string = string>\n  extends IBaseCommandLineDefinition {\n  /**\n   * A list of strings (which contain no spaces), of possible options which can be selected\n   */\n  alternatives: TChoice[];\n\n  /**\n   * An optional callback that provides a list of custom choices for tab completion.\n   * @remarks\n   * This option is only used when `ICommandLineParserOptions.enableTabCompletionAction`\n   * is enabled.\n   */\n  completions?: () => Promise<TChoice[]>;\n}\n\n/**\n * For use with {@link CommandLineParameterProvider.defineFlagParameter},\n * this interface defines a command line parameter that is a boolean flag.\n *\n * @public\n */\nexport interface ICommandLineFlagDefinition extends IBaseCommandLineDefinition {}\n\n/**\n * For use with {@link CommandLineParameterProvider.(defineIntegerParameter:1)},\n * {@link CommandLineParameterProvider.(defineIntegerParameter:2)}, this interface\n * defines a command line parameter whose argument is an integer value.\n *\n * @public\n */\nexport interface ICommandLineIntegerDefinition extends IBaseCommandLineDefinitionWithArgument {\n  /**\n   * {@inheritDoc ICommandLineStringDefinition.defaultValue}\n   */\n  defaultValue?: number;\n}\n\n/**\n * For use with {@link CommandLineParameterProvider.defineIntegerListParameter},\n * this interface defines a command line parameter whose argument is an integer value. The\n * parameter can be specified multiple times to build a list.\n *\n * @public\n */\nexport interface ICommandLineIntegerListDefinition extends IBaseCommandLineDefinitionWithArgument {}\n\n/**\n * For use with {@link CommandLineParameterProvider.(defineStringParameter:1)} and\n * {@link CommandLineParameterProvider.(defineStringParameter:2)}, this interface\n * defines a command line parameter whose argument is a string value.\n *\n * @public\n */\nexport interface ICommandLineStringDefinition extends IBaseCommandLineDefinitionWithArgument {\n  /**\n   * The default value which will be used if the parameter is omitted from the command line.\n   *\n   * @remarks\n   * If a default value is specified, then {@link IBaseCommandLineDefinition.required}\n   * must not be true.  Instead, a custom error message should be used to report cases\n   * where a default value was not available.\n   */\n  defaultValue?: string;\n}\n\n/**\n * For use with {@link CommandLineParameterProvider.defineStringListParameter},\n * this interface defines a command line parameter whose argument is a single text string.\n * The parameter can be specified multiple times to build a list.\n *\n * @public\n */\nexport interface ICommandLineStringListDefinition extends IBaseCommandLineDefinitionWithArgument {}\n\n/**\n * For use with {@link CommandLineParameterProvider.defineCommandLineRemainder},\n * this interface defines a rule that captures any remaining command line arguments after the recognized portion.\n *\n * @public\n */\nexport interface ICommandLineRemainderDefinition {\n  /**\n   * Documentation for how the remaining arguments will be used.  This will be shown when invoking\n   * the tool with \"--help\".\n   */\n  description: string;\n}\n"]}
+{"version":3,"file":"CommandLineDefinition.js","sourceRoot":"","sources":["../../src/parameters/CommandLineDefinition.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D","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 type { SCOPING_PARAMETER_GROUP } from '../Constants';\n\n/**\n * For use with CommandLineParser, this interface represents a generic command-line parameter\n *\n * @public\n */\nexport interface IBaseCommandLineDefinition {\n  /**\n   * The long name of the flag including double dashes, e.g. \"--do-something\"\n   */\n  parameterLongName: string;\n\n  /**\n   * An optional short name for the flag including the dash, e.g. \"-d\"\n   */\n  parameterShortName?: string;\n\n  /**\n   * An optional parameter group name, shown when invoking the tool with \"--help\"\n   */\n  parameterGroup?: string | typeof SCOPING_PARAMETER_GROUP;\n\n  /**\n   * An optional parameter scope name, used to add a scope-prefixed parameter synonym,\n   * e.g. \"--scope:do-something\". Scopes provide additional flexibility for parameters\n   * in conflict resolution since when a scope is specified, parameters that have\n   * conflicting long names will be defined using only the scope-prefixed name.\n   */\n  parameterScope?: string;\n\n  /**\n   * Documentation for the parameter that will be shown when invoking the tool with \"--help\"\n   */\n  description: string;\n\n  /**\n   * If true, then an error occurs if the parameter was not included on the command-line.\n   */\n  required?: boolean;\n\n  /**\n   * The name of an environment variable that the parameter value will be read from,\n   * if it was omitted from the command-line.  An error will be reported if the\n   * environment value cannot be parsed.\n   *\n   * @remarks\n   * The environment variable name must consist only of upper-case letters, numbers,\n   * and underscores. It may not start with a number. To disable this validation, set\n   * `{@link IBaseCommandLineDefinition.allowNonStandardEnvironmentVariableNames}`\n   * to `true`.\n   *\n   * Syntax notes for environment variable values:\n   *\n   * - Choice Parameter: The value must match one of the defined choices,\n   *   otherwise a validation error is reported.\n   *   An empty string causes the environment variable to be ignored.\n   *\n   * - Flag Parameter: The value must be `1` for true, or `0` for false,\n   *   otherwise a validation error is reported.\n   *   An empty string causes the environment variable to be ignored.\n   *\n   * - Integer Parameter: The value must be an integer number,\n   *   otherwise a validation error is reported.\n   *   An empty string causes the environment variable to be ignored.\n   *\n   * - String Parameter: Any value is accepted, including an empty string.\n   *\n   * - String List Parameter: If the string starts with `[` (ignoring whitespace)\n   *   then it will be parsed as a JSON array, whose elements must be strings,\n   *   numbers, or boolean values.\n   *   If the string does not start with `[`, then it behaves like an\n   *   ordinary String Parameter:  Any value is accepted, including an empty string.\n   */\n  environmentVariable?: string;\n\n  /**\n   * Allows for the use of environment variable names that do not conform to the standard\n   * described by the Shell and Utilities volume of IEEE Std 1003.1-2001. This disables\n   * the validation that is performed on the provided\n   * {@link IBaseCommandLineDefinition.environmentVariable} value by default.\n   *\n   * @remarks\n   * if this is set to `true`, environment variable discovery will vary based on the\n   * platform in use. For example, Windows environment variable names are case-insensitive,\n   * while on Linux, environment variable names are case-sensitive. It is recommended that\n   * this option be used only when necessary based on environmental constraints.\n   */\n  allowNonStandardEnvironmentVariableNames?: boolean;\n\n  /**\n   * Specifies additional names for this parameter that are accepted but not displayed\n   * in the command line help.\n   *\n   * @remarks\n   * This option can be used in cases where a command-line parameter may have been renamed,\n   * but the developer doesn't want to break backwards compatibility with systems that may\n   * still be using the old name. Only the `parameterLongName` syntax is currently allowed.\n   */\n  undocumentedSynonyms?: string[];\n}\n\n/**\n * The common base interface for parameter types that accept an argument.\n *\n * @remarks\n * An argument is an accompanying command-line token, such as \"123\" in the\n * example \"--max-count 123\".\n * @public\n */\nexport interface IBaseCommandLineDefinitionWithArgument extends IBaseCommandLineDefinition {\n  /**\n   * The name of the argument, which will be shown in the command-line help.\n   *\n   * @remarks\n   * For example, if the parameter name is '--count\" and the argument name is \"NUMBER\",\n   * then the command-line help would display \"--count NUMBER\".  The argument name must\n   * be comprised of upper-case letters, numbers, and underscores.  It should be kept short.\n   */\n  argumentName: string;\n\n  /**\n   * An optional callback that provides a list of custom choices for tab completion.\n   * @remarks\n   * This option is only used when `ICommandLineParserOptions.enableTabCompletionAction`\n   * is enabled.\n   *\n   * In a future release, this will be renamed to `getCompletionsAsync`\n   */\n  completions?: () => Promise<string[]>;\n}\n\n/**\n * For use with {@link CommandLineParameterProvider.(defineChoiceParameter:1)} and\n * {@link CommandLineParameterProvider.(defineChoiceParameter:2)}, this interface\n * defines a command line parameter which is constrained to a list of possible\n * options.\n *\n * @public\n */\nexport interface ICommandLineChoiceDefinition<TChoice extends string = string>\n  extends IBaseCommandLineDefinition {\n  /**\n   * A list of strings (which contain no spaces), of possible options which can be selected\n   */\n  alternatives: TChoice[];\n\n  /**\n   * {@inheritDoc ICommandLineStringDefinition.defaultValue}\n   */\n  defaultValue?: TChoice;\n\n  /**\n   * An optional callback that provides a list of custom choices for tab completion.\n   * @remarks\n   * This option is only used when `ICommandLineParserOptions.enableTabCompletionAction`\n   * is enabled.\n   */\n  completions?: () => Promise<TChoice[]>;\n}\n\n/**\n * For use with {@link CommandLineParameterProvider.defineChoiceListParameter},\n * this interface defines a command line parameter which is constrained to a list of possible\n * options. The parameter can be specified multiple times to build a list.\n *\n * @public\n */\nexport interface ICommandLineChoiceListDefinition<TChoice extends string = string>\n  extends IBaseCommandLineDefinition {\n  /**\n   * A list of strings (which contain no spaces), of possible options which can be selected\n   */\n  alternatives: TChoice[];\n\n  /**\n   * An optional callback that provides a list of custom choices for tab completion.\n   * @remarks\n   * This option is only used when `ICommandLineParserOptions.enableTabCompletionAction`\n   * is enabled.\n   */\n  completions?: () => Promise<TChoice[]>;\n}\n\n/**\n * For use with {@link CommandLineParameterProvider.defineFlagParameter},\n * this interface defines a command line parameter that is a boolean flag.\n *\n * @public\n */\nexport interface ICommandLineFlagDefinition extends IBaseCommandLineDefinition {}\n\n/**\n * For use with {@link CommandLineParameterProvider.(defineIntegerParameter:1)},\n * {@link CommandLineParameterProvider.(defineIntegerParameter:2)}, this interface\n * defines a command line parameter whose argument is an integer value.\n *\n * @public\n */\nexport interface ICommandLineIntegerDefinition extends IBaseCommandLineDefinitionWithArgument {\n  /**\n   * {@inheritDoc ICommandLineStringDefinition.defaultValue}\n   */\n  defaultValue?: number;\n}\n\n/**\n * For use with {@link CommandLineParameterProvider.defineIntegerListParameter},\n * this interface defines a command line parameter whose argument is an integer value. The\n * parameter can be specified multiple times to build a list.\n *\n * @public\n */\nexport interface ICommandLineIntegerListDefinition extends IBaseCommandLineDefinitionWithArgument {}\n\n/**\n * For use with {@link CommandLineParameterProvider.(defineStringParameter:1)} and\n * {@link CommandLineParameterProvider.(defineStringParameter:2)}, this interface\n * defines a command line parameter whose argument is a string value.\n *\n * @public\n */\nexport interface ICommandLineStringDefinition extends IBaseCommandLineDefinitionWithArgument {\n  /**\n   * The default value which will be used if the parameter is omitted from the command line.\n   *\n   * @remarks\n   * If a default value is specified, then {@link IBaseCommandLineDefinition.required}\n   * must not be true.  Instead, a custom error message should be used to report cases\n   * where a default value was not available.\n   */\n  defaultValue?: string;\n}\n\n/**\n * For use with {@link CommandLineParameterProvider.defineStringListParameter},\n * this interface defines a command line parameter whose argument is a single text string.\n * The parameter can be specified multiple times to build a list.\n *\n * @public\n */\nexport interface ICommandLineStringListDefinition extends IBaseCommandLineDefinitionWithArgument {}\n\n/**\n * For use with {@link CommandLineParameterProvider.defineCommandLineRemainder},\n * this interface defines a rule that captures any remaining command line arguments after the recognized portion.\n *\n * @public\n */\nexport interface ICommandLineRemainderDefinition {\n  /**\n   * Documentation for how the remaining arguments will be used.  This will be shown when invoking\n   * the tool with \"--help\".\n   */\n  description: string;\n}\n"]}

package/lib/providers/AliasCommandLineAction.js

@@ -143,7 +143,7 @@ class AliasCommandLineAction extends CommandLineAction_1.CommandLineAction {
      * Executes the target action.
      */
     async onExecute() {
-        await this.targetAction._execute();
+        await this.targetAction._executeAsync();
     }
 }
 exports.AliasCommandLineAction = AliasCommandLineAction;

package/lib/providers/AliasCommandLineAction.js.map

@@ -1 +1 @@
-{"version":3,"file":"AliasCommandLineAction.js","sourceRoot":"","sources":["../../src/providers/AliasCommandLineAction.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D;;;;;;;;;;;;;;;;;;;;;;;;;;AAE3D,mDAAqC;AAErC,2DAAwD;AACxD,2DAImC;AA+BnC;;;;;;;;;GASG;AACH,MAAa,sBAAuB,SAAQ,qCAAiB;IAa3D,YAAmB,OAAuC;QACxD,MAAM,YAAY,GAAW,OAAO,CAAC,YAAY,CAAC;QAClD,MAAM,gBAAgB,GAAW,OAAO,CAAC,YAAY,CAAC,UAAU,CAAC;QACjE,MAAM,uBAAuB,GAAW,CAAC,OAAO,CAAC,iBAAiB,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACpF,MAAM,OAAO,GAAW,iBAAiB,YAAY,IAAI,gBAAgB,GACvE,uBAAuB,CAAC,CAAC,CAAC,IAAI,uBAAuB,EAAE,CAAC,CAAC,CAAC,EAC5D,IAAI,CAAC;QAEL,KAAK,CAAC;YACJ,UAAU,EAAE,OAAO,CAAC,SAAS;YAC7B,OAAO;YACP,aAAa,EACX,GAAG,OAAO,oDAAoD;gBAC9D,IAAI,YAAY,IAAI,gBAAgB,WAAW;SAClD,CAAC,CAAC;QAhBG,qBAAgB,GAAwB,IAAI,GAAG,EAAE,CAAC;QAkBxD,IAAI,CAAC,YAAY,GAAG,OAAO,CAAC,YAAY,CAAC;QACzC,IAAI,CAAC,iBAAiB,GAAG,OAAO,CAAC,iBAAiB,IAAI,EAAE,CAAC;IAC3D,CAAC;IAED,gBAAgB;IACT,0BAA0B,CAAC,KAAsC;QACtE,cAAc;QACd,mGAAmG;QACnG,mBAAmB;QACnB,KAAK,MAAM,SAAS,IAAI,IAAI,CAAC,YAAY,CAAC,UAAoC,EAAE,CAAC;YAC/E,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,SAAS,EAAE,GAAG,SAAS,CAAC;YAChD,IAAI,cAAwC,CAAC;YAC7C,MAAM,WAAW,GAA0E;gBACzF,iBAAiB,EAAE,QAAQ;gBAC3B,kBAAkB,EAAE,SAAS;aAC9B,CAAC;YACF,QAAQ,IAAI,EAAE,CAAC;gBACb,KAAK,sCAAwB,CAAC,MAAM;oBAClC,cAAc,GAAG,IAAI,CAAC,qBAAqB,+CACtC,WAAW,GACX,SAAS,KACZ,YAAY,EAAE,CAAC,GAAG,SAAS,CAAC,YAAY,CAAC,IACzC,CAAC;oBACH,MAAM;gBACR,KAAK,sCAAwB,CAAC,UAAU;oBACtC,cAAc,GAAG,IAAI,CAAC,yBAAyB,+CAC1C,WAAW,GACX,SAAS,KACZ,YAAY,EAAE,CAAC,GAAG,SAAS,CAAC,YAAY,CAAC,IACzC,CAAC;oBACH,MAAM;gBACR,KAAK,sCAAwB,CAAC,IAAI;oBAChC,cAAc,GAAG,IAAI,CAAC,mBAAmB,iCAAM,WAAW,GAAK,SAAS,EAAG,CAAC;oBAC5E,MAAM;gBACR,KAAK,sCAAwB,CAAC,OAAO;oBACnC,cAAc,GAAG,IAAI,CAAC,sBAAsB,iCAAM,WAAW,GAAK,SAAS,EAAG,CAAC;oBAC/E,MAAM;gBACR,KAAK,sCAAwB,CAAC,WAAW;oBACvC,cAAc,GAAG,IAAI,CAAC,0BAA0B,iCAAM,WAAW,GAAK,SAAS,EAAG,CAAC;oBACnF,MAAM;gBACR,KAAK,sCAAwB,CAAC,MAAM;oBAClC,cAAc,GAAG,IAAI,CAAC,qBAAqB,iCAAM,WAAW,GAAK,SAAS,EAAG,CAAC;oBAC9E,MAAM;gBACR,KAAK,sCAAwB,CAAC,UAAU;oBACtC,cAAc,GAAG,IAAI,CAAC,yBAAyB,iCAAM,WAAW,GAAK,SAAS,EAAG,CAAC;oBAClF,MAAM;gBACR;oBACE,MAAM,IAAI,KAAK,CAAC,+BAA+B,IAAI,EAAE,CAAC,CAAC;YAC3D,CAAC;YAED,2FAA2F;YAC3F,uEAAuE;YACvE,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,cAAc,CAAC,UAAW,EAAE,SAAS,CAAC,UAAW,CAAC,CAAC;QAC/E,CAAC;QAED,4FAA4F;QAC5F,sCAAsC;QACtC,IAAI,IAAI,CAAC,YAAY,CAAC,SAAS,EAAE,CAAC;YAChC,IAAI,CAAC,0BAA0B,CAAC,IAAI,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC;YAC7D,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,QAAQ,CAAC,KAAK,CAAC,SAAS,EAAE,QAAQ,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;QAChF,CAAC;QAED,gGAAgG;QAChG,iGAAiG;QACjG,mFAAmF;QACnF,IAAI,CAAC,YAAY,CAAC,0BAA0B,CAAC,KAAK,CAAC,CAAC;QACpD,KAAK,CAAC,0BAA0B,CAAC,KAAK,CAAC,CAAC;QAExC,+EAA+E;QAC/E,qCAAqC;QACrC,KAAK,MAAM,CAAC,sBAAsB,EAAE,SAAS,CAAC,IAAI,IAAI,CAAC,mCAAmC,EAAE,CAAC;YAC3F,MAAM,eAAe,GACnB,IAAI,CAAC,YAAY,CAAC,mCAAmC,CAAC,GAAG,CAAC,sBAAsB,CAAC,CAAC;YAEpF,yFAAyF;YACzF,IAAI,eAAe,EAAE,CAAC;gBACpB,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,SAAS,EAAE,eAAe,CAAC,CAAC;YACxD,CAAC;QACH,CAAC;IACH,CAAC;IAED;;;OAGG;IACI,kBAAkB,CAAC,aAAwC,EAAE,IAA4B;QAC9F,oGAAoG;QACpG,MAAM,UAAU,GAA2B;YACzC,MAAM,EAAE,IAAI,CAAC,YAAY,CAAC,UAAU;YACpC,WAAW,EAAE,IAAI,CAAC,MAAM;YACxB,kBAAkB,EAAE,IAAI,CAAC,aAAa;SACvC,CAAC;QACF,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;YAChD,yFAAyF;YACzF,qFAAqF;YACrF,IAAI,GAAG,KAAK,QAAQ,EAAE,CAAC;gBACrB,SAAS;YACX,CAAC;YACD,MAAM,SAAS,GAAuB,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;YACrE,UAAU,CAAC,SAAS,aAAT,SAAS,cAAT,SAAS,GAAI,GAAG,CAAC,GAAG,KAAK,CAAC;QACvC,CAAC;QACD,IAAI,CAAC,YAAY,CAAC,kBAAkB,CAAC,aAAa,EAAE,UAAU,CAAC,CAAC;IAClE,CAAC;IAED;;OAEG;IACO,KAAK,CAAC,SAAS;QACvB,MAAM,IAAI,CAAC,YAAY,CAAC,QAAQ,EAAE,CAAC;IACrC,CAAC;CACF;AA3ID,wDA2IC","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 { CommandLineAction } from './CommandLineAction';\nimport {\n  CommandLineParameterKind,\n  type CommandLineParameterBase,\n  type CommandLineParameter\n} from '../parameters/BaseClasses';\nimport type { ICommandLineParserData, IRegisterDefinedParametersState } from './CommandLineParameterProvider';\nimport type { ICommandLineParserOptions } from './CommandLineParser';\n\n/**\n * Options for the AliasCommandLineAction constructor.\n * @public\n */\nexport interface IAliasCommandLineActionOptions {\n  /**\n   * The name of your tool when invoked from the command line. Used for generating help text.\n   */\n  toolFilename: string;\n\n  /**\n   * The name of the alias.  For example, if the tool is called \"example\",\n   * then the \"build\" alias might be invoked as: \"example build -q --some-other-option\"\n   */\n  aliasName: string;\n\n  /**\n   * A list of default parameters to pass to the target action.\n   */\n  defaultParameters?: string[];\n\n  /**\n   * The action that this alias invokes.\n   */\n  targetAction: CommandLineAction;\n}\n\n/**\n * Represents a sub-command that is part of the CommandLineParser command line.\n * The sub-command is an alias for another existing action.\n *\n * The alias 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\").\n *\n * @public\n */\nexport class AliasCommandLineAction extends CommandLineAction {\n  /**\n   * The action that this alias invokes.\n   */\n  public readonly targetAction: CommandLineAction;\n\n  /**\n   * A list of default arguments to pass to the target action.\n   */\n  public readonly defaultParameters: ReadonlyArray<string>;\n\n  private _parameterKeyMap: Map<string, string> = new Map();\n\n  public constructor(options: IAliasCommandLineActionOptions) {\n    const toolFilename: string = options.toolFilename;\n    const targetActionName: string = options.targetAction.actionName;\n    const defaultParametersString: string = (options.defaultParameters || []).join(' ');\n    const summary: string = `An alias for \"${toolFilename} ${targetActionName}${\n      defaultParametersString ? ` ${defaultParametersString}` : ''\n    }\".`;\n\n    super({\n      actionName: options.aliasName,\n      summary,\n      documentation:\n        `${summary} For more information on the aliased command, use ` +\n        `\"${toolFilename} ${targetActionName} --help\".`\n    });\n\n    this.targetAction = options.targetAction;\n    this.defaultParameters = options.defaultParameters || [];\n  }\n\n  /** @internal */\n  public _registerDefinedParameters(state: IRegisterDefinedParametersState): void {\n    /* override */\n    // All parameters are going to be defined by the target action. Re-use the target action parameters\n    // for this action.\n    for (const parameter of this.targetAction.parameters as CommandLineParameter[]) {\n      const { kind, longName, shortName } = parameter;\n      let aliasParameter: CommandLineParameterBase;\n      const nameOptions: { parameterLongName: string; parameterShortName: string | undefined } = {\n        parameterLongName: longName,\n        parameterShortName: shortName\n      };\n      switch (kind) {\n        case CommandLineParameterKind.Choice:\n          aliasParameter = this.defineChoiceParameter({\n            ...nameOptions,\n            ...parameter,\n            alternatives: [...parameter.alternatives]\n          });\n          break;\n        case CommandLineParameterKind.ChoiceList:\n          aliasParameter = this.defineChoiceListParameter({\n            ...nameOptions,\n            ...parameter,\n            alternatives: [...parameter.alternatives]\n          });\n          break;\n        case CommandLineParameterKind.Flag:\n          aliasParameter = this.defineFlagParameter({ ...nameOptions, ...parameter });\n          break;\n        case CommandLineParameterKind.Integer:\n          aliasParameter = this.defineIntegerParameter({ ...nameOptions, ...parameter });\n          break;\n        case CommandLineParameterKind.IntegerList:\n          aliasParameter = this.defineIntegerListParameter({ ...nameOptions, ...parameter });\n          break;\n        case CommandLineParameterKind.String:\n          aliasParameter = this.defineStringParameter({ ...nameOptions, ...parameter });\n          break;\n        case CommandLineParameterKind.StringList:\n          aliasParameter = this.defineStringListParameter({ ...nameOptions, ...parameter });\n          break;\n        default:\n          throw new Error(`Unsupported parameter kind: ${kind}`);\n      }\n\n      // We know the parserKey is defined because the underlying _defineParameter method sets it,\n      // and all parameters that we have access to have already been defined.\n      this._parameterKeyMap.set(aliasParameter._parserKey!, parameter._parserKey!);\n    }\n\n    // We also need to register the remainder parameter if the target action has one. The parser\n    // key for this parameter is constant.\n    if (this.targetAction.remainder) {\n      this.defineCommandLineRemainder(this.targetAction.remainder);\n      this._parameterKeyMap.set(argparse.Const.REMAINDER, argparse.Const.REMAINDER);\n    }\n\n    // Finally, register the parameters with the parser. We need to make sure that the target action\n    // is registered, since we need to re-use its parameters, and ambiguous parameters are discovered\n    // during registration. This will no-op if the target action is already registered.\n    this.targetAction._registerDefinedParameters(state);\n    super._registerDefinedParameters(state);\n\n    // We need to re-map the ambiguous parameters after they are defined by calling\n    // super._registerDefinedParameters()\n    for (const [ambiguousParameterName, parserKey] of this._ambiguousParameterParserKeysByName) {\n      const targetParserKey: string | undefined =\n        this.targetAction._ambiguousParameterParserKeysByName.get(ambiguousParameterName);\n\n      // If we have a mapping for the specified key, then use it. Otherwise, use the key as-is.\n      if (targetParserKey) {\n        this._parameterKeyMap.set(parserKey, targetParserKey);\n      }\n    }\n  }\n\n  /**\n   * {@inheritdoc CommandLineParameterProvider._processParsedData}\n   * @internal\n   */\n  public _processParsedData(parserOptions: ICommandLineParserOptions, data: ICommandLineParserData): void {\n    // Re-map the parsed data to the target action's parameters and execute the target action processor.\n    const targetData: ICommandLineParserData = {\n      action: this.targetAction.actionName,\n      aliasAction: data.action,\n      aliasDocumentation: this.documentation\n    };\n    for (const [key, value] of Object.entries(data)) {\n      // If we have a mapping for the specified key, then use it. Otherwise, use the key as-is.\n      // Skip over the action key though, since we've already re-mapped it to \"aliasAction\"\n      if (key === 'action') {\n        continue;\n      }\n      const targetKey: string | undefined = this._parameterKeyMap.get(key);\n      targetData[targetKey ?? key] = value;\n    }\n    this.targetAction._processParsedData(parserOptions, targetData);\n  }\n\n  /**\n   * Executes the target action.\n   */\n  protected async onExecute(): Promise<void> {\n    await this.targetAction._execute();\n  }\n}\n"]}
+{"version":3,"file":"AliasCommandLineAction.js","sourceRoot":"","sources":["../../src/providers/AliasCommandLineAction.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D;;;;;;;;;;;;;;;;;;;;;;;;;;AAE3D,mDAAqC;AAErC,2DAAwD;AACxD,2DAImC;AA+BnC;;;;;;;;;GASG;AACH,MAAa,sBAAuB,SAAQ,qCAAiB;IAa3D,YAAmB,OAAuC;QACxD,MAAM,YAAY,GAAW,OAAO,CAAC,YAAY,CAAC;QAClD,MAAM,gBAAgB,GAAW,OAAO,CAAC,YAAY,CAAC,UAAU,CAAC;QACjE,MAAM,uBAAuB,GAAW,CAAC,OAAO,CAAC,iBAAiB,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACpF,MAAM,OAAO,GAAW,iBAAiB,YAAY,IAAI,gBAAgB,GACvE,uBAAuB,CAAC,CAAC,CAAC,IAAI,uBAAuB,EAAE,CAAC,CAAC,CAAC,EAC5D,IAAI,CAAC;QAEL,KAAK,CAAC;YACJ,UAAU,EAAE,OAAO,CAAC,SAAS;YAC7B,OAAO;YACP,aAAa,EACX,GAAG,OAAO,oDAAoD;gBAC9D,IAAI,YAAY,IAAI,gBAAgB,WAAW;SAClD,CAAC,CAAC;QAhBG,qBAAgB,GAAwB,IAAI,GAAG,EAAE,CAAC;QAkBxD,IAAI,CAAC,YAAY,GAAG,OAAO,CAAC,YAAY,CAAC;QACzC,IAAI,CAAC,iBAAiB,GAAG,OAAO,CAAC,iBAAiB,IAAI,EAAE,CAAC;IAC3D,CAAC;IAED,gBAAgB;IACT,0BAA0B,CAAC,KAAsC;QACtE,cAAc;QACd,mGAAmG;QACnG,mBAAmB;QACnB,KAAK,MAAM,SAAS,IAAI,IAAI,CAAC,YAAY,CAAC,UAAoC,EAAE,CAAC;YAC/E,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,SAAS,EAAE,GAAG,SAAS,CAAC;YAChD,IAAI,cAAwC,CAAC;YAC7C,MAAM,WAAW,GAA0E;gBACzF,iBAAiB,EAAE,QAAQ;gBAC3B,kBAAkB,EAAE,SAAS;aAC9B,CAAC;YACF,QAAQ,IAAI,EAAE,CAAC;gBACb,KAAK,sCAAwB,CAAC,MAAM;oBAClC,cAAc,GAAG,IAAI,CAAC,qBAAqB,+CACtC,WAAW,GACX,SAAS,KACZ,YAAY,EAAE,CAAC,GAAG,SAAS,CAAC,YAAY,CAAC,IACzC,CAAC;oBACH,MAAM;gBACR,KAAK,sCAAwB,CAAC,UAAU;oBACtC,cAAc,GAAG,IAAI,CAAC,yBAAyB,+CAC1C,WAAW,GACX,SAAS,KACZ,YAAY,EAAE,CAAC,GAAG,SAAS,CAAC,YAAY,CAAC,IACzC,CAAC;oBACH,MAAM;gBACR,KAAK,sCAAwB,CAAC,IAAI;oBAChC,cAAc,GAAG,IAAI,CAAC,mBAAmB,iCAAM,WAAW,GAAK,SAAS,EAAG,CAAC;oBAC5E,MAAM;gBACR,KAAK,sCAAwB,CAAC,OAAO;oBACnC,cAAc,GAAG,IAAI,CAAC,sBAAsB,iCAAM,WAAW,GAAK,SAAS,EAAG,CAAC;oBAC/E,MAAM;gBACR,KAAK,sCAAwB,CAAC,WAAW;oBACvC,cAAc,GAAG,IAAI,CAAC,0BAA0B,iCAAM,WAAW,GAAK,SAAS,EAAG,CAAC;oBACnF,MAAM;gBACR,KAAK,sCAAwB,CAAC,MAAM;oBAClC,cAAc,GAAG,IAAI,CAAC,qBAAqB,iCAAM,WAAW,GAAK,SAAS,EAAG,CAAC;oBAC9E,MAAM;gBACR,KAAK,sCAAwB,CAAC,UAAU;oBACtC,cAAc,GAAG,IAAI,CAAC,yBAAyB,iCAAM,WAAW,GAAK,SAAS,EAAG,CAAC;oBAClF,MAAM;gBACR;oBACE,MAAM,IAAI,KAAK,CAAC,+BAA+B,IAAI,EAAE,CAAC,CAAC;YAC3D,CAAC;YAED,2FAA2F;YAC3F,uEAAuE;YACvE,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,cAAc,CAAC,UAAW,EAAE,SAAS,CAAC,UAAW,CAAC,CAAC;QAC/E,CAAC;QAED,4FAA4F;QAC5F,sCAAsC;QACtC,IAAI,IAAI,CAAC,YAAY,CAAC,SAAS,EAAE,CAAC;YAChC,IAAI,CAAC,0BAA0B,CAAC,IAAI,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC;YAC7D,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,QAAQ,CAAC,KAAK,CAAC,SAAS,EAAE,QAAQ,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;QAChF,CAAC;QAED,gGAAgG;QAChG,iGAAiG;QACjG,mFAAmF;QACnF,IAAI,CAAC,YAAY,CAAC,0BAA0B,CAAC,KAAK,CAAC,CAAC;QACpD,KAAK,CAAC,0BAA0B,CAAC,KAAK,CAAC,CAAC;QAExC,+EAA+E;QAC/E,qCAAqC;QACrC,KAAK,MAAM,CAAC,sBAAsB,EAAE,SAAS,CAAC,IAAI,IAAI,CAAC,mCAAmC,EAAE,CAAC;YAC3F,MAAM,eAAe,GACnB,IAAI,CAAC,YAAY,CAAC,mCAAmC,CAAC,GAAG,CAAC,sBAAsB,CAAC,CAAC;YAEpF,yFAAyF;YACzF,IAAI,eAAe,EAAE,CAAC;gBACpB,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,SAAS,EAAE,eAAe,CAAC,CAAC;YACxD,CAAC;QACH,CAAC;IACH,CAAC;IAED;;;OAGG;IACI,kBAAkB,CAAC,aAAwC,EAAE,IAA4B;QAC9F,oGAAoG;QACpG,MAAM,UAAU,GAA2B;YACzC,MAAM,EAAE,IAAI,CAAC,YAAY,CAAC,UAAU;YACpC,WAAW,EAAE,IAAI,CAAC,MAAM;YACxB,kBAAkB,EAAE,IAAI,CAAC,aAAa;SACvC,CAAC;QACF,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;YAChD,yFAAyF;YACzF,qFAAqF;YACrF,IAAI,GAAG,KAAK,QAAQ,EAAE,CAAC;gBACrB,SAAS;YACX,CAAC;YACD,MAAM,SAAS,GAAuB,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;YACrE,UAAU,CAAC,SAAS,aAAT,SAAS,cAAT,SAAS,GAAI,GAAG,CAAC,GAAG,KAAK,CAAC;QACvC,CAAC;QACD,IAAI,CAAC,YAAY,CAAC,kBAAkB,CAAC,aAAa,EAAE,UAAU,CAAC,CAAC;IAClE,CAAC;IAED;;OAEG;IACO,KAAK,CAAC,SAAS;QACvB,MAAM,IAAI,CAAC,YAAY,CAAC,aAAa,EAAE,CAAC;IAC1C,CAAC;CACF;AA3ID,wDA2IC","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 { CommandLineAction } from './CommandLineAction';\nimport {\n  CommandLineParameterKind,\n  type CommandLineParameterBase,\n  type CommandLineParameter\n} from '../parameters/BaseClasses';\nimport type { ICommandLineParserData, IRegisterDefinedParametersState } from './CommandLineParameterProvider';\nimport type { ICommandLineParserOptions } from './CommandLineParser';\n\n/**\n * Options for the AliasCommandLineAction constructor.\n * @public\n */\nexport interface IAliasCommandLineActionOptions {\n  /**\n   * The name of your tool when invoked from the command line. Used for generating help text.\n   */\n  toolFilename: string;\n\n  /**\n   * The name of the alias.  For example, if the tool is called \"example\",\n   * then the \"build\" alias might be invoked as: \"example build -q --some-other-option\"\n   */\n  aliasName: string;\n\n  /**\n   * A list of default parameters to pass to the target action.\n   */\n  defaultParameters?: string[];\n\n  /**\n   * The action that this alias invokes.\n   */\n  targetAction: CommandLineAction;\n}\n\n/**\n * Represents a sub-command that is part of the CommandLineParser command line.\n * The sub-command is an alias for another existing action.\n *\n * The alias 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\").\n *\n * @public\n */\nexport class AliasCommandLineAction extends CommandLineAction {\n  /**\n   * The action that this alias invokes.\n   */\n  public readonly targetAction: CommandLineAction;\n\n  /**\n   * A list of default arguments to pass to the target action.\n   */\n  public readonly defaultParameters: ReadonlyArray<string>;\n\n  private _parameterKeyMap: Map<string, string> = new Map();\n\n  public constructor(options: IAliasCommandLineActionOptions) {\n    const toolFilename: string = options.toolFilename;\n    const targetActionName: string = options.targetAction.actionName;\n    const defaultParametersString: string = (options.defaultParameters || []).join(' ');\n    const summary: string = `An alias for \"${toolFilename} ${targetActionName}${\n      defaultParametersString ? ` ${defaultParametersString}` : ''\n    }\".`;\n\n    super({\n      actionName: options.aliasName,\n      summary,\n      documentation:\n        `${summary} For more information on the aliased command, use ` +\n        `\"${toolFilename} ${targetActionName} --help\".`\n    });\n\n    this.targetAction = options.targetAction;\n    this.defaultParameters = options.defaultParameters || [];\n  }\n\n  /** @internal */\n  public _registerDefinedParameters(state: IRegisterDefinedParametersState): void {\n    /* override */\n    // All parameters are going to be defined by the target action. Re-use the target action parameters\n    // for this action.\n    for (const parameter of this.targetAction.parameters as CommandLineParameter[]) {\n      const { kind, longName, shortName } = parameter;\n      let aliasParameter: CommandLineParameterBase;\n      const nameOptions: { parameterLongName: string; parameterShortName: string | undefined } = {\n        parameterLongName: longName,\n        parameterShortName: shortName\n      };\n      switch (kind) {\n        case CommandLineParameterKind.Choice:\n          aliasParameter = this.defineChoiceParameter({\n            ...nameOptions,\n            ...parameter,\n            alternatives: [...parameter.alternatives]\n          });\n          break;\n        case CommandLineParameterKind.ChoiceList:\n          aliasParameter = this.defineChoiceListParameter({\n            ...nameOptions,\n            ...parameter,\n            alternatives: [...parameter.alternatives]\n          });\n          break;\n        case CommandLineParameterKind.Flag:\n          aliasParameter = this.defineFlagParameter({ ...nameOptions, ...parameter });\n          break;\n        case CommandLineParameterKind.Integer:\n          aliasParameter = this.defineIntegerParameter({ ...nameOptions, ...parameter });\n          break;\n        case CommandLineParameterKind.IntegerList:\n          aliasParameter = this.defineIntegerListParameter({ ...nameOptions, ...parameter });\n          break;\n        case CommandLineParameterKind.String:\n          aliasParameter = this.defineStringParameter({ ...nameOptions, ...parameter });\n          break;\n        case CommandLineParameterKind.StringList:\n          aliasParameter = this.defineStringListParameter({ ...nameOptions, ...parameter });\n          break;\n        default:\n          throw new Error(`Unsupported parameter kind: ${kind}`);\n      }\n\n      // We know the parserKey is defined because the underlying _defineParameter method sets it,\n      // and all parameters that we have access to have already been defined.\n      this._parameterKeyMap.set(aliasParameter._parserKey!, parameter._parserKey!);\n    }\n\n    // We also need to register the remainder parameter if the target action has one. The parser\n    // key for this parameter is constant.\n    if (this.targetAction.remainder) {\n      this.defineCommandLineRemainder(this.targetAction.remainder);\n      this._parameterKeyMap.set(argparse.Const.REMAINDER, argparse.Const.REMAINDER);\n    }\n\n    // Finally, register the parameters with the parser. We need to make sure that the target action\n    // is registered, since we need to re-use its parameters, and ambiguous parameters are discovered\n    // during registration. This will no-op if the target action is already registered.\n    this.targetAction._registerDefinedParameters(state);\n    super._registerDefinedParameters(state);\n\n    // We need to re-map the ambiguous parameters after they are defined by calling\n    // super._registerDefinedParameters()\n    for (const [ambiguousParameterName, parserKey] of this._ambiguousParameterParserKeysByName) {\n      const targetParserKey: string | undefined =\n        this.targetAction._ambiguousParameterParserKeysByName.get(ambiguousParameterName);\n\n      // If we have a mapping for the specified key, then use it. Otherwise, use the key as-is.\n      if (targetParserKey) {\n        this._parameterKeyMap.set(parserKey, targetParserKey);\n      }\n    }\n  }\n\n  /**\n   * {@inheritdoc CommandLineParameterProvider._processParsedData}\n   * @internal\n   */\n  public _processParsedData(parserOptions: ICommandLineParserOptions, data: ICommandLineParserData): void {\n    // Re-map the parsed data to the target action's parameters and execute the target action processor.\n    const targetData: ICommandLineParserData = {\n      action: this.targetAction.actionName,\n      aliasAction: data.action,\n      aliasDocumentation: this.documentation\n    };\n    for (const [key, value] of Object.entries(data)) {\n      // If we have a mapping for the specified key, then use it. Otherwise, use the key as-is.\n      // Skip over the action key though, since we've already re-mapped it to \"aliasAction\"\n      if (key === 'action') {\n        continue;\n      }\n      const targetKey: string | undefined = this._parameterKeyMap.get(key);\n      targetData[targetKey ?? key] = value;\n    }\n    this.targetAction._processParsedData(parserOptions, targetData);\n  }\n\n  /**\n   * Executes the target action.\n   */\n  protected async onExecute(): Promise<void> {\n    await this.targetAction._executeAsync();\n  }\n}\n"]}

package/lib/providers/CommandLineAction.d.ts

@@ -52,7 +52,7 @@ export declare abstract class CommandLineAction extends CommandLineParameterProv
      * Invoked by CommandLineParser.onExecute().
      * @internal
      */
-    _execute(): Promise<void>;
+    _executeAsync(): Promise<void>;
     /**
      * {@inheritDoc CommandLineParameterProvider._getArgumentParser}
      * @internal
@@ -60,6 +60,9 @@ export declare abstract class CommandLineAction extends CommandLineParameterProv
     _getArgumentParser(): argparse.ArgumentParser;
     /**
      * Your subclass should implement this hook to perform the operation.
+     *
+     * @remarks
+     * In a future release, this function will be renamed to onExecuteAsync
      */
     protected abstract onExecute(): Promise<void>;
 }

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,KAAK,QAAQ,MAAM,UAAU,CAAC;AAE1C,OAAO,EAAE,4BAA4B,EAAE,MAAM,gCAAgC,CAAC;AAG9E;;;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;AAOD;;;;;;;;;;;;GAYG;AACH,8BAAsB,iBAAkB,SAAQ,4BAA4B;IAC1E,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;IAwB/D;;;OAGG;IACI,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC;IAIhC;;;OAGG;IACI,kBAAkB,IAAI,QAAQ,CAAC,cAAc;IAUpD;;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,KAAK,QAAQ,MAAM,UAAU,CAAC;AAE1C,OAAO,EAAE,4BAA4B,EAAE,MAAM,gCAAgC,CAAC;AAG9E;;;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;AAOD;;;;;;;;;;;;GAYG;AACH,8BAAsB,iBAAkB,SAAQ,4BAA4B;IAC1E,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;IAwB/D;;;OAGG;IACI,aAAa,IAAI,OAAO,CAAC,IAAI,CAAC;IAIrC;;;OAGG;IACI,kBAAkB,IAAI,QAAQ,CAAC,cAAc;IAUpD;;;;;OAKG;IACH,SAAS,CAAC,QAAQ,CAAC,SAAS,IAAI,OAAO,CAAC,IAAI,CAAC;CAC9C"}

package/lib/providers/CommandLineAction.js

@@ -62,7 +62,7 @@ class CommandLineAction extends CommandLineParameterProvider_1.CommandLineParame
      * Invoked by CommandLineParser.onExecute().
      * @internal
      */
-    _execute() {
+    _executeAsync() {
         return this.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;;;AAI3D,iFAA8E;AAC9E,6EAA0E;AA0B1E;;GAEG;AACH,MAAM,kBAAkB,GAAW,kCAAkC,CAAC;AAEtE;;;;;;;;;;;;GAYG;AACH,MAAsB,iBAAkB,SAAQ,2DAA4B;IAY1E,YAAmB,OAAkC;QACnD,KAAK,EAAE,CAAC;QAER,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,CAAC;YACjD,MAAM,IAAI,KAAK,CACb,wBAAwB,OAAO,CAAC,UAAU,KAAK;gBAC7C,2FAA2F,CAC9F,CAAC;QACJ,CAAC;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,wDAAwD;QACxD,IAAI,CAAC,eAAe,CAAC,IAAI,GAAG,CAAC,MAAc,EAAE,OAAe,EAAE,EAAE;YAC9D,MAAM,IAAI,uDAA0B,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QACxD,CAAC,CAAC;QACF,MAAM,6BAA6B,GAAkC,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,IAAI,CAClG,IAAI,CAAC,eAAe,CACrB,CAAC;QACF,IAAI,CAAC,eAAe,CAAC,KAAK,GAAG,CAAC,GAAmB,EAAE,EAAE;YACnD,kFAAkF;YAClF,IAAI,GAAG,YAAY,uDAA0B,EAAE,CAAC;gBAC9C,MAAM,GAAG,CAAC;YACZ,CAAC;YACD,6BAA6B,CAAC,GAAG,CAAC,CAAC;QACrC,CAAC,CAAC;QAEF,MAAA,IAAI,CAAC,kBAAkB,oDAAI,CAAC;IAC9B,CAAC;IAED;;;OAGG;IACI,QAAQ;QACb,OAAO,IAAI,CAAC,SAAS,EAAE,CAAC;IAC1B,CAAC;IAED;;;OAGG;IACI,kBAAkB;QACvB,WAAW;QACX,IAAI,CAAC,IAAI,CAAC,eAAe,EAAE,CAAC;YAC1B,qCAAqC;YACrC,MAAM,IAAI,KAAK,CAAC,kFAAkF,CAAC,CAAC;QACtG,CAAC;QAED,OAAO,IAAI,CAAC,eAAe,CAAC;IAC9B,CAAC;CAMF;AAnFD,8CAmFC","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 type * as argparse from 'argparse';\n\nimport { CommandLineParameterProvider } from './CommandLineParameterProvider';\nimport { CommandLineParserExitError } from './CommandLineParserExitError';\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 * Example: \"do-something\"\n */\nconst ACTION_NAME_REGEXP: RegExp = /^[a-z][a-z0-9]*([-:][a-z0-9]+)*$/;\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  /** {@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 (!ACTION_NAME_REGEXP.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    // Monkey-patch the error handling for the action parser\n    this._argumentParser.exit = (status: number, message: string) => {\n      throw new CommandLineParserExitError(status, message);\n    };\n    const originalArgumentParserErrorFn: (err: Error | string) => void = this._argumentParser.error.bind(\n      this._argumentParser\n    );\n    this._argumentParser.error = (err: Error | string) => {\n      // Ensure the ParserExitError bubbles up to the top without any special processing\n      if (err instanceof CommandLineParserExitError) {\n        throw err;\n      }\n      originalArgumentParserErrorFn(err);\n    };\n\n    this.onDefineParameters?.();\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  public _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   * 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,iFAA8E;AAC9E,6EAA0E;AA0B1E;;GAEG;AACH,MAAM,kBAAkB,GAAW,kCAAkC,CAAC;AAEtE;;;;;;;;;;;;GAYG;AACH,MAAsB,iBAAkB,SAAQ,2DAA4B;IAY1E,YAAmB,OAAkC;QACnD,KAAK,EAAE,CAAC;QAER,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,CAAC;YACjD,MAAM,IAAI,KAAK,CACb,wBAAwB,OAAO,CAAC,UAAU,KAAK;gBAC7C,2FAA2F,CAC9F,CAAC;QACJ,CAAC;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,wDAAwD;QACxD,IAAI,CAAC,eAAe,CAAC,IAAI,GAAG,CAAC,MAAc,EAAE,OAAe,EAAE,EAAE;YAC9D,MAAM,IAAI,uDAA0B,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QACxD,CAAC,CAAC;QACF,MAAM,6BAA6B,GAAkC,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,IAAI,CAClG,IAAI,CAAC,eAAe,CACrB,CAAC;QACF,IAAI,CAAC,eAAe,CAAC,KAAK,GAAG,CAAC,GAAmB,EAAE,EAAE;YACnD,kFAAkF;YAClF,IAAI,GAAG,YAAY,uDAA0B,EAAE,CAAC;gBAC9C,MAAM,GAAG,CAAC;YACZ,CAAC;YACD,6BAA6B,CAAC,GAAG,CAAC,CAAC;QACrC,CAAC,CAAC;QAEF,MAAA,IAAI,CAAC,kBAAkB,oDAAI,CAAC;IAC9B,CAAC;IAED;;;OAGG;IACI,aAAa;QAClB,OAAO,IAAI,CAAC,SAAS,EAAE,CAAC;IAC1B,CAAC;IAED;;;OAGG;IACI,kBAAkB;QACvB,WAAW;QACX,IAAI,CAAC,IAAI,CAAC,eAAe,EAAE,CAAC;YAC1B,qCAAqC;YACrC,MAAM,IAAI,KAAK,CAAC,kFAAkF,CAAC,CAAC;QACtG,CAAC;QAED,OAAO,IAAI,CAAC,eAAe,CAAC;IAC9B,CAAC;CASF;AAtFD,8CAsFC","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 type * as argparse from 'argparse';\n\nimport { CommandLineParameterProvider } from './CommandLineParameterProvider';\nimport { CommandLineParserExitError } from './CommandLineParserExitError';\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 * Example: \"do-something\"\n */\nconst ACTION_NAME_REGEXP: RegExp = /^[a-z][a-z0-9]*([-:][a-z0-9]+)*$/;\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  /** {@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 (!ACTION_NAME_REGEXP.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    // Monkey-patch the error handling for the action parser\n    this._argumentParser.exit = (status: number, message: string) => {\n      throw new CommandLineParserExitError(status, message);\n    };\n    const originalArgumentParserErrorFn: (err: Error | string) => void = this._argumentParser.error.bind(\n      this._argumentParser\n    );\n    this._argumentParser.error = (err: Error | string) => {\n      // Ensure the ParserExitError bubbles up to the top without any special processing\n      if (err instanceof CommandLineParserExitError) {\n        throw err;\n      }\n      originalArgumentParserErrorFn(err);\n    };\n\n    this.onDefineParameters?.();\n  }\n\n  /**\n   * Invoked by CommandLineParser.onExecute().\n   * @internal\n   */\n  public _executeAsync(): Promise<void> {\n    return this.onExecute();\n  }\n\n  /**\n   * {@inheritDoc CommandLineParameterProvider._getArgumentParser}\n   * @internal\n   */\n  public _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   * Your subclass should implement this hook to perform the operation.\n   *\n   * @remarks\n   * In a future release, this function will be renamed to onExecuteAsync\n   */\n  protected abstract onExecute(): Promise<void>;\n}\n"]}

package/lib/providers/CommandLineParameterProvider.d.ts

@@ -305,17 +305,17 @@ export declare abstract class CommandLineParameterProvider {
      */
     protected abstract _getArgumentParser(): argparse.ArgumentParser;
     /**
-     * This is called internally by {@link CommandLineParser.execute}
+     * This is called internally by {@link CommandLineParser.executeAsync}
      * @internal
      */
     _preParse(): void;
     /**
-     * This is called internally by {@link CommandLineParser.execute} before `printUsage` is called
+     * This is called internally by {@link CommandLineParser.executeAsync} before `printUsage` is called
      * @internal
      */
     _postParse(): void;
     /**
-     * This is called internally by {@link CommandLineParser.execute}
+     * This is called internally by {@link CommandLineParser.executeAsync}
      * @internal
      */
     _processParsedData(parserOptions: ICommandLineParserOptions, data: ICommandLineParserData): void;

package/lib/providers/CommandLineParameterProvider.js

@@ -356,7 +356,7 @@ class CommandLineParameterProvider {
         this._parametersHaveBeenRegistered = true;
     }
     /**
-     * This is called internally by {@link CommandLineParser.execute}
+     * This is called internally by {@link CommandLineParser.executeAsync}
      * @internal
      */
     _preParse() {
@@ -366,7 +366,7 @@ class CommandLineParameterProvider {
         }
     }
     /**
-     * This is called internally by {@link CommandLineParser.execute} before `printUsage` is called
+     * This is called internally by {@link CommandLineParser.executeAsync} before `printUsage` is called
      * @internal
      */
     _postParse() {
@@ -376,7 +376,7 @@ class CommandLineParameterProvider {
         }
     }
     /**
-     * This is called internally by {@link CommandLineParser.execute}
+     * This is called internally by {@link CommandLineParser.executeAsync}
      * @internal
      */
     _processParsedData(parserOptions, data) {

package/lib/providers/CommandLineParameterProvider.js.map

@@ -1 +1 @@
-{"version":3,"file":"CommandLineParameterProvider.js","sourceRoot":"","sources":["../../src/providers/CommandLineParameterProvider.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D;;;;;;;;;;;;;;;;;;;;;;;;;;AAE3D,mDAAqC;AAarC,2DAKmC;AACnC,yFAGkD;AAClD,iGAA8F;AAC9F,2FAGmD;AACnD,mGAAgG;AAChG,qFAAkF;AAClF,yFAGkD;AAClD,iGAA8F;AAC9F,6EAA0E;AAC1E,4CAAuD;AACvD,6EAA0E;AA6C1E,MAAM,gBAAgB,GAAW,OAAO,CAAC;AACzC,MAAM,oBAAoB,GAAW,UAAU,CAAC;AAChD,MAAM,gCAAgC,GACpC,gFAAgF,CAAC;AAanF;;;;;GAKG;AACH,MAAsB,4BAA4B;IAmBhD,gBAAgB;IAChB,0EAA0E;IAC1E;QACE,IAAI,CAAC,WAAW,GAAG,EAAE,CAAC;QACtB,IAAI,CAAC,qBAAqB,GAAG,IAAI,GAAG,EAAE,CAAC;QACvC,IAAI,CAAC,sBAAsB,GAAG,IAAI,GAAG,EAAE,CAAC;QACxC,IAAI,CAAC,sBAAsB,GAAG,IAAI,GAAG,EAAE,CAAC;QACxC,IAAI,CAAC,mCAAmC,GAAG,IAAI,GAAG,EAAE,CAAC;QACrD,IAAI,CAAC,oCAAoC,GAAG,IAAI,GAAG,EAAE,CAAC;QACtD,IAAI,CAAC,6BAA6B,GAAG,KAAK,CAAC;QAC3C,IAAI,CAAC,4BAA4B,GAAG,KAAK,CAAC;IAC5C,CAAC;IAED;;OAEG;IACH,IAAW,UAAU;QACnB,OAAO,IAAI,CAAC,WAAW,CAAC;IAC1B,CAAC;IAED;;OAEG;IACH,IAAW,mBAAmB;QAC5B,OAAO,IAAI,CAAC,4BAA4B,CAAC;IAC3C,CAAC;IAED;;;OAGG;IACH,IAAW,SAAS;QAClB,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;IAoCM,qBAAqB,CAC1B,UAAiD;QAEjD,MAAM,SAAS,GAAwC,IAAI,uDAA0B,CAAC,UAAU,CAAC,CAAC;QAClG,IAAI,CAAC,gBAAgB,CAAC,SAAS,CAAC,CAAC;QACjC,OAAO,SAAS,CAAC;IACnB,CAAC;IAED;;;;OAIG;IACI,kBAAkB,CAAC,iBAAyB,EAAE,cAAuB;QAC1E,OAAO,IAAI,CAAC,aAAa,CAAC,iBAAiB,EAAE,sCAAwB,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;IAChG,CAAC;IAED;;;;;;;;;;OAUG;IACI,yBAAyB,CAC9B,UAAqD;QAErD,MAAM,SAAS,GAA4C,IAAI,+DAA8B,CAAC,UAAU,CAAC,CAAC;QAC1G,IAAI,CAAC,gBAAgB,CAAC,SAAS,CAAC,CAAC;QACjC,OAAO,SAAS,CAAC;IACnB,CAAC;IAED;;;;OAIG;IACI,sBAAsB,CAC3B,iBAAyB,EACzB,cAAuB;QAEvB,OAAO,IAAI,CAAC,aAAa,CAAC,iBAAiB,EAAE,sCAAwB,CAAC,UAAU,EAAE,cAAc,CAAC,CAAC;IACpG,CAAC;IAED;;;;;;;;;OASG;IACI,mBAAmB,CAAC,UAAsC;QAC/D,MAAM,SAAS,GAA6B,IAAI,mDAAwB,CAAC,UAAU,CAAC,CAAC;QACrF,IAAI,CAAC,gBAAgB,CAAC,SAAS,CAAC,CAAC;QACjC,OAAO,SAAS,CAAC;IACnB,CAAC;IAED;;;;OAIG;IACI,gBAAgB,CAAC,iBAAyB,EAAE,cAAuB;QACxE,OAAO,IAAI,CAAC,aAAa,CAAC,iBAAiB,EAAE,sCAAwB,CAAC,IAAI,EAAE,cAAc,CAAC,CAAC;IAC9F,CAAC;IA8BM,sBAAsB,CAAC,UAAyC;QACrE,MAAM,SAAS,GAAgC,IAAI,yDAA2B,CAAC,UAAU,CAAC,CAAC;QAC3F,IAAI,CAAC,gBAAgB,CAAC,SAAS,CAAC,CAAC;QACjC,OAAO,SAAS,CAAC;IACnB,CAAC;IAED;;;;OAIG;IACI,mBAAmB,CACxB,iBAAyB,EACzB,cAAuB;QAEvB,OAAO,IAAI,CAAC,aAAa,CAAC,iBAAiB,EAAE,sCAAwB,CAAC,OAAO,EAAE,cAAc,CAAC,CAAC;IACjG,CAAC;IAED;;;;;;;;;OASG;IACI,0BAA0B,CAC/B,UAA6C;QAE7C,MAAM,SAAS,GAAoC,IAAI,iEAA+B,CAAC,UAAU,CAAC,CAAC;QACnG,IAAI,CAAC,gBAAgB,CAAC,SAAS,CAAC,CAAC;QACjC,OAAO,SAAS,CAAC;IACnB,CAAC;IAED;;;;OAIG;IACI,uBAAuB,CAC5B,iBAAyB,EACzB,cAAuB;QAEvB,OAAO,IAAI,CAAC,aAAa,CAAC,iBAAiB,EAAE,sCAAwB,CAAC,WAAW,EAAE,cAAc,CAAC,CAAC;IACrG,CAAC;IA8BM,qBAAqB,CAAC,UAAwC;QACnE,MAAM,SAAS,GAA+B,IAAI,uDAA0B,CAAC,UAAU,CAAC,CAAC;QACzF,IAAI,CAAC,gBAAgB,CAAC,SAAS,CAAC,CAAC;QACjC,OAAO,SAAS,CAAC;IACnB,CAAC;IAED;;;;OAIG;IACI,kBAAkB,CAAC,iBAAyB,EAAE,cAAuB;QAC1E,OAAO,IAAI,CAAC,aAAa,CAAC,iBAAiB,EAAE,sCAAwB,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;IAChG,CAAC;IAED;;;;;;;;;OASG;IACI,yBAAyB,CAC9B,UAA4C;QAE5C,MAAM,SAAS,GAAmC,IAAI,+DAA8B,CAAC,UAAU,CAAC,CAAC;QACjG,IAAI,CAAC,gBAAgB,CAAC,SAAS,CAAC,CAAC;QACjC,OAAO,SAAS,CAAC;IACnB,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACI,0BAA0B,CAAC,UAA2C;QAC3E,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;YACpB,MAAM,IAAI,KAAK,CAAC,sEAAsE,CAAC,CAAC;QAC1F,CAAC;QACD,IAAI,CAAC,UAAU,GAAG,IAAI,2CAAoB,CAAC,UAAU,CAAC,CAAC;QACvD,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;IAED;;;;OAIG;IACI,sBAAsB,CAC3B,iBAAyB,EACzB,cAAuB;QAEvB,OAAO,IAAI,CAAC,aAAa,CAAC,iBAAiB,EAAE,sCAAwB,CAAC,UAAU,EAAE,cAAc,CAAC,CAAC;IACpG,CAAC;IAED;;OAEG;IACI,cAAc;QACnB,MAAM,YAAY,GAAoC;YACpD,oBAAoB,EAAE,IAAI,GAAG,EAAE;SAChC,CAAC;QACF,IAAI,CAAC,0BAA0B,CAAC,YAAY,CAAC,CAAC;QAC9C,OAAO,IAAI,CAAC,kBAAkB,EAAE,CAAC,UAAU,EAAE,CAAC;IAChD,CAAC;IAED;;OAEG;IACI,eAAe;QACpB,MAAM,YAAY,GAAoC;YACpD,oBAAoB,EAAE,IAAI,GAAG,EAAE;SAChC,CAAC;QACF,IAAI,CAAC,0BAA0B,CAAC,YAAY,CAAC,CAAC;QAC9C,OAAO,IAAI,CAAC,kBAAkB,EAAE,CAAC,WAAW,EAAE,CAAC;IACjD,CAAC;IAED;;;;OAIG;IACI,qBAAqB;QAC1B,MAAM,YAAY,GAA2B,EAAE,CAAC;QAChD,KAAK,MAAM,SAAS,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;YACxC,MAAM,aAAa,GAAW,SAAS,CAAC,cAAc,IAAI,SAAS,CAAC,QAAQ,CAAC;YAC7E,QAAQ,SAAS,CAAC,IAAI,EAAE,CAAC;gBACvB,KAAK,sCAAwB,CAAC,IAAI,CAAC;gBACnC,KAAK,sCAAwB,CAAC,MAAM,CAAC;gBACrC,KAAK,sCAAwB,CAAC,MAAM,CAAC;gBACrC,KAAK,sCAAwB,CAAC,OAAO;oBACnC,YAAY,CAAC,aAAa,CAAC,GAAG,IAAI,CAAC,SAAS,CAExC,SAKD,CAAC,KAAK,CACR,CAAC;oBACF,MAAM;gBACR,KAAK,sCAAwB,CAAC,UAAU,CAAC;gBACzC,KAAK,sCAAwB,CAAC,WAAW,CAAC;gBAC1C,KAAK,sCAAwB,CAAC,UAAU;oBACtC,MAAM,UAAU,GACd,SAID,CAAC,MAAM,CAAC;oBACT,YAAY,CAAC,aAAa,CAAC,GAAG,UAAU,CAAC,CAAC,CAAC,UAAU,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;oBACrE,MAAM;YACV,CAAC;QACH,CAAC;QACD,OAAO,YAAY,CAAC;IACtB,CAAC;IAED;;OAEG;IACI,mBAAmB,CAAC,cAAsB;QAC/C,MAAM,MAAM,GAA2B,gCAAgC,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QAC7F,IAAI,CAAC,MAAM,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;YAC9B,MAAM,IAAI,KAAK,CAAC,4BAA4B,cAAc,iBAAiB,CAAC,CAAC;QAC/E,CAAC;QACD,OAAO;YACL,QAAQ,EAAE,KAAK,MAAM,CAAC,MAAM,CAAC,oBAAoB,CAAC,EAAE;YACpD,KAAK,EAAE,MAAM,CAAC,MAAM,CAAC,gBAAgB,CAAC;SACvC,CAAC;IACJ,CAAC;IAED,gBAAgB;IACT,0BAA0B,CAAC,KAAsC;QACtE,IAAI,IAAI,CAAC,6BAA6B,EAAE,CAAC;YACvC,mGAAmG;YACnG,gEAAgE;YAChE,OAAO;QACT,CAAC;QAED,4GAA4G;QAC5G,2GAA2G;QAC3G,0DAA0D;QAC1D,MAAM,iCAAiC,GAAkC,IAAI,GAAG,EAAE,CAAC;QACnF,KAAK,MAAM,CAAC,SAAS,EAAE,mBAAmB,CAAC,IAAI,IAAI,CAAC,sBAAsB,CAAC,OAAO,EAAE,EAAE,CAAC;YACrF,IAAI,mBAAmB,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBACnC,KAAK,MAAM,SAAS,IAAI,mBAAmB,EAAE,CAAC;oBAC5C,IAAI,CAAC,yBAAyB,CAAC,SAAS,CAAC,CAAC;oBAC1C,iCAAiC,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;gBACnD,CAAC;YACH,CAAC;QACH,CAAC;QAED,0GAA0G;QAC1G,2GAA2G;QAC3G,oCAAoC;QACpC,KAAK,MAAM,kBAAkB,IAAI,IAAI,CAAC,qBAAqB,CAAC,MAAM,EAAE,EAAE,CAAC;YACrE,MAAM,iBAAiB,GAAY,kBAAkB,CAAC,MAAM,GAAG,CAAC,CAAC;YACjE,KAAK,MAAM,SAAS,IAAI,kBAAkB,EAAE,CAAC;gBAC3C,IAAI,iBAAiB,EAAE,CAAC;oBACtB,IAAI,CAAC,SAAS,CAAC,cAAc,EAAE,CAAC;wBAC9B,MAAM,IAAI,KAAK,CACb,kBAAkB,SAAS,CAAC,QAAQ,uDAAuD;4BACzF,yDAAyD,CAC5D,CAAC;oBACJ,CAAC;oBACD,IAAI,CAAC,yBAAyB,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;gBACrD,CAAC;gBAED,MAAM,eAAe,GAAY,iCAAiC,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;gBAClF,IAAI,CAAC,kBAAkB,CAAC,SAAS,EAAE,iBAAiB,EAAE,eAAe,CAAC,CAAC;YACzE,CAAC;QACH,CAAC;QAED,gGAAgG;QAChG,iBAAiB;QACjB,MAAM,EAAE,oBAAoB,EAAE,GAAG,KAAK,CAAC;QACvC,KAAK,MAAM,mBAAmB,IAAI,oBAAoB,EAAE,CAAC;YACvD,IAAI,CAAC,yBAAyB,CAAC,mBAAmB,CAAC,CAAC;QACtD,CAAC;QAED,0GAA0G;QAC1G,8CAA8C;QAC9C,KAAK,MAAM,CAAC,sBAAsB,EAAE,SAAS,CAAC,IAAI,IAAI,CAAC,mCAAmC,EAAE,CAAC;YAC3F,yGAAyG;YACzG,sGAAsG;YACtG,yDAAyD;YACzD,IAAI,CAAC,IAAI,CAAC,oCAAoC,CAAC,GAAG,CAAC,sBAAsB,CAAC,EAAE,CAAC;gBAC3E,IAAI,CAAC,2BAA2B,CAAC,sBAAsB,EAAE,SAAS,CAAC,CAAC;YACtE,CAAC;QACH,CAAC;QAED,2CAA2C;QAC3C,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;YACpB,MAAM,eAAe,GAA6B;gBAChD,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,WAAW;gBACjC,KAAK,EAAE,QAAQ,CAAC,KAAK,CAAC,SAAS;gBAC/B,OAAO,EAAE,OAAO;aACjB,CAAC;YAEF,IAAI,CAAC,kBAAkB,EAAE,CAAC,WAAW,CAAC,QAAQ,CAAC,KAAK,CAAC,SAAS,EAAE,eAAe,CAAC,CAAC;QACnF,CAAC;QAED,IAAI,CAAC,6BAA6B,GAAG,IAAI,CAAC;IAC5C,CAAC;IAcD;;;OAGG;IACI,SAAS;;QACd,KAAK,MAAM,SAAS,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;YACzC,MAAA,SAAS,CAAC,SAAS,yDAAI,CAAC;QAC1B,CAAC;IACH,CAAC;IAED;;;OAGG;IACI,UAAU;;QACf,KAAK,MAAM,SAAS,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;YACzC,MAAA,SAAS,CAAC,UAAU,yDAAI,CAAC;QAC3B,CAAC;IACH,CAAC;IAED;;;OAGG;IACI,kBAAkB,CAAC,aAAwC,EAAE,IAA4B;;QAC9F,IAAI,CAAC,IAAI,CAAC,6BAA6B,EAAE,CAAC;YACxC,MAAM,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAC;QACzD,CAAC;QAED,IAAI,IAAI,CAAC,4BAA4B,EAAE,CAAC;YACtC,MAAM,IAAI,KAAK,CAAC,gDAAgD,CAAC,CAAC;QACpE,CAAC;QAED,0EAA0E;QAC1E,KAAK,MAAM,CAAC,aAAa,EAAE,SAAS,CAAC,IAAI,IAAI,CAAC,mCAAmC,EAAE,CAAC;YAClF,IAAI,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC;gBACpB,mGAAmG;gBACnG,mDAAmD;gBACnD,IAAI,IAAI,CAAC,oCAAoC,CAAC,GAAG,CAAC,aAAa,CAAC,KAAK,SAAS,EAAE,CAAC;oBAC/E,IAAI,CAAC,qBAAqB,CAAC,aAAa,EAAE,IAAI,EAAE,CAAC,EAAE,sBAAsB,aAAa,IAAI,CAAC,CAAC;gBAC9F,CAAC;gBAED,oGAAoG;gBACpG,gDAAgD;gBAChD,MAAM,4BAA4B,GAChC,IAAI,CAAC,sBAAsB,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;gBACjD,IAAI,4BAA4B,EAAE,CAAC;oBACjC,8FAA8F;oBAC9F,wDAAwD;oBACxD,MAAM,qBAAqB,GAAa,EAAE,CAAC;oBAC3C,KAAK,MAAM,SAAS,IAAI,4BAA4B,EAAE,CAAC;wBACrD,MAAM,0BAA0B,GAC9B,IAAI,CAAC,qBAAqB,CAAC,GAAG,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;wBACrD,IAAI,CAAC,CAAA,0BAA0B,aAA1B,0BAA0B,uBAA1B,0BAA0B,CAAE,MAAM,CAAA,EAAE,CAAC;4BACxC,2BAA2B;4BAC3B,MAAM,IAAI,KAAK,CACb,2EAA2E,aAAa,IAAI,CAC7F,CAAC;wBACJ,CAAC;wBACD,+FAA+F;wBAC/F,sFAAsF;wBACtF,IAAI,0BAA0B,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;4BAC1C,IAAI,CAAC,SAAS,CAAC,cAAc,EAAE,CAAC;gCAC9B,2BAA2B;gCAC3B,MAAM,IAAI,KAAK,CACb,uEAAuE,aAAa,IAAI,CACzF,CAAC;4BACJ,CAAC;4BACD,qBAAqB,CAAC,IAAI,CAAC,SAAS,CAAC,cAAc,CAAC,CAAC;wBACvD,CAAC;6BAAM,CAAC;4BACN,qBAAqB,CAAC,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;wBACjD,CAAC;oBACH,CAAC;oBAED,mGAAmG;oBACnG,kBAAkB;oBAClB,kEAAkE;oBAClE,IAAI,CAAC,qBAAqB,CACxB,aAAa,EACb,IAAI,EACJ,CAAC,EACD,sBAAsB,aAAa,iBAAiB,qBAAqB,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CACxF,CAAC;gBACJ,CAAC;gBAED,MAAM,2BAA2B,GAC/B,IAAI,CAAC,qBAAqB,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;gBAChD,IAAI,2BAA2B,EAAE,CAAC;oBAChC,MAAM,qBAAqB,GAAa,2BAA2B,CAAC,GAAG,CACrE,CAAC,CAA2B,EAAE,EAAE;wBAC9B,iDAAiD;wBACjD,IAAI,CAAC,CAAC,CAAC,cAAc,EAAE,CAAC;4BACtB,2BAA2B;4BAC3B,MAAM,IAAI,KAAK,CACb,sEAAsE,aAAa,IAAI,CACxF,CAAC;wBACJ,CAAC;wBACD,OAAO,CAAC,CAAC,cAAc,CAAC;oBAC1B,CAAC,CACF,CAAC;oBAEF,gGAAgG;oBAChG,2BAA2B;oBAC3B,gFAAgF;oBAChF,IAAI,CAAC,qBAAqB,CACxB,aAAa,EACb,IAAI,EACJ,CAAC,EACD,sBAAsB,aAAa,iBAAiB,qBAAqB,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CACxF,CAAC;gBACJ,CAAC;gBAED,6FAA6F;gBAC7F,IAAI,CAAC,qBAAqB,CAAC,aAAa,EAAE,IAAI,EAAE,CAAC,EAAE,sBAAsB,aAAa,IAAI,CAAC,CAAC;YAC9F,CAAC;QACH,CAAC;QAED,wCAAwC;QACxC,KAAK,MAAM,SAAS,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;YACzC,MAAM,KAAK,GAAY,IAAI,CAAC,SAAS,CAAC,UAAW,CAAC,CAAC;YACnD,SAAS,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;YAC3B,MAAA,SAAS,CAAC,cAAc,yDAAI,CAAC;QAC/B,CAAC;QAED,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;YACnB,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC;QAC3D,CAAC;QAED,IAAI,CAAC,4BAA4B,GAAG,IAAI,CAAC;IAC3C,CAAC;IAED,gBAAgB;IACN,gBAAgB,CAAC,SAA+B;QACxD,IAAI,IAAI,CAAC,6BAA6B,EAAE,CAAC;YACvC,MAAM,IAAI,KAAK,CAAC,2DAA2D,CAAC,CAAC;QAC/E,CAAC;QAED,qDAAqD;QACrD,SAAS,CAAC,UAAU,GAAG,IAAI,CAAC,YAAY,EAAE,CAAC;QAE3C,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAEjC,uGAAuG;QACvG,IAAI,kBAAkB,GAAuC,IAAI,CAAC,qBAAqB,CAAC,GAAG,CACzF,SAAS,CAAC,QAAQ,CACnB,CAAC;QACF,IAAI,CAAC,kBAAkB,EAAE,CAAC;YACxB,kBAAkB,GAAG,EAAE,CAAC;YACxB,IAAI,CAAC,qBAAqB,CAAC,GAAG,CAAC,SAAS,CAAC,QAAQ,EAAE,kBAAkB,CAAC,CAAC;QACzE,CAAC;QACD,kBAAkB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAEnC,wGAAwG;QACxG,IAAI,SAAS,CAAC,SAAS,EAAE,CAAC;YACxB,IAAI,mBAAmB,GAAuC,IAAI,CAAC,sBAAsB,CAAC,GAAG,CAC3F,SAAS,CAAC,SAAS,CACpB,CAAC;YACF,IAAI,CAAC,mBAAmB,EAAE,CAAC;gBACzB,mBAAmB,GAAG,EAAE,CAAC;gBACzB,IAAI,CAAC,sBAAsB,CAAC,GAAG,CAAC,SAAS,CAAC,SAAS,EAAE,mBAAmB,CAAC,CAAC;YAC5E,CAAC;YACD,mBAAmB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QACtC,CAAC;IACH,CAAC;IAED,gBAAgB;IACN,yBAAyB,CAAC,IAAY;QAC9C,IAAI,IAAI,CAAC,6BAA6B,EAAE,CAAC;YACvC,MAAM,IAAI,KAAK,CAAC,2DAA2D,CAAC,CAAC;QAC/E,CAAC;QAED,qFAAqF;QACrF,oEAAoE;QACpE,IAAI,iBAAiB,GACnB,IAAI,CAAC,oCAAoC,CAAC,GAAG,CAAC,IAAI,CAAC;YACnD,IAAI,CAAC,mCAAmC,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QACrD,IAAI,CAAC,iBAAiB,EAAE,CAAC;YACvB,iBAAiB,GAAG,IAAI,CAAC,YAAY,EAAE,CAAC;QAC1C,CAAC;QAED,IAAI,CAAC,mCAAmC,CAAC,GAAG,CAAC,IAAI,EAAE,iBAAiB,CAAC,CAAC;QACtE,OAAO,iBAAiB,CAAC;IAC3B,CAAC;IAED,gBAAgB;IACN,kBAAkB,CAC1B,SAA+B,EAC/B,iBAA0B,EAC1B,eAAwB;;QAExB,MAAM,EACJ,SAAS,EACT,QAAQ,EACR,cAAc,EACd,WAAW,EACX,IAAI,EACJ,QAAQ,EACR,mBAAmB,EACnB,cAAc,EACd,oBAAoB,EACpB,UAAU,EAAE,SAAS,EACtB,GAAG,SAAS,CAAC;QAEd,MAAM,KAAK,GAAa,EAAE,CAAC;QAC3B,IAAI,SAAS,IAAI,CAAC,eAAe,EAAE,CAAC;YAClC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QACxB,CAAC;QAED,wDAAwD;QACxD,IAAI,CAAC,iBAAiB,EAAE,CAAC;YACvB,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACvB,CAAC;QAED,wCAAwC;QACxC,IAAI,cAAc,EAAE,CAAC;YACnB,KAAK,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QAC7B,CAAC;QAED,IAAI,gBAAgB,GAAW,WAAW,CAAC;QAE3C,MAAM,kBAAkB,GAAa,EAAE,CAAC;QACxC,SAAS,CAAC,sBAAsB,CAAC,kBAAkB,CAAC,CAAC;QACrD,IAAI,kBAAkB,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAClC,uEAAuE;YACvE,IAAI,gBAAgB,CAAC,KAAK,CAAC,iBAAiB,CAAC,EAAE,CAAC;gBAC9C,gBAAgB,GAAG,gBAAgB,CAAC,OAAO,EAAE,GAAG,GAAG,CAAC;YACtD,CAAC;YACD,gCAAgC;YAChC,gBAAgB,IAAI,GAAG,GAAG,kBAAkB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACzD,CAAC;QAED,IAAI,OAA6B,CAAC;QAClC,IAAI,MAA0B,CAAC;QAC/B,IAAI,IAAwB,CAAC;QAC7B,QAAQ,IAAI,EAAE,CAAC;YACb,KAAK,sCAAwB,CAAC,MAAM,CAAC,CAAC,CAAC;gBACrC,OAAO,GAAG,SAAS,CAAC,YAAwB,CAAC;gBAC7C,MAAM;YACR,CAAC;YACD,KAAK,sCAAwB,CAAC,UAAU,CAAC,CAAC,CAAC;gBACzC,OAAO,GAAG,SAAS,CAAC,YAAwB,CAAC;gBAC7C,MAAM,GAAG,QAAQ,CAAC;gBAClB,MAAM;YACR,CAAC;YACD,KAAK,sCAAwB,CAAC,IAAI;gBAChC,MAAM,GAAG,WAAW,CAAC;gBACrB,MAAM;YACR,KAAK,sCAAwB,CAAC,OAAO;gBACnC,IAAI,GAAG,KAAK,CAAC;gBACb,MAAM;YACR,KAAK,sCAAwB,CAAC,WAAW;gBACvC,IAAI,GAAG,KAAK,CAAC;gBACb,MAAM,GAAG,QAAQ,CAAC;gBAClB,MAAM;YACR,KAAK,sCAAwB,CAAC,MAAM;gBAClC,MAAM;YACR,KAAK,sCAAwB,CAAC,UAAU;gBACtC,MAAM,GAAG,QAAQ,CAAC;gBAClB,MAAM;QACV,CAAC;QAED,2FAA2F;QAC3F,0CAA0C;QAC1C,MAAM,eAAe,GAA6B;YAChD,IAAI,EAAE,gBAAgB;YACtB,IAAI,EAAE,SAAS;YACf,OAAO,EAAG,SAA8C,CAAC,YAAY;YACrE,QAAQ;YACR,OAAO;YACP,MAAM;YACN,IAAI;SACL,CAAC;QAEF,MAAM,cAAc,GAA4B,IAAI,CAAC,kBAAkB,EAA6B,CAAC;QACrG,IAAI,aAAiD,CAAC;QACtD,IAAI,cAAc,EAAE,CAAC;YACnB,aAAa,GAAG,IAAI,CAAC,sBAAsB,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;YAChE,IAAI,CAAC,aAAa,EAAE,CAAC;gBACnB,IAAI,kBAA0B,CAAC;gBAC/B,IAAI,OAAO,cAAc,KAAK,QAAQ,EAAE,CAAC;oBACvC,kBAAkB,GAAG,cAAc,CAAC;gBACtC,CAAC;qBAAM,IAAI,cAAc,KAAK,mCAAuB,EAAE,CAAC;oBACtD,kBAAkB,GAAG,SAAS,CAAC;gBACjC,CAAC;qBAAM,CAAC;oBACN,MAAM,IAAI,KAAK,CAAC,8BAA8B,GAAG,cAAc,CAAC,CAAC;gBACnE,CAAC;gBAED,aAAa,GAAG,cAAc,CAAC,gBAAgB,CAAC;oBAC9C,KAAK,EAAE,YAAY,kBAAkB,YAAY;iBAClD,CAAC,CAAC;gBACH,IAAI,CAAC,sBAAsB,CAAC,GAAG,CAAC,cAAc,EAAE,aAAa,CAAC,CAAC;YACjE,CAAC;QACH,CAAC;aAAM,CAAC;YACN,aAAa,GAAG,cAAc,CAAC;QACjC,CAAC;QAED,MAAM,gBAAgB,GAA8B,aAAwC,CAAC,WAAW,CACtG,KAAK,EACL,eAAe,CAChB,CAAC;QACF,IAAI,QAAQ,IAAI,mBAAmB,EAAE,CAAC;YACpC,wFAAwF;YAExF,MAAM,gBAAgB,GAA6B,MAAA,SAAS,CAAC,SAAS,0CAAE,IAAI,CAAC,SAAS,CAAC,CAAC;YACxF,SAAS,CAAC,SAAS,GAAG,GAAG,EAAE;gBACzB,gBAAgB,aAAhB,gBAAgB,uBAAhB,gBAAgB,EAAI,CAAC;gBACrB,6EAA6E;gBAC7E,gBAAgB,CAAC,QAAQ,GAAG,KAAK,CAAC;YACpC,CAAC,CAAC;YAEF,MAAM,iBAAiB,GAA6B,MAAA,SAAS,CAAC,UAAU,0CAAE,IAAI,CAAC,SAAS,CAAC,CAAC;YAC1F,SAAS,CAAC,UAAU,GAAG,GAAG,EAAE;gBAC1B,0DAA0D;gBAC1D,gBAAgB,CAAC,QAAQ,GAAG,IAAI,CAAC;gBACjC,iBAAiB,aAAjB,iBAAiB,uBAAjB,iBAAiB,EAAI,CAAC;YACxB,CAAC,CAAC;YAEF,SAAS,0BAA0B;gBACjC,cAAc,CAAC,KAAK,CAAC,aAAa,QAAQ,eAAe,CAAC,CAAC;YAC7D,CAAC;YAED,MAAM,qBAAqB,GAA6B,MAAA,SAAS,CAAC,cAAc,0CAAE,IAAI,CAAC,SAAS,CAAC,CAAC;YAClG,qFAAqF;YACrF,0FAA0F;YAC1F,iCAAiC;YACjC,QAAQ,IAAI,EAAE,CAAC;gBACb,KAAK,sCAAwB,CAAC,MAAM,CAAC;gBACrC,KAAK,sCAAwB,CAAC,OAAO,CAAC;gBACtC,KAAK,sCAAwB,CAAC,MAAM;oBAClC,SAAS,CAAC,cAAc,GAAG;wBACzB,IAAI,IAAI,CAAC,KAAK,KAAK,SAAS,IAAI,IAAI,CAAC,KAAK,KAAK,IAAI,EAAE,CAAC;4BACpD,0BAA0B,EAAE,CAAC;wBAC/B,CAAC;wBAED,qBAAqB,aAArB,qBAAqB,uBAArB,qBAAqB,EAAI,CAAC;oBAC5B,CAAC,CAAC;oBACF,MAAM;gBACR,KAAK,sCAAwB,CAAC,UAAU,CAAC;gBACzC,KAAK,sCAAwB,CAAC,WAAW,CAAC;gBAC1C,KAAK,sCAAwB,CAAC,UAAU;oBACtC,SAAS,CAAC,cAAc,GAAG;wBACzB,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;4BAC7B,0BAA0B,EAAE,CAAC;wBAC/B,CAAC;wBAED,qBAAqB,aAArB,qBAAqB,uBAArB,qBAAqB,EAAI,CAAC;oBAC5B,CAAC,CAAC;oBACF,MAAM;YACV,CAAC;QACH,CAAC;QAED,IAAI,oBAAoB,aAApB,oBAAoB,uBAApB,oBAAoB,CAAE,MAAM,EAAE,CAAC;YACjC,aAAa,CAAC,WAAW,CAAC,oBAAoB,kCACzC,eAAe,KAClB,IAAI,EAAE,QAAQ,CAAC,KAAK,CAAC,QAAQ,IAC7B,CAAC;QACL,CAAC;QAED,0EAA0E;QAC1E,KAAK,MAAM,IAAI,IAAI,CAAC,GAAG,KAAK,EAAE,GAAG,CAAC,oBAAoB,IAAI,EAAE,CAAC,CAAC,EAAE,CAAC;YAC/D,IAAI,CAAC,oCAAoC,CAAC,GAAG,CAAC,IAAI,EAAE,SAAU,CAAC,CAAC;QAClE,CAAC;IACH,CAAC;IAES,2BAA2B,CAAC,IAAY,EAAE,SAAiB;QACnE,IAAI,CAAC,kBAAkB,EAAE,CAAC,WAAW,CAAC,IAAI,EAAE;YAC1C,IAAI,EAAE,SAAS;YACf,kGAAkG;YAClG,KAAK,EAAE,GAAG;YACV,mGAAmG;YACnG,2DAA2D;YAC3D,IAAI,EAAE,QAAQ,CAAC,KAAK,CAAC,QAAQ;SAC9B,CAAC,CAAC;IACL,CAAC;IAEO,YAAY;QAClB,OAAO,MAAM,GAAG,CAAC,4BAA4B,CAAC,WAAW,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC;IAC1E,CAAC;IAEO,aAAa,CACnB,iBAAyB,EACzB,YAAsC,EACtC,cAAuB;QAEvB,gEAAgE;QAChE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,GAAG,IAAI,CAAC,mBAAmB,CAAC,iBAAiB,CAAC,CAAC;QACxE,iBAAiB,GAAG,QAAQ,CAAC;QAC7B,cAAc,GAAG,KAAK,IAAI,cAAc,CAAC;QAEzC,MAAM,UAAU,GACd,IAAI,CAAC,qBAAqB,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC;QACpD,IAAI,CAAC,UAAU,EAAE,CAAC;YAChB,MAAM,IAAI,KAAK,CAAC,kBAAkB,iBAAiB,kBAAkB,CAAC,CAAC;QACzE,CAAC;QAED,IAAI,SAAS,GAAyC,UAAU,CAAC,IAAI,CACnE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,cAAc,KAAK,cAAc,CAC3C,CAAC;QACF,IAAI,CAAC,SAAS,EAAE,CAAC;YACf,IAAI,cAAc,KAAK,SAAS,EAAE,CAAC;gBACjC,MAAM,IAAI,KAAK,CACb,kBAAkB,iBAAiB,iBAAiB,cAAc,mBAAmB,CACtF,CAAC;YACJ,CAAC;YACD,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBAC5B,MAAM,IAAI,KAAK,CAAC,kBAAkB,iBAAiB,2CAA2C,CAAC,CAAC;YAClG,CAAC;YACD,SAAS,GAAG,UAAU,CAAC,CAAC,CAAC,CAAC;QAC5B,CAAC;QAED,IAAI,SAAS,CAAC,IAAI,KAAK,YAAY,EAAE,CAAC;YACpC,MAAM,IAAI,KAAK,CACb,kBAAkB,iBAAiB,iBAAiB,sCAAwB,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG;gBAC7F,sCAAsC,sCAAwB,CAAC,YAAY,CAAC,IAAI,CACnF,CAAC;QACJ,CAAC;QAED,OAAO,SAAc,CAAC;IACxB,CAAC;IAEO,qBAAqB,CAC3B,aAAwC,EACxC,IAA4B,EAC5B,SAAiB,EACjB,OAAe;QAEf,6FAA6F;QAC7F,MAAM,gBAAgB,GAAW,IAAI,CAAC,WAAW,IAAI,IAAI,CAAC,MAAM,IAAI,EAAE,CAAC;QACvE,MAAM,WAAW,GACf,UAAU,aAAa,CAAC,YAAY,EAAE;YACtC,8DAA8D;YAC9D,GAAG,gBAAgB,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,GAAG,gBAAgB,WAAW,CAAC;QAE/D,sCAAsC;QACtC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,eAAe,EAAE,CAAC,CAAC;QACpC,MAAM,IAAI,uDAA0B,CAAC,SAAS,EAAE,GAAG,WAAW,GAAG,OAAO,CAAC,SAAS,EAAE,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;IACtG,CAAC;;AAn6BH,oEAo6BC;AAn6BgB,wCAAW,GAAW,CAAC,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 type {\n  ICommandLineChoiceDefinition,\n  ICommandLineChoiceListDefinition,\n  ICommandLineIntegerDefinition,\n  ICommandLineIntegerListDefinition,\n  ICommandLineFlagDefinition,\n  ICommandLineStringDefinition,\n  ICommandLineStringListDefinition,\n  ICommandLineRemainderDefinition\n} from '../parameters/CommandLineDefinition';\nimport type { ICommandLineParserOptions } from './CommandLineParser';\nimport {\n  type CommandLineParameterBase,\n  type CommandLineParameterWithArgument,\n  CommandLineParameterKind,\n  type CommandLineParameter\n} from '../parameters/BaseClasses';\nimport {\n  CommandLineChoiceParameter,\n  type IRequiredCommandLineChoiceParameter\n} from '../parameters/CommandLineChoiceParameter';\nimport { CommandLineChoiceListParameter } from '../parameters/CommandLineChoiceListParameter';\nimport {\n  CommandLineIntegerParameter,\n  type IRequiredCommandLineIntegerParameter\n} from '../parameters/CommandLineIntegerParameter';\nimport { CommandLineIntegerListParameter } from '../parameters/CommandLineIntegerListParameter';\nimport { CommandLineFlagParameter } from '../parameters/CommandLineFlagParameter';\nimport {\n  CommandLineStringParameter,\n  type IRequiredCommandLineStringParameter\n} from '../parameters/CommandLineStringParameter';\nimport { CommandLineStringListParameter } from '../parameters/CommandLineStringListParameter';\nimport { CommandLineRemainder } from '../parameters/CommandLineRemainder';\nimport { SCOPING_PARAMETER_GROUP } from '../Constants';\nimport { CommandLineParserExitError } from './CommandLineParserExitError';\n\n/**\n * The result containing the parsed parameter long name and scope. Returned when calling\n * {@link CommandLineParameterProvider.parseScopedLongName}.\n *\n * @public\n */\nexport interface IScopedLongNameParseResult {\n  /**\n   * The long name parsed from the scoped long name, e.g. \"--my-scope:my-parameter\" -\\> \"--my-parameter\"\n   */\n  longName: string;\n\n  /**\n   * The scope parsed from the scoped long name or undefined if no scope was found,\n   * e.g. \"--my-scope:my-parameter\" -\\> \"my-scope\"\n   */\n  scope: string | undefined;\n}\n\n/**\n * An object containing the state of the\n *\n * @internal\n */\nexport interface IRegisterDefinedParametersState {\n  /**\n   * A set of all defined parameter names registered by parent {@link CommandLineParameterProvider}\n   * objects.\n   */\n  parentParameterNames: Set<string>;\n}\n\n/**\n * This is the argparse result data object\n * @internal\n */\nexport interface ICommandLineParserData {\n  action: string;\n  aliasAction?: string;\n  aliasDocumentation?: string;\n  [key: string]: any; // eslint-disable-line @typescript-eslint/no-explicit-any\n}\n\nconst SCOPE_GROUP_NAME: string = 'scope';\nconst LONG_NAME_GROUP_NAME: string = 'longName';\nconst POSSIBLY_SCOPED_LONG_NAME_REGEXP: RegExp =\n  /^--((?<scope>[a-z0-9]+(-[a-z0-9]+)*):)?(?<longName>[a-z0-9]+((-[a-z0-9]+)+)?)$/;\n\ninterface IExtendedArgumentGroup extends argparse.ArgumentGroup {\n  // The types are incorrect - this function returns the constructed argument\n  // object, which looks like the argument options type.\n  addArgument(nameOrFlags: string | string[], options: argparse.ArgumentOptions): argparse.ArgumentOptions;\n}\n\ninterface IExtendedArgumentParser extends argparse.ArgumentParser {\n  // This function throws\n  error(message: string): never;\n}\n\n/**\n * This is the common base class for CommandLineAction and CommandLineParser\n * that provides functionality for defining command-line parameters.\n *\n * @public\n */\nexport abstract class CommandLineParameterProvider {\n  private static _keyCounter: number = 0;\n\n  /** @internal */\n  public readonly _ambiguousParameterParserKeysByName: Map<string, string>;\n  /** @internal */\n  protected readonly _registeredParameterParserKeysByName: Map<string, string>;\n\n  private readonly _parameters: CommandLineParameter[];\n  private readonly _parametersByLongName: Map<string, CommandLineParameter[]>;\n  private readonly _parametersByShortName: Map<string, CommandLineParameter[]>;\n  private readonly _parameterGroupsByName: Map<\n    string | typeof SCOPING_PARAMETER_GROUP,\n    argparse.ArgumentGroup\n  >;\n  private _parametersHaveBeenRegistered: boolean;\n  private _parametersHaveBeenProcessed: boolean;\n  private _remainder: CommandLineRemainder | undefined;\n\n  /** @internal */\n  // Third party code should not inherit subclasses or call this constructor\n  public constructor() {\n    this._parameters = [];\n    this._parametersByLongName = new Map();\n    this._parametersByShortName = new Map();\n    this._parameterGroupsByName = new Map();\n    this._ambiguousParameterParserKeysByName = new Map();\n    this._registeredParameterParserKeysByName = new Map();\n    this._parametersHaveBeenRegistered = false;\n    this._parametersHaveBeenProcessed = false;\n  }\n\n  /**\n   * Returns a collection of the parameters that were defined for this object.\n   */\n  public get parameters(): ReadonlyArray<CommandLineParameterBase> {\n    return this._parameters;\n  }\n\n  /**\n   * Informs the caller if the argparse data has been processed into parameters.\n   */\n  public get parametersProcessed(): boolean {\n    return this._parametersHaveBeenProcessed;\n  }\n\n  /**\n   * If {@link CommandLineParameterProvider.defineCommandLineRemainder} was called,\n   * this object captures any remaining command line arguments after the recognized portion.\n   */\n  public get remainder(): CommandLineRemainder | undefined {\n    return this._remainder;\n  }\n\n  /**\n   * Defines a command-line parameter whose value must be a string from a fixed set of\n   * allowable choices (similar to an enum).\n   *\n   * @remarks\n   * Example of a choice parameter:\n   * ```\n   * example-tool --log-level warn\n   * ```\n   */\n  public defineChoiceParameter<TChoice extends string = string>(\n    definition: ICommandLineChoiceDefinition<TChoice> & {\n      required: false | undefined;\n      defaultValue: undefined;\n    }\n  ): CommandLineChoiceParameter<TChoice>;\n  /**\n   * {@inheritdoc CommandLineParameterProvider.(defineChoiceParameter:1)}\n   */\n  public defineChoiceParameter<TChoice extends string = string>(\n    definition: ICommandLineChoiceDefinition<TChoice> & { required: true }\n  ): IRequiredCommandLineChoiceParameter<TChoice>;\n  /**\n   * {@inheritdoc CommandLineParameterProvider.(defineChoiceParameter:1)}\n   */\n  public defineChoiceParameter<TChoice extends string = string>(\n    definition: ICommandLineChoiceDefinition<TChoice> & { defaultValue: TChoice }\n  ): IRequiredCommandLineChoiceParameter<TChoice>;\n  /**\n   * {@inheritdoc CommandLineParameterProvider.(defineChoiceParameter:1)}\n   */\n  public defineChoiceParameter<TChoice extends string = string>(\n    definition: ICommandLineChoiceDefinition<TChoice>\n  ): CommandLineChoiceParameter<TChoice>;\n  public defineChoiceParameter<TChoice extends string = string>(\n    definition: ICommandLineChoiceDefinition<TChoice>\n  ): CommandLineChoiceParameter<TChoice> {\n    const parameter: CommandLineChoiceParameter<TChoice> = new CommandLineChoiceParameter(definition);\n    this._defineParameter(parameter);\n    return parameter;\n  }\n\n  /**\n   * Returns the CommandLineChoiceParameter with the specified long name.\n   * @remarks\n   * This method throws an exception if the parameter is not defined.\n   */\n  public getChoiceParameter(parameterLongName: string, parameterScope?: string): CommandLineChoiceParameter {\n    return this._getParameter(parameterLongName, CommandLineParameterKind.Choice, parameterScope);\n  }\n\n  /**\n   * Defines a command-line parameter whose value must be a string from a fixed set of\n   * allowable choices (similar to an enum). The parameter can be specified multiple times to\n   * build a list.\n   *\n   * @remarks\n   * Example of a choice list parameter:\n   * ```\n   * example-tool --allow-color red --allow-color green\n   * ```\n   */\n  public defineChoiceListParameter<TChoice extends string = string>(\n    definition: ICommandLineChoiceListDefinition<TChoice>\n  ): CommandLineChoiceListParameter<TChoice> {\n    const parameter: CommandLineChoiceListParameter<TChoice> = new CommandLineChoiceListParameter(definition);\n    this._defineParameter(parameter);\n    return parameter;\n  }\n\n  /**\n   * Returns the CommandLineChoiceListParameter with the specified long name.\n   * @remarks\n   * This method throws an exception if the parameter is not defined.\n   */\n  public getChoiceListParameter(\n    parameterLongName: string,\n    parameterScope?: string\n  ): CommandLineChoiceListParameter {\n    return this._getParameter(parameterLongName, CommandLineParameterKind.ChoiceList, parameterScope);\n  }\n\n  /**\n   * Defines a command-line switch whose boolean value is true if the switch is provided,\n   * and false otherwise.\n   *\n   * @remarks\n   * Example usage of a flag parameter:\n   * ```\n   * example-tool --debug\n   * ```\n   */\n  public defineFlagParameter(definition: ICommandLineFlagDefinition): CommandLineFlagParameter {\n    const parameter: CommandLineFlagParameter = new CommandLineFlagParameter(definition);\n    this._defineParameter(parameter);\n    return parameter;\n  }\n\n  /**\n   * Returns the CommandLineFlagParameter with the specified long name.\n   * @remarks\n   * This method throws an exception if the parameter is not defined.\n   */\n  public getFlagParameter(parameterLongName: string, parameterScope?: string): CommandLineFlagParameter {\n    return this._getParameter(parameterLongName, CommandLineParameterKind.Flag, parameterScope);\n  }\n\n  /**\n   * Defines a command-line parameter whose argument is an integer.\n   *\n   * @remarks\n   * Example usage of an integer parameter:\n   * ```\n   * example-tool --max-attempts 5\n   * ```\n   */\n  public defineIntegerParameter(\n    definition: ICommandLineIntegerDefinition & { required: false | undefined; defaultValue: undefined }\n  ): CommandLineIntegerParameter;\n  /**\n   * {@inheritdoc CommandLineParameterProvider.(defineIntegerParameter:1)}\n   */\n  public defineIntegerParameter(\n    definition: ICommandLineIntegerDefinition & { required: true }\n  ): IRequiredCommandLineIntegerParameter;\n  /**\n   * {@inheritdoc CommandLineParameterProvider.(defineIntegerParameter:1)}\n   */\n  public defineIntegerParameter(\n    definition: ICommandLineIntegerDefinition & { defaultValue: number }\n  ): IRequiredCommandLineIntegerParameter;\n  /**\n   * {@inheritdoc CommandLineParameterProvider.(defineIntegerParameter:1)}\n   */\n  public defineIntegerParameter(definition: ICommandLineIntegerDefinition): CommandLineIntegerParameter;\n  public defineIntegerParameter(definition: ICommandLineIntegerDefinition): CommandLineIntegerParameter {\n    const parameter: CommandLineIntegerParameter = new CommandLineIntegerParameter(definition);\n    this._defineParameter(parameter);\n    return parameter;\n  }\n\n  /**\n   * Returns the CommandLineIntegerParameter with the specified long name.\n   * @remarks\n   * This method throws an exception if the parameter is not defined.\n   */\n  public getIntegerParameter(\n    parameterLongName: string,\n    parameterScope?: string\n  ): CommandLineIntegerParameter {\n    return this._getParameter(parameterLongName, CommandLineParameterKind.Integer, parameterScope);\n  }\n\n  /**\n   * Defines a command-line parameter whose argument is an integer. The parameter can be specified\n   * multiple times to build a list.\n   *\n   * @remarks\n   * Example usage of an integer list parameter:\n   * ```\n   * example-tool --avoid 4 --avoid 13\n   * ```\n   */\n  public defineIntegerListParameter(\n    definition: ICommandLineIntegerListDefinition\n  ): CommandLineIntegerListParameter {\n    const parameter: CommandLineIntegerListParameter = new CommandLineIntegerListParameter(definition);\n    this._defineParameter(parameter);\n    return parameter;\n  }\n\n  /**\n   * Returns the CommandLineIntegerParameter with the specified long name.\n   * @remarks\n   * This method throws an exception if the parameter is not defined.\n   */\n  public getIntegerListParameter(\n    parameterLongName: string,\n    parameterScope?: string\n  ): CommandLineIntegerListParameter {\n    return this._getParameter(parameterLongName, CommandLineParameterKind.IntegerList, parameterScope);\n  }\n\n  /**\n   * Defines a command-line parameter whose argument is a single text string.\n   *\n   * @remarks\n   * Example usage of a string parameter:\n   * ```\n   * example-tool --message \"Hello, world!\"\n   * ```\n   */\n  public defineStringParameter(\n    definition: ICommandLineStringDefinition & { required: false | undefined; defaultValue: undefined }\n  ): CommandLineStringParameter;\n  /**\n   * {@inheritdoc CommandLineParameterProvider.(defineStringParameter:1)}\n   */\n  public defineStringParameter(\n    definition: ICommandLineStringDefinition & { required: true }\n  ): IRequiredCommandLineStringParameter;\n  /**\n   * {@inheritdoc CommandLineParameterProvider.(defineStringParameter:1)}\n   */\n  public defineStringParameter(\n    definition: ICommandLineStringDefinition & { defaultValue: string }\n  ): IRequiredCommandLineStringParameter;\n  /**\n   * {@inheritdoc CommandLineParameterProvider.(defineStringParameter:1)}\n   */\n  public defineStringParameter(definition: ICommandLineStringDefinition): CommandLineStringParameter;\n  public defineStringParameter(definition: ICommandLineStringDefinition): CommandLineStringParameter {\n    const parameter: CommandLineStringParameter = new CommandLineStringParameter(definition);\n    this._defineParameter(parameter);\n    return parameter;\n  }\n\n  /**\n   * Returns the CommandLineStringParameter with the specified long name.\n   * @remarks\n   * This method throws an exception if the parameter is not defined.\n   */\n  public getStringParameter(parameterLongName: string, parameterScope?: string): CommandLineStringParameter {\n    return this._getParameter(parameterLongName, CommandLineParameterKind.String, parameterScope);\n  }\n\n  /**\n   * Defines a command-line parameter whose argument is a single text string.  The parameter can be\n   * specified multiple times to build a list.\n   *\n   * @remarks\n   * Example usage of a string list parameter:\n   * ```\n   * example-tool --add file1.txt --add file2.txt --add file3.txt\n   * ```\n   */\n  public defineStringListParameter(\n    definition: ICommandLineStringListDefinition\n  ): CommandLineStringListParameter {\n    const parameter: CommandLineStringListParameter = new CommandLineStringListParameter(definition);\n    this._defineParameter(parameter);\n    return parameter;\n  }\n\n  /**\n   * Defines a rule that captures any remaining command line arguments after the recognized portion.\n   *\n   * @remarks\n   * This feature is useful for commands that pass their arguments along to an external tool, relying on\n   * that tool to perform validation.  (It could also be used to parse parameters without any validation\n   * or documentation, but that is not recommended.)\n   *\n   * Example of capturing the remainder after an optional flag parameter.\n   * ```\n   * example-tool --my-flag this is the remainder\n   * ```\n   *\n   * In the \"--help\" documentation, the remainder rule will be represented as \"...\".\n   */\n  public defineCommandLineRemainder(definition: ICommandLineRemainderDefinition): CommandLineRemainder {\n    if (this._remainder) {\n      throw new Error('defineRemainingArguments() has already been called for this provider');\n    }\n    this._remainder = new CommandLineRemainder(definition);\n    return this._remainder;\n  }\n\n  /**\n   * Returns the CommandLineStringListParameter with the specified long name.\n   * @remarks\n   * This method throws an exception if the parameter is not defined.\n   */\n  public getStringListParameter(\n    parameterLongName: string,\n    parameterScope?: string\n  ): CommandLineStringListParameter {\n    return this._getParameter(parameterLongName, CommandLineParameterKind.StringList, parameterScope);\n  }\n\n  /**\n   * Generates the command-line help text.\n   */\n  public renderHelpText(): string {\n    const initialState: IRegisterDefinedParametersState = {\n      parentParameterNames: new Set()\n    };\n    this._registerDefinedParameters(initialState);\n    return this._getArgumentParser().formatHelp();\n  }\n\n  /**\n   * Generates the command-line usage text.\n   */\n  public renderUsageText(): string {\n    const initialState: IRegisterDefinedParametersState = {\n      parentParameterNames: new Set()\n    };\n    this._registerDefinedParameters(initialState);\n    return this._getArgumentParser().formatUsage();\n  }\n\n  /**\n   * Returns a object which maps the long name of each parameter in this.parameters\n   * to the stringified form of its value. This is useful for logging telemetry, but\n   * it is not the proper way of accessing parameters or their values.\n   */\n  public getParameterStringMap(): Record<string, string> {\n    const parameterMap: Record<string, string> = {};\n    for (const parameter of this.parameters) {\n      const parameterName: string = parameter.scopedLongName || parameter.longName;\n      switch (parameter.kind) {\n        case CommandLineParameterKind.Flag:\n        case CommandLineParameterKind.Choice:\n        case CommandLineParameterKind.String:\n        case CommandLineParameterKind.Integer:\n          parameterMap[parameterName] = JSON.stringify(\n            (\n              parameter as\n                | CommandLineFlagParameter\n                | CommandLineIntegerParameter\n                | CommandLineChoiceParameter\n                | CommandLineStringParameter\n            ).value\n          );\n          break;\n        case CommandLineParameterKind.StringList:\n        case CommandLineParameterKind.IntegerList:\n        case CommandLineParameterKind.ChoiceList:\n          const arrayValue: ReadonlyArray<string | number> | undefined = (\n            parameter as\n              | CommandLineIntegerListParameter\n              | CommandLineStringListParameter\n              | CommandLineChoiceListParameter\n          ).values;\n          parameterMap[parameterName] = arrayValue ? arrayValue.join(',') : '';\n          break;\n      }\n    }\n    return parameterMap;\n  }\n\n  /**\n   * Returns an object with the parsed scope (if present) and the long name of the parameter.\n   */\n  public parseScopedLongName(scopedLongName: string): IScopedLongNameParseResult {\n    const result: RegExpExecArray | null = POSSIBLY_SCOPED_LONG_NAME_REGEXP.exec(scopedLongName);\n    if (!result || !result.groups) {\n      throw new Error(`The parameter long name \"${scopedLongName}\" is not valid.`);\n    }\n    return {\n      longName: `--${result.groups[LONG_NAME_GROUP_NAME]}`,\n      scope: result.groups[SCOPE_GROUP_NAME]\n    };\n  }\n\n  /** @internal */\n  public _registerDefinedParameters(state: IRegisterDefinedParametersState): void {\n    if (this._parametersHaveBeenRegistered) {\n      // We prevent new parameters from being defined after the first call to _registerDefinedParameters,\n      // so we can already ensure that all parameters were registered.\n      return;\n    }\n\n    // First, loop through all parameters with short names. If there are any duplicates, disable the short names\n    // since we can't prefix scopes to short names in order to deduplicate them. The duplicate short names will\n    // be reported as errors if the user attempts to use them.\n    const parametersWithDuplicateShortNames: Set<CommandLineParameterBase> = new Set();\n    for (const [shortName, shortNameParameters] of this._parametersByShortName.entries()) {\n      if (shortNameParameters.length > 1) {\n        for (const parameter of shortNameParameters) {\n          this._defineAmbiguousParameter(shortName);\n          parametersWithDuplicateShortNames.add(parameter);\n        }\n      }\n    }\n\n    // Then, loop through all parameters and register them. If there are any duplicates, ensure that they have\n    // provided a scope and register them with the scope. The duplicate long names will be reported as an error\n    // if the user attempts to use them.\n    for (const longNameParameters of this._parametersByLongName.values()) {\n      const useScopedLongName: boolean = longNameParameters.length > 1;\n      for (const parameter of longNameParameters) {\n        if (useScopedLongName) {\n          if (!parameter.parameterScope) {\n            throw new Error(\n              `The parameter \"${parameter.longName}\" is defined multiple times with the same long name. ` +\n                'Parameters with the same long name must define a scope.'\n            );\n          }\n          this._defineAmbiguousParameter(parameter.longName);\n        }\n\n        const ignoreShortName: boolean = parametersWithDuplicateShortNames.has(parameter);\n        this._registerParameter(parameter, useScopedLongName, ignoreShortName);\n      }\n    }\n\n    // Register the existing parameters as ambiguous parameters. These are generally provided by the\n    // parent action.\n    const { parentParameterNames } = state;\n    for (const parentParameterName of parentParameterNames) {\n      this._defineAmbiguousParameter(parentParameterName);\n    }\n\n    // We also need to loop through the defined ambiguous parameters and register them. These will be reported\n    // as errors if the user attempts to use them.\n    for (const [ambiguousParameterName, parserKey] of this._ambiguousParameterParserKeysByName) {\n      // Only register the ambiguous parameter if it hasn't already been registered. We will still handle these\n      // already-registered parameters as ambiguous, but by avoiding registering again, we will defer errors\n      // until the user actually attempts to use the parameter.\n      if (!this._registeredParameterParserKeysByName.has(ambiguousParameterName)) {\n        this._registerAmbiguousParameter(ambiguousParameterName, parserKey);\n      }\n    }\n\n    // Need to add the remainder parameter last\n    if (this._remainder) {\n      const argparseOptions: argparse.ArgumentOptions = {\n        help: this._remainder.description,\n        nargs: argparse.Const.REMAINDER,\n        metavar: '\"...\"'\n      };\n\n      this._getArgumentParser().addArgument(argparse.Const.REMAINDER, argparseOptions);\n    }\n\n    this._parametersHaveBeenRegistered = true;\n  }\n\n  /**\n   * The child class should implement this hook to define its command-line parameters,\n   * e.g. by calling defineFlagParameter().\n   */\n  protected onDefineParameters?(): void;\n\n  /**\n   * Retrieves the argparse object.\n   * @internal\n   */\n  protected abstract _getArgumentParser(): argparse.ArgumentParser;\n\n  /**\n   * This is called internally by {@link CommandLineParser.execute}\n   * @internal\n   */\n  public _preParse(): void {\n    for (const parameter of this._parameters) {\n      parameter._preParse?.();\n    }\n  }\n\n  /**\n   * This is called internally by {@link CommandLineParser.execute} before `printUsage` is called\n   * @internal\n   */\n  public _postParse(): void {\n    for (const parameter of this._parameters) {\n      parameter._postParse?.();\n    }\n  }\n\n  /**\n   * This is called internally by {@link CommandLineParser.execute}\n   * @internal\n   */\n  public _processParsedData(parserOptions: ICommandLineParserOptions, data: ICommandLineParserData): void {\n    if (!this._parametersHaveBeenRegistered) {\n      throw new Error('Parameters have not been registered');\n    }\n\n    if (this._parametersHaveBeenProcessed) {\n      throw new Error('Command Line Parser Data was already processed');\n    }\n\n    // Search for any ambiguous parameters and throw an error if any are found\n    for (const [parameterName, parserKey] of this._ambiguousParameterParserKeysByName) {\n      if (data[parserKey]) {\n        // When the parser key matches the actually registered parameter, we know that this is an ambiguous\n        // parameter sourced from the parent action or tool\n        if (this._registeredParameterParserKeysByName.get(parameterName) === parserKey) {\n          this._throwParserExitError(parserOptions, data, 1, `Ambiguous option: \"${parameterName}\".`);\n        }\n\n        // Determine if the ambiguous parameter is a short name or a long name, since the process of finding\n        // the non-ambiguous name is different for each.\n        const duplicateShortNameParameters: CommandLineParameterBase[] | undefined =\n          this._parametersByShortName.get(parameterName);\n        if (duplicateShortNameParameters) {\n          // We also need to make sure we get the non-ambiguous long name for the parameter, since it is\n          // possible for that the long name is ambiguous as well.\n          const nonAmbiguousLongNames: string[] = [];\n          for (const parameter of duplicateShortNameParameters) {\n            const matchingLongNameParameters: CommandLineParameterBase[] | undefined =\n              this._parametersByLongName.get(parameter.longName);\n            if (!matchingLongNameParameters?.length) {\n              // This should never happen\n              throw new Error(\n                `Unable to find long name parameters for ambiguous short name parameter \"${parameterName}\".`\n              );\n            }\n            // If there is more than one matching long name parameter, then we know that we need to use the\n            // scoped long name for the parameter. The scoped long name should always be provided.\n            if (matchingLongNameParameters.length > 1) {\n              if (!parameter.scopedLongName) {\n                // This should never happen\n                throw new Error(\n                  `Unable to find scoped long name for ambiguous short name parameter \"${parameterName}\".`\n                );\n              }\n              nonAmbiguousLongNames.push(parameter.scopedLongName);\n            } else {\n              nonAmbiguousLongNames.push(parameter.longName);\n            }\n          }\n\n          // Throw an error including the non-ambiguous long names for the parameters that have the ambiguous\n          // short name, ex.\n          // Error: Ambiguous option \"-p\" could match \"--param1\", \"--param2\"\n          this._throwParserExitError(\n            parserOptions,\n            data,\n            1,\n            `Ambiguous option: \"${parameterName}\" could match ${nonAmbiguousLongNames.join(', ')}.`\n          );\n        }\n\n        const duplicateLongNameParameters: CommandLineParameterBase[] | undefined =\n          this._parametersByLongName.get(parameterName);\n        if (duplicateLongNameParameters) {\n          const nonAmbiguousLongNames: string[] = duplicateLongNameParameters.map(\n            (p: CommandLineParameterBase) => {\n              // The scoped long name should always be provided\n              if (!p.scopedLongName) {\n                // This should never happen\n                throw new Error(\n                  `Unable to find scoped long name for ambiguous long name parameter \"${parameterName}\".`\n                );\n              }\n              return p.scopedLongName;\n            }\n          );\n\n          // Throw an error including the non-ambiguous scoped long names for the parameters that have the\n          // ambiguous long name, ex.\n          // Error: Ambiguous option: \"--param\" could match --scope1:param, --scope2:param\n          this._throwParserExitError(\n            parserOptions,\n            data,\n            1,\n            `Ambiguous option: \"${parameterName}\" could match ${nonAmbiguousLongNames.join(', ')}.`\n          );\n        }\n\n        // This shouldn't happen, but we also shouldn't allow the user to use the ambiguous parameter\n        this._throwParserExitError(parserOptions, data, 1, `Ambiguous option: \"${parameterName}\".`);\n      }\n    }\n\n    // Fill in the values for the parameters\n    for (const parameter of this._parameters) {\n      const value: unknown = data[parameter._parserKey!];\n      parameter._setValue(value);\n      parameter._validateValue?.();\n    }\n\n    if (this.remainder) {\n      this.remainder._setValue(data[argparse.Const.REMAINDER]);\n    }\n\n    this._parametersHaveBeenProcessed = true;\n  }\n\n  /** @internal */\n  protected _defineParameter(parameter: CommandLineParameter): void {\n    if (this._parametersHaveBeenRegistered) {\n      throw new Error('Parameters have already been registered for this provider');\n    }\n\n    // Generate and set the parser key at definition time\n    parameter._parserKey = this._generateKey();\n\n    this._parameters.push(parameter);\n\n    // Collect all parameters with the same long name. We will perform conflict resolution at registration.\n    let longNameParameters: CommandLineParameter[] | undefined = this._parametersByLongName.get(\n      parameter.longName\n    );\n    if (!longNameParameters) {\n      longNameParameters = [];\n      this._parametersByLongName.set(parameter.longName, longNameParameters);\n    }\n    longNameParameters.push(parameter);\n\n    // Collect all parameters with the same short name. We will perform conflict resolution at registration.\n    if (parameter.shortName) {\n      let shortNameParameters: CommandLineParameter[] | undefined = this._parametersByShortName.get(\n        parameter.shortName\n      );\n      if (!shortNameParameters) {\n        shortNameParameters = [];\n        this._parametersByShortName.set(parameter.shortName, shortNameParameters);\n      }\n      shortNameParameters.push(parameter);\n    }\n  }\n\n  /** @internal */\n  protected _defineAmbiguousParameter(name: string): string {\n    if (this._parametersHaveBeenRegistered) {\n      throw new Error('Parameters have already been registered for this provider');\n    }\n\n    // Only generate a new parser key if the ambiguous parameter hasn't been defined yet,\n    // either as an existing parameter or as another ambiguous parameter\n    let existingParserKey: string | undefined =\n      this._registeredParameterParserKeysByName.get(name) ||\n      this._ambiguousParameterParserKeysByName.get(name);\n    if (!existingParserKey) {\n      existingParserKey = this._generateKey();\n    }\n\n    this._ambiguousParameterParserKeysByName.set(name, existingParserKey);\n    return existingParserKey;\n  }\n\n  /** @internal */\n  protected _registerParameter(\n    parameter: CommandLineParameter,\n    useScopedLongName: boolean,\n    ignoreShortName: boolean\n  ): void {\n    const {\n      shortName,\n      longName,\n      scopedLongName,\n      description,\n      kind,\n      required,\n      environmentVariable,\n      parameterGroup,\n      undocumentedSynonyms,\n      _parserKey: parserKey\n    } = parameter;\n\n    const names: string[] = [];\n    if (shortName && !ignoreShortName) {\n      names.push(shortName);\n    }\n\n    // Use the original long name unless otherwise requested\n    if (!useScopedLongName) {\n      names.push(longName);\n    }\n\n    // Add the scoped long name if it exists\n    if (scopedLongName) {\n      names.push(scopedLongName);\n    }\n\n    let finalDescription: string = description;\n\n    const supplementaryNotes: string[] = [];\n    parameter._getSupplementaryNotes(supplementaryNotes);\n    if (supplementaryNotes.length > 0) {\n      // If they left the period off the end of their sentence, then add one.\n      if (finalDescription.match(/[a-z0-9]\"?\\s*$/i)) {\n        finalDescription = finalDescription.trimEnd() + '.';\n      }\n      // Append the supplementary text\n      finalDescription += ' ' + supplementaryNotes.join(' ');\n    }\n\n    let choices: string[] | undefined;\n    let action: string | undefined;\n    let type: string | undefined;\n    switch (kind) {\n      case CommandLineParameterKind.Choice: {\n        choices = parameter.alternatives as string[];\n        break;\n      }\n      case CommandLineParameterKind.ChoiceList: {\n        choices = parameter.alternatives as string[];\n        action = 'append';\n        break;\n      }\n      case CommandLineParameterKind.Flag:\n        action = 'storeTrue';\n        break;\n      case CommandLineParameterKind.Integer:\n        type = 'int';\n        break;\n      case CommandLineParameterKind.IntegerList:\n        type = 'int';\n        action = 'append';\n        break;\n      case CommandLineParameterKind.String:\n        break;\n      case CommandLineParameterKind.StringList:\n        action = 'append';\n        break;\n    }\n\n    // NOTE: Our \"environmentVariable\" feature takes precedence over argparse's \"defaultValue\",\n    // so we have to reimplement that feature.\n    const argparseOptions: argparse.ArgumentOptions = {\n      help: finalDescription,\n      dest: parserKey,\n      metavar: (parameter as CommandLineParameterWithArgument).argumentName,\n      required,\n      choices,\n      action,\n      type\n    };\n\n    const argumentParser: IExtendedArgumentParser = this._getArgumentParser() as IExtendedArgumentParser;\n    let argumentGroup: argparse.ArgumentGroup | undefined;\n    if (parameterGroup) {\n      argumentGroup = this._parameterGroupsByName.get(parameterGroup);\n      if (!argumentGroup) {\n        let parameterGroupName: string;\n        if (typeof parameterGroup === 'string') {\n          parameterGroupName = parameterGroup;\n        } else if (parameterGroup === SCOPING_PARAMETER_GROUP) {\n          parameterGroupName = 'scoping';\n        } else {\n          throw new Error('Unexpected parameter group: ' + parameterGroup);\n        }\n\n        argumentGroup = argumentParser.addArgumentGroup({\n          title: `Optional ${parameterGroupName} arguments`\n        });\n        this._parameterGroupsByName.set(parameterGroup, argumentGroup);\n      }\n    } else {\n      argumentGroup = argumentParser;\n    }\n\n    const argparseArgument: argparse.ArgumentOptions = (argumentGroup as IExtendedArgumentGroup).addArgument(\n      names,\n      argparseOptions\n    );\n    if (required && environmentVariable) {\n      // Add some special-cased logic to handle required parameters with environment variables\n\n      const originalPreParse: (() => void) | undefined = parameter._preParse?.bind(parameter);\n      parameter._preParse = () => {\n        originalPreParse?.();\n        // Set the value as non-required before parsing. We'll validate it explicitly\n        argparseArgument.required = false;\n      };\n\n      const originalPostParse: (() => void) | undefined = parameter._postParse?.bind(parameter);\n      parameter._postParse = () => {\n        // Reset the required value to make the usage text correct\n        argparseArgument.required = true;\n        originalPostParse?.();\n      };\n\n      function throwMissingParameterError(): never {\n        argumentParser.error(`Argument \"${longName}\" is required`);\n      }\n\n      const originalValidateValue: (() => void) | undefined = parameter._validateValue?.bind(parameter);\n      // For these values, we have to perform explicit validation because they're requested\n      // as required, but we disabled argparse's required flag to allow the environment variable\n      // to potentially fill the value.\n      switch (kind) {\n        case CommandLineParameterKind.Choice:\n        case CommandLineParameterKind.Integer:\n        case CommandLineParameterKind.String:\n          parameter._validateValue = function () {\n            if (this.value === undefined || this.value === null) {\n              throwMissingParameterError();\n            }\n\n            originalValidateValue?.();\n          };\n          break;\n        case CommandLineParameterKind.ChoiceList:\n        case CommandLineParameterKind.IntegerList:\n        case CommandLineParameterKind.StringList:\n          parameter._validateValue = function () {\n            if (this.values.length === 0) {\n              throwMissingParameterError();\n            }\n\n            originalValidateValue?.();\n          };\n          break;\n      }\n    }\n\n    if (undocumentedSynonyms?.length) {\n      argumentGroup.addArgument(undocumentedSynonyms, {\n        ...argparseOptions,\n        help: argparse.Const.SUPPRESS\n      });\n    }\n\n    // Register the parameter names so that we can detect ambiguous parameters\n    for (const name of [...names, ...(undocumentedSynonyms || [])]) {\n      this._registeredParameterParserKeysByName.set(name, parserKey!);\n    }\n  }\n\n  protected _registerAmbiguousParameter(name: string, parserKey: string): void {\n    this._getArgumentParser().addArgument(name, {\n      dest: parserKey,\n      // We don't know if this argument takes parameters or not, so we need to accept any number of args\n      nargs: '*',\n      // Ensure that the argument is not shown in the help text, since these parameters are only included\n      // to inform the user that ambiguous parameters are present\n      help: argparse.Const.SUPPRESS\n    });\n  }\n\n  private _generateKey(): string {\n    return 'key_' + (CommandLineParameterProvider._keyCounter++).toString();\n  }\n\n  private _getParameter<T extends CommandLineParameterBase>(\n    parameterLongName: string,\n    expectedKind: CommandLineParameterKind,\n    parameterScope?: string\n  ): T {\n    // Support the parameter long name being prefixed with the scope\n    const { scope, longName } = this.parseScopedLongName(parameterLongName);\n    parameterLongName = longName;\n    parameterScope = scope || parameterScope;\n\n    const parameters: CommandLineParameterBase[] | undefined =\n      this._parametersByLongName.get(parameterLongName);\n    if (!parameters) {\n      throw new Error(`The parameter \"${parameterLongName}\" is not defined`);\n    }\n\n    let parameter: CommandLineParameterBase | undefined = parameters.find(\n      (p) => p.parameterScope === parameterScope\n    );\n    if (!parameter) {\n      if (parameterScope !== undefined) {\n        throw new Error(\n          `The parameter \"${parameterLongName}\" with scope \"${parameterScope}\" is not defined.`\n        );\n      }\n      if (parameters.length !== 1) {\n        throw new Error(`The parameter \"${parameterLongName}\" is ambiguous. You must specify a scope.`);\n      }\n      parameter = parameters[0];\n    }\n\n    if (parameter.kind !== expectedKind) {\n      throw new Error(\n        `The parameter \"${parameterLongName}\" is of type \"${CommandLineParameterKind[parameter.kind]}\"` +\n          ` whereas the caller was expecting \"${CommandLineParameterKind[expectedKind]}\".`\n      );\n    }\n\n    return parameter as T;\n  }\n\n  private _throwParserExitError(\n    parserOptions: ICommandLineParserOptions,\n    data: ICommandLineParserData,\n    errorCode: number,\n    message: string\n  ): never {\n    // Write out the usage text to make it easier for the user to find the correct parameter name\n    const targetActionName: string = data.aliasAction || data.action || '';\n    const errorPrefix: string =\n      `Error: ${parserOptions.toolFilename}` +\n      // Handle aliases, actions, and actionless parameter providers\n      `${targetActionName ? ' ' : ''}${targetActionName}: error: `;\n\n    // eslint-disable-next-line no-console\n    console.log(this.renderUsageText());\n    throw new CommandLineParserExitError(errorCode, `${errorPrefix}${message.trimStart().trimEnd()}\\n`);\n  }\n}\n"]}
+{"version":3,"file":"CommandLineParameterProvider.js","sourceRoot":"","sources":["../../src/providers/CommandLineParameterProvider.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D;;;;;;;;;;;;;;;;;;;;;;;;;;AAE3D,mDAAqC;AAarC,2DAKmC;AACnC,yFAGkD;AAClD,iGAA8F;AAC9F,2FAGmD;AACnD,mGAAgG;AAChG,qFAAkF;AAClF,yFAGkD;AAClD,iGAA8F;AAC9F,6EAA0E;AAC1E,4CAAuD;AACvD,6EAA0E;AA6C1E,MAAM,gBAAgB,GAAW,OAAO,CAAC;AACzC,MAAM,oBAAoB,GAAW,UAAU,CAAC;AAChD,MAAM,gCAAgC,GACpC,gFAAgF,CAAC;AAanF;;;;;GAKG;AACH,MAAsB,4BAA4B;IAmBhD,gBAAgB;IAChB,0EAA0E;IAC1E;QACE,IAAI,CAAC,WAAW,GAAG,EAAE,CAAC;QACtB,IAAI,CAAC,qBAAqB,GAAG,IAAI,GAAG,EAAE,CAAC;QACvC,IAAI,CAAC,sBAAsB,GAAG,IAAI,GAAG,EAAE,CAAC;QACxC,IAAI,CAAC,sBAAsB,GAAG,IAAI,GAAG,EAAE,CAAC;QACxC,IAAI,CAAC,mCAAmC,GAAG,IAAI,GAAG,EAAE,CAAC;QACrD,IAAI,CAAC,oCAAoC,GAAG,IAAI,GAAG,EAAE,CAAC;QACtD,IAAI,CAAC,6BAA6B,GAAG,KAAK,CAAC;QAC3C,IAAI,CAAC,4BAA4B,GAAG,KAAK,CAAC;IAC5C,CAAC;IAED;;OAEG;IACH,IAAW,UAAU;QACnB,OAAO,IAAI,CAAC,WAAW,CAAC;IAC1B,CAAC;IAED;;OAEG;IACH,IAAW,mBAAmB;QAC5B,OAAO,IAAI,CAAC,4BAA4B,CAAC;IAC3C,CAAC;IAED;;;OAGG;IACH,IAAW,SAAS;QAClB,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;IAoCM,qBAAqB,CAC1B,UAAiD;QAEjD,MAAM,SAAS,GAAwC,IAAI,uDAA0B,CAAC,UAAU,CAAC,CAAC;QAClG,IAAI,CAAC,gBAAgB,CAAC,SAAS,CAAC,CAAC;QACjC,OAAO,SAAS,CAAC;IACnB,CAAC;IAED;;;;OAIG;IACI,kBAAkB,CAAC,iBAAyB,EAAE,cAAuB;QAC1E,OAAO,IAAI,CAAC,aAAa,CAAC,iBAAiB,EAAE,sCAAwB,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;IAChG,CAAC;IAED;;;;;;;;;;OAUG;IACI,yBAAyB,CAC9B,UAAqD;QAErD,MAAM,SAAS,GAA4C,IAAI,+DAA8B,CAAC,UAAU,CAAC,CAAC;QAC1G,IAAI,CAAC,gBAAgB,CAAC,SAAS,CAAC,CAAC;QACjC,OAAO,SAAS,CAAC;IACnB,CAAC;IAED;;;;OAIG;IACI,sBAAsB,CAC3B,iBAAyB,EACzB,cAAuB;QAEvB,OAAO,IAAI,CAAC,aAAa,CAAC,iBAAiB,EAAE,sCAAwB,CAAC,UAAU,EAAE,cAAc,CAAC,CAAC;IACpG,CAAC;IAED;;;;;;;;;OASG;IACI,mBAAmB,CAAC,UAAsC;QAC/D,MAAM,SAAS,GAA6B,IAAI,mDAAwB,CAAC,UAAU,CAAC,CAAC;QACrF,IAAI,CAAC,gBAAgB,CAAC,SAAS,CAAC,CAAC;QACjC,OAAO,SAAS,CAAC;IACnB,CAAC;IAED;;;;OAIG;IACI,gBAAgB,CAAC,iBAAyB,EAAE,cAAuB;QACxE,OAAO,IAAI,CAAC,aAAa,CAAC,iBAAiB,EAAE,sCAAwB,CAAC,IAAI,EAAE,cAAc,CAAC,CAAC;IAC9F,CAAC;IA8BM,sBAAsB,CAAC,UAAyC;QACrE,MAAM,SAAS,GAAgC,IAAI,yDAA2B,CAAC,UAAU,CAAC,CAAC;QAC3F,IAAI,CAAC,gBAAgB,CAAC,SAAS,CAAC,CAAC;QACjC,OAAO,SAAS,CAAC;IACnB,CAAC;IAED;;;;OAIG;IACI,mBAAmB,CACxB,iBAAyB,EACzB,cAAuB;QAEvB,OAAO,IAAI,CAAC,aAAa,CAAC,iBAAiB,EAAE,sCAAwB,CAAC,OAAO,EAAE,cAAc,CAAC,CAAC;IACjG,CAAC;IAED;;;;;;;;;OASG;IACI,0BAA0B,CAC/B,UAA6C;QAE7C,MAAM,SAAS,GAAoC,IAAI,iEAA+B,CAAC,UAAU,CAAC,CAAC;QACnG,IAAI,CAAC,gBAAgB,CAAC,SAAS,CAAC,CAAC;QACjC,OAAO,SAAS,CAAC;IACnB,CAAC;IAED;;;;OAIG;IACI,uBAAuB,CAC5B,iBAAyB,EACzB,cAAuB;QAEvB,OAAO,IAAI,CAAC,aAAa,CAAC,iBAAiB,EAAE,sCAAwB,CAAC,WAAW,EAAE,cAAc,CAAC,CAAC;IACrG,CAAC;IA8BM,qBAAqB,CAAC,UAAwC;QACnE,MAAM,SAAS,GAA+B,IAAI,uDAA0B,CAAC,UAAU,CAAC,CAAC;QACzF,IAAI,CAAC,gBAAgB,CAAC,SAAS,CAAC,CAAC;QACjC,OAAO,SAAS,CAAC;IACnB,CAAC;IAED;;;;OAIG;IACI,kBAAkB,CAAC,iBAAyB,EAAE,cAAuB;QAC1E,OAAO,IAAI,CAAC,aAAa,CAAC,iBAAiB,EAAE,sCAAwB,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;IAChG,CAAC;IAED;;;;;;;;;OASG;IACI,yBAAyB,CAC9B,UAA4C;QAE5C,MAAM,SAAS,GAAmC,IAAI,+DAA8B,CAAC,UAAU,CAAC,CAAC;QACjG,IAAI,CAAC,gBAAgB,CAAC,SAAS,CAAC,CAAC;QACjC,OAAO,SAAS,CAAC;IACnB,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACI,0BAA0B,CAAC,UAA2C;QAC3E,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;YACpB,MAAM,IAAI,KAAK,CAAC,sEAAsE,CAAC,CAAC;QAC1F,CAAC;QACD,IAAI,CAAC,UAAU,GAAG,IAAI,2CAAoB,CAAC,UAAU,CAAC,CAAC;QACvD,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;IAED;;;;OAIG;IACI,sBAAsB,CAC3B,iBAAyB,EACzB,cAAuB;QAEvB,OAAO,IAAI,CAAC,aAAa,CAAC,iBAAiB,EAAE,sCAAwB,CAAC,UAAU,EAAE,cAAc,CAAC,CAAC;IACpG,CAAC;IAED;;OAEG;IACI,cAAc;QACnB,MAAM,YAAY,GAAoC;YACpD,oBAAoB,EAAE,IAAI,GAAG,EAAE;SAChC,CAAC;QACF,IAAI,CAAC,0BAA0B,CAAC,YAAY,CAAC,CAAC;QAC9C,OAAO,IAAI,CAAC,kBAAkB,EAAE,CAAC,UAAU,EAAE,CAAC;IAChD,CAAC;IAED;;OAEG;IACI,eAAe;QACpB,MAAM,YAAY,GAAoC;YACpD,oBAAoB,EAAE,IAAI,GAAG,EAAE;SAChC,CAAC;QACF,IAAI,CAAC,0BAA0B,CAAC,YAAY,CAAC,CAAC;QAC9C,OAAO,IAAI,CAAC,kBAAkB,EAAE,CAAC,WAAW,EAAE,CAAC;IACjD,CAAC;IAED;;;;OAIG;IACI,qBAAqB;QAC1B,MAAM,YAAY,GAA2B,EAAE,CAAC;QAChD,KAAK,MAAM,SAAS,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;YACxC,MAAM,aAAa,GAAW,SAAS,CAAC,cAAc,IAAI,SAAS,CAAC,QAAQ,CAAC;YAC7E,QAAQ,SAAS,CAAC,IAAI,EAAE,CAAC;gBACvB,KAAK,sCAAwB,CAAC,IAAI,CAAC;gBACnC,KAAK,sCAAwB,CAAC,MAAM,CAAC;gBACrC,KAAK,sCAAwB,CAAC,MAAM,CAAC;gBACrC,KAAK,sCAAwB,CAAC,OAAO;oBACnC,YAAY,CAAC,aAAa,CAAC,GAAG,IAAI,CAAC,SAAS,CAExC,SAKD,CAAC,KAAK,CACR,CAAC;oBACF,MAAM;gBACR,KAAK,sCAAwB,CAAC,UAAU,CAAC;gBACzC,KAAK,sCAAwB,CAAC,WAAW,CAAC;gBAC1C,KAAK,sCAAwB,CAAC,UAAU;oBACtC,MAAM,UAAU,GACd,SAID,CAAC,MAAM,CAAC;oBACT,YAAY,CAAC,aAAa,CAAC,GAAG,UAAU,CAAC,CAAC,CAAC,UAAU,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;oBACrE,MAAM;YACV,CAAC;QACH,CAAC;QACD,OAAO,YAAY,CAAC;IACtB,CAAC;IAED;;OAEG;IACI,mBAAmB,CAAC,cAAsB;QAC/C,MAAM,MAAM,GAA2B,gCAAgC,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QAC7F,IAAI,CAAC,MAAM,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;YAC9B,MAAM,IAAI,KAAK,CAAC,4BAA4B,cAAc,iBAAiB,CAAC,CAAC;QAC/E,CAAC;QACD,OAAO;YACL,QAAQ,EAAE,KAAK,MAAM,CAAC,MAAM,CAAC,oBAAoB,CAAC,EAAE;YACpD,KAAK,EAAE,MAAM,CAAC,MAAM,CAAC,gBAAgB,CAAC;SACvC,CAAC;IACJ,CAAC;IAED,gBAAgB;IACT,0BAA0B,CAAC,KAAsC;QACtE,IAAI,IAAI,CAAC,6BAA6B,EAAE,CAAC;YACvC,mGAAmG;YACnG,gEAAgE;YAChE,OAAO;QACT,CAAC;QAED,4GAA4G;QAC5G,2GAA2G;QAC3G,0DAA0D;QAC1D,MAAM,iCAAiC,GAAkC,IAAI,GAAG,EAAE,CAAC;QACnF,KAAK,MAAM,CAAC,SAAS,EAAE,mBAAmB,CAAC,IAAI,IAAI,CAAC,sBAAsB,CAAC,OAAO,EAAE,EAAE,CAAC;YACrF,IAAI,mBAAmB,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBACnC,KAAK,MAAM,SAAS,IAAI,mBAAmB,EAAE,CAAC;oBAC5C,IAAI,CAAC,yBAAyB,CAAC,SAAS,CAAC,CAAC;oBAC1C,iCAAiC,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;gBACnD,CAAC;YACH,CAAC;QACH,CAAC;QAED,0GAA0G;QAC1G,2GAA2G;QAC3G,oCAAoC;QACpC,KAAK,MAAM,kBAAkB,IAAI,IAAI,CAAC,qBAAqB,CAAC,MAAM,EAAE,EAAE,CAAC;YACrE,MAAM,iBAAiB,GAAY,kBAAkB,CAAC,MAAM,GAAG,CAAC,CAAC;YACjE,KAAK,MAAM,SAAS,IAAI,kBAAkB,EAAE,CAAC;gBAC3C,IAAI,iBAAiB,EAAE,CAAC;oBACtB,IAAI,CAAC,SAAS,CAAC,cAAc,EAAE,CAAC;wBAC9B,MAAM,IAAI,KAAK,CACb,kBAAkB,SAAS,CAAC,QAAQ,uDAAuD;4BACzF,yDAAyD,CAC5D,CAAC;oBACJ,CAAC;oBACD,IAAI,CAAC,yBAAyB,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;gBACrD,CAAC;gBAED,MAAM,eAAe,GAAY,iCAAiC,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;gBAClF,IAAI,CAAC,kBAAkB,CAAC,SAAS,EAAE,iBAAiB,EAAE,eAAe,CAAC,CAAC;YACzE,CAAC;QACH,CAAC;QAED,gGAAgG;QAChG,iBAAiB;QACjB,MAAM,EAAE,oBAAoB,EAAE,GAAG,KAAK,CAAC;QACvC,KAAK,MAAM,mBAAmB,IAAI,oBAAoB,EAAE,CAAC;YACvD,IAAI,CAAC,yBAAyB,CAAC,mBAAmB,CAAC,CAAC;QACtD,CAAC;QAED,0GAA0G;QAC1G,8CAA8C;QAC9C,KAAK,MAAM,CAAC,sBAAsB,EAAE,SAAS,CAAC,IAAI,IAAI,CAAC,mCAAmC,EAAE,CAAC;YAC3F,yGAAyG;YACzG,sGAAsG;YACtG,yDAAyD;YACzD,IAAI,CAAC,IAAI,CAAC,oCAAoC,CAAC,GAAG,CAAC,sBAAsB,CAAC,EAAE,CAAC;gBAC3E,IAAI,CAAC,2BAA2B,CAAC,sBAAsB,EAAE,SAAS,CAAC,CAAC;YACtE,CAAC;QACH,CAAC;QAED,2CAA2C;QAC3C,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;YACpB,MAAM,eAAe,GAA6B;gBAChD,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,WAAW;gBACjC,KAAK,EAAE,QAAQ,CAAC,KAAK,CAAC,SAAS;gBAC/B,OAAO,EAAE,OAAO;aACjB,CAAC;YAEF,IAAI,CAAC,kBAAkB,EAAE,CAAC,WAAW,CAAC,QAAQ,CAAC,KAAK,CAAC,SAAS,EAAE,eAAe,CAAC,CAAC;QACnF,CAAC;QAED,IAAI,CAAC,6BAA6B,GAAG,IAAI,CAAC;IAC5C,CAAC;IAcD;;;OAGG;IACI,SAAS;;QACd,KAAK,MAAM,SAAS,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;YACzC,MAAA,SAAS,CAAC,SAAS,yDAAI,CAAC;QAC1B,CAAC;IACH,CAAC;IAED;;;OAGG;IACI,UAAU;;QACf,KAAK,MAAM,SAAS,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;YACzC,MAAA,SAAS,CAAC,UAAU,yDAAI,CAAC;QAC3B,CAAC;IACH,CAAC;IAED;;;OAGG;IACI,kBAAkB,CAAC,aAAwC,EAAE,IAA4B;;QAC9F,IAAI,CAAC,IAAI,CAAC,6BAA6B,EAAE,CAAC;YACxC,MAAM,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAC;QACzD,CAAC;QAED,IAAI,IAAI,CAAC,4BAA4B,EAAE,CAAC;YACtC,MAAM,IAAI,KAAK,CAAC,gDAAgD,CAAC,CAAC;QACpE,CAAC;QAED,0EAA0E;QAC1E,KAAK,MAAM,CAAC,aAAa,EAAE,SAAS,CAAC,IAAI,IAAI,CAAC,mCAAmC,EAAE,CAAC;YAClF,IAAI,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC;gBACpB,mGAAmG;gBACnG,mDAAmD;gBACnD,IAAI,IAAI,CAAC,oCAAoC,CAAC,GAAG,CAAC,aAAa,CAAC,KAAK,SAAS,EAAE,CAAC;oBAC/E,IAAI,CAAC,qBAAqB,CAAC,aAAa,EAAE,IAAI,EAAE,CAAC,EAAE,sBAAsB,aAAa,IAAI,CAAC,CAAC;gBAC9F,CAAC;gBAED,oGAAoG;gBACpG,gDAAgD;gBAChD,MAAM,4BAA4B,GAChC,IAAI,CAAC,sBAAsB,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;gBACjD,IAAI,4BAA4B,EAAE,CAAC;oBACjC,8FAA8F;oBAC9F,wDAAwD;oBACxD,MAAM,qBAAqB,GAAa,EAAE,CAAC;oBAC3C,KAAK,MAAM,SAAS,IAAI,4BAA4B,EAAE,CAAC;wBACrD,MAAM,0BAA0B,GAC9B,IAAI,CAAC,qBAAqB,CAAC,GAAG,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;wBACrD,IAAI,CAAC,CAAA,0BAA0B,aAA1B,0BAA0B,uBAA1B,0BAA0B,CAAE,MAAM,CAAA,EAAE,CAAC;4BACxC,2BAA2B;4BAC3B,MAAM,IAAI,KAAK,CACb,2EAA2E,aAAa,IAAI,CAC7F,CAAC;wBACJ,CAAC;wBACD,+FAA+F;wBAC/F,sFAAsF;wBACtF,IAAI,0BAA0B,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;4BAC1C,IAAI,CAAC,SAAS,CAAC,cAAc,EAAE,CAAC;gCAC9B,2BAA2B;gCAC3B,MAAM,IAAI,KAAK,CACb,uEAAuE,aAAa,IAAI,CACzF,CAAC;4BACJ,CAAC;4BACD,qBAAqB,CAAC,IAAI,CAAC,SAAS,CAAC,cAAc,CAAC,CAAC;wBACvD,CAAC;6BAAM,CAAC;4BACN,qBAAqB,CAAC,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;wBACjD,CAAC;oBACH,CAAC;oBAED,mGAAmG;oBACnG,kBAAkB;oBAClB,kEAAkE;oBAClE,IAAI,CAAC,qBAAqB,CACxB,aAAa,EACb,IAAI,EACJ,CAAC,EACD,sBAAsB,aAAa,iBAAiB,qBAAqB,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CACxF,CAAC;gBACJ,CAAC;gBAED,MAAM,2BAA2B,GAC/B,IAAI,CAAC,qBAAqB,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;gBAChD,IAAI,2BAA2B,EAAE,CAAC;oBAChC,MAAM,qBAAqB,GAAa,2BAA2B,CAAC,GAAG,CACrE,CAAC,CAA2B,EAAE,EAAE;wBAC9B,iDAAiD;wBACjD,IAAI,CAAC,CAAC,CAAC,cAAc,EAAE,CAAC;4BACtB,2BAA2B;4BAC3B,MAAM,IAAI,KAAK,CACb,sEAAsE,aAAa,IAAI,CACxF,CAAC;wBACJ,CAAC;wBACD,OAAO,CAAC,CAAC,cAAc,CAAC;oBAC1B,CAAC,CACF,CAAC;oBAEF,gGAAgG;oBAChG,2BAA2B;oBAC3B,gFAAgF;oBAChF,IAAI,CAAC,qBAAqB,CACxB,aAAa,EACb,IAAI,EACJ,CAAC,EACD,sBAAsB,aAAa,iBAAiB,qBAAqB,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CACxF,CAAC;gBACJ,CAAC;gBAED,6FAA6F;gBAC7F,IAAI,CAAC,qBAAqB,CAAC,aAAa,EAAE,IAAI,EAAE,CAAC,EAAE,sBAAsB,aAAa,IAAI,CAAC,CAAC;YAC9F,CAAC;QACH,CAAC;QAED,wCAAwC;QACxC,KAAK,MAAM,SAAS,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;YACzC,MAAM,KAAK,GAAY,IAAI,CAAC,SAAS,CAAC,UAAW,CAAC,CAAC;YACnD,SAAS,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;YAC3B,MAAA,SAAS,CAAC,cAAc,yDAAI,CAAC;QAC/B,CAAC;QAED,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;YACnB,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC;QAC3D,CAAC;QAED,IAAI,CAAC,4BAA4B,GAAG,IAAI,CAAC;IAC3C,CAAC;IAED,gBAAgB;IACN,gBAAgB,CAAC,SAA+B;QACxD,IAAI,IAAI,CAAC,6BAA6B,EAAE,CAAC;YACvC,MAAM,IAAI,KAAK,CAAC,2DAA2D,CAAC,CAAC;QAC/E,CAAC;QAED,qDAAqD;QACrD,SAAS,CAAC,UAAU,GAAG,IAAI,CAAC,YAAY,EAAE,CAAC;QAE3C,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAEjC,uGAAuG;QACvG,IAAI,kBAAkB,GAAuC,IAAI,CAAC,qBAAqB,CAAC,GAAG,CACzF,SAAS,CAAC,QAAQ,CACnB,CAAC;QACF,IAAI,CAAC,kBAAkB,EAAE,CAAC;YACxB,kBAAkB,GAAG,EAAE,CAAC;YACxB,IAAI,CAAC,qBAAqB,CAAC,GAAG,CAAC,SAAS,CAAC,QAAQ,EAAE,kBAAkB,CAAC,CAAC;QACzE,CAAC;QACD,kBAAkB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAEnC,wGAAwG;QACxG,IAAI,SAAS,CAAC,SAAS,EAAE,CAAC;YACxB,IAAI,mBAAmB,GAAuC,IAAI,CAAC,sBAAsB,CAAC,GAAG,CAC3F,SAAS,CAAC,SAAS,CACpB,CAAC;YACF,IAAI,CAAC,mBAAmB,EAAE,CAAC;gBACzB,mBAAmB,GAAG,EAAE,CAAC;gBACzB,IAAI,CAAC,sBAAsB,CAAC,GAAG,CAAC,SAAS,CAAC,SAAS,EAAE,mBAAmB,CAAC,CAAC;YAC5E,CAAC;YACD,mBAAmB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QACtC,CAAC;IACH,CAAC;IAED,gBAAgB;IACN,yBAAyB,CAAC,IAAY;QAC9C,IAAI,IAAI,CAAC,6BAA6B,EAAE,CAAC;YACvC,MAAM,IAAI,KAAK,CAAC,2DAA2D,CAAC,CAAC;QAC/E,CAAC;QAED,qFAAqF;QACrF,oEAAoE;QACpE,IAAI,iBAAiB,GACnB,IAAI,CAAC,oCAAoC,CAAC,GAAG,CAAC,IAAI,CAAC;YACnD,IAAI,CAAC,mCAAmC,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QACrD,IAAI,CAAC,iBAAiB,EAAE,CAAC;YACvB,iBAAiB,GAAG,IAAI,CAAC,YAAY,EAAE,CAAC;QAC1C,CAAC;QAED,IAAI,CAAC,mCAAmC,CAAC,GAAG,CAAC,IAAI,EAAE,iBAAiB,CAAC,CAAC;QACtE,OAAO,iBAAiB,CAAC;IAC3B,CAAC;IAED,gBAAgB;IACN,kBAAkB,CAC1B,SAA+B,EAC/B,iBAA0B,EAC1B,eAAwB;;QAExB,MAAM,EACJ,SAAS,EACT,QAAQ,EACR,cAAc,EACd,WAAW,EACX,IAAI,EACJ,QAAQ,EACR,mBAAmB,EACnB,cAAc,EACd,oBAAoB,EACpB,UAAU,EAAE,SAAS,EACtB,GAAG,SAAS,CAAC;QAEd,MAAM,KAAK,GAAa,EAAE,CAAC;QAC3B,IAAI,SAAS,IAAI,CAAC,eAAe,EAAE,CAAC;YAClC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QACxB,CAAC;QAED,wDAAwD;QACxD,IAAI,CAAC,iBAAiB,EAAE,CAAC;YACvB,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACvB,CAAC;QAED,wCAAwC;QACxC,IAAI,cAAc,EAAE,CAAC;YACnB,KAAK,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QAC7B,CAAC;QAED,IAAI,gBAAgB,GAAW,WAAW,CAAC;QAE3C,MAAM,kBAAkB,GAAa,EAAE,CAAC;QACxC,SAAS,CAAC,sBAAsB,CAAC,kBAAkB,CAAC,CAAC;QACrD,IAAI,kBAAkB,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAClC,uEAAuE;YACvE,IAAI,gBAAgB,CAAC,KAAK,CAAC,iBAAiB,CAAC,EAAE,CAAC;gBAC9C,gBAAgB,GAAG,gBAAgB,CAAC,OAAO,EAAE,GAAG,GAAG,CAAC;YACtD,CAAC;YACD,gCAAgC;YAChC,gBAAgB,IAAI,GAAG,GAAG,kBAAkB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACzD,CAAC;QAED,IAAI,OAA6B,CAAC;QAClC,IAAI,MAA0B,CAAC;QAC/B,IAAI,IAAwB,CAAC;QAC7B,QAAQ,IAAI,EAAE,CAAC;YACb,KAAK,sCAAwB,CAAC,MAAM,CAAC,CAAC,CAAC;gBACrC,OAAO,GAAG,SAAS,CAAC,YAAwB,CAAC;gBAC7C,MAAM;YACR,CAAC;YACD,KAAK,sCAAwB,CAAC,UAAU,CAAC,CAAC,CAAC;gBACzC,OAAO,GAAG,SAAS,CAAC,YAAwB,CAAC;gBAC7C,MAAM,GAAG,QAAQ,CAAC;gBAClB,MAAM;YACR,CAAC;YACD,KAAK,sCAAwB,CAAC,IAAI;gBAChC,MAAM,GAAG,WAAW,CAAC;gBACrB,MAAM;YACR,KAAK,sCAAwB,CAAC,OAAO;gBACnC,IAAI,GAAG,KAAK,CAAC;gBACb,MAAM;YACR,KAAK,sCAAwB,CAAC,WAAW;gBACvC,IAAI,GAAG,KAAK,CAAC;gBACb,MAAM,GAAG,QAAQ,CAAC;gBAClB,MAAM;YACR,KAAK,sCAAwB,CAAC,MAAM;gBAClC,MAAM;YACR,KAAK,sCAAwB,CAAC,UAAU;gBACtC,MAAM,GAAG,QAAQ,CAAC;gBAClB,MAAM;QACV,CAAC;QAED,2FAA2F;QAC3F,0CAA0C;QAC1C,MAAM,eAAe,GAA6B;YAChD,IAAI,EAAE,gBAAgB;YACtB,IAAI,EAAE,SAAS;YACf,OAAO,EAAG,SAA8C,CAAC,YAAY;YACrE,QAAQ;YACR,OAAO;YACP,MAAM;YACN,IAAI;SACL,CAAC;QAEF,MAAM,cAAc,GAA4B,IAAI,CAAC,kBAAkB,EAA6B,CAAC;QACrG,IAAI,aAAiD,CAAC;QACtD,IAAI,cAAc,EAAE,CAAC;YACnB,aAAa,GAAG,IAAI,CAAC,sBAAsB,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;YAChE,IAAI,CAAC,aAAa,EAAE,CAAC;gBACnB,IAAI,kBAA0B,CAAC;gBAC/B,IAAI,OAAO,cAAc,KAAK,QAAQ,EAAE,CAAC;oBACvC,kBAAkB,GAAG,cAAc,CAAC;gBACtC,CAAC;qBAAM,IAAI,cAAc,KAAK,mCAAuB,EAAE,CAAC;oBACtD,kBAAkB,GAAG,SAAS,CAAC;gBACjC,CAAC;qBAAM,CAAC;oBACN,MAAM,IAAI,KAAK,CAAC,8BAA8B,GAAG,cAAc,CAAC,CAAC;gBACnE,CAAC;gBAED,aAAa,GAAG,cAAc,CAAC,gBAAgB,CAAC;oBAC9C,KAAK,EAAE,YAAY,kBAAkB,YAAY;iBAClD,CAAC,CAAC;gBACH,IAAI,CAAC,sBAAsB,CAAC,GAAG,CAAC,cAAc,EAAE,aAAa,CAAC,CAAC;YACjE,CAAC;QACH,CAAC;aAAM,CAAC;YACN,aAAa,GAAG,cAAc,CAAC;QACjC,CAAC;QAED,MAAM,gBAAgB,GAA8B,aAAwC,CAAC,WAAW,CACtG,KAAK,EACL,eAAe,CAChB,CAAC;QACF,IAAI,QAAQ,IAAI,mBAAmB,EAAE,CAAC;YACpC,wFAAwF;YAExF,MAAM,gBAAgB,GAA6B,MAAA,SAAS,CAAC,SAAS,0CAAE,IAAI,CAAC,SAAS,CAAC,CAAC;YACxF,SAAS,CAAC,SAAS,GAAG,GAAG,EAAE;gBACzB,gBAAgB,aAAhB,gBAAgB,uBAAhB,gBAAgB,EAAI,CAAC;gBACrB,6EAA6E;gBAC7E,gBAAgB,CAAC,QAAQ,GAAG,KAAK,CAAC;YACpC,CAAC,CAAC;YAEF,MAAM,iBAAiB,GAA6B,MAAA,SAAS,CAAC,UAAU,0CAAE,IAAI,CAAC,SAAS,CAAC,CAAC;YAC1F,SAAS,CAAC,UAAU,GAAG,GAAG,EAAE;gBAC1B,0DAA0D;gBAC1D,gBAAgB,CAAC,QAAQ,GAAG,IAAI,CAAC;gBACjC,iBAAiB,aAAjB,iBAAiB,uBAAjB,iBAAiB,EAAI,CAAC;YACxB,CAAC,CAAC;YAEF,SAAS,0BAA0B;gBACjC,cAAc,CAAC,KAAK,CAAC,aAAa,QAAQ,eAAe,CAAC,CAAC;YAC7D,CAAC;YAED,MAAM,qBAAqB,GAA6B,MAAA,SAAS,CAAC,cAAc,0CAAE,IAAI,CAAC,SAAS,CAAC,CAAC;YAClG,qFAAqF;YACrF,0FAA0F;YAC1F,iCAAiC;YACjC,QAAQ,IAAI,EAAE,CAAC;gBACb,KAAK,sCAAwB,CAAC,MAAM,CAAC;gBACrC,KAAK,sCAAwB,CAAC,OAAO,CAAC;gBACtC,KAAK,sCAAwB,CAAC,MAAM;oBAClC,SAAS,CAAC,cAAc,GAAG;wBACzB,IAAI,IAAI,CAAC,KAAK,KAAK,SAAS,IAAI,IAAI,CAAC,KAAK,KAAK,IAAI,EAAE,CAAC;4BACpD,0BAA0B,EAAE,CAAC;wBAC/B,CAAC;wBAED,qBAAqB,aAArB,qBAAqB,uBAArB,qBAAqB,EAAI,CAAC;oBAC5B,CAAC,CAAC;oBACF,MAAM;gBACR,KAAK,sCAAwB,CAAC,UAAU,CAAC;gBACzC,KAAK,sCAAwB,CAAC,WAAW,CAAC;gBAC1C,KAAK,sCAAwB,CAAC,UAAU;oBACtC,SAAS,CAAC,cAAc,GAAG;wBACzB,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;4BAC7B,0BAA0B,EAAE,CAAC;wBAC/B,CAAC;wBAED,qBAAqB,aAArB,qBAAqB,uBAArB,qBAAqB,EAAI,CAAC;oBAC5B,CAAC,CAAC;oBACF,MAAM;YACV,CAAC;QACH,CAAC;QAED,IAAI,oBAAoB,aAApB,oBAAoB,uBAApB,oBAAoB,CAAE,MAAM,EAAE,CAAC;YACjC,aAAa,CAAC,WAAW,CAAC,oBAAoB,kCACzC,eAAe,KAClB,IAAI,EAAE,QAAQ,CAAC,KAAK,CAAC,QAAQ,IAC7B,CAAC;QACL,CAAC;QAED,0EAA0E;QAC1E,KAAK,MAAM,IAAI,IAAI,CAAC,GAAG,KAAK,EAAE,GAAG,CAAC,oBAAoB,IAAI,EAAE,CAAC,CAAC,EAAE,CAAC;YAC/D,IAAI,CAAC,oCAAoC,CAAC,GAAG,CAAC,IAAI,EAAE,SAAU,CAAC,CAAC;QAClE,CAAC;IACH,CAAC;IAES,2BAA2B,CAAC,IAAY,EAAE,SAAiB;QACnE,IAAI,CAAC,kBAAkB,EAAE,CAAC,WAAW,CAAC,IAAI,EAAE;YAC1C,IAAI,EAAE,SAAS;YACf,kGAAkG;YAClG,KAAK,EAAE,GAAG;YACV,mGAAmG;YACnG,2DAA2D;YAC3D,IAAI,EAAE,QAAQ,CAAC,KAAK,CAAC,QAAQ;SAC9B,CAAC,CAAC;IACL,CAAC;IAEO,YAAY;QAClB,OAAO,MAAM,GAAG,CAAC,4BAA4B,CAAC,WAAW,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC;IAC1E,CAAC;IAEO,aAAa,CACnB,iBAAyB,EACzB,YAAsC,EACtC,cAAuB;QAEvB,gEAAgE;QAChE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,GAAG,IAAI,CAAC,mBAAmB,CAAC,iBAAiB,CAAC,CAAC;QACxE,iBAAiB,GAAG,QAAQ,CAAC;QAC7B,cAAc,GAAG,KAAK,IAAI,cAAc,CAAC;QAEzC,MAAM,UAAU,GACd,IAAI,CAAC,qBAAqB,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC;QACpD,IAAI,CAAC,UAAU,EAAE,CAAC;YAChB,MAAM,IAAI,KAAK,CAAC,kBAAkB,iBAAiB,kBAAkB,CAAC,CAAC;QACzE,CAAC;QAED,IAAI,SAAS,GAAyC,UAAU,CAAC,IAAI,CACnE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,cAAc,KAAK,cAAc,CAC3C,CAAC;QACF,IAAI,CAAC,SAAS,EAAE,CAAC;YACf,IAAI,cAAc,KAAK,SAAS,EAAE,CAAC;gBACjC,MAAM,IAAI,KAAK,CACb,kBAAkB,iBAAiB,iBAAiB,cAAc,mBAAmB,CACtF,CAAC;YACJ,CAAC;YACD,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBAC5B,MAAM,IAAI,KAAK,CAAC,kBAAkB,iBAAiB,2CAA2C,CAAC,CAAC;YAClG,CAAC;YACD,SAAS,GAAG,UAAU,CAAC,CAAC,CAAC,CAAC;QAC5B,CAAC;QAED,IAAI,SAAS,CAAC,IAAI,KAAK,YAAY,EAAE,CAAC;YACpC,MAAM,IAAI,KAAK,CACb,kBAAkB,iBAAiB,iBAAiB,sCAAwB,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG;gBAC7F,sCAAsC,sCAAwB,CAAC,YAAY,CAAC,IAAI,CACnF,CAAC;QACJ,CAAC;QAED,OAAO,SAAc,CAAC;IACxB,CAAC;IAEO,qBAAqB,CAC3B,aAAwC,EACxC,IAA4B,EAC5B,SAAiB,EACjB,OAAe;QAEf,6FAA6F;QAC7F,MAAM,gBAAgB,GAAW,IAAI,CAAC,WAAW,IAAI,IAAI,CAAC,MAAM,IAAI,EAAE,CAAC;QACvE,MAAM,WAAW,GACf,UAAU,aAAa,CAAC,YAAY,EAAE;YACtC,8DAA8D;YAC9D,GAAG,gBAAgB,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,GAAG,gBAAgB,WAAW,CAAC;QAE/D,sCAAsC;QACtC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,eAAe,EAAE,CAAC,CAAC;QACpC,MAAM,IAAI,uDAA0B,CAAC,SAAS,EAAE,GAAG,WAAW,GAAG,OAAO,CAAC,SAAS,EAAE,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;IACtG,CAAC;;AAn6BH,oEAo6BC;AAn6BgB,wCAAW,GAAW,CAAC,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 type {\n  ICommandLineChoiceDefinition,\n  ICommandLineChoiceListDefinition,\n  ICommandLineIntegerDefinition,\n  ICommandLineIntegerListDefinition,\n  ICommandLineFlagDefinition,\n  ICommandLineStringDefinition,\n  ICommandLineStringListDefinition,\n  ICommandLineRemainderDefinition\n} from '../parameters/CommandLineDefinition';\nimport type { ICommandLineParserOptions } from './CommandLineParser';\nimport {\n  type CommandLineParameterBase,\n  type CommandLineParameterWithArgument,\n  CommandLineParameterKind,\n  type CommandLineParameter\n} from '../parameters/BaseClasses';\nimport {\n  CommandLineChoiceParameter,\n  type IRequiredCommandLineChoiceParameter\n} from '../parameters/CommandLineChoiceParameter';\nimport { CommandLineChoiceListParameter } from '../parameters/CommandLineChoiceListParameter';\nimport {\n  CommandLineIntegerParameter,\n  type IRequiredCommandLineIntegerParameter\n} from '../parameters/CommandLineIntegerParameter';\nimport { CommandLineIntegerListParameter } from '../parameters/CommandLineIntegerListParameter';\nimport { CommandLineFlagParameter } from '../parameters/CommandLineFlagParameter';\nimport {\n  CommandLineStringParameter,\n  type IRequiredCommandLineStringParameter\n} from '../parameters/CommandLineStringParameter';\nimport { CommandLineStringListParameter } from '../parameters/CommandLineStringListParameter';\nimport { CommandLineRemainder } from '../parameters/CommandLineRemainder';\nimport { SCOPING_PARAMETER_GROUP } from '../Constants';\nimport { CommandLineParserExitError } from './CommandLineParserExitError';\n\n/**\n * The result containing the parsed parameter long name and scope. Returned when calling\n * {@link CommandLineParameterProvider.parseScopedLongName}.\n *\n * @public\n */\nexport interface IScopedLongNameParseResult {\n  /**\n   * The long name parsed from the scoped long name, e.g. \"--my-scope:my-parameter\" -\\> \"--my-parameter\"\n   */\n  longName: string;\n\n  /**\n   * The scope parsed from the scoped long name or undefined if no scope was found,\n   * e.g. \"--my-scope:my-parameter\" -\\> \"my-scope\"\n   */\n  scope: string | undefined;\n}\n\n/**\n * An object containing the state of the\n *\n * @internal\n */\nexport interface IRegisterDefinedParametersState {\n  /**\n   * A set of all defined parameter names registered by parent {@link CommandLineParameterProvider}\n   * objects.\n   */\n  parentParameterNames: Set<string>;\n}\n\n/**\n * This is the argparse result data object\n * @internal\n */\nexport interface ICommandLineParserData {\n  action: string;\n  aliasAction?: string;\n  aliasDocumentation?: string;\n  [key: string]: any; // eslint-disable-line @typescript-eslint/no-explicit-any\n}\n\nconst SCOPE_GROUP_NAME: string = 'scope';\nconst LONG_NAME_GROUP_NAME: string = 'longName';\nconst POSSIBLY_SCOPED_LONG_NAME_REGEXP: RegExp =\n  /^--((?<scope>[a-z0-9]+(-[a-z0-9]+)*):)?(?<longName>[a-z0-9]+((-[a-z0-9]+)+)?)$/;\n\ninterface IExtendedArgumentGroup extends argparse.ArgumentGroup {\n  // The types are incorrect - this function returns the constructed argument\n  // object, which looks like the argument options type.\n  addArgument(nameOrFlags: string | string[], options: argparse.ArgumentOptions): argparse.ArgumentOptions;\n}\n\ninterface IExtendedArgumentParser extends argparse.ArgumentParser {\n  // This function throws\n  error(message: string): never;\n}\n\n/**\n * This is the common base class for CommandLineAction and CommandLineParser\n * that provides functionality for defining command-line parameters.\n *\n * @public\n */\nexport abstract class CommandLineParameterProvider {\n  private static _keyCounter: number = 0;\n\n  /** @internal */\n  public readonly _ambiguousParameterParserKeysByName: Map<string, string>;\n  /** @internal */\n  protected readonly _registeredParameterParserKeysByName: Map<string, string>;\n\n  private readonly _parameters: CommandLineParameter[];\n  private readonly _parametersByLongName: Map<string, CommandLineParameter[]>;\n  private readonly _parametersByShortName: Map<string, CommandLineParameter[]>;\n  private readonly _parameterGroupsByName: Map<\n    string | typeof SCOPING_PARAMETER_GROUP,\n    argparse.ArgumentGroup\n  >;\n  private _parametersHaveBeenRegistered: boolean;\n  private _parametersHaveBeenProcessed: boolean;\n  private _remainder: CommandLineRemainder | undefined;\n\n  /** @internal */\n  // Third party code should not inherit subclasses or call this constructor\n  public constructor() {\n    this._parameters = [];\n    this._parametersByLongName = new Map();\n    this._parametersByShortName = new Map();\n    this._parameterGroupsByName = new Map();\n    this._ambiguousParameterParserKeysByName = new Map();\n    this._registeredParameterParserKeysByName = new Map();\n    this._parametersHaveBeenRegistered = false;\n    this._parametersHaveBeenProcessed = false;\n  }\n\n  /**\n   * Returns a collection of the parameters that were defined for this object.\n   */\n  public get parameters(): ReadonlyArray<CommandLineParameterBase> {\n    return this._parameters;\n  }\n\n  /**\n   * Informs the caller if the argparse data has been processed into parameters.\n   */\n  public get parametersProcessed(): boolean {\n    return this._parametersHaveBeenProcessed;\n  }\n\n  /**\n   * If {@link CommandLineParameterProvider.defineCommandLineRemainder} was called,\n   * this object captures any remaining command line arguments after the recognized portion.\n   */\n  public get remainder(): CommandLineRemainder | undefined {\n    return this._remainder;\n  }\n\n  /**\n   * Defines a command-line parameter whose value must be a string from a fixed set of\n   * allowable choices (similar to an enum).\n   *\n   * @remarks\n   * Example of a choice parameter:\n   * ```\n   * example-tool --log-level warn\n   * ```\n   */\n  public defineChoiceParameter<TChoice extends string = string>(\n    definition: ICommandLineChoiceDefinition<TChoice> & {\n      required: false | undefined;\n      defaultValue: undefined;\n    }\n  ): CommandLineChoiceParameter<TChoice>;\n  /**\n   * {@inheritdoc CommandLineParameterProvider.(defineChoiceParameter:1)}\n   */\n  public defineChoiceParameter<TChoice extends string = string>(\n    definition: ICommandLineChoiceDefinition<TChoice> & { required: true }\n  ): IRequiredCommandLineChoiceParameter<TChoice>;\n  /**\n   * {@inheritdoc CommandLineParameterProvider.(defineChoiceParameter:1)}\n   */\n  public defineChoiceParameter<TChoice extends string = string>(\n    definition: ICommandLineChoiceDefinition<TChoice> & { defaultValue: TChoice }\n  ): IRequiredCommandLineChoiceParameter<TChoice>;\n  /**\n   * {@inheritdoc CommandLineParameterProvider.(defineChoiceParameter:1)}\n   */\n  public defineChoiceParameter<TChoice extends string = string>(\n    definition: ICommandLineChoiceDefinition<TChoice>\n  ): CommandLineChoiceParameter<TChoice>;\n  public defineChoiceParameter<TChoice extends string = string>(\n    definition: ICommandLineChoiceDefinition<TChoice>\n  ): CommandLineChoiceParameter<TChoice> {\n    const parameter: CommandLineChoiceParameter<TChoice> = new CommandLineChoiceParameter(definition);\n    this._defineParameter(parameter);\n    return parameter;\n  }\n\n  /**\n   * Returns the CommandLineChoiceParameter with the specified long name.\n   * @remarks\n   * This method throws an exception if the parameter is not defined.\n   */\n  public getChoiceParameter(parameterLongName: string, parameterScope?: string): CommandLineChoiceParameter {\n    return this._getParameter(parameterLongName, CommandLineParameterKind.Choice, parameterScope);\n  }\n\n  /**\n   * Defines a command-line parameter whose value must be a string from a fixed set of\n   * allowable choices (similar to an enum). The parameter can be specified multiple times to\n   * build a list.\n   *\n   * @remarks\n   * Example of a choice list parameter:\n   * ```\n   * example-tool --allow-color red --allow-color green\n   * ```\n   */\n  public defineChoiceListParameter<TChoice extends string = string>(\n    definition: ICommandLineChoiceListDefinition<TChoice>\n  ): CommandLineChoiceListParameter<TChoice> {\n    const parameter: CommandLineChoiceListParameter<TChoice> = new CommandLineChoiceListParameter(definition);\n    this._defineParameter(parameter);\n    return parameter;\n  }\n\n  /**\n   * Returns the CommandLineChoiceListParameter with the specified long name.\n   * @remarks\n   * This method throws an exception if the parameter is not defined.\n   */\n  public getChoiceListParameter(\n    parameterLongName: string,\n    parameterScope?: string\n  ): CommandLineChoiceListParameter {\n    return this._getParameter(parameterLongName, CommandLineParameterKind.ChoiceList, parameterScope);\n  }\n\n  /**\n   * Defines a command-line switch whose boolean value is true if the switch is provided,\n   * and false otherwise.\n   *\n   * @remarks\n   * Example usage of a flag parameter:\n   * ```\n   * example-tool --debug\n   * ```\n   */\n  public defineFlagParameter(definition: ICommandLineFlagDefinition): CommandLineFlagParameter {\n    const parameter: CommandLineFlagParameter = new CommandLineFlagParameter(definition);\n    this._defineParameter(parameter);\n    return parameter;\n  }\n\n  /**\n   * Returns the CommandLineFlagParameter with the specified long name.\n   * @remarks\n   * This method throws an exception if the parameter is not defined.\n   */\n  public getFlagParameter(parameterLongName: string, parameterScope?: string): CommandLineFlagParameter {\n    return this._getParameter(parameterLongName, CommandLineParameterKind.Flag, parameterScope);\n  }\n\n  /**\n   * Defines a command-line parameter whose argument is an integer.\n   *\n   * @remarks\n   * Example usage of an integer parameter:\n   * ```\n   * example-tool --max-attempts 5\n   * ```\n   */\n  public defineIntegerParameter(\n    definition: ICommandLineIntegerDefinition & { required: false | undefined; defaultValue: undefined }\n  ): CommandLineIntegerParameter;\n  /**\n   * {@inheritdoc CommandLineParameterProvider.(defineIntegerParameter:1)}\n   */\n  public defineIntegerParameter(\n    definition: ICommandLineIntegerDefinition & { required: true }\n  ): IRequiredCommandLineIntegerParameter;\n  /**\n   * {@inheritdoc CommandLineParameterProvider.(defineIntegerParameter:1)}\n   */\n  public defineIntegerParameter(\n    definition: ICommandLineIntegerDefinition & { defaultValue: number }\n  ): IRequiredCommandLineIntegerParameter;\n  /**\n   * {@inheritdoc CommandLineParameterProvider.(defineIntegerParameter:1)}\n   */\n  public defineIntegerParameter(definition: ICommandLineIntegerDefinition): CommandLineIntegerParameter;\n  public defineIntegerParameter(definition: ICommandLineIntegerDefinition): CommandLineIntegerParameter {\n    const parameter: CommandLineIntegerParameter = new CommandLineIntegerParameter(definition);\n    this._defineParameter(parameter);\n    return parameter;\n  }\n\n  /**\n   * Returns the CommandLineIntegerParameter with the specified long name.\n   * @remarks\n   * This method throws an exception if the parameter is not defined.\n   */\n  public getIntegerParameter(\n    parameterLongName: string,\n    parameterScope?: string\n  ): CommandLineIntegerParameter {\n    return this._getParameter(parameterLongName, CommandLineParameterKind.Integer, parameterScope);\n  }\n\n  /**\n   * Defines a command-line parameter whose argument is an integer. The parameter can be specified\n   * multiple times to build a list.\n   *\n   * @remarks\n   * Example usage of an integer list parameter:\n   * ```\n   * example-tool --avoid 4 --avoid 13\n   * ```\n   */\n  public defineIntegerListParameter(\n    definition: ICommandLineIntegerListDefinition\n  ): CommandLineIntegerListParameter {\n    const parameter: CommandLineIntegerListParameter = new CommandLineIntegerListParameter(definition);\n    this._defineParameter(parameter);\n    return parameter;\n  }\n\n  /**\n   * Returns the CommandLineIntegerParameter with the specified long name.\n   * @remarks\n   * This method throws an exception if the parameter is not defined.\n   */\n  public getIntegerListParameter(\n    parameterLongName: string,\n    parameterScope?: string\n  ): CommandLineIntegerListParameter {\n    return this._getParameter(parameterLongName, CommandLineParameterKind.IntegerList, parameterScope);\n  }\n\n  /**\n   * Defines a command-line parameter whose argument is a single text string.\n   *\n   * @remarks\n   * Example usage of a string parameter:\n   * ```\n   * example-tool --message \"Hello, world!\"\n   * ```\n   */\n  public defineStringParameter(\n    definition: ICommandLineStringDefinition & { required: false | undefined; defaultValue: undefined }\n  ): CommandLineStringParameter;\n  /**\n   * {@inheritdoc CommandLineParameterProvider.(defineStringParameter:1)}\n   */\n  public defineStringParameter(\n    definition: ICommandLineStringDefinition & { required: true }\n  ): IRequiredCommandLineStringParameter;\n  /**\n   * {@inheritdoc CommandLineParameterProvider.(defineStringParameter:1)}\n   */\n  public defineStringParameter(\n    definition: ICommandLineStringDefinition & { defaultValue: string }\n  ): IRequiredCommandLineStringParameter;\n  /**\n   * {@inheritdoc CommandLineParameterProvider.(defineStringParameter:1)}\n   */\n  public defineStringParameter(definition: ICommandLineStringDefinition): CommandLineStringParameter;\n  public defineStringParameter(definition: ICommandLineStringDefinition): CommandLineStringParameter {\n    const parameter: CommandLineStringParameter = new CommandLineStringParameter(definition);\n    this._defineParameter(parameter);\n    return parameter;\n  }\n\n  /**\n   * Returns the CommandLineStringParameter with the specified long name.\n   * @remarks\n   * This method throws an exception if the parameter is not defined.\n   */\n  public getStringParameter(parameterLongName: string, parameterScope?: string): CommandLineStringParameter {\n    return this._getParameter(parameterLongName, CommandLineParameterKind.String, parameterScope);\n  }\n\n  /**\n   * Defines a command-line parameter whose argument is a single text string.  The parameter can be\n   * specified multiple times to build a list.\n   *\n   * @remarks\n   * Example usage of a string list parameter:\n   * ```\n   * example-tool --add file1.txt --add file2.txt --add file3.txt\n   * ```\n   */\n  public defineStringListParameter(\n    definition: ICommandLineStringListDefinition\n  ): CommandLineStringListParameter {\n    const parameter: CommandLineStringListParameter = new CommandLineStringListParameter(definition);\n    this._defineParameter(parameter);\n    return parameter;\n  }\n\n  /**\n   * Defines a rule that captures any remaining command line arguments after the recognized portion.\n   *\n   * @remarks\n   * This feature is useful for commands that pass their arguments along to an external tool, relying on\n   * that tool to perform validation.  (It could also be used to parse parameters without any validation\n   * or documentation, but that is not recommended.)\n   *\n   * Example of capturing the remainder after an optional flag parameter.\n   * ```\n   * example-tool --my-flag this is the remainder\n   * ```\n   *\n   * In the \"--help\" documentation, the remainder rule will be represented as \"...\".\n   */\n  public defineCommandLineRemainder(definition: ICommandLineRemainderDefinition): CommandLineRemainder {\n    if (this._remainder) {\n      throw new Error('defineRemainingArguments() has already been called for this provider');\n    }\n    this._remainder = new CommandLineRemainder(definition);\n    return this._remainder;\n  }\n\n  /**\n   * Returns the CommandLineStringListParameter with the specified long name.\n   * @remarks\n   * This method throws an exception if the parameter is not defined.\n   */\n  public getStringListParameter(\n    parameterLongName: string,\n    parameterScope?: string\n  ): CommandLineStringListParameter {\n    return this._getParameter(parameterLongName, CommandLineParameterKind.StringList, parameterScope);\n  }\n\n  /**\n   * Generates the command-line help text.\n   */\n  public renderHelpText(): string {\n    const initialState: IRegisterDefinedParametersState = {\n      parentParameterNames: new Set()\n    };\n    this._registerDefinedParameters(initialState);\n    return this._getArgumentParser().formatHelp();\n  }\n\n  /**\n   * Generates the command-line usage text.\n   */\n  public renderUsageText(): string {\n    const initialState: IRegisterDefinedParametersState = {\n      parentParameterNames: new Set()\n    };\n    this._registerDefinedParameters(initialState);\n    return this._getArgumentParser().formatUsage();\n  }\n\n  /**\n   * Returns a object which maps the long name of each parameter in this.parameters\n   * to the stringified form of its value. This is useful for logging telemetry, but\n   * it is not the proper way of accessing parameters or their values.\n   */\n  public getParameterStringMap(): Record<string, string> {\n    const parameterMap: Record<string, string> = {};\n    for (const parameter of this.parameters) {\n      const parameterName: string = parameter.scopedLongName || parameter.longName;\n      switch (parameter.kind) {\n        case CommandLineParameterKind.Flag:\n        case CommandLineParameterKind.Choice:\n        case CommandLineParameterKind.String:\n        case CommandLineParameterKind.Integer:\n          parameterMap[parameterName] = JSON.stringify(\n            (\n              parameter as\n                | CommandLineFlagParameter\n                | CommandLineIntegerParameter\n                | CommandLineChoiceParameter\n                | CommandLineStringParameter\n            ).value\n          );\n          break;\n        case CommandLineParameterKind.StringList:\n        case CommandLineParameterKind.IntegerList:\n        case CommandLineParameterKind.ChoiceList:\n          const arrayValue: ReadonlyArray<string | number> | undefined = (\n            parameter as\n              | CommandLineIntegerListParameter\n              | CommandLineStringListParameter\n              | CommandLineChoiceListParameter\n          ).values;\n          parameterMap[parameterName] = arrayValue ? arrayValue.join(',') : '';\n          break;\n      }\n    }\n    return parameterMap;\n  }\n\n  /**\n   * Returns an object with the parsed scope (if present) and the long name of the parameter.\n   */\n  public parseScopedLongName(scopedLongName: string): IScopedLongNameParseResult {\n    const result: RegExpExecArray | null = POSSIBLY_SCOPED_LONG_NAME_REGEXP.exec(scopedLongName);\n    if (!result || !result.groups) {\n      throw new Error(`The parameter long name \"${scopedLongName}\" is not valid.`);\n    }\n    return {\n      longName: `--${result.groups[LONG_NAME_GROUP_NAME]}`,\n      scope: result.groups[SCOPE_GROUP_NAME]\n    };\n  }\n\n  /** @internal */\n  public _registerDefinedParameters(state: IRegisterDefinedParametersState): void {\n    if (this._parametersHaveBeenRegistered) {\n      // We prevent new parameters from being defined after the first call to _registerDefinedParameters,\n      // so we can already ensure that all parameters were registered.\n      return;\n    }\n\n    // First, loop through all parameters with short names. If there are any duplicates, disable the short names\n    // since we can't prefix scopes to short names in order to deduplicate them. The duplicate short names will\n    // be reported as errors if the user attempts to use them.\n    const parametersWithDuplicateShortNames: Set<CommandLineParameterBase> = new Set();\n    for (const [shortName, shortNameParameters] of this._parametersByShortName.entries()) {\n      if (shortNameParameters.length > 1) {\n        for (const parameter of shortNameParameters) {\n          this._defineAmbiguousParameter(shortName);\n          parametersWithDuplicateShortNames.add(parameter);\n        }\n      }\n    }\n\n    // Then, loop through all parameters and register them. If there are any duplicates, ensure that they have\n    // provided a scope and register them with the scope. The duplicate long names will be reported as an error\n    // if the user attempts to use them.\n    for (const longNameParameters of this._parametersByLongName.values()) {\n      const useScopedLongName: boolean = longNameParameters.length > 1;\n      for (const parameter of longNameParameters) {\n        if (useScopedLongName) {\n          if (!parameter.parameterScope) {\n            throw new Error(\n              `The parameter \"${parameter.longName}\" is defined multiple times with the same long name. ` +\n                'Parameters with the same long name must define a scope.'\n            );\n          }\n          this._defineAmbiguousParameter(parameter.longName);\n        }\n\n        const ignoreShortName: boolean = parametersWithDuplicateShortNames.has(parameter);\n        this._registerParameter(parameter, useScopedLongName, ignoreShortName);\n      }\n    }\n\n    // Register the existing parameters as ambiguous parameters. These are generally provided by the\n    // parent action.\n    const { parentParameterNames } = state;\n    for (const parentParameterName of parentParameterNames) {\n      this._defineAmbiguousParameter(parentParameterName);\n    }\n\n    // We also need to loop through the defined ambiguous parameters and register them. These will be reported\n    // as errors if the user attempts to use them.\n    for (const [ambiguousParameterName, parserKey] of this._ambiguousParameterParserKeysByName) {\n      // Only register the ambiguous parameter if it hasn't already been registered. We will still handle these\n      // already-registered parameters as ambiguous, but by avoiding registering again, we will defer errors\n      // until the user actually attempts to use the parameter.\n      if (!this._registeredParameterParserKeysByName.has(ambiguousParameterName)) {\n        this._registerAmbiguousParameter(ambiguousParameterName, parserKey);\n      }\n    }\n\n    // Need to add the remainder parameter last\n    if (this._remainder) {\n      const argparseOptions: argparse.ArgumentOptions = {\n        help: this._remainder.description,\n        nargs: argparse.Const.REMAINDER,\n        metavar: '\"...\"'\n      };\n\n      this._getArgumentParser().addArgument(argparse.Const.REMAINDER, argparseOptions);\n    }\n\n    this._parametersHaveBeenRegistered = true;\n  }\n\n  /**\n   * The child class should implement this hook to define its command-line parameters,\n   * e.g. by calling defineFlagParameter().\n   */\n  protected onDefineParameters?(): void;\n\n  /**\n   * Retrieves the argparse object.\n   * @internal\n   */\n  protected abstract _getArgumentParser(): argparse.ArgumentParser;\n\n  /**\n   * This is called internally by {@link CommandLineParser.executeAsync}\n   * @internal\n   */\n  public _preParse(): void {\n    for (const parameter of this._parameters) {\n      parameter._preParse?.();\n    }\n  }\n\n  /**\n   * This is called internally by {@link CommandLineParser.executeAsync} before `printUsage` is called\n   * @internal\n   */\n  public _postParse(): void {\n    for (const parameter of this._parameters) {\n      parameter._postParse?.();\n    }\n  }\n\n  /**\n   * This is called internally by {@link CommandLineParser.executeAsync}\n   * @internal\n   */\n  public _processParsedData(parserOptions: ICommandLineParserOptions, data: ICommandLineParserData): void {\n    if (!this._parametersHaveBeenRegistered) {\n      throw new Error('Parameters have not been registered');\n    }\n\n    if (this._parametersHaveBeenProcessed) {\n      throw new Error('Command Line Parser Data was already processed');\n    }\n\n    // Search for any ambiguous parameters and throw an error if any are found\n    for (const [parameterName, parserKey] of this._ambiguousParameterParserKeysByName) {\n      if (data[parserKey]) {\n        // When the parser key matches the actually registered parameter, we know that this is an ambiguous\n        // parameter sourced from the parent action or tool\n        if (this._registeredParameterParserKeysByName.get(parameterName) === parserKey) {\n          this._throwParserExitError(parserOptions, data, 1, `Ambiguous option: \"${parameterName}\".`);\n        }\n\n        // Determine if the ambiguous parameter is a short name or a long name, since the process of finding\n        // the non-ambiguous name is different for each.\n        const duplicateShortNameParameters: CommandLineParameterBase[] | undefined =\n          this._parametersByShortName.get(parameterName);\n        if (duplicateShortNameParameters) {\n          // We also need to make sure we get the non-ambiguous long name for the parameter, since it is\n          // possible for that the long name is ambiguous as well.\n          const nonAmbiguousLongNames: string[] = [];\n          for (const parameter of duplicateShortNameParameters) {\n            const matchingLongNameParameters: CommandLineParameterBase[] | undefined =\n              this._parametersByLongName.get(parameter.longName);\n            if (!matchingLongNameParameters?.length) {\n              // This should never happen\n              throw new Error(\n                `Unable to find long name parameters for ambiguous short name parameter \"${parameterName}\".`\n              );\n            }\n            // If there is more than one matching long name parameter, then we know that we need to use the\n            // scoped long name for the parameter. The scoped long name should always be provided.\n            if (matchingLongNameParameters.length > 1) {\n              if (!parameter.scopedLongName) {\n                // This should never happen\n                throw new Error(\n                  `Unable to find scoped long name for ambiguous short name parameter \"${parameterName}\".`\n                );\n              }\n              nonAmbiguousLongNames.push(parameter.scopedLongName);\n            } else {\n              nonAmbiguousLongNames.push(parameter.longName);\n            }\n          }\n\n          // Throw an error including the non-ambiguous long names for the parameters that have the ambiguous\n          // short name, ex.\n          // Error: Ambiguous option \"-p\" could match \"--param1\", \"--param2\"\n          this._throwParserExitError(\n            parserOptions,\n            data,\n            1,\n            `Ambiguous option: \"${parameterName}\" could match ${nonAmbiguousLongNames.join(', ')}.`\n          );\n        }\n\n        const duplicateLongNameParameters: CommandLineParameterBase[] | undefined =\n          this._parametersByLongName.get(parameterName);\n        if (duplicateLongNameParameters) {\n          const nonAmbiguousLongNames: string[] = duplicateLongNameParameters.map(\n            (p: CommandLineParameterBase) => {\n              // The scoped long name should always be provided\n              if (!p.scopedLongName) {\n                // This should never happen\n                throw new Error(\n                  `Unable to find scoped long name for ambiguous long name parameter \"${parameterName}\".`\n                );\n              }\n              return p.scopedLongName;\n            }\n          );\n\n          // Throw an error including the non-ambiguous scoped long names for the parameters that have the\n          // ambiguous long name, ex.\n          // Error: Ambiguous option: \"--param\" could match --scope1:param, --scope2:param\n          this._throwParserExitError(\n            parserOptions,\n            data,\n            1,\n            `Ambiguous option: \"${parameterName}\" could match ${nonAmbiguousLongNames.join(', ')}.`\n          );\n        }\n\n        // This shouldn't happen, but we also shouldn't allow the user to use the ambiguous parameter\n        this._throwParserExitError(parserOptions, data, 1, `Ambiguous option: \"${parameterName}\".`);\n      }\n    }\n\n    // Fill in the values for the parameters\n    for (const parameter of this._parameters) {\n      const value: unknown = data[parameter._parserKey!];\n      parameter._setValue(value);\n      parameter._validateValue?.();\n    }\n\n    if (this.remainder) {\n      this.remainder._setValue(data[argparse.Const.REMAINDER]);\n    }\n\n    this._parametersHaveBeenProcessed = true;\n  }\n\n  /** @internal */\n  protected _defineParameter(parameter: CommandLineParameter): void {\n    if (this._parametersHaveBeenRegistered) {\n      throw new Error('Parameters have already been registered for this provider');\n    }\n\n    // Generate and set the parser key at definition time\n    parameter._parserKey = this._generateKey();\n\n    this._parameters.push(parameter);\n\n    // Collect all parameters with the same long name. We will perform conflict resolution at registration.\n    let longNameParameters: CommandLineParameter[] | undefined = this._parametersByLongName.get(\n      parameter.longName\n    );\n    if (!longNameParameters) {\n      longNameParameters = [];\n      this._parametersByLongName.set(parameter.longName, longNameParameters);\n    }\n    longNameParameters.push(parameter);\n\n    // Collect all parameters with the same short name. We will perform conflict resolution at registration.\n    if (parameter.shortName) {\n      let shortNameParameters: CommandLineParameter[] | undefined = this._parametersByShortName.get(\n        parameter.shortName\n      );\n      if (!shortNameParameters) {\n        shortNameParameters = [];\n        this._parametersByShortName.set(parameter.shortName, shortNameParameters);\n      }\n      shortNameParameters.push(parameter);\n    }\n  }\n\n  /** @internal */\n  protected _defineAmbiguousParameter(name: string): string {\n    if (this._parametersHaveBeenRegistered) {\n      throw new Error('Parameters have already been registered for this provider');\n    }\n\n    // Only generate a new parser key if the ambiguous parameter hasn't been defined yet,\n    // either as an existing parameter or as another ambiguous parameter\n    let existingParserKey: string | undefined =\n      this._registeredParameterParserKeysByName.get(name) ||\n      this._ambiguousParameterParserKeysByName.get(name);\n    if (!existingParserKey) {\n      existingParserKey = this._generateKey();\n    }\n\n    this._ambiguousParameterParserKeysByName.set(name, existingParserKey);\n    return existingParserKey;\n  }\n\n  /** @internal */\n  protected _registerParameter(\n    parameter: CommandLineParameter,\n    useScopedLongName: boolean,\n    ignoreShortName: boolean\n  ): void {\n    const {\n      shortName,\n      longName,\n      scopedLongName,\n      description,\n      kind,\n      required,\n      environmentVariable,\n      parameterGroup,\n      undocumentedSynonyms,\n      _parserKey: parserKey\n    } = parameter;\n\n    const names: string[] = [];\n    if (shortName && !ignoreShortName) {\n      names.push(shortName);\n    }\n\n    // Use the original long name unless otherwise requested\n    if (!useScopedLongName) {\n      names.push(longName);\n    }\n\n    // Add the scoped long name if it exists\n    if (scopedLongName) {\n      names.push(scopedLongName);\n    }\n\n    let finalDescription: string = description;\n\n    const supplementaryNotes: string[] = [];\n    parameter._getSupplementaryNotes(supplementaryNotes);\n    if (supplementaryNotes.length > 0) {\n      // If they left the period off the end of their sentence, then add one.\n      if (finalDescription.match(/[a-z0-9]\"?\\s*$/i)) {\n        finalDescription = finalDescription.trimEnd() + '.';\n      }\n      // Append the supplementary text\n      finalDescription += ' ' + supplementaryNotes.join(' ');\n    }\n\n    let choices: string[] | undefined;\n    let action: string | undefined;\n    let type: string | undefined;\n    switch (kind) {\n      case CommandLineParameterKind.Choice: {\n        choices = parameter.alternatives as string[];\n        break;\n      }\n      case CommandLineParameterKind.ChoiceList: {\n        choices = parameter.alternatives as string[];\n        action = 'append';\n        break;\n      }\n      case CommandLineParameterKind.Flag:\n        action = 'storeTrue';\n        break;\n      case CommandLineParameterKind.Integer:\n        type = 'int';\n        break;\n      case CommandLineParameterKind.IntegerList:\n        type = 'int';\n        action = 'append';\n        break;\n      case CommandLineParameterKind.String:\n        break;\n      case CommandLineParameterKind.StringList:\n        action = 'append';\n        break;\n    }\n\n    // NOTE: Our \"environmentVariable\" feature takes precedence over argparse's \"defaultValue\",\n    // so we have to reimplement that feature.\n    const argparseOptions: argparse.ArgumentOptions = {\n      help: finalDescription,\n      dest: parserKey,\n      metavar: (parameter as CommandLineParameterWithArgument).argumentName,\n      required,\n      choices,\n      action,\n      type\n    };\n\n    const argumentParser: IExtendedArgumentParser = this._getArgumentParser() as IExtendedArgumentParser;\n    let argumentGroup: argparse.ArgumentGroup | undefined;\n    if (parameterGroup) {\n      argumentGroup = this._parameterGroupsByName.get(parameterGroup);\n      if (!argumentGroup) {\n        let parameterGroupName: string;\n        if (typeof parameterGroup === 'string') {\n          parameterGroupName = parameterGroup;\n        } else if (parameterGroup === SCOPING_PARAMETER_GROUP) {\n          parameterGroupName = 'scoping';\n        } else {\n          throw new Error('Unexpected parameter group: ' + parameterGroup);\n        }\n\n        argumentGroup = argumentParser.addArgumentGroup({\n          title: `Optional ${parameterGroupName} arguments`\n        });\n        this._parameterGroupsByName.set(parameterGroup, argumentGroup);\n      }\n    } else {\n      argumentGroup = argumentParser;\n    }\n\n    const argparseArgument: argparse.ArgumentOptions = (argumentGroup as IExtendedArgumentGroup).addArgument(\n      names,\n      argparseOptions\n    );\n    if (required && environmentVariable) {\n      // Add some special-cased logic to handle required parameters with environment variables\n\n      const originalPreParse: (() => void) | undefined = parameter._preParse?.bind(parameter);\n      parameter._preParse = () => {\n        originalPreParse?.();\n        // Set the value as non-required before parsing. We'll validate it explicitly\n        argparseArgument.required = false;\n      };\n\n      const originalPostParse: (() => void) | undefined = parameter._postParse?.bind(parameter);\n      parameter._postParse = () => {\n        // Reset the required value to make the usage text correct\n        argparseArgument.required = true;\n        originalPostParse?.();\n      };\n\n      function throwMissingParameterError(): never {\n        argumentParser.error(`Argument \"${longName}\" is required`);\n      }\n\n      const originalValidateValue: (() => void) | undefined = parameter._validateValue?.bind(parameter);\n      // For these values, we have to perform explicit validation because they're requested\n      // as required, but we disabled argparse's required flag to allow the environment variable\n      // to potentially fill the value.\n      switch (kind) {\n        case CommandLineParameterKind.Choice:\n        case CommandLineParameterKind.Integer:\n        case CommandLineParameterKind.String:\n          parameter._validateValue = function () {\n            if (this.value === undefined || this.value === null) {\n              throwMissingParameterError();\n            }\n\n            originalValidateValue?.();\n          };\n          break;\n        case CommandLineParameterKind.ChoiceList:\n        case CommandLineParameterKind.IntegerList:\n        case CommandLineParameterKind.StringList:\n          parameter._validateValue = function () {\n            if (this.values.length === 0) {\n              throwMissingParameterError();\n            }\n\n            originalValidateValue?.();\n          };\n          break;\n      }\n    }\n\n    if (undocumentedSynonyms?.length) {\n      argumentGroup.addArgument(undocumentedSynonyms, {\n        ...argparseOptions,\n        help: argparse.Const.SUPPRESS\n      });\n    }\n\n    // Register the parameter names so that we can detect ambiguous parameters\n    for (const name of [...names, ...(undocumentedSynonyms || [])]) {\n      this._registeredParameterParserKeysByName.set(name, parserKey!);\n    }\n  }\n\n  protected _registerAmbiguousParameter(name: string, parserKey: string): void {\n    this._getArgumentParser().addArgument(name, {\n      dest: parserKey,\n      // We don't know if this argument takes parameters or not, so we need to accept any number of args\n      nargs: '*',\n      // Ensure that the argument is not shown in the help text, since these parameters are only included\n      // to inform the user that ambiguous parameters are present\n      help: argparse.Const.SUPPRESS\n    });\n  }\n\n  private _generateKey(): string {\n    return 'key_' + (CommandLineParameterProvider._keyCounter++).toString();\n  }\n\n  private _getParameter<T extends CommandLineParameterBase>(\n    parameterLongName: string,\n    expectedKind: CommandLineParameterKind,\n    parameterScope?: string\n  ): T {\n    // Support the parameter long name being prefixed with the scope\n    const { scope, longName } = this.parseScopedLongName(parameterLongName);\n    parameterLongName = longName;\n    parameterScope = scope || parameterScope;\n\n    const parameters: CommandLineParameterBase[] | undefined =\n      this._parametersByLongName.get(parameterLongName);\n    if (!parameters) {\n      throw new Error(`The parameter \"${parameterLongName}\" is not defined`);\n    }\n\n    let parameter: CommandLineParameterBase | undefined = parameters.find(\n      (p) => p.parameterScope === parameterScope\n    );\n    if (!parameter) {\n      if (parameterScope !== undefined) {\n        throw new Error(\n          `The parameter \"${parameterLongName}\" with scope \"${parameterScope}\" is not defined.`\n        );\n      }\n      if (parameters.length !== 1) {\n        throw new Error(`The parameter \"${parameterLongName}\" is ambiguous. You must specify a scope.`);\n      }\n      parameter = parameters[0];\n    }\n\n    if (parameter.kind !== expectedKind) {\n      throw new Error(\n        `The parameter \"${parameterLongName}\" is of type \"${CommandLineParameterKind[parameter.kind]}\"` +\n          ` whereas the caller was expecting \"${CommandLineParameterKind[expectedKind]}\".`\n      );\n    }\n\n    return parameter as T;\n  }\n\n  private _throwParserExitError(\n    parserOptions: ICommandLineParserOptions,\n    data: ICommandLineParserData,\n    errorCode: number,\n    message: string\n  ): never {\n    // Write out the usage text to make it easier for the user to find the correct parameter name\n    const targetActionName: string = data.aliasAction || data.action || '';\n    const errorPrefix: string =\n      `Error: ${parserOptions.toolFilename}` +\n      // Handle aliases, actions, and actionless parameter providers\n      `${targetActionName ? ' ' : ''}${targetActionName}: error: `;\n\n    // eslint-disable-next-line no-console\n    console.log(this.renderUsageText());\n    throw new CommandLineParserExitError(errorCode, `${errorPrefix}${message.trimStart().trimEnd()}\\n`);\n  }\n}\n"]}

package/lib/providers/CommandLineParser.d.ts

@@ -78,17 +78,25 @@ export declare abstract class CommandLineParser extends CommandLineParameterProv
      * want to be involved with the command-line logic, and will discard the promise without
      * a then() or catch() block.
      *
-     * If your caller wants to trap and handle errors, use {@link CommandLineParser.executeWithoutErrorHandling}
+     * If your caller wants to trap and handle errors, use {@link CommandLineParser.executeWithoutErrorHandlingAsync}
      * instead.
      *
      * @param args - the command-line arguments to be parsed; if omitted, then
      *               the process.argv will be used
      */
+    executeAsync(args?: string[]): Promise<boolean>;
+    /**
+     * @deprecated Use {@link CommandLineParser.executeAsync} instead.
+     */
     execute(args?: string[]): Promise<boolean>;
     /**
-     * This is similar to {@link CommandLineParser.execute}, except that execution errors
+     * This is similar to {@link CommandLineParser.executeAsync}, except that execution errors
      * simply cause the promise to reject.  It is the caller's responsibility to trap
      */
+    executeWithoutErrorHandlingAsync(args?: string[]): Promise<void>;
+    /**
+     * @deprecated Use {@link CommandLineParser.executeWithoutErrorHandlingAsync} instead.
+     */
     executeWithoutErrorHandling(args?: string[]): Promise<void>;
     /** @internal */
     _registerDefinedParameters(state: IRegisterDefinedParametersState): void;

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

@@ -1 +1 @@
-{"version":3,"file":"CommandLineParser.d.ts","sourceRoot":"","sources":["../../src/providers/CommandLineParser.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,KAAK,QAAQ,MAAM,UAAU,CAAC;AAG1C,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAE7D,OAAO,EACL,4BAA4B,EAC5B,KAAK,+BAA+B,EAErC,MAAM,gCAAgC,CAAC;AAIxC;;;GAGG;AACH,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,yBAAyB,CAAC,EAAE,OAAO,CAAC;CACrC;AAED;;;;;;;;;GASG;AACH,8BAAsB,iBAAkB,SAAQ,4BAA4B;IAC1E;;;;OAIG;IACI,cAAc,EAAE,iBAAiB,GAAG,SAAS,CAAC;IAErD,OAAO,CAAC,QAAQ,CAAC,eAAe,CAA0B;IAC1D,OAAO,CAAC,iBAAiB,CAAiC;IAC1D,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAA4B;IACrD,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAsB;IAC/C,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAiC;IAChE,OAAO,CAAC,SAAS,CAAkB;IACnC,OAAO,CAAC,0BAA0B,CAAkB;gBAEjC,OAAO,EAAE,yBAAyB;IAoBrD;;OAEG;IACH,IAAW,OAAO,IAAI,aAAa,CAAC,iBAAiB,CAAC,CAErD;IAED;;OAEG;IACI,SAAS,CAAC,MAAM,EAAE,iBAAiB,GAAG,IAAI;IAajD;;;OAGG;IACI,SAAS,CAAC,UAAU,EAAE,MAAM,GAAG,iBAAiB;IAQvD;;;OAGG;IACI,YAAY,CAAC,UAAU,EAAE,MAAM,GAAG,iBAAiB,GAAG,SAAS;IAItE;;;;;;;;;;;;;;;;OAgBG;IACU,OAAO,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,OAAO,CAAC;IA0CvD;;;OAGG;IACU,2BAA2B,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAkGxE,gBAAgB;IACT,0BAA0B,CAAC,KAAK,EAAE,+BAA+B,GAAG,IAAI;IAkB/E,OAAO,CAAC,oBAAoB;IAO5B;;;OAGG;IACH,SAAS,CAAC,kBAAkB,IAAI,QAAQ,CAAC,cAAc;IAKvD;;;OAGG;cACa,SAAS,IAAI,OAAO,CAAC,IAAI,CAAC;CAK3C"}
+{"version":3,"file":"CommandLineParser.d.ts","sourceRoot":"","sources":["../../src/providers/CommandLineParser.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,KAAK,QAAQ,MAAM,UAAU,CAAC;AAG1C,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAE7D,OAAO,EACL,4BAA4B,EAC5B,KAAK,+BAA+B,EAErC,MAAM,gCAAgC,CAAC;AAIxC;;;GAGG;AACH,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,yBAAyB,CAAC,EAAE,OAAO,CAAC;CACrC;AAED;;;;;;;;;GASG;AACH,8BAAsB,iBAAkB,SAAQ,4BAA4B;IAC1E;;;;OAIG;IACI,cAAc,EAAE,iBAAiB,GAAG,SAAS,CAAC;IAErD,OAAO,CAAC,QAAQ,CAAC,eAAe,CAA0B;IAC1D,OAAO,CAAC,iBAAiB,CAAiC;IAC1D,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAA4B;IACrD,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAsB;IAC/C,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAiC;IAChE,OAAO,CAAC,SAAS,CAAkB;IACnC,OAAO,CAAC,0BAA0B,CAAkB;gBAEjC,OAAO,EAAE,yBAAyB;IAoBrD;;OAEG;IACH,IAAW,OAAO,IAAI,aAAa,CAAC,iBAAiB,CAAC,CAErD;IAED;;OAEG;IACI,SAAS,CAAC,MAAM,EAAE,iBAAiB,GAAG,IAAI;IAajD;;;OAGG;IACI,SAAS,CAAC,UAAU,EAAE,MAAM,GAAG,iBAAiB;IAQvD;;;OAGG;IACI,YAAY,CAAC,UAAU,EAAE,MAAM,GAAG,iBAAiB,GAAG,SAAS;IAItE;;;;;;;;;;;;;;;;OAgBG;IACU,YAAY,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,OAAO,CAAC;IA0C5D;;OAEG;IAEU,OAAO,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,OAAO,CAAC;IAIvD;;;OAGG;IACU,gCAAgC,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAkG7E;;OAEG;IAEU,2BAA2B,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAIxE,gBAAgB;IACT,0BAA0B,CAAC,KAAK,EAAE,+BAA+B,GAAG,IAAI;IAkB/E,OAAO,CAAC,oBAAoB;IAO5B;;;OAGG;IACH,SAAS,CAAC,kBAAkB,IAAI,QAAQ,CAAC,cAAc;IAKvD;;;OAGG;cACa,SAAS,IAAI,OAAO,CAAC,IAAI,CAAC;CAK3C"}

package/lib/providers/CommandLineParser.js

@@ -83,24 +83,24 @@ class CommandLineParser extends CommandLineParameterProvider_1.CommandLineParame
      * want to be involved with the command-line logic, and will discard the promise without
      * a then() or catch() block.
      *
-     * If your caller wants to trap and handle errors, use {@link CommandLineParser.executeWithoutErrorHandling}
+     * If your caller wants to trap and handle errors, use {@link CommandLineParser.executeWithoutErrorHandlingAsync}
      * instead.
      *
      * @param args - the command-line arguments to be parsed; if omitted, then
      *               the process.argv will be used
      */
-    async execute(args) {
+    async executeAsync(args) {
         if (this._options.enableTabCompletionAction && !this._tabCompleteActionWasAdded) {
             this.addAction(new TabCompletionAction_1.TabCompleteAction(this.actions, this.parameters));
             this._tabCompleteActionWasAdded = true;
         }
         try {
-            await this.executeWithoutErrorHandling(args);
+            await this.executeWithoutErrorHandlingAsync(args);
             return true;
         }
         catch (err) {
             if (err instanceof CommandLineParserExitError_1.CommandLineParserExitError) {
-                // executeWithoutErrorHandling() handles the successful cases,
+                // executeWithoutErrorHandlingAsync() handles the successful cases,
                 // so here we can assume err has a nonzero exit code
                 if (err.message) {
                     // eslint-disable-next-line no-console
@@ -128,17 +128,24 @@ class CommandLineParser extends CommandLineParameterProvider_1.CommandLineParame
         }
     }
     /**
-     * This is similar to {@link CommandLineParser.execute}, except that execution errors
+     * @deprecated Use {@link CommandLineParser.executeAsync} instead.
+     */
+    // eslint-disable-next-line @typescript-eslint/naming-convention
+    async execute(args) {
+        return await this.executeAsync(args);
+    }
+    /**
+     * This is similar to {@link CommandLineParser.executeAsync}, except that execution errors
      * simply cause the promise to reject.  It is the caller's responsibility to trap
      */
-    async executeWithoutErrorHandling(args) {
+    async executeWithoutErrorHandlingAsync(args) {
         var _a, _b;
         try {
             if (this._executed) {
                 // In the future we could allow the same parser to be invoked multiple times
                 // with different arguments.  We'll do that work as soon as someone encounters
                 // a real world need for it.
-                throw new Error('execute() was already called for this parser instance');
+                throw new Error('executeAsync() was already called for this parser instance');
             }
             this._executed = true;
             this._validateDefinitions();
@@ -218,6 +225,13 @@ class CommandLineParser extends CommandLineParameterProvider_1.CommandLineParame
             throw err;
         }
     }
+    /**
+     * @deprecated Use {@link CommandLineParser.executeWithoutErrorHandlingAsync} instead.
+     */
+    // eslint-disable-next-line @typescript-eslint/naming-convention
+    async executeWithoutErrorHandling(args) {
+        await this.executeWithoutErrorHandlingAsync(args);
+    }
     /** @internal */
     _registerDefinedParameters(state) {
         super._registerDefinedParameters(state);
@@ -251,7 +265,7 @@ class CommandLineParser extends CommandLineParameterProvider_1.CommandLineParame
      */
     async onExecute() {
         if (this.selectedAction) {
-            await this.selectedAction._execute();
+            await this.selectedAction._executeAsync();
         }
     }
 }

package/lib/providers/CommandLineParser.js.map

@@ -1 +1 @@
-{"version":3,"file":"CommandLineParser.js","sourceRoot":"","sources":["../../src/providers/CommandLineParser.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D;;;AAG3D,kDAA+C;AAI/C,iFAIwC;AACxC,6EAAgG;AAChG,+DAA0D;AA6B1D;;;;;;;;;GASG;AACH,MAAsB,iBAAkB,SAAQ,2DAA4B;IAgB1E,YAAmB,OAAkC;;QACnD,KAAK,EAAE,CAAC;QAJF,cAAS,GAAY,KAAK,CAAC;QAC3B,+BAA0B,GAAY,KAAK,CAAC;QAKlD,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;QACxB,IAAI,CAAC,QAAQ,GAAG,EAAE,CAAC;QACnB,IAAI,CAAC,cAAc,GAAG,IAAI,GAAG,EAA6B,CAAC;QAE3D,IAAI,CAAC,eAAe,GAAG,IAAI,iDAAoB,CAAC;YAC9C,OAAO,EAAE,IAAI;YACb,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,YAAY;YAChC,WAAW,EAAE,IAAI,CAAC,QAAQ,CAAC,eAAe;YAC1C,MAAM,EAAE,mBAAQ,CAAC,IAAI,CACnB,MAAA,IAAI,CAAC,QAAQ,CAAC,UAAU,mCACtB,oDAAoD,IAAI,CAAC,QAAQ,CAAC,YAAY,eAAe,CAChG;SACF,CAAC,CAAC;QAEH,MAAA,IAAI,CAAC,kBAAkB,oDAAI,CAAC;IAC9B,CAAC;IAED;;OAEG;IACH,IAAW,OAAO;QAChB,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAED;;OAEG;IACI,SAAS,CAAC,MAAyB;QACxC,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC;YAC5B,IAAI,CAAC,iBAAiB,GAAG,IAAI,CAAC,eAAe,CAAC,aAAa,CAAC;gBAC1D,OAAO,EAAE,WAAW;gBACpB,IAAI,EAAE,QAAQ;aACf,CAAC,CAAC;QACL,CAAC;QAED,MAAM,CAAC,YAAY,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;QAC5C,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAC3B,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,MAAM,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC;IACrD,CAAC;IAED;;;OAGG;IACI,SAAS,CAAC,UAAkB;QACjC,MAAM,MAAM,GAAkC,IAAI,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC;QAC5E,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,MAAM,IAAI,KAAK,CAAC,eAAe,UAAU,mBAAmB,CAAC,CAAC;QAChE,CAAC;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;;OAGG;IACI,YAAY,CAAC,UAAkB;QACpC,OAAO,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;IAC7C,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACI,KAAK,CAAC,OAAO,CAAC,IAAe;QAClC,IAAI,IAAI,CAAC,QAAQ,CAAC,yBAAyB,IAAI,CAAC,IAAI,CAAC,0BAA0B,EAAE,CAAC;YAChF,IAAI,CAAC,SAAS,CAAC,IAAI,uCAAiB,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC;YACrE,IAAI,CAAC,0BAA0B,GAAG,IAAI,CAAC;QACzC,CAAC;QAED,IAAI,CAAC;YACH,MAAM,IAAI,CAAC,2BAA2B,CAAC,IAAI,CAAC,CAAC;YAC7C,OAAO,IAAI,CAAC;QACd,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,IAAI,GAAG,YAAY,uDAA0B,EAAE,CAAC;gBAC9C,8DAA8D;gBAC9D,oDAAoD;gBACpD,IAAI,GAAG,CAAC,OAAO,EAAE,CAAC;oBAChB,sCAAsC;oBACtC,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;gBAC7B,CAAC;gBACD,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC;oBACtB,OAAO,CAAC,QAAQ,GAAG,GAAG,CAAC,QAAQ,CAAC;gBAClC,CAAC;YACH,CAAC;iBAAM,CAAC;gBACN,IAAI,OAAO,GAAW,CAAE,GAAa,CAAC,OAAO,IAAI,2BAA2B,CAAC,CAAC,IAAI,EAAE,CAAC;gBAErF,uEAAuE;gBACvE,IAAI,CAAC,oCAAoC,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC;oBACxD,OAAO,GAAG,SAAS,GAAG,OAAO,CAAC;gBAChC,CAAC;gBAED,sCAAsC;gBACtC,OAAO,CAAC,KAAK,EAAE,CAAC;gBAChB,sCAAsC;gBACtC,OAAO,CAAC,KAAK,CAAC,mBAAQ,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC;gBAErC,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC;oBACtB,OAAO,CAAC,QAAQ,GAAG,CAAC,CAAC;gBACvB,CAAC;YACH,CAAC;YAED,OAAO,KAAK,CAAC;QACf,CAAC;IACH,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,2BAA2B,CAAC,IAAe;;QACtD,IAAI,CAAC;YACH,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;gBACnB,4EAA4E;gBAC5E,8EAA8E;gBAC9E,4BAA4B;gBAC5B,MAAM,IAAI,KAAK,CAAC,uDAAuD,CAAC,CAAC;YAC3E,CAAC;YACD,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;YAEtB,IAAI,CAAC,oBAAoB,EAAE,CAAC;YAE5B,gEAAgE;YAChE,MAAM,YAAY,GAAoC;gBACpD,oBAAoB,EAAE,IAAI,GAAG,EAAE;aAChC,CAAC;YACF,IAAI,CAAC,0BAA0B,CAAC,YAAY,CAAC,CAAC;YAE9C,IAAI,CAAC,IAAI,EAAE,CAAC;gBACV,4BAA4B;gBAC5B,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;YAC/B,CAAC;YACD,IAAI,IAAI,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBAC5B,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;oBACtB,6EAA6E;oBAC7E,+CAA+C;oBAC/C,IAAI,CAAC,eAAe,CAAC,SAAS,EAAE,CAAC;oBACjC,OAAO;gBACT,CAAC;gBACD,mFAAmF;gBACnF,kFAAkF;gBAClF,oFAAoF;gBACpF,kFAAkF;gBAClF,uBAAuB;gBACvB,MAAM,eAAe,GAAuB,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC;gBACtF,IAAI,eAAe,KAAK,SAAS,EAAE,CAAC;oBAClC,MAAM,UAAU,GAAW,IAAI,CAAC,eAAe,CAAC,CAAC;oBACjD,MAAM,MAAM,GAAkC,IAAI,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC;oBAC5E,MAAM,WAAW,GAAuC,MAAgC,CAAC;oBACzF,IAAI,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,iBAAiB,0CAAE,MAAM,EAAE,CAAC;wBAC3C,MAAM,WAAW,GAAW,eAAe,GAAG,CAAC,CAAC;wBAChD,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,WAAW,CAAC,CAAC,MAAM,CAAC,WAAW,CAAC,iBAAiB,EAAE,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC;oBACnG,CAAC;gBACH,CAAC;YACH,CAAC;YAED,MAAM,SAAS,GAAe,GAAG,EAAE;gBACjC,IAAI,CAAC,UAAU,EAAE,CAAC;gBAClB,KAAK,MAAM,MAAM,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;oBAClC,MAAM,CAAC,UAAU,EAAE,CAAC;gBACtB,CAAC;YACH,CAAC,CAAC;YAEF,SAAS,iCAAiC,CAAC,cAAuC;gBAChF,MAAM,mBAAmB,GAAiB,cAAc,CAAC,WAAW,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;gBAC1F,cAAc,CAAC,WAAW,GAAG,GAAG,EAAE;oBAChC,SAAS,EAAE,CAAC;oBACZ,OAAO,mBAAmB,EAAE,CAAC;gBAC/B,CAAC,CAAC;YACJ,CAAC;YAED,IAAI,CAAC,SAAS,EAAE,CAAC;YACjB,iCAAiC,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;YACxD,KAAK,MAAM,MAAM,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;gBAClC,MAAM,CAAC,SAAS,EAAE,CAAC;gBACnB,iCAAiC,CAAC,MAAM,CAAC,kBAAkB,EAAE,CAAC,CAAC;YACjE,CAAC;YAED,MAAM,IAAI,GAA2B,IAAI,CAAC,eAAe,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;YAE1E,SAAS,EAAE,CAAC;YACZ,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;YAE7C,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YACrD,IAAI,IAAI,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,CAAC;gBACpD,MAAM,OAAO,GAAa,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC;gBAChE,MAAM,IAAI,KAAK,CAAC,gCAAgC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YACzE,CAAC;YAED,MAAA,IAAI,CAAC,cAAc,0CAAE,kBAAkB,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;YAC7D,MAAM,IAAI,CAAC,SAAS,EAAE,CAAC;QACzB,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,IAAI,GAAG,YAAY,uDAA0B,EAAE,CAAC;gBAC9C,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC;oBAClB,kDAAkD;oBAClD,IAAI,GAAG,CAAC,OAAO,EAAE,CAAC;wBAChB,sCAAsC;wBACtC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;oBAC3B,CAAC;oBAED,OAAO;gBACT,CAAC;YACH,CAAC;YAED,MAAM,GAAG,CAAC;QACZ,CAAC;IACH,CAAC;IAED,gBAAgB;IACT,0BAA0B,CAAC,KAAsC;QACtE,KAAK,CAAC,0BAA0B,CAAC,KAAK,CAAC,CAAC;QAExC,MAAM,EAAE,oBAAoB,EAAE,GAAG,KAAK,CAAC;QACvC,MAAM,2BAA2B,GAAgB,IAAI,GAAG,CAAC;YACvD,GAAG,oBAAoB;YACvB,GAAG,IAAI,CAAC,oCAAoC,CAAC,IAAI,EAAE;SACpD,CAAC,CAAC;QAEH,MAAM,WAAW,mCACZ,KAAK,KACR,oBAAoB,EAAE,2BAA2B,GAClD,CAAC;QACF,KAAK,MAAM,MAAM,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;YACnC,MAAM,CAAC,0BAA0B,CAAC,WAAW,CAAC,CAAC;QACjD,CAAC;IACH,CAAC;IAEO,oBAAoB;QAC1B,IAAI,IAAI,CAAC,SAAS,IAAI,IAAI,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC9C,+CAA+C;YAC/C,MAAM,IAAI,KAAK,CAAC,oFAAoF,CAAC,CAAC;QACxG,CAAC;IACH,CAAC;IAED;;;OAGG;IACO,kBAAkB;QAC1B,WAAW;QACX,OAAO,IAAI,CAAC,eAAe,CAAC;IAC9B,CAAC;IAED;;;OAGG;IACO,KAAK,CAAC,SAAS;QACvB,IAAI,IAAI,CAAC,cAAc,EAAE,CAAC;YACxB,MAAM,IAAI,CAAC,cAAc,CAAC,QAAQ,EAAE,CAAC;QACvC,CAAC;IACH,CAAC;CACF;AA5RD,8CA4RC","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 type * as argparse from 'argparse';\nimport { Colorize } from '@rushstack/terminal';\n\nimport type { CommandLineAction } from './CommandLineAction';\nimport type { AliasCommandLineAction } from './AliasCommandLineAction';\nimport {\n  CommandLineParameterProvider,\n  type IRegisterDefinedParametersState,\n  type ICommandLineParserData\n} from './CommandLineParameterProvider';\nimport { CommandLineParserExitError, CustomArgumentParser } from './CommandLineParserExitError';\nimport { TabCompleteAction } from './TabCompletionAction';\n\n/**\n * Options for the {@link CommandLineParser} constructor.\n * @public\n */\nexport interface ICommandLineParserOptions {\n  /**\n   * The name of your tool when invoked from the command line\n   */\n  toolFilename: string;\n\n  /**\n   * General documentation that is included in the \"--help\" main page\n   */\n  toolDescription: string;\n\n  /**\n   * An optional string to append at the end of the \"--help\" main page. If not provided, an epilog\n   * will be automatically generated based on the toolFilename.\n   */\n  toolEpilog?: string;\n\n  /**\n   * Set to true to auto-define a tab completion action. False by default.\n   */\n  enableTabCompletionAction?: boolean;\n}\n\n/**\n * The \"argparse\" library is a relatively advanced command-line parser with features such\n * as word-wrapping and intelligible error messages (that are lacking in other similar\n * libraries such as commander, yargs, and nomnom).  Unfortunately, its ruby-inspired API\n * is awkward to use.  The abstract base classes CommandLineParser and CommandLineAction\n * provide a wrapper for \"argparse\" that makes defining and consuming arguments quick\n * and simple, and enforces that appropriate documentation is provided for each parameter.\n *\n * @public\n */\nexport abstract class CommandLineParser extends CommandLineParameterProvider {\n  /**\n   * Reports which CommandLineAction was specified on the command line.\n   * @remarks\n   * The value will be assigned before onExecute() is invoked.\n   */\n  public selectedAction: CommandLineAction | undefined;\n\n  private readonly _argumentParser: argparse.ArgumentParser;\n  private _actionsSubParser: argparse.SubParser | undefined;\n  private readonly _options: ICommandLineParserOptions;\n  private readonly _actions: CommandLineAction[];\n  private readonly _actionsByName: Map<string, CommandLineAction>;\n  private _executed: boolean = false;\n  private _tabCompleteActionWasAdded: boolean = false;\n\n  public constructor(options: ICommandLineParserOptions) {\n    super();\n\n    this._options = options;\n    this._actions = [];\n    this._actionsByName = new Map<string, CommandLineAction>();\n\n    this._argumentParser = new CustomArgumentParser({\n      addHelp: true,\n      prog: this._options.toolFilename,\n      description: this._options.toolDescription,\n      epilog: Colorize.bold(\n        this._options.toolEpilog ??\n          `For detailed help about a specific command, use: ${this._options.toolFilename} <command> -h`\n      )\n    });\n\n    this.onDefineParameters?.();\n  }\n\n  /**\n   * Returns the list of actions that were defined for this CommandLineParser object.\n   */\n  public get actions(): ReadonlyArray<CommandLineAction> {\n    return this._actions;\n  }\n\n  /**\n   * Defines a new action that can be used with the CommandLineParser instance.\n   */\n  public addAction(action: CommandLineAction): void {\n    if (!this._actionsSubParser) {\n      this._actionsSubParser = this._argumentParser.addSubparsers({\n        metavar: '<command>',\n        dest: 'action'\n      });\n    }\n\n    action._buildParser(this._actionsSubParser);\n    this._actions.push(action);\n    this._actionsByName.set(action.actionName, action);\n  }\n\n  /**\n   * Retrieves the action with the specified name.  If no matching action is found,\n   * an exception is thrown.\n   */\n  public getAction(actionName: string): CommandLineAction {\n    const action: CommandLineAction | undefined = this.tryGetAction(actionName);\n    if (!action) {\n      throw new Error(`The action \"${actionName}\" was not defined`);\n    }\n    return action;\n  }\n\n  /**\n   * Retrieves the action with the specified name.  If no matching action is found,\n   * undefined is returned.\n   */\n  public tryGetAction(actionName: string): CommandLineAction | undefined {\n    return this._actionsByName.get(actionName);\n  }\n\n  /**\n   * The program entry point will call this method to begin parsing command-line arguments\n   * and executing the corresponding action.\n   *\n   * @remarks\n   * The returned promise will never reject:  If an error occurs, it will be printed\n   * to stderr, process.exitCode will be set to 1, and the promise will resolve to false.\n   * This simplifies the most common usage scenario where the program entry point doesn't\n   * want to be involved with the command-line logic, and will discard the promise without\n   * a then() or catch() block.\n   *\n   * If your caller wants to trap and handle errors, use {@link CommandLineParser.executeWithoutErrorHandling}\n   * instead.\n   *\n   * @param args - the command-line arguments to be parsed; if omitted, then\n   *               the process.argv will be used\n   */\n  public async execute(args?: string[]): Promise<boolean> {\n    if (this._options.enableTabCompletionAction && !this._tabCompleteActionWasAdded) {\n      this.addAction(new TabCompleteAction(this.actions, this.parameters));\n      this._tabCompleteActionWasAdded = true;\n    }\n\n    try {\n      await this.executeWithoutErrorHandling(args);\n      return true;\n    } catch (err) {\n      if (err instanceof CommandLineParserExitError) {\n        // executeWithoutErrorHandling() handles the successful cases,\n        // so here we can assume err has a nonzero exit code\n        if (err.message) {\n          // eslint-disable-next-line no-console\n          console.error(err.message);\n        }\n        if (!process.exitCode) {\n          process.exitCode = err.exitCode;\n        }\n      } else {\n        let message: string = ((err as Error).message || 'An unknown error occurred').trim();\n\n        // If the message doesn't already start with \"Error:\" then add a prefix\n        if (!/^(error|internal error|warning)\\b/i.test(message)) {\n          message = 'Error: ' + message;\n        }\n\n        // eslint-disable-next-line no-console\n        console.error();\n        // eslint-disable-next-line no-console\n        console.error(Colorize.red(message));\n\n        if (!process.exitCode) {\n          process.exitCode = 1;\n        }\n      }\n\n      return false;\n    }\n  }\n\n  /**\n   * This is similar to {@link CommandLineParser.execute}, except that execution errors\n   * simply cause the promise to reject.  It is the caller's responsibility to trap\n   */\n  public async executeWithoutErrorHandling(args?: string[]): Promise<void> {\n    try {\n      if (this._executed) {\n        // In the future we could allow the same parser to be invoked multiple times\n        // with different arguments.  We'll do that work as soon as someone encounters\n        // a real world need for it.\n        throw new Error('execute() was already called for this parser instance');\n      }\n      this._executed = true;\n\n      this._validateDefinitions();\n\n      // Register the parameters before we print help or parse the CLI\n      const initialState: IRegisterDefinedParametersState = {\n        parentParameterNames: new Set()\n      };\n      this._registerDefinedParameters(initialState);\n\n      if (!args) {\n        // 0=node.exe, 1=script name\n        args = process.argv.slice(2);\n      }\n      if (this.actions.length > 0) {\n        if (args.length === 0) {\n          // Parsers that use actions should print help when 0 args are provided. Allow\n          // actionless parsers to continue on zero args.\n          this._argumentParser.printHelp();\n          return;\n        }\n        // Alias actions may provide a list of default params to add after the action name.\n        // Since we don't know which params are required and which are optional, perform a\n        // manual search for the action name to obtain the default params and insert them if\n        // any are found. We will guess that the action name is the first arg that doesn't\n        // start with a hyphen.\n        const actionNameIndex: number | undefined = args.findIndex((x) => !x.startsWith('-'));\n        if (actionNameIndex !== undefined) {\n          const actionName: string = args[actionNameIndex];\n          const action: CommandLineAction | undefined = this.tryGetAction(actionName);\n          const aliasAction: AliasCommandLineAction | undefined = action as AliasCommandLineAction;\n          if (aliasAction?.defaultParameters?.length) {\n            const insertIndex: number = actionNameIndex + 1;\n            args = args.slice(0, insertIndex).concat(aliasAction.defaultParameters, args.slice(insertIndex));\n          }\n        }\n      }\n\n      const postParse: () => void = () => {\n        this._postParse();\n        for (const action of this.actions) {\n          action._postParse();\n        }\n      };\n\n      function patchFormatUsageForArgumentParser(argumentParser: argparse.ArgumentParser): void {\n        const originalFormatUsage: () => string = argumentParser.formatUsage.bind(argumentParser);\n        argumentParser.formatUsage = () => {\n          postParse();\n          return originalFormatUsage();\n        };\n      }\n\n      this._preParse();\n      patchFormatUsageForArgumentParser(this._argumentParser);\n      for (const action of this.actions) {\n        action._preParse();\n        patchFormatUsageForArgumentParser(action._getArgumentParser());\n      }\n\n      const data: ICommandLineParserData = this._argumentParser.parseArgs(args);\n\n      postParse();\n      this._processParsedData(this._options, data);\n\n      this.selectedAction = this.tryGetAction(data.action);\n      if (this.actions.length > 0 && !this.selectedAction) {\n        const actions: string[] = this.actions.map((x) => x.actionName);\n        throw new Error(`An action must be specified (${actions.join(', ')})`);\n      }\n\n      this.selectedAction?._processParsedData(this._options, data);\n      await this.onExecute();\n    } catch (err) {\n      if (err instanceof CommandLineParserExitError) {\n        if (!err.exitCode) {\n          // non-error exit modeled using exception handling\n          if (err.message) {\n            // eslint-disable-next-line no-console\n            console.log(err.message);\n          }\n\n          return;\n        }\n      }\n\n      throw err;\n    }\n  }\n\n  /** @internal */\n  public _registerDefinedParameters(state: IRegisterDefinedParametersState): void {\n    super._registerDefinedParameters(state);\n\n    const { parentParameterNames } = state;\n    const updatedParentParameterNames: Set<string> = new Set([\n      ...parentParameterNames,\n      ...this._registeredParameterParserKeysByName.keys()\n    ]);\n\n    const parentState: IRegisterDefinedParametersState = {\n      ...state,\n      parentParameterNames: updatedParentParameterNames\n    };\n    for (const action of this._actions) {\n      action._registerDefinedParameters(parentState);\n    }\n  }\n\n  private _validateDefinitions(): void {\n    if (this.remainder && this.actions.length > 0) {\n      // This is apparently not supported by argparse\n      throw new Error('defineCommandLineRemainder() cannot be called for a CommandLineParser with actions');\n    }\n  }\n\n  /**\n   * {@inheritDoc CommandLineParameterProvider._getArgumentParser}\n   * @internal\n   */\n  protected _getArgumentParser(): argparse.ArgumentParser {\n    // override\n    return this._argumentParser;\n  }\n\n  /**\n   * This hook allows the subclass to perform additional operations before or after\n   * the chosen action is executed.\n   */\n  protected async onExecute(): Promise<void> {\n    if (this.selectedAction) {\n      await this.selectedAction._execute();\n    }\n  }\n}\n"]}
+{"version":3,"file":"CommandLineParser.js","sourceRoot":"","sources":["../../src/providers/CommandLineParser.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D;;;AAG3D,kDAA+C;AAI/C,iFAIwC;AACxC,6EAAgG;AAChG,+DAA0D;AA6B1D;;;;;;;;;GASG;AACH,MAAsB,iBAAkB,SAAQ,2DAA4B;IAgB1E,YAAmB,OAAkC;;QACnD,KAAK,EAAE,CAAC;QAJF,cAAS,GAAY,KAAK,CAAC;QAC3B,+BAA0B,GAAY,KAAK,CAAC;QAKlD,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;QACxB,IAAI,CAAC,QAAQ,GAAG,EAAE,CAAC;QACnB,IAAI,CAAC,cAAc,GAAG,IAAI,GAAG,EAA6B,CAAC;QAE3D,IAAI,CAAC,eAAe,GAAG,IAAI,iDAAoB,CAAC;YAC9C,OAAO,EAAE,IAAI;YACb,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,YAAY;YAChC,WAAW,EAAE,IAAI,CAAC,QAAQ,CAAC,eAAe;YAC1C,MAAM,EAAE,mBAAQ,CAAC,IAAI,CACnB,MAAA,IAAI,CAAC,QAAQ,CAAC,UAAU,mCACtB,oDAAoD,IAAI,CAAC,QAAQ,CAAC,YAAY,eAAe,CAChG;SACF,CAAC,CAAC;QAEH,MAAA,IAAI,CAAC,kBAAkB,oDAAI,CAAC;IAC9B,CAAC;IAED;;OAEG;IACH,IAAW,OAAO;QAChB,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAED;;OAEG;IACI,SAAS,CAAC,MAAyB;QACxC,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC;YAC5B,IAAI,CAAC,iBAAiB,GAAG,IAAI,CAAC,eAAe,CAAC,aAAa,CAAC;gBAC1D,OAAO,EAAE,WAAW;gBACpB,IAAI,EAAE,QAAQ;aACf,CAAC,CAAC;QACL,CAAC;QAED,MAAM,CAAC,YAAY,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;QAC5C,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAC3B,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,MAAM,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC;IACrD,CAAC;IAED;;;OAGG;IACI,SAAS,CAAC,UAAkB;QACjC,MAAM,MAAM,GAAkC,IAAI,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC;QAC5E,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,MAAM,IAAI,KAAK,CAAC,eAAe,UAAU,mBAAmB,CAAC,CAAC;QAChE,CAAC;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;;OAGG;IACI,YAAY,CAAC,UAAkB;QACpC,OAAO,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;IAC7C,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACI,KAAK,CAAC,YAAY,CAAC,IAAe;QACvC,IAAI,IAAI,CAAC,QAAQ,CAAC,yBAAyB,IAAI,CAAC,IAAI,CAAC,0BAA0B,EAAE,CAAC;YAChF,IAAI,CAAC,SAAS,CAAC,IAAI,uCAAiB,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC;YACrE,IAAI,CAAC,0BAA0B,GAAG,IAAI,CAAC;QACzC,CAAC;QAED,IAAI,CAAC;YACH,MAAM,IAAI,CAAC,gCAAgC,CAAC,IAAI,CAAC,CAAC;YAClD,OAAO,IAAI,CAAC;QACd,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,IAAI,GAAG,YAAY,uDAA0B,EAAE,CAAC;gBAC9C,mEAAmE;gBACnE,oDAAoD;gBACpD,IAAI,GAAG,CAAC,OAAO,EAAE,CAAC;oBAChB,sCAAsC;oBACtC,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;gBAC7B,CAAC;gBACD,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC;oBACtB,OAAO,CAAC,QAAQ,GAAG,GAAG,CAAC,QAAQ,CAAC;gBAClC,CAAC;YACH,CAAC;iBAAM,CAAC;gBACN,IAAI,OAAO,GAAW,CAAE,GAAa,CAAC,OAAO,IAAI,2BAA2B,CAAC,CAAC,IAAI,EAAE,CAAC;gBAErF,uEAAuE;gBACvE,IAAI,CAAC,oCAAoC,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC;oBACxD,OAAO,GAAG,SAAS,GAAG,OAAO,CAAC;gBAChC,CAAC;gBAED,sCAAsC;gBACtC,OAAO,CAAC,KAAK,EAAE,CAAC;gBAChB,sCAAsC;gBACtC,OAAO,CAAC,KAAK,CAAC,mBAAQ,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC;gBAErC,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC;oBACtB,OAAO,CAAC,QAAQ,GAAG,CAAC,CAAC;gBACvB,CAAC;YACH,CAAC;YAED,OAAO,KAAK,CAAC;QACf,CAAC;IACH,CAAC;IAED;;OAEG;IACH,gEAAgE;IACzD,KAAK,CAAC,OAAO,CAAC,IAAe;QAClC,OAAO,MAAM,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;IACvC,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,gCAAgC,CAAC,IAAe;;QAC3D,IAAI,CAAC;YACH,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;gBACnB,4EAA4E;gBAC5E,8EAA8E;gBAC9E,4BAA4B;gBAC5B,MAAM,IAAI,KAAK,CAAC,4DAA4D,CAAC,CAAC;YAChF,CAAC;YACD,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;YAEtB,IAAI,CAAC,oBAAoB,EAAE,CAAC;YAE5B,gEAAgE;YAChE,MAAM,YAAY,GAAoC;gBACpD,oBAAoB,EAAE,IAAI,GAAG,EAAE;aAChC,CAAC;YACF,IAAI,CAAC,0BAA0B,CAAC,YAAY,CAAC,CAAC;YAE9C,IAAI,CAAC,IAAI,EAAE,CAAC;gBACV,4BAA4B;gBAC5B,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;YAC/B,CAAC;YACD,IAAI,IAAI,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBAC5B,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;oBACtB,6EAA6E;oBAC7E,+CAA+C;oBAC/C,IAAI,CAAC,eAAe,CAAC,SAAS,EAAE,CAAC;oBACjC,OAAO;gBACT,CAAC;gBACD,mFAAmF;gBACnF,kFAAkF;gBAClF,oFAAoF;gBACpF,kFAAkF;gBAClF,uBAAuB;gBACvB,MAAM,eAAe,GAAuB,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC;gBACtF,IAAI,eAAe,KAAK,SAAS,EAAE,CAAC;oBAClC,MAAM,UAAU,GAAW,IAAI,CAAC,eAAe,CAAC,CAAC;oBACjD,MAAM,MAAM,GAAkC,IAAI,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC;oBAC5E,MAAM,WAAW,GAAuC,MAAgC,CAAC;oBACzF,IAAI,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,iBAAiB,0CAAE,MAAM,EAAE,CAAC;wBAC3C,MAAM,WAAW,GAAW,eAAe,GAAG,CAAC,CAAC;wBAChD,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,WAAW,CAAC,CAAC,MAAM,CAAC,WAAW,CAAC,iBAAiB,EAAE,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC;oBACnG,CAAC;gBACH,CAAC;YACH,CAAC;YAED,MAAM,SAAS,GAAe,GAAG,EAAE;gBACjC,IAAI,CAAC,UAAU,EAAE,CAAC;gBAClB,KAAK,MAAM,MAAM,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;oBAClC,MAAM,CAAC,UAAU,EAAE,CAAC;gBACtB,CAAC;YACH,CAAC,CAAC;YAEF,SAAS,iCAAiC,CAAC,cAAuC;gBAChF,MAAM,mBAAmB,GAAiB,cAAc,CAAC,WAAW,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;gBAC1F,cAAc,CAAC,WAAW,GAAG,GAAG,EAAE;oBAChC,SAAS,EAAE,CAAC;oBACZ,OAAO,mBAAmB,EAAE,CAAC;gBAC/B,CAAC,CAAC;YACJ,CAAC;YAED,IAAI,CAAC,SAAS,EAAE,CAAC;YACjB,iCAAiC,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;YACxD,KAAK,MAAM,MAAM,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;gBAClC,MAAM,CAAC,SAAS,EAAE,CAAC;gBACnB,iCAAiC,CAAC,MAAM,CAAC,kBAAkB,EAAE,CAAC,CAAC;YACjE,CAAC;YAED,MAAM,IAAI,GAA2B,IAAI,CAAC,eAAe,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;YAE1E,SAAS,EAAE,CAAC;YACZ,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;YAE7C,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YACrD,IAAI,IAAI,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,CAAC;gBACpD,MAAM,OAAO,GAAa,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC;gBAChE,MAAM,IAAI,KAAK,CAAC,gCAAgC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YACzE,CAAC;YAED,MAAA,IAAI,CAAC,cAAc,0CAAE,kBAAkB,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;YAC7D,MAAM,IAAI,CAAC,SAAS,EAAE,CAAC;QACzB,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,IAAI,GAAG,YAAY,uDAA0B,EAAE,CAAC;gBAC9C,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC;oBAClB,kDAAkD;oBAClD,IAAI,GAAG,CAAC,OAAO,EAAE,CAAC;wBAChB,sCAAsC;wBACtC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;oBAC3B,CAAC;oBAED,OAAO;gBACT,CAAC;YACH,CAAC;YAED,MAAM,GAAG,CAAC;QACZ,CAAC;IACH,CAAC;IAED;;OAEG;IACH,gEAAgE;IACzD,KAAK,CAAC,2BAA2B,CAAC,IAAe;QACtD,MAAM,IAAI,CAAC,gCAAgC,CAAC,IAAI,CAAC,CAAC;IACpD,CAAC;IAED,gBAAgB;IACT,0BAA0B,CAAC,KAAsC;QACtE,KAAK,CAAC,0BAA0B,CAAC,KAAK,CAAC,CAAC;QAExC,MAAM,EAAE,oBAAoB,EAAE,GAAG,KAAK,CAAC;QACvC,MAAM,2BAA2B,GAAgB,IAAI,GAAG,CAAC;YACvD,GAAG,oBAAoB;YACvB,GAAG,IAAI,CAAC,oCAAoC,CAAC,IAAI,EAAE;SACpD,CAAC,CAAC;QAEH,MAAM,WAAW,mCACZ,KAAK,KACR,oBAAoB,EAAE,2BAA2B,GAClD,CAAC;QACF,KAAK,MAAM,MAAM,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;YACnC,MAAM,CAAC,0BAA0B,CAAC,WAAW,CAAC,CAAC;QACjD,CAAC;IACH,CAAC;IAEO,oBAAoB;QAC1B,IAAI,IAAI,CAAC,SAAS,IAAI,IAAI,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC9C,+CAA+C;YAC/C,MAAM,IAAI,KAAK,CAAC,oFAAoF,CAAC,CAAC;QACxG,CAAC;IACH,CAAC;IAED;;;OAGG;IACO,kBAAkB;QAC1B,WAAW;QACX,OAAO,IAAI,CAAC,eAAe,CAAC;IAC9B,CAAC;IAED;;;OAGG;IACO,KAAK,CAAC,SAAS;QACvB,IAAI,IAAI,CAAC,cAAc,EAAE,CAAC;YACxB,MAAM,IAAI,CAAC,cAAc,CAAC,aAAa,EAAE,CAAC;QAC5C,CAAC;IACH,CAAC;CACF;AA5SD,8CA4SC","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 type * as argparse from 'argparse';\nimport { Colorize } from '@rushstack/terminal';\n\nimport type { CommandLineAction } from './CommandLineAction';\nimport type { AliasCommandLineAction } from './AliasCommandLineAction';\nimport {\n  CommandLineParameterProvider,\n  type IRegisterDefinedParametersState,\n  type ICommandLineParserData\n} from './CommandLineParameterProvider';\nimport { CommandLineParserExitError, CustomArgumentParser } from './CommandLineParserExitError';\nimport { TabCompleteAction } from './TabCompletionAction';\n\n/**\n * Options for the {@link CommandLineParser} constructor.\n * @public\n */\nexport interface ICommandLineParserOptions {\n  /**\n   * The name of your tool when invoked from the command line\n   */\n  toolFilename: string;\n\n  /**\n   * General documentation that is included in the \"--help\" main page\n   */\n  toolDescription: string;\n\n  /**\n   * An optional string to append at the end of the \"--help\" main page. If not provided, an epilog\n   * will be automatically generated based on the toolFilename.\n   */\n  toolEpilog?: string;\n\n  /**\n   * Set to true to auto-define a tab completion action. False by default.\n   */\n  enableTabCompletionAction?: boolean;\n}\n\n/**\n * The \"argparse\" library is a relatively advanced command-line parser with features such\n * as word-wrapping and intelligible error messages (that are lacking in other similar\n * libraries such as commander, yargs, and nomnom).  Unfortunately, its ruby-inspired API\n * is awkward to use.  The abstract base classes CommandLineParser and CommandLineAction\n * provide a wrapper for \"argparse\" that makes defining and consuming arguments quick\n * and simple, and enforces that appropriate documentation is provided for each parameter.\n *\n * @public\n */\nexport abstract class CommandLineParser extends CommandLineParameterProvider {\n  /**\n   * Reports which CommandLineAction was specified on the command line.\n   * @remarks\n   * The value will be assigned before onExecute() is invoked.\n   */\n  public selectedAction: CommandLineAction | undefined;\n\n  private readonly _argumentParser: argparse.ArgumentParser;\n  private _actionsSubParser: argparse.SubParser | undefined;\n  private readonly _options: ICommandLineParserOptions;\n  private readonly _actions: CommandLineAction[];\n  private readonly _actionsByName: Map<string, CommandLineAction>;\n  private _executed: boolean = false;\n  private _tabCompleteActionWasAdded: boolean = false;\n\n  public constructor(options: ICommandLineParserOptions) {\n    super();\n\n    this._options = options;\n    this._actions = [];\n    this._actionsByName = new Map<string, CommandLineAction>();\n\n    this._argumentParser = new CustomArgumentParser({\n      addHelp: true,\n      prog: this._options.toolFilename,\n      description: this._options.toolDescription,\n      epilog: Colorize.bold(\n        this._options.toolEpilog ??\n          `For detailed help about a specific command, use: ${this._options.toolFilename} <command> -h`\n      )\n    });\n\n    this.onDefineParameters?.();\n  }\n\n  /**\n   * Returns the list of actions that were defined for this CommandLineParser object.\n   */\n  public get actions(): ReadonlyArray<CommandLineAction> {\n    return this._actions;\n  }\n\n  /**\n   * Defines a new action that can be used with the CommandLineParser instance.\n   */\n  public addAction(action: CommandLineAction): void {\n    if (!this._actionsSubParser) {\n      this._actionsSubParser = this._argumentParser.addSubparsers({\n        metavar: '<command>',\n        dest: 'action'\n      });\n    }\n\n    action._buildParser(this._actionsSubParser);\n    this._actions.push(action);\n    this._actionsByName.set(action.actionName, action);\n  }\n\n  /**\n   * Retrieves the action with the specified name.  If no matching action is found,\n   * an exception is thrown.\n   */\n  public getAction(actionName: string): CommandLineAction {\n    const action: CommandLineAction | undefined = this.tryGetAction(actionName);\n    if (!action) {\n      throw new Error(`The action \"${actionName}\" was not defined`);\n    }\n    return action;\n  }\n\n  /**\n   * Retrieves the action with the specified name.  If no matching action is found,\n   * undefined is returned.\n   */\n  public tryGetAction(actionName: string): CommandLineAction | undefined {\n    return this._actionsByName.get(actionName);\n  }\n\n  /**\n   * The program entry point will call this method to begin parsing command-line arguments\n   * and executing the corresponding action.\n   *\n   * @remarks\n   * The returned promise will never reject:  If an error occurs, it will be printed\n   * to stderr, process.exitCode will be set to 1, and the promise will resolve to false.\n   * This simplifies the most common usage scenario where the program entry point doesn't\n   * want to be involved with the command-line logic, and will discard the promise without\n   * a then() or catch() block.\n   *\n   * If your caller wants to trap and handle errors, use {@link CommandLineParser.executeWithoutErrorHandlingAsync}\n   * instead.\n   *\n   * @param args - the command-line arguments to be parsed; if omitted, then\n   *               the process.argv will be used\n   */\n  public async executeAsync(args?: string[]): Promise<boolean> {\n    if (this._options.enableTabCompletionAction && !this._tabCompleteActionWasAdded) {\n      this.addAction(new TabCompleteAction(this.actions, this.parameters));\n      this._tabCompleteActionWasAdded = true;\n    }\n\n    try {\n      await this.executeWithoutErrorHandlingAsync(args);\n      return true;\n    } catch (err) {\n      if (err instanceof CommandLineParserExitError) {\n        // executeWithoutErrorHandlingAsync() handles the successful cases,\n        // so here we can assume err has a nonzero exit code\n        if (err.message) {\n          // eslint-disable-next-line no-console\n          console.error(err.message);\n        }\n        if (!process.exitCode) {\n          process.exitCode = err.exitCode;\n        }\n      } else {\n        let message: string = ((err as Error).message || 'An unknown error occurred').trim();\n\n        // If the message doesn't already start with \"Error:\" then add a prefix\n        if (!/^(error|internal error|warning)\\b/i.test(message)) {\n          message = 'Error: ' + message;\n        }\n\n        // eslint-disable-next-line no-console\n        console.error();\n        // eslint-disable-next-line no-console\n        console.error(Colorize.red(message));\n\n        if (!process.exitCode) {\n          process.exitCode = 1;\n        }\n      }\n\n      return false;\n    }\n  }\n\n  /**\n   * @deprecated Use {@link CommandLineParser.executeAsync} instead.\n   */\n  // eslint-disable-next-line @typescript-eslint/naming-convention\n  public async execute(args?: string[]): Promise<boolean> {\n    return await this.executeAsync(args);\n  }\n\n  /**\n   * This is similar to {@link CommandLineParser.executeAsync}, except that execution errors\n   * simply cause the promise to reject.  It is the caller's responsibility to trap\n   */\n  public async executeWithoutErrorHandlingAsync(args?: string[]): Promise<void> {\n    try {\n      if (this._executed) {\n        // In the future we could allow the same parser to be invoked multiple times\n        // with different arguments.  We'll do that work as soon as someone encounters\n        // a real world need for it.\n        throw new Error('executeAsync() was already called for this parser instance');\n      }\n      this._executed = true;\n\n      this._validateDefinitions();\n\n      // Register the parameters before we print help or parse the CLI\n      const initialState: IRegisterDefinedParametersState = {\n        parentParameterNames: new Set()\n      };\n      this._registerDefinedParameters(initialState);\n\n      if (!args) {\n        // 0=node.exe, 1=script name\n        args = process.argv.slice(2);\n      }\n      if (this.actions.length > 0) {\n        if (args.length === 0) {\n          // Parsers that use actions should print help when 0 args are provided. Allow\n          // actionless parsers to continue on zero args.\n          this._argumentParser.printHelp();\n          return;\n        }\n        // Alias actions may provide a list of default params to add after the action name.\n        // Since we don't know which params are required and which are optional, perform a\n        // manual search for the action name to obtain the default params and insert them if\n        // any are found. We will guess that the action name is the first arg that doesn't\n        // start with a hyphen.\n        const actionNameIndex: number | undefined = args.findIndex((x) => !x.startsWith('-'));\n        if (actionNameIndex !== undefined) {\n          const actionName: string = args[actionNameIndex];\n          const action: CommandLineAction | undefined = this.tryGetAction(actionName);\n          const aliasAction: AliasCommandLineAction | undefined = action as AliasCommandLineAction;\n          if (aliasAction?.defaultParameters?.length) {\n            const insertIndex: number = actionNameIndex + 1;\n            args = args.slice(0, insertIndex).concat(aliasAction.defaultParameters, args.slice(insertIndex));\n          }\n        }\n      }\n\n      const postParse: () => void = () => {\n        this._postParse();\n        for (const action of this.actions) {\n          action._postParse();\n        }\n      };\n\n      function patchFormatUsageForArgumentParser(argumentParser: argparse.ArgumentParser): void {\n        const originalFormatUsage: () => string = argumentParser.formatUsage.bind(argumentParser);\n        argumentParser.formatUsage = () => {\n          postParse();\n          return originalFormatUsage();\n        };\n      }\n\n      this._preParse();\n      patchFormatUsageForArgumentParser(this._argumentParser);\n      for (const action of this.actions) {\n        action._preParse();\n        patchFormatUsageForArgumentParser(action._getArgumentParser());\n      }\n\n      const data: ICommandLineParserData = this._argumentParser.parseArgs(args);\n\n      postParse();\n      this._processParsedData(this._options, data);\n\n      this.selectedAction = this.tryGetAction(data.action);\n      if (this.actions.length > 0 && !this.selectedAction) {\n        const actions: string[] = this.actions.map((x) => x.actionName);\n        throw new Error(`An action must be specified (${actions.join(', ')})`);\n      }\n\n      this.selectedAction?._processParsedData(this._options, data);\n      await this.onExecute();\n    } catch (err) {\n      if (err instanceof CommandLineParserExitError) {\n        if (!err.exitCode) {\n          // non-error exit modeled using exception handling\n          if (err.message) {\n            // eslint-disable-next-line no-console\n            console.log(err.message);\n          }\n\n          return;\n        }\n      }\n\n      throw err;\n    }\n  }\n\n  /**\n   * @deprecated Use {@link CommandLineParser.executeWithoutErrorHandlingAsync} instead.\n   */\n  // eslint-disable-next-line @typescript-eslint/naming-convention\n  public async executeWithoutErrorHandling(args?: string[]): Promise<void> {\n    await this.executeWithoutErrorHandlingAsync(args);\n  }\n\n  /** @internal */\n  public _registerDefinedParameters(state: IRegisterDefinedParametersState): void {\n    super._registerDefinedParameters(state);\n\n    const { parentParameterNames } = state;\n    const updatedParentParameterNames: Set<string> = new Set([\n      ...parentParameterNames,\n      ...this._registeredParameterParserKeysByName.keys()\n    ]);\n\n    const parentState: IRegisterDefinedParametersState = {\n      ...state,\n      parentParameterNames: updatedParentParameterNames\n    };\n    for (const action of this._actions) {\n      action._registerDefinedParameters(parentState);\n    }\n  }\n\n  private _validateDefinitions(): void {\n    if (this.remainder && this.actions.length > 0) {\n      // This is apparently not supported by argparse\n      throw new Error('defineCommandLineRemainder() cannot be called for a CommandLineParser with actions');\n    }\n  }\n\n  /**\n   * {@inheritDoc CommandLineParameterProvider._getArgumentParser}\n   * @internal\n   */\n  protected _getArgumentParser(): argparse.ArgumentParser {\n    // override\n    return this._argumentParser;\n  }\n\n  /**\n   * This hook allows the subclass to perform additional operations before or after\n   * the chosen action is executed.\n   */\n  protected async onExecute(): Promise<void> {\n    if (this.selectedAction) {\n      await this.selectedAction._executeAsync();\n    }\n  }\n}\n"]}

package/lib/providers/ScopedCommandLineAction.d.ts

@@ -49,10 +49,10 @@ export declare abstract class ScopedCommandLineAction extends CommandLineAction
      */
     _processParsedData(parserOptions: ICommandLineParserOptions, data: ICommandLineParserData): void;
     /**
-     * {@inheritdoc CommandLineAction._execute}
+     * {@inheritdoc CommandLineAction._executeAsync}
      * @internal
      */
-    _execute(): Promise<void>;
+    _executeAsync(): Promise<void>;
     /** @internal */
     _registerDefinedParameters(state: IRegisterDefinedParametersState): void;
     /**

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

@@ -1 +1 @@
-{"version":3,"file":"ScopedCommandLineAction.d.ts","sourceRoot":"","sources":["../../src/providers/ScopedCommandLineAction.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,uBAAuB,EAAE,MAAM,cAAc,CAAC;AACvD,OAAO,EAAE,iBAAiB,EAAE,KAAK,yBAAyB,EAAE,MAAM,qBAAqB,CAAC;AACxF,OAAO,EAAE,iBAAiB,EAAE,KAAK,yBAAyB,EAAE,MAAM,qBAAqB,CAAC;AAExF,OAAO,KAAK,EAAE,oBAAoB,EAAE,wBAAwB,EAAE,MAAM,2BAA2B,CAAC;AAChG,OAAO,KAAK,EACV,4BAA4B,EAC5B,sBAAsB,EACtB,+BAA+B,EAChC,MAAM,gCAAgC,CAAC;AAmExC;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,8BAAsB,uBAAwB,SAAQ,iBAAiB;IACrE,OAAO,CAAC,QAAQ,CAA4B;IAC5C,OAAO,CAAC,kBAAkB,CAAyB;IACnD,OAAO,CAAC,sBAAsB,CAAwC;IACtE,OAAO,CAAC,wBAAwB,CAA8C;IAC9E,OAAO,CAAC,eAAe,CAA8C;IAErE;;;OAGG;IACH,gBAAuB,qBAAqB,EAAE,OAAO,uBAAuB,CAA2B;gBAEpF,OAAO,EAAE,yBAAyB;IAOrD;;;;;OAKG;IACH,IAAW,UAAU,IAAI,aAAa,CAAC,wBAAwB,CAAC,CAM/D;IAED;;;OAGG;IACI,kBAAkB,CAAC,aAAa,EAAE,yBAAyB,EAAE,IAAI,EAAE,sBAAsB,GAAG,IAAI;IAyBvG;;;OAGG;IACU,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC;IAuCtC,gBAAgB;IACT,0BAA0B,CAAC,KAAK,EAAE,+BAA+B,GAAG,IAAI;IAe/E;;OAEG;IACH,SAAS,CAAC,kBAAkB,IAAI,IAAI;IA2BpC;;;OAGG;IACH,SAAS,CAAC,2BAA2B,IAAI,iBAAiB;IAO1D,gBAAgB;IAChB,SAAS,CAAC,gBAAgB,CAAC,SAAS,EAAE,oBAAoB,GAAG,IAAI;IAOjE;;;;;OAKG;IACH,SAAS,CAAC,0BAA0B,CAAC,IAAI,IAAI;IAE7C;;;;;;;;OAQG;IACH,SAAS,CAAC,QAAQ,CAAC,wBAAwB,CAAC,uBAAuB,EAAE,4BAA4B,GAAG,IAAI;IAExG;;OAEG;IACH,SAAS,CAAC,QAAQ,CAAC,SAAS,IAAI,OAAO,CAAC,IAAI,CAAC;CAC9C"}
+{"version":3,"file":"ScopedCommandLineAction.d.ts","sourceRoot":"","sources":["../../src/providers/ScopedCommandLineAction.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,uBAAuB,EAAE,MAAM,cAAc,CAAC;AACvD,OAAO,EAAE,iBAAiB,EAAE,KAAK,yBAAyB,EAAE,MAAM,qBAAqB,CAAC;AACxF,OAAO,EAAE,iBAAiB,EAAE,KAAK,yBAAyB,EAAE,MAAM,qBAAqB,CAAC;AAExF,OAAO,KAAK,EAAE,oBAAoB,EAAE,wBAAwB,EAAE,MAAM,2BAA2B,CAAC;AAChG,OAAO,KAAK,EACV,4BAA4B,EAC5B,sBAAsB,EACtB,+BAA+B,EAChC,MAAM,gCAAgC,CAAC;AAmExC;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,8BAAsB,uBAAwB,SAAQ,iBAAiB;IACrE,OAAO,CAAC,QAAQ,CAA4B;IAC5C,OAAO,CAAC,kBAAkB,CAAyB;IACnD,OAAO,CAAC,sBAAsB,CAAwC;IACtE,OAAO,CAAC,wBAAwB,CAA8C;IAC9E,OAAO,CAAC,eAAe,CAA8C;IAErE;;;OAGG;IACH,gBAAuB,qBAAqB,EAAE,OAAO,uBAAuB,CAA2B;gBAEpF,OAAO,EAAE,yBAAyB;IAOrD;;;;;OAKG;IACH,IAAW,UAAU,IAAI,aAAa,CAAC,wBAAwB,CAAC,CAM/D;IAED;;;OAGG;IACI,kBAAkB,CAAC,aAAa,EAAE,yBAAyB,EAAE,IAAI,EAAE,sBAAsB,GAAG,IAAI;IAyBvG;;;OAGG;IACU,aAAa,IAAI,OAAO,CAAC,IAAI,CAAC;IAuC3C,gBAAgB;IACT,0BAA0B,CAAC,KAAK,EAAE,+BAA+B,GAAG,IAAI;IAe/E;;OAEG;IACH,SAAS,CAAC,kBAAkB,IAAI,IAAI;IA2BpC;;;OAGG;IACH,SAAS,CAAC,2BAA2B,IAAI,iBAAiB;IAO1D,gBAAgB;IAChB,SAAS,CAAC,gBAAgB,CAAC,SAAS,EAAE,oBAAoB,GAAG,IAAI;IAOjE;;;;;OAKG;IACH,SAAS,CAAC,0BAA0B,CAAC,IAAI,IAAI;IAE7C;;;;;;;;OAQG;IACH,SAAS,CAAC,QAAQ,CAAC,wBAAwB,CAAC,uBAAuB,EAAE,4BAA4B,GAAG,IAAI;IAExG;;OAEG;IACH,SAAS,CAAC,QAAQ,CAAC,SAAS,IAAI,OAAO,CAAC,IAAI,CAAC;CAC9C"}

package/lib/providers/ScopedCommandLineAction.js

@@ -111,10 +111,10 @@ class ScopedCommandLineAction extends CommandLineAction_1.CommandLineAction {
         this._scopedCommandLineParser = new InternalScopedCommandLineParser(Object.assign(Object.assign({}, parserOptions), { actionOptions: this._options, aliasAction: data.aliasAction, aliasDocumentation: data.aliasDocumentation, unscopedActionParameters: this.parameters, registerDefinedParametersState: this._subparserState, onDefineScopedParameters: this.onDefineScopedParameters.bind(this) }));
     }
     /**
-     * {@inheritdoc CommandLineAction._execute}
+     * {@inheritdoc CommandLineAction._executeAsync}
      * @internal
      */
-    async _execute() {
+    async _executeAsync() {
         // override
         if (!this._unscopedParserOptions || !this._scopedCommandLineParser) {
             throw new Error('The CommandLineAction parameters must be processed before execution.');
@@ -139,11 +139,11 @@ class ScopedCommandLineAction extends CommandLineAction_1.CommandLineAction {
             }
         }
         // Call the scoped parser using only the scoped args to handle parsing
-        await this._scopedCommandLineParser.executeWithoutErrorHandling(scopedArgs);
+        await this._scopedCommandLineParser.executeWithoutErrorHandlingAsync(scopedArgs);
         // Only call execute if the parser reached the execute stage. This may not be true if
         // the parser exited early due to a specified '--help' parameter.
         if (this._scopedCommandLineParser.canExecute) {
-            await super._execute();
+            await super._executeAsync();
         }
         return;
     }

package/lib/providers/ScopedCommandLineAction.js.map

@@ -1 +1 @@
-{"version":3,"file":"ScopedCommandLineAction.js","sourceRoot":"","sources":["../../src/providers/ScopedCommandLineAction.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D;;;AAE3D,4CAAuD;AACvD,2DAAwF;AACxF,2DAAwF;AACxF,6EAA0E;AAiB1E;;;GAGG;AACH,MAAM,+BAAgC,SAAQ,qCAAiB;IAI7D,IAAW,UAAU;QACnB,OAAO,IAAI,CAAC,WAAW,CAAC;IAC1B,CAAC;IAED,YAAmB,OAAgD;QACjE,MAAM,EAAE,aAAa,EAAE,wBAAwB,EAAE,YAAY,EAAE,WAAW,EAAE,kBAAkB,EAAE,GAC9F,OAAO,CAAC;QAEV,MAAM,WAAW,GAAW,GAAG,YAAY,IAAI,aAAa,CAAC,UAAU,EAAE,CAAC;QAC1E,6FAA6F;QAC7F,MAAM,qBAAqB,GAAW,GAAG,YAAY,IAAI,WAAW,aAAX,WAAW,cAAX,WAAW,GAAI,aAAa,CAAC,UAAU,EAAE,CAAC;QACnG,MAAM,WAAW,GAAa,EAAE,CAAC;QACjC,KAAK,MAAM,SAAS,IAAI,wBAAwB,EAAE,CAAC;YACjD,SAAS,CAAC,eAAe,CAAC,WAAW,CAAC,CAAC;QACzC,CAAC;QACD,MAAM,KAAK,GAAW,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAE5C,2FAA2F;QAC3F,+EAA+E;QAC/E,MAAM,8BAA8B,GAA8B;YAChE,wFAAwF;YACxF,8BAA8B;YAC9B,YAAY,EAAE,GAAG,qBAAqB,GAAG,KAAK,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,IAAI,KAAK,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE;YACtF,eAAe,EAAE,kBAAkB,aAAlB,kBAAkB,cAAlB,kBAAkB,GAAI,aAAa,CAAC,aAAa;YAClE,UAAU,EAAE,+DAA+D,WAAW,UAAU;YAChG,yBAAyB,EAAE,KAAK;SACjC,CAAC;QAEF,KAAK,CAAC,8BAA8B,CAAC,CAAC;QACtC,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC;QACzB,IAAI,CAAC,gBAAgB,GAAG,OAAO,CAAC;QAChC,IAAI,CAAC,gBAAgB,CAAC,wBAAwB,CAAC,IAAI,CAAC,CAAC;IACvD,CAAC;IAEM,0BAA0B,CAAC,KAAsC;QACtE,wFAAwF;QACxF,0BAA0B;QAC1B,KAAK,CAAC,0BAA0B,CAAC,IAAI,CAAC,gBAAgB,CAAC,8BAA8B,CAAC,CAAC;IACzF,CAAC;IAES,KAAK,CAAC,SAAS;QACvB,WAAW;QACX,qFAAqF;QACrF,6BAA6B;QAC7B,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC;IAC1B,CAAC;CACF;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAsB,uBAAwB,SAAQ,qCAAiB;IAarE,YAAmB,OAAkC;QACnD,KAAK,CAAC,OAAO,CAAC,CAAC;QAEf,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;QACxB,IAAI,CAAC,kBAAkB,GAAG,EAAE,CAAC;IAC/B,CAAC;IAED;;;;;OAKG;IACH,IAAW,UAAU;QACnB,IAAI,IAAI,CAAC,wBAAwB,EAAE,CAAC;YAClC,OAAO,CAAC,GAAG,KAAK,CAAC,UAAU,EAAE,GAAG,IAAI,CAAC,wBAAwB,CAAC,UAAU,CAAC,CAAC;QAC5E,CAAC;aAAM,CAAC;YACN,OAAO,KAAK,CAAC,UAAU,CAAC;QAC1B,CAAC;IACH,CAAC;IAED;;;OAGG;IACI,kBAAkB,CAAC,aAAwC,EAAE,IAA4B;QAC9F,WAAW;QACX,KAAK,CAAC,kBAAkB,CAAC,aAAa,EAAE,IAAI,CAAC,CAAC;QAE9C,wGAAwG;QACxG,uCAAuC;QACvC,IAAI,IAAI,CAAC,eAAe,KAAK,SAAS,EAAE,CAAC;YACvC,MAAM,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAC;QACzD,CAAC;QAED,IAAI,CAAC,sBAAsB,GAAG,aAAa,CAAC;QAE5C,mGAAmG;QACnG,iFAAiF;QACjF,IAAI,CAAC,wBAAwB,GAAG,IAAI,+BAA+B,iCAC9D,aAAa,KAChB,aAAa,EAAE,IAAI,CAAC,QAAQ,EAC5B,WAAW,EAAE,IAAI,CAAC,WAAW,EAC7B,kBAAkB,EAAE,IAAI,CAAC,kBAAkB,EAC3C,wBAAwB,EAAE,IAAI,CAAC,UAAoC,EACnE,8BAA8B,EAAE,IAAI,CAAC,eAAe,EACpD,wBAAwB,EAAE,IAAI,CAAC,wBAAwB,CAAC,IAAI,CAAC,IAAI,CAAC,IAClE,CAAC;IACL,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,QAAQ;QACnB,WAAW;QACX,IAAI,CAAC,IAAI,CAAC,sBAAsB,IAAI,CAAC,IAAI,CAAC,wBAAwB,EAAE,CAAC;YACnE,MAAM,IAAI,KAAK,CAAC,sEAAsE,CAAC,CAAC;QAC1F,CAAC;QACD,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC;YACpB,MAAM,IAAI,KAAK,CAAC,uEAAuE,CAAC,CAAC;QAC3F,CAAC;QAED,8FAA8F;QAC9F,gGAAgG;QAChG,MAAM,UAAU,GAAa,EAAE,CAAC;QAChC,IAAI,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;YACjC,IAAI,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,IAAI,EAAE,CAAC;gBACtC,MAAM,IAAI,uDAA0B;gBAClC,kDAAkD;gBAClD,CAAC;gBACD,yEAAyE;gBACzE,GAAG,IAAI,CAAC,eAAe,EAAE,KAAK,IAAI,CAAC,sBAAsB,CAAC,YAAY,IAAI,IAAI,CAAC,UAAU,IAAI;oBAC3F,kCAAkC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAClE,CAAC;YACJ,CAAC;YACD,KAAK,MAAM,SAAS,IAAI,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;gBACvD,UAAU,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;YAC7B,CAAC;QACH,CAAC;QAED,sEAAsE;QACtE,MAAM,IAAI,CAAC,wBAAwB,CAAC,2BAA2B,CAAC,UAAU,CAAC,CAAC;QAE5E,qFAAqF;QACrF,iEAAiE;QACjE,IAAI,IAAI,CAAC,wBAAwB,CAAC,UAAU,EAAE,CAAC;YAC7C,MAAM,KAAK,CAAC,QAAQ,EAAE,CAAC;QACzB,CAAC;QAED,OAAO;IACT,CAAC;IAED,gBAAgB;IACT,0BAA0B,CAAC,KAAsC;QACtE,KAAK,CAAC,0BAA0B,CAAC,KAAK,CAAC,CAAC;QAExC,MAAM,EAAE,oBAAoB,EAAE,GAAG,KAAK,CAAC;QACvC,MAAM,2BAA2B,GAAgB,IAAI,GAAG,CAAC;YACvD,GAAG,oBAAoB;YACvB,GAAG,IAAI,CAAC,oCAAoC,CAAC,IAAI,EAAE;SACpD,CAAC,CAAC;QAEH,IAAI,CAAC,eAAe,mCACf,KAAK,KACR,oBAAoB,EAAE,2BAA2B,GAClD,CAAC;IACJ,CAAC;IAED;;OAEG;IACO,kBAAkB;;QAC1B,MAAA,IAAI,CAAC,0BAA0B,oDAAI,CAAC;QAEpC,IAAI,CAAC,IAAI,CAAC,kBAAkB,CAAC,MAAM,EAAE,CAAC;YACpC,MAAM,IAAI,KAAK,CACb,iFAAiF;gBAC/E,sEAAsE;gBACtE,oDAAoD,CACvD,CAAC;QACJ,CAAC;QACD,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;YACnB,MAAM,IAAI,KAAK,CACb,6FAA6F;gBAC3F,8DAA8D,CACjE,CAAC;QACJ,CAAC;QAED,2FAA2F;QAC3F,4FAA4F;QAC5F,mCAAmC;QACnC,IAAI,CAAC,0BAA0B,CAAC;YAC9B,WAAW,EACT,4EAA4E;gBAC5E,2FAA2F;SAC9F,CAAC,CAAC;IACL,CAAC;IAED;;;OAGG;IACO,2BAA2B;QACnC,IAAI,CAAC,IAAI,CAAC,wBAAwB,EAAE,CAAC;YACnC,MAAM,IAAI,KAAK,CAAC,8EAA8E,CAAC,CAAC;QAClG,CAAC;QACD,OAAO,IAAI,CAAC,wBAAwB,CAAC;IACvC,CAAC;IAED,gBAAgB;IACN,gBAAgB,CAAC,SAA+B;QACxD,KAAK,CAAC,gBAAgB,CAAC,SAAS,CAAC,CAAC;QAClC,IAAI,SAAS,CAAC,cAAc,KAAK,uBAAuB,CAAC,qBAAqB,EAAE,CAAC;YAC/E,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAC1C,CAAC;IACH,CAAC;;AAzKH,0DAkMC;AA3LC;;;GAGG;AACoB,6CAAqB,GAAmC,mCAAuB,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 { SCOPING_PARAMETER_GROUP } from '../Constants';\nimport { CommandLineAction, type ICommandLineActionOptions } from './CommandLineAction';\nimport { CommandLineParser, type ICommandLineParserOptions } from './CommandLineParser';\nimport { CommandLineParserExitError } from './CommandLineParserExitError';\nimport type { CommandLineParameter, CommandLineParameterBase } from '../parameters/BaseClasses';\nimport type {\n  CommandLineParameterProvider,\n  ICommandLineParserData,\n  IRegisterDefinedParametersState\n} from './CommandLineParameterProvider';\n\ninterface IInternalScopedCommandLineParserOptions extends ICommandLineParserOptions {\n  readonly actionOptions: ICommandLineActionOptions;\n  readonly unscopedActionParameters: ReadonlyArray<CommandLineParameter>;\n  readonly onDefineScopedParameters: (commandLineParameterProvider: CommandLineParameterProvider) => void;\n  readonly aliasAction?: string;\n  readonly aliasDocumentation?: string;\n  readonly registerDefinedParametersState: IRegisterDefinedParametersState;\n}\n\n/**\n * A CommandLineParser used exclusively to parse the scoped command-line parameters\n * for a ScopedCommandLineAction.\n */\nclass InternalScopedCommandLineParser extends CommandLineParser {\n  private _canExecute: boolean;\n  private readonly _internalOptions: IInternalScopedCommandLineParserOptions;\n\n  public get canExecute(): boolean {\n    return this._canExecute;\n  }\n\n  public constructor(options: IInternalScopedCommandLineParserOptions) {\n    const { actionOptions, unscopedActionParameters, toolFilename, aliasAction, aliasDocumentation } =\n      options;\n\n    const toolCommand: string = `${toolFilename} ${actionOptions.actionName}`;\n    // When coming from an alias command, we want to show the alias command name in the help text\n    const toolCommandForLogging: string = `${toolFilename} ${aliasAction ?? actionOptions.actionName}`;\n    const scopingArgs: string[] = [];\n    for (const parameter of unscopedActionParameters) {\n      parameter.appendToArgList(scopingArgs);\n    }\n    const scope: string = scopingArgs.join(' ');\n\n    // We can run the parser directly because we are not going to use it for any other actions,\n    // so construct a special options object to make the \"--help\" text more useful.\n    const scopedCommandLineParserOptions: ICommandLineParserOptions = {\n      // Strip the scoping args if coming from an alias command, since they are not applicable\n      // to the alias command itself\n      toolFilename: `${toolCommandForLogging}${scope && !aliasAction ? ` ${scope} --` : ''}`,\n      toolDescription: aliasDocumentation ?? actionOptions.documentation,\n      toolEpilog: `For more information on available unscoped parameters, use \"${toolCommand} --help\"`,\n      enableTabCompletionAction: false\n    };\n\n    super(scopedCommandLineParserOptions);\n    this._canExecute = false;\n    this._internalOptions = options;\n    this._internalOptions.onDefineScopedParameters(this);\n  }\n\n  public _registerDefinedParameters(state: IRegisterDefinedParametersState): void {\n    // Since we are in a separate parser, we need to register the parameters using the state\n    // from the parent parser.\n    super._registerDefinedParameters(this._internalOptions.registerDefinedParametersState);\n  }\n\n  protected async onExecute(): Promise<void> {\n    // override\n    // Only set if we made it this far, which may not be the case if an error occurred or\n    // if '--help' was specified.\n    this._canExecute = true;\n  }\n}\n\n/**\n * Represents a sub-command that is part of the CommandLineParser command-line.\n * Applications should create subclasses of ScopedCommandLineAction 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 * Scoped commands allow for different parameters to be specified for different\n * provided scoping values. For example, the \"scoped-action --scope A\" command\n * may allow for different scoped arguments to be specified than the \"scoped-action\n * --scope B\" command.\n *\n * Scoped arguments are specified after the \"--\" pseudo-argument. For example,\n * \"scoped-action --scope A -- --scopedFoo --scopedBar\".\n *\n * @public\n */\nexport abstract class ScopedCommandLineAction extends CommandLineAction {\n  private _options: ICommandLineActionOptions;\n  private _scopingParameters: CommandLineParameter[];\n  private _unscopedParserOptions: ICommandLineParserOptions | undefined;\n  private _scopedCommandLineParser: InternalScopedCommandLineParser | undefined;\n  private _subparserState: IRegisterDefinedParametersState | undefined;\n\n  /**\n   * The required group name to apply to all scoping parameters. At least one parameter\n   * must be defined with this group name.\n   */\n  public static readonly ScopingParameterGroup: typeof SCOPING_PARAMETER_GROUP = SCOPING_PARAMETER_GROUP;\n\n  public constructor(options: ICommandLineActionOptions) {\n    super(options);\n\n    this._options = options;\n    this._scopingParameters = [];\n  }\n\n  /**\n   * {@inheritDoc CommandLineParameterProvider.parameters}\n   *\n   * @internalremarks\n   * TODO: Replace this type with `CommandLineParameter` in the next major bump.\n   */\n  public get parameters(): ReadonlyArray<CommandLineParameterBase> {\n    if (this._scopedCommandLineParser) {\n      return [...super.parameters, ...this._scopedCommandLineParser.parameters];\n    } else {\n      return super.parameters;\n    }\n  }\n\n  /**\n   * {@inheritdoc CommandLineParameterProvider._processParsedData}\n   * @internal\n   */\n  public _processParsedData(parserOptions: ICommandLineParserOptions, data: ICommandLineParserData): void {\n    // override\n    super._processParsedData(parserOptions, data);\n\n    // This should never happen because the super method should throw if parameters haven't been registered,\n    // but guard against this just in-case.\n    if (this._subparserState === undefined) {\n      throw new Error('Parameters have not been registered');\n    }\n\n    this._unscopedParserOptions = parserOptions;\n\n    // Generate the scoped parser using the parent parser information. We can only create this after we\n    // have parsed the data, since the parameter values are used during construction.\n    this._scopedCommandLineParser = new InternalScopedCommandLineParser({\n      ...parserOptions,\n      actionOptions: this._options,\n      aliasAction: data.aliasAction,\n      aliasDocumentation: data.aliasDocumentation,\n      unscopedActionParameters: this.parameters as CommandLineParameter[],\n      registerDefinedParametersState: this._subparserState,\n      onDefineScopedParameters: this.onDefineScopedParameters.bind(this)\n    });\n  }\n\n  /**\n   * {@inheritdoc CommandLineAction._execute}\n   * @internal\n   */\n  public async _execute(): Promise<void> {\n    // override\n    if (!this._unscopedParserOptions || !this._scopedCommandLineParser) {\n      throw new Error('The CommandLineAction parameters must be processed before execution.');\n    }\n    if (!this.remainder) {\n      throw new Error('CommandLineAction.onDefineParameters must be called before execution.');\n    }\n\n    // The '--' argument is required to separate the action parameters from the scoped parameters,\n    // so it needs to be trimmed. If remainder values are provided but no '--' is found, then throw.\n    const scopedArgs: string[] = [];\n    if (this.remainder.values.length) {\n      if (this.remainder.values[0] !== '--') {\n        throw new CommandLineParserExitError(\n          // argparse sets exit code 2 for invalid arguments\n          2,\n          // model the message off of the built-in \"unrecognized arguments\" message\n          `${this.renderUsageText()}\\n${this._unscopedParserOptions.toolFilename} ${this.actionName}: ` +\n            `error: Unrecognized arguments: ${this.remainder.values[0]}.\\n`\n        );\n      }\n      for (const scopedArg of this.remainder.values.slice(1)) {\n        scopedArgs.push(scopedArg);\n      }\n    }\n\n    // Call the scoped parser using only the scoped args to handle parsing\n    await this._scopedCommandLineParser.executeWithoutErrorHandling(scopedArgs);\n\n    // Only call execute if the parser reached the execute stage. This may not be true if\n    // the parser exited early due to a specified '--help' parameter.\n    if (this._scopedCommandLineParser.canExecute) {\n      await super._execute();\n    }\n\n    return;\n  }\n\n  /** @internal */\n  public _registerDefinedParameters(state: IRegisterDefinedParametersState): void {\n    super._registerDefinedParameters(state);\n\n    const { parentParameterNames } = state;\n    const updatedParentParameterNames: Set<string> = new Set([\n      ...parentParameterNames,\n      ...this._registeredParameterParserKeysByName.keys()\n    ]);\n\n    this._subparserState = {\n      ...state,\n      parentParameterNames: updatedParentParameterNames\n    };\n  }\n\n  /**\n   * {@inheritdoc CommandLineParameterProvider.onDefineParameters}\n   */\n  protected onDefineParameters(): void {\n    this.onDefineUnscopedParameters?.();\n\n    if (!this._scopingParameters.length) {\n      throw new Error(\n        'No scoping parameters defined. At least one scoping parameter must be defined. ' +\n          'Scoping parameters are defined by setting the parameterGroupName to ' +\n          'ScopedCommandLineAction.ScopingParameterGroupName.'\n      );\n    }\n    if (this.remainder) {\n      throw new Error(\n        'Unscoped remainder parameters are not allowed. Remainder parameters can only be defined on ' +\n          'the scoped parameter provider in onDefineScopedParameters().'\n      );\n    }\n\n    // Consume the remainder of the command-line, which will later be passed the scoped parser.\n    // This will also prevent developers from calling this.defineCommandLineRemainder(...) since\n    // we will have already defined it.\n    this.defineCommandLineRemainder({\n      description:\n        'Scoped parameters.  Must be prefixed with \"--\", ex. \"-- --scopedParameter ' +\n        'foo --scopedFlag\".  For more information on available scoped parameters, use \"-- --help\".'\n    });\n  }\n\n  /**\n   * Retrieves the scoped CommandLineParser, which is populated after the ScopedCommandLineAction is executed.\n   * @internal\n   */\n  protected _getScopedCommandLineParser(): CommandLineParser {\n    if (!this._scopedCommandLineParser) {\n      throw new Error('The scoped CommandLineParser is only populated after the action is executed.');\n    }\n    return this._scopedCommandLineParser;\n  }\n\n  /** @internal */\n  protected _defineParameter(parameter: CommandLineParameter): void {\n    super._defineParameter(parameter);\n    if (parameter.parameterGroup === ScopedCommandLineAction.ScopingParameterGroup) {\n      this._scopingParameters.push(parameter);\n    }\n  }\n\n  /**\n   * The child class should implement this hook to define its unscoped command-line parameters,\n   * e.g. by calling defineFlagParameter(). At least one scoping parameter must be defined.\n   * Scoping parameters are defined by setting the parameterGroupName to\n   * ScopedCommandLineAction.ScopingParameterGroupName.\n   */\n  protected onDefineUnscopedParameters?(): void;\n\n  /**\n   * The child class should implement this hook to define its scoped command-line\n   * parameters, e.g. by calling scopedParameterProvider.defineFlagParameter(). These\n   * parameters will only be available if the action is invoked with a scope.\n   *\n   * @remarks\n   * onDefineScopedParameters is called after the unscoped parameters have been parsed.\n   * The values they provide can be used to vary the defined scope parameters.\n   */\n  protected abstract onDefineScopedParameters(scopedParameterProvider: CommandLineParameterProvider): void;\n\n  /**\n   * {@inheritDoc CommandLineAction.onExecute}\n   */\n  protected abstract onExecute(): Promise<void>;\n}\n"]}
+{"version":3,"file":"ScopedCommandLineAction.js","sourceRoot":"","sources":["../../src/providers/ScopedCommandLineAction.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D;;;AAE3D,4CAAuD;AACvD,2DAAwF;AACxF,2DAAwF;AACxF,6EAA0E;AAiB1E;;;GAGG;AACH,MAAM,+BAAgC,SAAQ,qCAAiB;IAI7D,IAAW,UAAU;QACnB,OAAO,IAAI,CAAC,WAAW,CAAC;IAC1B,CAAC;IAED,YAAmB,OAAgD;QACjE,MAAM,EAAE,aAAa,EAAE,wBAAwB,EAAE,YAAY,EAAE,WAAW,EAAE,kBAAkB,EAAE,GAC9F,OAAO,CAAC;QAEV,MAAM,WAAW,GAAW,GAAG,YAAY,IAAI,aAAa,CAAC,UAAU,EAAE,CAAC;QAC1E,6FAA6F;QAC7F,MAAM,qBAAqB,GAAW,GAAG,YAAY,IAAI,WAAW,aAAX,WAAW,cAAX,WAAW,GAAI,aAAa,CAAC,UAAU,EAAE,CAAC;QACnG,MAAM,WAAW,GAAa,EAAE,CAAC;QACjC,KAAK,MAAM,SAAS,IAAI,wBAAwB,EAAE,CAAC;YACjD,SAAS,CAAC,eAAe,CAAC,WAAW,CAAC,CAAC;QACzC,CAAC;QACD,MAAM,KAAK,GAAW,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAE5C,2FAA2F;QAC3F,+EAA+E;QAC/E,MAAM,8BAA8B,GAA8B;YAChE,wFAAwF;YACxF,8BAA8B;YAC9B,YAAY,EAAE,GAAG,qBAAqB,GAAG,KAAK,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,IAAI,KAAK,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE;YACtF,eAAe,EAAE,kBAAkB,aAAlB,kBAAkB,cAAlB,kBAAkB,GAAI,aAAa,CAAC,aAAa;YAClE,UAAU,EAAE,+DAA+D,WAAW,UAAU;YAChG,yBAAyB,EAAE,KAAK;SACjC,CAAC;QAEF,KAAK,CAAC,8BAA8B,CAAC,CAAC;QACtC,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC;QACzB,IAAI,CAAC,gBAAgB,GAAG,OAAO,CAAC;QAChC,IAAI,CAAC,gBAAgB,CAAC,wBAAwB,CAAC,IAAI,CAAC,CAAC;IACvD,CAAC;IAEM,0BAA0B,CAAC,KAAsC;QACtE,wFAAwF;QACxF,0BAA0B;QAC1B,KAAK,CAAC,0BAA0B,CAAC,IAAI,CAAC,gBAAgB,CAAC,8BAA8B,CAAC,CAAC;IACzF,CAAC;IAES,KAAK,CAAC,SAAS;QACvB,WAAW;QACX,qFAAqF;QACrF,6BAA6B;QAC7B,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC;IAC1B,CAAC;CACF;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAsB,uBAAwB,SAAQ,qCAAiB;IAarE,YAAmB,OAAkC;QACnD,KAAK,CAAC,OAAO,CAAC,CAAC;QAEf,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;QACxB,IAAI,CAAC,kBAAkB,GAAG,EAAE,CAAC;IAC/B,CAAC;IAED;;;;;OAKG;IACH,IAAW,UAAU;QACnB,IAAI,IAAI,CAAC,wBAAwB,EAAE,CAAC;YAClC,OAAO,CAAC,GAAG,KAAK,CAAC,UAAU,EAAE,GAAG,IAAI,CAAC,wBAAwB,CAAC,UAAU,CAAC,CAAC;QAC5E,CAAC;aAAM,CAAC;YACN,OAAO,KAAK,CAAC,UAAU,CAAC;QAC1B,CAAC;IACH,CAAC;IAED;;;OAGG;IACI,kBAAkB,CAAC,aAAwC,EAAE,IAA4B;QAC9F,WAAW;QACX,KAAK,CAAC,kBAAkB,CAAC,aAAa,EAAE,IAAI,CAAC,CAAC;QAE9C,wGAAwG;QACxG,uCAAuC;QACvC,IAAI,IAAI,CAAC,eAAe,KAAK,SAAS,EAAE,CAAC;YACvC,MAAM,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAC;QACzD,CAAC;QAED,IAAI,CAAC,sBAAsB,GAAG,aAAa,CAAC;QAE5C,mGAAmG;QACnG,iFAAiF;QACjF,IAAI,CAAC,wBAAwB,GAAG,IAAI,+BAA+B,iCAC9D,aAAa,KAChB,aAAa,EAAE,IAAI,CAAC,QAAQ,EAC5B,WAAW,EAAE,IAAI,CAAC,WAAW,EAC7B,kBAAkB,EAAE,IAAI,CAAC,kBAAkB,EAC3C,wBAAwB,EAAE,IAAI,CAAC,UAAoC,EACnE,8BAA8B,EAAE,IAAI,CAAC,eAAe,EACpD,wBAAwB,EAAE,IAAI,CAAC,wBAAwB,CAAC,IAAI,CAAC,IAAI,CAAC,IAClE,CAAC;IACL,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,aAAa;QACxB,WAAW;QACX,IAAI,CAAC,IAAI,CAAC,sBAAsB,IAAI,CAAC,IAAI,CAAC,wBAAwB,EAAE,CAAC;YACnE,MAAM,IAAI,KAAK,CAAC,sEAAsE,CAAC,CAAC;QAC1F,CAAC;QACD,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC;YACpB,MAAM,IAAI,KAAK,CAAC,uEAAuE,CAAC,CAAC;QAC3F,CAAC;QAED,8FAA8F;QAC9F,gGAAgG;QAChG,MAAM,UAAU,GAAa,EAAE,CAAC;QAChC,IAAI,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;YACjC,IAAI,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,IAAI,EAAE,CAAC;gBACtC,MAAM,IAAI,uDAA0B;gBAClC,kDAAkD;gBAClD,CAAC;gBACD,yEAAyE;gBACzE,GAAG,IAAI,CAAC,eAAe,EAAE,KAAK,IAAI,CAAC,sBAAsB,CAAC,YAAY,IAAI,IAAI,CAAC,UAAU,IAAI;oBAC3F,kCAAkC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAClE,CAAC;YACJ,CAAC;YACD,KAAK,MAAM,SAAS,IAAI,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;gBACvD,UAAU,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;YAC7B,CAAC;QACH,CAAC;QAED,sEAAsE;QACtE,MAAM,IAAI,CAAC,wBAAwB,CAAC,gCAAgC,CAAC,UAAU,CAAC,CAAC;QAEjF,qFAAqF;QACrF,iEAAiE;QACjE,IAAI,IAAI,CAAC,wBAAwB,CAAC,UAAU,EAAE,CAAC;YAC7C,MAAM,KAAK,CAAC,aAAa,EAAE,CAAC;QAC9B,CAAC;QAED,OAAO;IACT,CAAC;IAED,gBAAgB;IACT,0BAA0B,CAAC,KAAsC;QACtE,KAAK,CAAC,0BAA0B,CAAC,KAAK,CAAC,CAAC;QAExC,MAAM,EAAE,oBAAoB,EAAE,GAAG,KAAK,CAAC;QACvC,MAAM,2BAA2B,GAAgB,IAAI,GAAG,CAAC;YACvD,GAAG,oBAAoB;YACvB,GAAG,IAAI,CAAC,oCAAoC,CAAC,IAAI,EAAE;SACpD,CAAC,CAAC;QAEH,IAAI,CAAC,eAAe,mCACf,KAAK,KACR,oBAAoB,EAAE,2BAA2B,GAClD,CAAC;IACJ,CAAC;IAED;;OAEG;IACO,kBAAkB;;QAC1B,MAAA,IAAI,CAAC,0BAA0B,oDAAI,CAAC;QAEpC,IAAI,CAAC,IAAI,CAAC,kBAAkB,CAAC,MAAM,EAAE,CAAC;YACpC,MAAM,IAAI,KAAK,CACb,iFAAiF;gBAC/E,sEAAsE;gBACtE,oDAAoD,CACvD,CAAC;QACJ,CAAC;QACD,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;YACnB,MAAM,IAAI,KAAK,CACb,6FAA6F;gBAC3F,8DAA8D,CACjE,CAAC;QACJ,CAAC;QAED,2FAA2F;QAC3F,4FAA4F;QAC5F,mCAAmC;QACnC,IAAI,CAAC,0BAA0B,CAAC;YAC9B,WAAW,EACT,4EAA4E;gBAC5E,2FAA2F;SAC9F,CAAC,CAAC;IACL,CAAC;IAED;;;OAGG;IACO,2BAA2B;QACnC,IAAI,CAAC,IAAI,CAAC,wBAAwB,EAAE,CAAC;YACnC,MAAM,IAAI,KAAK,CAAC,8EAA8E,CAAC,CAAC;QAClG,CAAC;QACD,OAAO,IAAI,CAAC,wBAAwB,CAAC;IACvC,CAAC;IAED,gBAAgB;IACN,gBAAgB,CAAC,SAA+B;QACxD,KAAK,CAAC,gBAAgB,CAAC,SAAS,CAAC,CAAC;QAClC,IAAI,SAAS,CAAC,cAAc,KAAK,uBAAuB,CAAC,qBAAqB,EAAE,CAAC;YAC/E,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAC1C,CAAC;IACH,CAAC;;AAzKH,0DAkMC;AA3LC;;;GAGG;AACoB,6CAAqB,GAAmC,mCAAuB,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 { SCOPING_PARAMETER_GROUP } from '../Constants';\nimport { CommandLineAction, type ICommandLineActionOptions } from './CommandLineAction';\nimport { CommandLineParser, type ICommandLineParserOptions } from './CommandLineParser';\nimport { CommandLineParserExitError } from './CommandLineParserExitError';\nimport type { CommandLineParameter, CommandLineParameterBase } from '../parameters/BaseClasses';\nimport type {\n  CommandLineParameterProvider,\n  ICommandLineParserData,\n  IRegisterDefinedParametersState\n} from './CommandLineParameterProvider';\n\ninterface IInternalScopedCommandLineParserOptions extends ICommandLineParserOptions {\n  readonly actionOptions: ICommandLineActionOptions;\n  readonly unscopedActionParameters: ReadonlyArray<CommandLineParameter>;\n  readonly onDefineScopedParameters: (commandLineParameterProvider: CommandLineParameterProvider) => void;\n  readonly aliasAction?: string;\n  readonly aliasDocumentation?: string;\n  readonly registerDefinedParametersState: IRegisterDefinedParametersState;\n}\n\n/**\n * A CommandLineParser used exclusively to parse the scoped command-line parameters\n * for a ScopedCommandLineAction.\n */\nclass InternalScopedCommandLineParser extends CommandLineParser {\n  private _canExecute: boolean;\n  private readonly _internalOptions: IInternalScopedCommandLineParserOptions;\n\n  public get canExecute(): boolean {\n    return this._canExecute;\n  }\n\n  public constructor(options: IInternalScopedCommandLineParserOptions) {\n    const { actionOptions, unscopedActionParameters, toolFilename, aliasAction, aliasDocumentation } =\n      options;\n\n    const toolCommand: string = `${toolFilename} ${actionOptions.actionName}`;\n    // When coming from an alias command, we want to show the alias command name in the help text\n    const toolCommandForLogging: string = `${toolFilename} ${aliasAction ?? actionOptions.actionName}`;\n    const scopingArgs: string[] = [];\n    for (const parameter of unscopedActionParameters) {\n      parameter.appendToArgList(scopingArgs);\n    }\n    const scope: string = scopingArgs.join(' ');\n\n    // We can run the parser directly because we are not going to use it for any other actions,\n    // so construct a special options object to make the \"--help\" text more useful.\n    const scopedCommandLineParserOptions: ICommandLineParserOptions = {\n      // Strip the scoping args if coming from an alias command, since they are not applicable\n      // to the alias command itself\n      toolFilename: `${toolCommandForLogging}${scope && !aliasAction ? ` ${scope} --` : ''}`,\n      toolDescription: aliasDocumentation ?? actionOptions.documentation,\n      toolEpilog: `For more information on available unscoped parameters, use \"${toolCommand} --help\"`,\n      enableTabCompletionAction: false\n    };\n\n    super(scopedCommandLineParserOptions);\n    this._canExecute = false;\n    this._internalOptions = options;\n    this._internalOptions.onDefineScopedParameters(this);\n  }\n\n  public _registerDefinedParameters(state: IRegisterDefinedParametersState): void {\n    // Since we are in a separate parser, we need to register the parameters using the state\n    // from the parent parser.\n    super._registerDefinedParameters(this._internalOptions.registerDefinedParametersState);\n  }\n\n  protected async onExecute(): Promise<void> {\n    // override\n    // Only set if we made it this far, which may not be the case if an error occurred or\n    // if '--help' was specified.\n    this._canExecute = true;\n  }\n}\n\n/**\n * Represents a sub-command that is part of the CommandLineParser command-line.\n * Applications should create subclasses of ScopedCommandLineAction 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 * Scoped commands allow for different parameters to be specified for different\n * provided scoping values. For example, the \"scoped-action --scope A\" command\n * may allow for different scoped arguments to be specified than the \"scoped-action\n * --scope B\" command.\n *\n * Scoped arguments are specified after the \"--\" pseudo-argument. For example,\n * \"scoped-action --scope A -- --scopedFoo --scopedBar\".\n *\n * @public\n */\nexport abstract class ScopedCommandLineAction extends CommandLineAction {\n  private _options: ICommandLineActionOptions;\n  private _scopingParameters: CommandLineParameter[];\n  private _unscopedParserOptions: ICommandLineParserOptions | undefined;\n  private _scopedCommandLineParser: InternalScopedCommandLineParser | undefined;\n  private _subparserState: IRegisterDefinedParametersState | undefined;\n\n  /**\n   * The required group name to apply to all scoping parameters. At least one parameter\n   * must be defined with this group name.\n   */\n  public static readonly ScopingParameterGroup: typeof SCOPING_PARAMETER_GROUP = SCOPING_PARAMETER_GROUP;\n\n  public constructor(options: ICommandLineActionOptions) {\n    super(options);\n\n    this._options = options;\n    this._scopingParameters = [];\n  }\n\n  /**\n   * {@inheritDoc CommandLineParameterProvider.parameters}\n   *\n   * @internalremarks\n   * TODO: Replace this type with `CommandLineParameter` in the next major bump.\n   */\n  public get parameters(): ReadonlyArray<CommandLineParameterBase> {\n    if (this._scopedCommandLineParser) {\n      return [...super.parameters, ...this._scopedCommandLineParser.parameters];\n    } else {\n      return super.parameters;\n    }\n  }\n\n  /**\n   * {@inheritdoc CommandLineParameterProvider._processParsedData}\n   * @internal\n   */\n  public _processParsedData(parserOptions: ICommandLineParserOptions, data: ICommandLineParserData): void {\n    // override\n    super._processParsedData(parserOptions, data);\n\n    // This should never happen because the super method should throw if parameters haven't been registered,\n    // but guard against this just in-case.\n    if (this._subparserState === undefined) {\n      throw new Error('Parameters have not been registered');\n    }\n\n    this._unscopedParserOptions = parserOptions;\n\n    // Generate the scoped parser using the parent parser information. We can only create this after we\n    // have parsed the data, since the parameter values are used during construction.\n    this._scopedCommandLineParser = new InternalScopedCommandLineParser({\n      ...parserOptions,\n      actionOptions: this._options,\n      aliasAction: data.aliasAction,\n      aliasDocumentation: data.aliasDocumentation,\n      unscopedActionParameters: this.parameters as CommandLineParameter[],\n      registerDefinedParametersState: this._subparserState,\n      onDefineScopedParameters: this.onDefineScopedParameters.bind(this)\n    });\n  }\n\n  /**\n   * {@inheritdoc CommandLineAction._executeAsync}\n   * @internal\n   */\n  public async _executeAsync(): Promise<void> {\n    // override\n    if (!this._unscopedParserOptions || !this._scopedCommandLineParser) {\n      throw new Error('The CommandLineAction parameters must be processed before execution.');\n    }\n    if (!this.remainder) {\n      throw new Error('CommandLineAction.onDefineParameters must be called before execution.');\n    }\n\n    // The '--' argument is required to separate the action parameters from the scoped parameters,\n    // so it needs to be trimmed. If remainder values are provided but no '--' is found, then throw.\n    const scopedArgs: string[] = [];\n    if (this.remainder.values.length) {\n      if (this.remainder.values[0] !== '--') {\n        throw new CommandLineParserExitError(\n          // argparse sets exit code 2 for invalid arguments\n          2,\n          // model the message off of the built-in \"unrecognized arguments\" message\n          `${this.renderUsageText()}\\n${this._unscopedParserOptions.toolFilename} ${this.actionName}: ` +\n            `error: Unrecognized arguments: ${this.remainder.values[0]}.\\n`\n        );\n      }\n      for (const scopedArg of this.remainder.values.slice(1)) {\n        scopedArgs.push(scopedArg);\n      }\n    }\n\n    // Call the scoped parser using only the scoped args to handle parsing\n    await this._scopedCommandLineParser.executeWithoutErrorHandlingAsync(scopedArgs);\n\n    // Only call execute if the parser reached the execute stage. This may not be true if\n    // the parser exited early due to a specified '--help' parameter.\n    if (this._scopedCommandLineParser.canExecute) {\n      await super._executeAsync();\n    }\n\n    return;\n  }\n\n  /** @internal */\n  public _registerDefinedParameters(state: IRegisterDefinedParametersState): void {\n    super._registerDefinedParameters(state);\n\n    const { parentParameterNames } = state;\n    const updatedParentParameterNames: Set<string> = new Set([\n      ...parentParameterNames,\n      ...this._registeredParameterParserKeysByName.keys()\n    ]);\n\n    this._subparserState = {\n      ...state,\n      parentParameterNames: updatedParentParameterNames\n    };\n  }\n\n  /**\n   * {@inheritdoc CommandLineParameterProvider.onDefineParameters}\n   */\n  protected onDefineParameters(): void {\n    this.onDefineUnscopedParameters?.();\n\n    if (!this._scopingParameters.length) {\n      throw new Error(\n        'No scoping parameters defined. At least one scoping parameter must be defined. ' +\n          'Scoping parameters are defined by setting the parameterGroupName to ' +\n          'ScopedCommandLineAction.ScopingParameterGroupName.'\n      );\n    }\n    if (this.remainder) {\n      throw new Error(\n        'Unscoped remainder parameters are not allowed. Remainder parameters can only be defined on ' +\n          'the scoped parameter provider in onDefineScopedParameters().'\n      );\n    }\n\n    // Consume the remainder of the command-line, which will later be passed the scoped parser.\n    // This will also prevent developers from calling this.defineCommandLineRemainder(...) since\n    // we will have already defined it.\n    this.defineCommandLineRemainder({\n      description:\n        'Scoped parameters.  Must be prefixed with \"--\", ex. \"-- --scopedParameter ' +\n        'foo --scopedFlag\".  For more information on available scoped parameters, use \"-- --help\".'\n    });\n  }\n\n  /**\n   * Retrieves the scoped CommandLineParser, which is populated after the ScopedCommandLineAction is executed.\n   * @internal\n   */\n  protected _getScopedCommandLineParser(): CommandLineParser {\n    if (!this._scopedCommandLineParser) {\n      throw new Error('The scoped CommandLineParser is only populated after the action is executed.');\n    }\n    return this._scopedCommandLineParser;\n  }\n\n  /** @internal */\n  protected _defineParameter(parameter: CommandLineParameter): void {\n    super._defineParameter(parameter);\n    if (parameter.parameterGroup === ScopedCommandLineAction.ScopingParameterGroup) {\n      this._scopingParameters.push(parameter);\n    }\n  }\n\n  /**\n   * The child class should implement this hook to define its unscoped command-line parameters,\n   * e.g. by calling defineFlagParameter(). At least one scoping parameter must be defined.\n   * Scoping parameters are defined by setting the parameterGroupName to\n   * ScopedCommandLineAction.ScopingParameterGroupName.\n   */\n  protected onDefineUnscopedParameters?(): void;\n\n  /**\n   * The child class should implement this hook to define its scoped command-line\n   * parameters, e.g. by calling scopedParameterProvider.defineFlagParameter(). These\n   * parameters will only be available if the action is invoked with a scope.\n   *\n   * @remarks\n   * onDefineScopedParameters is called after the unscoped parameters have been parsed.\n   * The values they provide can be used to vary the defined scope parameters.\n   */\n  protected abstract onDefineScopedParameters(scopedParameterProvider: CommandLineParameterProvider): void;\n\n  /**\n   * {@inheritDoc CommandLineAction.onExecute}\n   */\n  protected abstract onExecute(): Promise<void>;\n}\n"]}

package/lib/providers/TabCompletionAction.d.ts

@@ -7,10 +7,10 @@ export declare class TabCompleteAction extends CommandLineAction {
     private readonly _globalParameters;
     constructor(actions: ReadonlyArray<CommandLineAction>, globalParameters: ReadonlyArray<CommandLineParameterBase>);
     protected onExecute(): Promise<void>;
-    getCompletions(commandLine: string, caretPosition?: number): AsyncIterable<string>;
+    getCompletionsAsync(commandLine: string, caretPosition?: number): AsyncIterable<string>;
     private _getAllActions;
     tokenizeCommandLine(commandLine: string): string[];
-    private _getParameterValueCompletions;
+    private _getParameterValueCompletionsAsync;
     private _getGlobalParameterOffset;
     private _completeParameterValues;
 }

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

@@ -1 +1 @@
-{"version":3,"file":"TabCompletionAction.d.ts","sourceRoot":"","sources":["../../src/providers/TabCompletionAction.ts"],"names":[],"mappings":"AAOA,OAAO,EAEL,KAAK,wBAAwB,EAG9B,MAAM,2BAA2B,CAAC;AAEnC,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAMxD,qBAAa,iBAAkB,SAAQ,iBAAiB;IACtD,OAAO,CAAC,QAAQ,CAAC,wBAAwB,CAAsC;IAC/E,OAAO,CAAC,QAAQ,CAAC,kBAAkB,CAAuC;IAC1E,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAiD;IAC1E,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAAoC;gBAGpE,OAAO,EAAE,aAAa,CAAC,iBAAiB,CAAC,EACzC,gBAAgB,EAAE,aAAa,CAAC,wBAAwB,CAAC;cA2C3C,SAAS,IAAI,OAAO,CAAC,IAAI,CAAC;IAU5B,cAAc,CAC1B,WAAW,EAAE,MAAM,EACnB,aAAa,GAAE,MAA2B,GACzC,aAAa,CAAC,MAAM,CAAC;IAiFxB,OAAO,CAAE,cAAc;IAKhB,mBAAmB,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,EAAE;YAI3C,6BAA6B;IA0B3C,OAAO,CAAC,yBAAyB;IAgBjC,OAAO,CAAE,wBAAwB;CAUlC"}
+{"version":3,"file":"TabCompletionAction.d.ts","sourceRoot":"","sources":["../../src/providers/TabCompletionAction.ts"],"names":[],"mappings":"AAOA,OAAO,EAEL,KAAK,wBAAwB,EAG9B,MAAM,2BAA2B,CAAC;AAEnC,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAMxD,qBAAa,iBAAkB,SAAQ,iBAAiB;IACtD,OAAO,CAAC,QAAQ,CAAC,wBAAwB,CAAsC;IAC/E,OAAO,CAAC,QAAQ,CAAC,kBAAkB,CAAuC;IAC1E,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAiD;IAC1E,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAAoC;gBAGpE,OAAO,EAAE,aAAa,CAAC,iBAAiB,CAAC,EACzC,gBAAgB,EAAE,aAAa,CAAC,wBAAwB,CAAC;cA2C3C,SAAS,IAAI,OAAO,CAAC,IAAI,CAAC;IAU5B,mBAAmB,CAC/B,WAAW,EAAE,MAAM,EACnB,aAAa,GAAE,MAA2B,GACzC,aAAa,CAAC,MAAM,CAAC;IAiFxB,OAAO,CAAE,cAAc;IAKhB,mBAAmB,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,EAAE;YAI3C,kCAAkC;IA0BhD,OAAO,CAAC,yBAAyB;IAgBjC,OAAO,CAAE,wBAAwB;CAUlC"}

package/lib/providers/TabCompletionAction.js

@@ -80,7 +80,7 @@ class TabCompleteAction extends CommandLineAction_1.CommandLineAction {
         const commandLine = this._wordToCompleteParameter.value;
         const caretPosition = this._positionParameter.value || commandLine.length;
         try {
-            for (var _d = true, _e = __asyncValues(this.getCompletions(commandLine, caretPosition)), _f; _f = await _e.next(), _a = _f.done, !_a; _d = true) {
+            for (var _d = true, _e = __asyncValues(this.getCompletionsAsync(commandLine, caretPosition)), _f; _f = await _e.next(), _a = _f.done, !_a; _d = true) {
                 _c = _f.value;
                 _d = false;
                 const value = _c;
@@ -96,8 +96,8 @@ class TabCompleteAction extends CommandLineAction_1.CommandLineAction {
             finally { if (e_1) throw e_1.error; }
         }
     }
-    getCompletions(commandLine, caretPosition = commandLine.length) {
-        return __asyncGenerator(this, arguments, function* getCompletions_1() {
+    getCompletionsAsync(commandLine, caretPosition = commandLine.length) {
+        return __asyncGenerator(this, arguments, function* getCompletionsAsync_1() {
             const actions = this._actions;
             if (!commandLine || !caretPosition) {
                 yield __await(yield* __asyncDelegator(__asyncValues(this._getAllActions())));
@@ -129,7 +129,7 @@ class TabCompleteAction extends CommandLineAction_1.CommandLineAction {
                         if (completePartialWord) {
                             for (const parameterName of parameterNames) {
                                 if (parameterName === secondLastToken) {
-                                    const values = yield __await(this._getParameterValueCompletions(parameterNameMap.get(parameterName)));
+                                    const values = yield __await(this._getParameterValueCompletionsAsync(parameterNameMap.get(parameterName)));
                                     if (values.length > 0) {
                                         yield __await(yield* __asyncDelegator(__asyncValues(this._completeParameterValues(values, lastToken))));
                                         return yield __await(void 0);
@@ -141,7 +141,7 @@ class TabCompleteAction extends CommandLineAction_1.CommandLineAction {
                         else {
                             for (const parameterName of parameterNames) {
                                 if (parameterName === lastToken) {
-                                    const values = yield __await(this._getParameterValueCompletions(parameterNameMap.get(parameterName)));
+                                    const values = yield __await(this._getParameterValueCompletionsAsync(parameterNameMap.get(parameterName)));
                                     if (values.length > 0) {
                                         yield __await(yield* __asyncDelegator(__asyncValues(values)));
                                         return yield __await(void 0);
@@ -170,7 +170,7 @@ class TabCompleteAction extends CommandLineAction_1.CommandLineAction {
     tokenizeCommandLine(commandLine) {
         return (0, string_argv_1.default)(commandLine);
     }
-    async _getParameterValueCompletions(parameter) {
+    async _getParameterValueCompletionsAsync(parameter) {
         let choiceParameterValues = [];
         if (parameter.kind === BaseClasses_1.CommandLineParameterKind.Choice) {
             choiceParameterValues = parameter.alternatives;

package/lib/providers/TabCompletionAction.js.map

@@ -1 +1 @@
-{"version":3,"file":"TabCompletionAction.js","sourceRoot":"","sources":["../../src/providers/TabCompletionAction.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAE3D,8DAAqC;AAIrC,2DAKmC;AACnC,yFAAsF;AACtF,2DAAwD;AAGxD,MAAM,4BAA4B,GAAW,EAAE,CAAC;AAChD,MAAM,gBAAgB,GAAW,CAAC,CAAC;AAEnC,MAAa,iBAAkB,SAAQ,qCAAiB;IAMtD,YACE,OAAyC,EACzC,gBAAyD;QAEzD,KAAK,CAAC;YACJ,UAAU,mEAA8C;YACxD,OAAO,EAAE,0BAA0B;YACnC,aAAa,EAAE,0BAA0B;SAC1C,CAAC,CAAC;QAEH,IAAI,CAAC,QAAQ,GAAG,IAAI,GAAG,EAAE,CAAC;QAC1B,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;YAC7B,MAAM,+BAA+B,GAAsC,IAAI,GAAG,EAAE,CAAC;YACrF,KAAK,MAAM,SAAS,IAAI,MAAM,CAAC,UAAU,EAAE,CAAC;gBAC1C,+BAA+B,CAAC,GAAG,CAAC,SAAS,CAAC,QAAQ,EAAE,SAAiC,CAAC,CAAC;gBAC3F,IAAI,SAAS,CAAC,SAAS,EAAE,CAAC;oBACxB,+BAA+B,CAAC,GAAG,CAAC,SAAS,CAAC,SAAS,EAAE,SAAiC,CAAC,CAAC;gBAC9F,CAAC;YACH,CAAC;YACD,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,MAAM,CAAC,UAAU,EAAE,+BAA+B,CAAC,CAAC;QACxE,CAAC;QAED,IAAI,CAAC,iBAAiB,GAAG,IAAI,GAAG,EAAgC,CAAC;QACjE,KAAK,MAAM,SAAS,IAAI,gBAAgB,EAAE,CAAC;YACzC,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,SAAS,CAAC,QAAQ,EAAE,SAAiC,CAAC,CAAC;YAClF,IAAI,SAAS,CAAC,SAAS,EAAE,CAAC;gBACxB,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,SAAS,CAAC,SAAS,EAAE,SAAiC,CAAC,CAAC;YACrF,CAAC;QACH,CAAC;QAED,IAAI,CAAC,wBAAwB,GAAG,IAAI,CAAC,qBAAqB,CAAC;YACzD,iBAAiB,EAAE,QAAQ;YAC3B,YAAY,EAAE,MAAM;YACpB,WAAW,EAAE,uBAAuB;YACpC,YAAY,EAAE,4BAA4B;SAC3C,CAAC,CAAC;QAEH,IAAI,CAAC,kBAAkB,GAAG,IAAI,CAAC,sBAAsB,CAAC;YACpD,iBAAiB,EAAE,YAAY;YAC/B,YAAY,EAAE,OAAO;YACrB,WAAW,EAAE,2CAA2C;YACxD,YAAY,EAAE,gBAAgB;SAC/B,CAAC,CAAC;IACL,CAAC;IAES,KAAK,CAAC,SAAS;;QACvB,MAAM,WAAW,GAAW,IAAI,CAAC,wBAAwB,CAAC,KAAK,CAAC;QAChE,MAAM,aAAa,GAAW,IAAI,CAAC,kBAAkB,CAAC,KAAK,IAAI,WAAW,CAAC,MAAM,CAAC;;YAElF,KAA0B,eAAA,KAAA,cAAA,IAAI,CAAC,cAAc,CAAC,WAAW,EAAE,aAAa,CAAC,CAAA,IAAA,sDAAE,CAAC;gBAAlD,cAA+C;gBAA/C,WAA+C;gBAA9D,MAAM,KAAK,KAAA,CAAA;gBACpB,sCAAsC;gBACtC,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;YACrB,CAAC;;;;;;;;;IACH,CAAC;IAEa,cAAc,CAC1B,WAAmB,EACnB,gBAAwB,WAAW,CAAC,MAAM;;YAE1C,MAAM,OAAO,GAAmD,IAAI,CAAC,QAAQ,CAAC;YAE9E,IAAI,CAAC,WAAW,IAAI,CAAC,aAAa,EAAE,CAAC;gBACnC,cAAA,KAAK,CAAC,CAAC,iBAAA,cAAA,IAAI,CAAC,cAAc,EAAE,CAAA,CAAA,CAAA,CAAC;gBAC7B,6BAAO;YACT,CAAC;YAED,MAAM,MAAM,GAAa,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,mBAAmB,CAAC,WAAW,CAAC,CAAC,CAAC;YAE3E,+DAA+D;YAC/D,MAAM,qBAAqB,GAAW,IAAI,CAAC,yBAAyB,CAAC,MAAM,CAAC,CAAC;YAE7E,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,GAAG,qBAAqB,EAAE,CAAC;gBAC9C,cAAA,KAAK,CAAC,CAAC,iBAAA,cAAA,IAAI,CAAC,cAAc,EAAE,CAAA,CAAA,CAAA,CAAC;gBAC7B,6BAAO;YACT,CAAC;YAED,MAAM,SAAS,GAAW,MAAM,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;YACpD,MAAM,eAAe,GAAW,MAAM,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;YAE1D,MAAM,yBAAyB,GAAY,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;YACzE,MAAM,mBAAmB,GAAY,aAAa,KAAK,WAAW,CAAC,MAAM,IAAI,CAAC,yBAAyB,CAAC;YAExG,IAAI,mBAAmB,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,GAAG,qBAAqB,EAAE,CAAC;gBACvE,KAAK,MAAM,UAAU,IAAI,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC;oBACxC,IAAI,UAAU,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,GAAG,qBAAqB,CAAC,CAAC,KAAK,CAAC,EAAE,CAAC;wBAChE,oBAAM,UAAU,CAAA,CAAC;oBACnB,CAAC;gBACH,CAAC;YACH,CAAC;iBAAM,CAAC;gBACN,KAAK,MAAM,UAAU,IAAI,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC;oBACxC,IAAI,UAAU,KAAK,MAAM,CAAC,CAAC,GAAG,qBAAqB,CAAC,EAAE,CAAC;wBACrD,MAAM,gBAAgB,GAAsC,OAAO,CAAC,GAAG,CAAC,UAAU,CAAE,CAAC;wBAErF,MAAM,cAAc,GAAa,KAAK,CAAC,IAAI,CAAC,gBAAgB,CAAC,IAAI,EAAE,CAAC,CAAC;wBAErE,IAAI,mBAAmB,EAAE,CAAC;4BACxB,KAAK,MAAM,aAAa,IAAI,cAAc,EAAE,CAAC;gCAC3C,IAAI,aAAa,KAAK,eAAe,EAAE,CAAC;oCACtC,MAAM,MAAM,GAA0B,cAAM,IAAI,CAAC,6BAA6B,CAC5E,gBAAgB,CAAC,GAAG,CAAC,aAAa,CAAE,CACrC,CAAA,CAAC;oCACF,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;wCACtB,cAAA,KAAK,CAAC,CAAC,iBAAA,cAAA,IAAI,CAAC,wBAAwB,CAAC,MAAM,EAAE,SAAS,CAAC,CAAA,CAAA,CAAA,CAAC;wCACxD,6BAAO;oCACT,CAAC;gCACH,CAAC;4BACH,CAAC;4BACD,cAAA,KAAK,CAAC,CAAC,iBAAA,cAAA,IAAI,CAAC,wBAAwB,CAAC,cAAc,EAAE,SAAS,CAAC,CAAA,CAAA,CAAA,CAAC;wBAClE,CAAC;6BAAM,CAAC;4BACN,KAAK,MAAM,aAAa,IAAI,cAAc,EAAE,CAAC;gCAC3C,IAAI,aAAa,KAAK,SAAS,EAAE,CAAC;oCAChC,MAAM,MAAM,GAA0B,cAAM,IAAI,CAAC,6BAA6B,CAC5E,gBAAgB,CAAC,GAAG,CAAC,aAAa,CAAE,CACrC,CAAA,CAAC;oCACF,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;wCACtB,cAAA,KAAK,CAAC,CAAC,iBAAA,cAAA,MAAM,CAAA,CAAA,CAAA,CAAC;wCACd,6BAAO;oCACT,CAAC;gCACH,CAAC;4BACH,CAAC;4BACD,KAAK,MAAM,aAAa,IAAI,cAAc,EAAE,CAAC;gCAC3C,IACE,aAAa,KAAK,SAAS;oCAC3B,gBAAgB,CAAC,GAAG,CAAC,aAAa,CAAE,CAAC,IAAI,KAAK,sCAAwB,CAAC,IAAI,EAC3E,CAAC;oCACD,6EAA6E;oCAC7E,6BAAO;gCACT,CAAC;4BACH,CAAC;4BAED,cAAA,KAAK,CAAC,CAAC,iBAAA,cAAA,cAAc,CAAA,CAAA,CAAA,CAAC;wBACxB,CAAC;wBAED,MAAM;oBACR,CAAC;gBACH,CAAC;YACH,CAAC;QACH,CAAC;KAAA;IAEO,CAAC,cAAc;QACrB,KAAK,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC;QAC5B,KAAK,CAAC,CAAC,IAAI,CAAC,iBAAiB,CAAC,IAAI,EAAE,CAAC;IACvC,CAAC;IAEM,mBAAmB,CAAC,WAAmB;QAC5C,OAAO,IAAA,qBAAU,EAAC,WAAW,CAAC,CAAC;IACjC,CAAC;IAEO,KAAK,CAAC,6BAA6B,CACzC,SAA+B;QAE/B,IAAI,qBAAqB,GAA0B,EAAE,CAAC;QACtD,IAAI,SAAS,CAAC,IAAI,KAAK,sCAAwB,CAAC,MAAM,EAAE,CAAC;YACvD,qBAAqB,GAAG,SAAS,CAAC,YAAY,CAAC;QACjD,CAAC;aAAM,IAAI,SAAS,CAAC,IAAI,KAAK,sCAAwB,CAAC,IAAI,EAAE,CAAC;YAC5D,IAAI,8BAA8B,GAGlB,SAAS,CAAC;YAC1B,IACE,SAAS,YAAY,8CAAgC;gBACrD,SAAS,YAAY,uDAA0B,EAC/C,CAAC;gBACD,8BAA8B,GAAG,SAAS,CAAC;YAC7C,CAAC;YAED,IAAI,8BAA8B,aAA9B,8BAA8B,uBAA9B,8BAA8B,CAAE,WAAW,EAAE,CAAC;gBAChD,qBAAqB,GAAG,MAAM,8BAA8B,CAAC,WAAW,EAAE,CAAC;YAC7E,CAAC;QACH,CAAC;QAED,OAAO,qBAAqB,CAAC;IAC/B,CAAC;IAEO,yBAAyB,CAAC,MAAgB;QAChD,MAAM,gBAAgB,GAAsC,IAAI,CAAC,iBAAiB,CAAC;QACnF,IAAI,KAAK,GAAW,CAAC,CAAC;QAEtB,KAAK,EAAE,KAAK,IAAI,CAAC,GAAW,CAAC,EAAE,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YACtD,KAAK,MAAM,eAAe,IAAI,gBAAgB,CAAC,MAAM,EAAE,EAAE,CAAC;gBACxD,IAAI,MAAM,CAAC,CAAC,CAAC,KAAK,eAAe,CAAC,QAAQ,IAAI,MAAM,CAAC,CAAC,CAAC,KAAK,eAAe,CAAC,SAAS,EAAE,CAAC;oBACtF,MAAM,KAAK,CAAC;gBACd,CAAC;YACH,CAAC;YACD,KAAK,EAAE,CAAC;QACV,CAAC;QAED,OAAO,KAAK,CAAC;IACf,CAAC;IAEO,CAAC,wBAAwB,CAC/B,qBAA4C,EAC5C,SAAiB;QAEjB,KAAK,MAAM,oBAAoB,IAAI,qBAAqB,EAAE,CAAC;YACzD,IAAI,oBAAoB,CAAC,OAAO,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,CAAC;gBAClD,MAAM,oBAAoB,CAAC;YAC7B,CAAC;QACH,CAAC;IACH,CAAC;CACF;AA9MD,8CA8MC","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 stringArgv from 'string-argv';\n\nimport type { IRequiredCommandLineIntegerParameter } from '../parameters/CommandLineIntegerParameter';\nimport type { IRequiredCommandLineStringParameter } from '../parameters/CommandLineStringParameter';\nimport {\n  CommandLineParameterKind,\n  type CommandLineParameterBase,\n  CommandLineParameterWithArgument,\n  type CommandLineParameter\n} from '../parameters/BaseClasses';\nimport { CommandLineChoiceParameter } from '../parameters/CommandLineChoiceParameter';\nimport { CommandLineAction } from './CommandLineAction';\nimport { CommandLineConstants } from '../Constants';\n\nconst DEFAULT_WORD_TO_AUTOCOMPLETE: string = '';\nconst DEFAULT_POSITION: number = 0;\n\nexport class TabCompleteAction extends CommandLineAction {\n  private readonly _wordToCompleteParameter: IRequiredCommandLineStringParameter;\n  private readonly _positionParameter: IRequiredCommandLineIntegerParameter;\n  private readonly _actions: Map<string, Map<string, CommandLineParameter>>;\n  private readonly _globalParameters: Map<string, CommandLineParameter>;\n\n  public constructor(\n    actions: ReadonlyArray<CommandLineAction>,\n    globalParameters: ReadonlyArray<CommandLineParameterBase>\n  ) {\n    super({\n      actionName: CommandLineConstants.TabCompletionActionName,\n      summary: 'Provides tab completion.',\n      documentation: 'Provides tab completion.'\n    });\n\n    this._actions = new Map();\n    for (const action of actions) {\n      const parameterNameToParameterInfoMap: Map<string, CommandLineParameter> = new Map();\n      for (const parameter of action.parameters) {\n        parameterNameToParameterInfoMap.set(parameter.longName, parameter as CommandLineParameter);\n        if (parameter.shortName) {\n          parameterNameToParameterInfoMap.set(parameter.shortName, parameter as CommandLineParameter);\n        }\n      }\n      this._actions.set(action.actionName, parameterNameToParameterInfoMap);\n    }\n\n    this._globalParameters = new Map<string, CommandLineParameter>();\n    for (const parameter of globalParameters) {\n      this._globalParameters.set(parameter.longName, parameter as CommandLineParameter);\n      if (parameter.shortName) {\n        this._globalParameters.set(parameter.shortName, parameter as CommandLineParameter);\n      }\n    }\n\n    this._wordToCompleteParameter = this.defineStringParameter({\n      parameterLongName: '--word',\n      argumentName: 'WORD',\n      description: `The word to complete.`,\n      defaultValue: DEFAULT_WORD_TO_AUTOCOMPLETE\n    });\n\n    this._positionParameter = this.defineIntegerParameter({\n      parameterLongName: '--position',\n      argumentName: 'INDEX',\n      description: `The position in the word to be completed.`,\n      defaultValue: DEFAULT_POSITION\n    });\n  }\n\n  protected async onExecute(): Promise<void> {\n    const commandLine: string = this._wordToCompleteParameter.value;\n    const caretPosition: number = this._positionParameter.value || commandLine.length;\n\n    for await (const value of this.getCompletions(commandLine, caretPosition)) {\n      // eslint-disable-next-line no-console\n      console.log(value);\n    }\n  }\n\n  public async *getCompletions(\n    commandLine: string,\n    caretPosition: number = commandLine.length\n  ): AsyncIterable<string> {\n    const actions: Map<string, Map<string, CommandLineParameter>> = this._actions;\n\n    if (!commandLine || !caretPosition) {\n      yield* this._getAllActions();\n      return;\n    }\n\n    const tokens: string[] = Array.from(this.tokenizeCommandLine(commandLine));\n\n    // offset arguments by the number of global params in the input\n    const globalParameterOffset: number = this._getGlobalParameterOffset(tokens);\n\n    if (tokens.length < 2 + globalParameterOffset) {\n      yield* this._getAllActions();\n      return;\n    }\n\n    const lastToken: string = tokens[tokens.length - 1];\n    const secondLastToken: string = tokens[tokens.length - 2];\n\n    const lastCharacterIsWhitespace: boolean = !commandLine.slice(-1).trim();\n    const completePartialWord: boolean = caretPosition === commandLine.length && !lastCharacterIsWhitespace;\n\n    if (completePartialWord && tokens.length === 2 + globalParameterOffset) {\n      for (const actionName of actions.keys()) {\n        if (actionName.indexOf(tokens[1 + globalParameterOffset]) === 0) {\n          yield actionName;\n        }\n      }\n    } else {\n      for (const actionName of actions.keys()) {\n        if (actionName === tokens[1 + globalParameterOffset]) {\n          const parameterNameMap: Map<string, CommandLineParameter> = actions.get(actionName)!;\n\n          const parameterNames: string[] = Array.from(parameterNameMap.keys());\n\n          if (completePartialWord) {\n            for (const parameterName of parameterNames) {\n              if (parameterName === secondLastToken) {\n                const values: ReadonlyArray<string> = await this._getParameterValueCompletions(\n                  parameterNameMap.get(parameterName)!\n                );\n                if (values.length > 0) {\n                  yield* this._completeParameterValues(values, lastToken);\n                  return;\n                }\n              }\n            }\n            yield* this._completeParameterValues(parameterNames, lastToken);\n          } else {\n            for (const parameterName of parameterNames) {\n              if (parameterName === lastToken) {\n                const values: ReadonlyArray<string> = await this._getParameterValueCompletions(\n                  parameterNameMap.get(parameterName)!\n                );\n                if (values.length > 0) {\n                  yield* values;\n                  return;\n                }\n              }\n            }\n            for (const parameterName of parameterNames) {\n              if (\n                parameterName === lastToken &&\n                parameterNameMap.get(parameterName)!.kind !== CommandLineParameterKind.Flag\n              ) {\n                // The parameter is expecting a value, so don't suggest parameter names again\n                return;\n              }\n            }\n\n            yield* parameterNames;\n          }\n\n          break;\n        }\n      }\n    }\n  }\n\n  private *_getAllActions(): IterableIterator<string> {\n    yield* this._actions.keys();\n    yield* this._globalParameters.keys();\n  }\n\n  public tokenizeCommandLine(commandLine: string): string[] {\n    return stringArgv(commandLine);\n  }\n\n  private async _getParameterValueCompletions(\n    parameter: CommandLineParameter\n  ): Promise<ReadonlyArray<string>> {\n    let choiceParameterValues: ReadonlyArray<string> = [];\n    if (parameter.kind === CommandLineParameterKind.Choice) {\n      choiceParameterValues = parameter.alternatives;\n    } else if (parameter.kind !== CommandLineParameterKind.Flag) {\n      let parameterWithArgumentOrChoices:\n        | CommandLineParameterWithArgument\n        | CommandLineChoiceParameter\n        | undefined = undefined;\n      if (\n        parameter instanceof CommandLineParameterWithArgument ||\n        parameter instanceof CommandLineChoiceParameter\n      ) {\n        parameterWithArgumentOrChoices = parameter;\n      }\n\n      if (parameterWithArgumentOrChoices?.completions) {\n        choiceParameterValues = await parameterWithArgumentOrChoices.completions();\n      }\n    }\n\n    return choiceParameterValues;\n  }\n\n  private _getGlobalParameterOffset(tokens: string[]): number {\n    const globalParameters: Map<string, CommandLineParameter> = this._globalParameters;\n    let count: number = 0;\n\n    outer: for (let i: number = 1; i < tokens.length; i++) {\n      for (const globalParameter of globalParameters.values()) {\n        if (tokens[i] !== globalParameter.longName && tokens[i] !== globalParameter.shortName) {\n          break outer;\n        }\n      }\n      count++;\n    }\n\n    return count;\n  }\n\n  private *_completeParameterValues(\n    choiceParameterValues: ReadonlyArray<string>,\n    lastToken: string\n  ): IterableIterator<string> {\n    for (const choiceParameterValue of choiceParameterValues) {\n      if (choiceParameterValue.indexOf(lastToken) === 0) {\n        yield choiceParameterValue;\n      }\n    }\n  }\n}\n"]}
+{"version":3,"file":"TabCompletionAction.js","sourceRoot":"","sources":["../../src/providers/TabCompletionAction.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAE3D,8DAAqC;AAIrC,2DAKmC;AACnC,yFAAsF;AACtF,2DAAwD;AAGxD,MAAM,4BAA4B,GAAW,EAAE,CAAC;AAChD,MAAM,gBAAgB,GAAW,CAAC,CAAC;AAEnC,MAAa,iBAAkB,SAAQ,qCAAiB;IAMtD,YACE,OAAyC,EACzC,gBAAyD;QAEzD,KAAK,CAAC;YACJ,UAAU,mEAA8C;YACxD,OAAO,EAAE,0BAA0B;YACnC,aAAa,EAAE,0BAA0B;SAC1C,CAAC,CAAC;QAEH,IAAI,CAAC,QAAQ,GAAG,IAAI,GAAG,EAAE,CAAC;QAC1B,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;YAC7B,MAAM,+BAA+B,GAAsC,IAAI,GAAG,EAAE,CAAC;YACrF,KAAK,MAAM,SAAS,IAAI,MAAM,CAAC,UAAU,EAAE,CAAC;gBAC1C,+BAA+B,CAAC,GAAG,CAAC,SAAS,CAAC,QAAQ,EAAE,SAAiC,CAAC,CAAC;gBAC3F,IAAI,SAAS,CAAC,SAAS,EAAE,CAAC;oBACxB,+BAA+B,CAAC,GAAG,CAAC,SAAS,CAAC,SAAS,EAAE,SAAiC,CAAC,CAAC;gBAC9F,CAAC;YACH,CAAC;YACD,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,MAAM,CAAC,UAAU,EAAE,+BAA+B,CAAC,CAAC;QACxE,CAAC;QAED,IAAI,CAAC,iBAAiB,GAAG,IAAI,GAAG,EAAgC,CAAC;QACjE,KAAK,MAAM,SAAS,IAAI,gBAAgB,EAAE,CAAC;YACzC,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,SAAS,CAAC,QAAQ,EAAE,SAAiC,CAAC,CAAC;YAClF,IAAI,SAAS,CAAC,SAAS,EAAE,CAAC;gBACxB,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,SAAS,CAAC,SAAS,EAAE,SAAiC,CAAC,CAAC;YACrF,CAAC;QACH,CAAC;QAED,IAAI,CAAC,wBAAwB,GAAG,IAAI,CAAC,qBAAqB,CAAC;YACzD,iBAAiB,EAAE,QAAQ;YAC3B,YAAY,EAAE,MAAM;YACpB,WAAW,EAAE,uBAAuB;YACpC,YAAY,EAAE,4BAA4B;SAC3C,CAAC,CAAC;QAEH,IAAI,CAAC,kBAAkB,GAAG,IAAI,CAAC,sBAAsB,CAAC;YACpD,iBAAiB,EAAE,YAAY;YAC/B,YAAY,EAAE,OAAO;YACrB,WAAW,EAAE,2CAA2C;YACxD,YAAY,EAAE,gBAAgB;SAC/B,CAAC,CAAC;IACL,CAAC;IAES,KAAK,CAAC,SAAS;;QACvB,MAAM,WAAW,GAAW,IAAI,CAAC,wBAAwB,CAAC,KAAK,CAAC;QAChE,MAAM,aAAa,GAAW,IAAI,CAAC,kBAAkB,CAAC,KAAK,IAAI,WAAW,CAAC,MAAM,CAAC;;YAElF,KAA0B,eAAA,KAAA,cAAA,IAAI,CAAC,mBAAmB,CAAC,WAAW,EAAE,aAAa,CAAC,CAAA,IAAA,sDAAE,CAAC;gBAAvD,cAAoD;gBAApD,WAAoD;gBAAnE,MAAM,KAAK,KAAA,CAAA;gBACpB,sCAAsC;gBACtC,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;YACrB,CAAC;;;;;;;;;IACH,CAAC;IAEa,mBAAmB,CAC/B,WAAmB,EACnB,gBAAwB,WAAW,CAAC,MAAM;;YAE1C,MAAM,OAAO,GAAmD,IAAI,CAAC,QAAQ,CAAC;YAE9E,IAAI,CAAC,WAAW,IAAI,CAAC,aAAa,EAAE,CAAC;gBACnC,cAAA,KAAK,CAAC,CAAC,iBAAA,cAAA,IAAI,CAAC,cAAc,EAAE,CAAA,CAAA,CAAA,CAAC;gBAC7B,6BAAO;YACT,CAAC;YAED,MAAM,MAAM,GAAa,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,mBAAmB,CAAC,WAAW,CAAC,CAAC,CAAC;YAE3E,+DAA+D;YAC/D,MAAM,qBAAqB,GAAW,IAAI,CAAC,yBAAyB,CAAC,MAAM,CAAC,CAAC;YAE7E,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,GAAG,qBAAqB,EAAE,CAAC;gBAC9C,cAAA,KAAK,CAAC,CAAC,iBAAA,cAAA,IAAI,CAAC,cAAc,EAAE,CAAA,CAAA,CAAA,CAAC;gBAC7B,6BAAO;YACT,CAAC;YAED,MAAM,SAAS,GAAW,MAAM,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;YACpD,MAAM,eAAe,GAAW,MAAM,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;YAE1D,MAAM,yBAAyB,GAAY,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;YACzE,MAAM,mBAAmB,GAAY,aAAa,KAAK,WAAW,CAAC,MAAM,IAAI,CAAC,yBAAyB,CAAC;YAExG,IAAI,mBAAmB,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,GAAG,qBAAqB,EAAE,CAAC;gBACvE,KAAK,MAAM,UAAU,IAAI,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC;oBACxC,IAAI,UAAU,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,GAAG,qBAAqB,CAAC,CAAC,KAAK,CAAC,EAAE,CAAC;wBAChE,oBAAM,UAAU,CAAA,CAAC;oBACnB,CAAC;gBACH,CAAC;YACH,CAAC;iBAAM,CAAC;gBACN,KAAK,MAAM,UAAU,IAAI,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC;oBACxC,IAAI,UAAU,KAAK,MAAM,CAAC,CAAC,GAAG,qBAAqB,CAAC,EAAE,CAAC;wBACrD,MAAM,gBAAgB,GAAsC,OAAO,CAAC,GAAG,CAAC,UAAU,CAAE,CAAC;wBAErF,MAAM,cAAc,GAAa,KAAK,CAAC,IAAI,CAAC,gBAAgB,CAAC,IAAI,EAAE,CAAC,CAAC;wBAErE,IAAI,mBAAmB,EAAE,CAAC;4BACxB,KAAK,MAAM,aAAa,IAAI,cAAc,EAAE,CAAC;gCAC3C,IAAI,aAAa,KAAK,eAAe,EAAE,CAAC;oCACtC,MAAM,MAAM,GAA0B,cAAM,IAAI,CAAC,kCAAkC,CACjF,gBAAgB,CAAC,GAAG,CAAC,aAAa,CAAE,CACrC,CAAA,CAAC;oCACF,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;wCACtB,cAAA,KAAK,CAAC,CAAC,iBAAA,cAAA,IAAI,CAAC,wBAAwB,CAAC,MAAM,EAAE,SAAS,CAAC,CAAA,CAAA,CAAA,CAAC;wCACxD,6BAAO;oCACT,CAAC;gCACH,CAAC;4BACH,CAAC;4BACD,cAAA,KAAK,CAAC,CAAC,iBAAA,cAAA,IAAI,CAAC,wBAAwB,CAAC,cAAc,EAAE,SAAS,CAAC,CAAA,CAAA,CAAA,CAAC;wBAClE,CAAC;6BAAM,CAAC;4BACN,KAAK,MAAM,aAAa,IAAI,cAAc,EAAE,CAAC;gCAC3C,IAAI,aAAa,KAAK,SAAS,EAAE,CAAC;oCAChC,MAAM,MAAM,GAA0B,cAAM,IAAI,CAAC,kCAAkC,CACjF,gBAAgB,CAAC,GAAG,CAAC,aAAa,CAAE,CACrC,CAAA,CAAC;oCACF,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;wCACtB,cAAA,KAAK,CAAC,CAAC,iBAAA,cAAA,MAAM,CAAA,CAAA,CAAA,CAAC;wCACd,6BAAO;oCACT,CAAC;gCACH,CAAC;4BACH,CAAC;4BACD,KAAK,MAAM,aAAa,IAAI,cAAc,EAAE,CAAC;gCAC3C,IACE,aAAa,KAAK,SAAS;oCAC3B,gBAAgB,CAAC,GAAG,CAAC,aAAa,CAAE,CAAC,IAAI,KAAK,sCAAwB,CAAC,IAAI,EAC3E,CAAC;oCACD,6EAA6E;oCAC7E,6BAAO;gCACT,CAAC;4BACH,CAAC;4BAED,cAAA,KAAK,CAAC,CAAC,iBAAA,cAAA,cAAc,CAAA,CAAA,CAAA,CAAC;wBACxB,CAAC;wBAED,MAAM;oBACR,CAAC;gBACH,CAAC;YACH,CAAC;QACH,CAAC;KAAA;IAEO,CAAC,cAAc;QACrB,KAAK,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC;QAC5B,KAAK,CAAC,CAAC,IAAI,CAAC,iBAAiB,CAAC,IAAI,EAAE,CAAC;IACvC,CAAC;IAEM,mBAAmB,CAAC,WAAmB;QAC5C,OAAO,IAAA,qBAAU,EAAC,WAAW,CAAC,CAAC;IACjC,CAAC;IAEO,KAAK,CAAC,kCAAkC,CAC9C,SAA+B;QAE/B,IAAI,qBAAqB,GAA0B,EAAE,CAAC;QACtD,IAAI,SAAS,CAAC,IAAI,KAAK,sCAAwB,CAAC,MAAM,EAAE,CAAC;YACvD,qBAAqB,GAAG,SAAS,CAAC,YAAY,CAAC;QACjD,CAAC;aAAM,IAAI,SAAS,CAAC,IAAI,KAAK,sCAAwB,CAAC,IAAI,EAAE,CAAC;YAC5D,IAAI,8BAA8B,GAGlB,SAAS,CAAC;YAC1B,IACE,SAAS,YAAY,8CAAgC;gBACrD,SAAS,YAAY,uDAA0B,EAC/C,CAAC;gBACD,8BAA8B,GAAG,SAAS,CAAC;YAC7C,CAAC;YAED,IAAI,8BAA8B,aAA9B,8BAA8B,uBAA9B,8BAA8B,CAAE,WAAW,EAAE,CAAC;gBAChD,qBAAqB,GAAG,MAAM,8BAA8B,CAAC,WAAW,EAAE,CAAC;YAC7E,CAAC;QACH,CAAC;QAED,OAAO,qBAAqB,CAAC;IAC/B,CAAC;IAEO,yBAAyB,CAAC,MAAgB;QAChD,MAAM,gBAAgB,GAAsC,IAAI,CAAC,iBAAiB,CAAC;QACnF,IAAI,KAAK,GAAW,CAAC,CAAC;QAEtB,KAAK,EAAE,KAAK,IAAI,CAAC,GAAW,CAAC,EAAE,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YACtD,KAAK,MAAM,eAAe,IAAI,gBAAgB,CAAC,MAAM,EAAE,EAAE,CAAC;gBACxD,IAAI,MAAM,CAAC,CAAC,CAAC,KAAK,eAAe,CAAC,QAAQ,IAAI,MAAM,CAAC,CAAC,CAAC,KAAK,eAAe,CAAC,SAAS,EAAE,CAAC;oBACtF,MAAM,KAAK,CAAC;gBACd,CAAC;YACH,CAAC;YACD,KAAK,EAAE,CAAC;QACV,CAAC;QAED,OAAO,KAAK,CAAC;IACf,CAAC;IAEO,CAAC,wBAAwB,CAC/B,qBAA4C,EAC5C,SAAiB;QAEjB,KAAK,MAAM,oBAAoB,IAAI,qBAAqB,EAAE,CAAC;YACzD,IAAI,oBAAoB,CAAC,OAAO,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,CAAC;gBAClD,MAAM,oBAAoB,CAAC;YAC7B,CAAC;QACH,CAAC;IACH,CAAC;CACF;AA9MD,8CA8MC","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 stringArgv from 'string-argv';\n\nimport type { IRequiredCommandLineIntegerParameter } from '../parameters/CommandLineIntegerParameter';\nimport type { IRequiredCommandLineStringParameter } from '../parameters/CommandLineStringParameter';\nimport {\n  CommandLineParameterKind,\n  type CommandLineParameterBase,\n  CommandLineParameterWithArgument,\n  type CommandLineParameter\n} from '../parameters/BaseClasses';\nimport { CommandLineChoiceParameter } from '../parameters/CommandLineChoiceParameter';\nimport { CommandLineAction } from './CommandLineAction';\nimport { CommandLineConstants } from '../Constants';\n\nconst DEFAULT_WORD_TO_AUTOCOMPLETE: string = '';\nconst DEFAULT_POSITION: number = 0;\n\nexport class TabCompleteAction extends CommandLineAction {\n  private readonly _wordToCompleteParameter: IRequiredCommandLineStringParameter;\n  private readonly _positionParameter: IRequiredCommandLineIntegerParameter;\n  private readonly _actions: Map<string, Map<string, CommandLineParameter>>;\n  private readonly _globalParameters: Map<string, CommandLineParameter>;\n\n  public constructor(\n    actions: ReadonlyArray<CommandLineAction>,\n    globalParameters: ReadonlyArray<CommandLineParameterBase>\n  ) {\n    super({\n      actionName: CommandLineConstants.TabCompletionActionName,\n      summary: 'Provides tab completion.',\n      documentation: 'Provides tab completion.'\n    });\n\n    this._actions = new Map();\n    for (const action of actions) {\n      const parameterNameToParameterInfoMap: Map<string, CommandLineParameter> = new Map();\n      for (const parameter of action.parameters) {\n        parameterNameToParameterInfoMap.set(parameter.longName, parameter as CommandLineParameter);\n        if (parameter.shortName) {\n          parameterNameToParameterInfoMap.set(parameter.shortName, parameter as CommandLineParameter);\n        }\n      }\n      this._actions.set(action.actionName, parameterNameToParameterInfoMap);\n    }\n\n    this._globalParameters = new Map<string, CommandLineParameter>();\n    for (const parameter of globalParameters) {\n      this._globalParameters.set(parameter.longName, parameter as CommandLineParameter);\n      if (parameter.shortName) {\n        this._globalParameters.set(parameter.shortName, parameter as CommandLineParameter);\n      }\n    }\n\n    this._wordToCompleteParameter = this.defineStringParameter({\n      parameterLongName: '--word',\n      argumentName: 'WORD',\n      description: `The word to complete.`,\n      defaultValue: DEFAULT_WORD_TO_AUTOCOMPLETE\n    });\n\n    this._positionParameter = this.defineIntegerParameter({\n      parameterLongName: '--position',\n      argumentName: 'INDEX',\n      description: `The position in the word to be completed.`,\n      defaultValue: DEFAULT_POSITION\n    });\n  }\n\n  protected async onExecute(): Promise<void> {\n    const commandLine: string = this._wordToCompleteParameter.value;\n    const caretPosition: number = this._positionParameter.value || commandLine.length;\n\n    for await (const value of this.getCompletionsAsync(commandLine, caretPosition)) {\n      // eslint-disable-next-line no-console\n      console.log(value);\n    }\n  }\n\n  public async *getCompletionsAsync(\n    commandLine: string,\n    caretPosition: number = commandLine.length\n  ): AsyncIterable<string> {\n    const actions: Map<string, Map<string, CommandLineParameter>> = this._actions;\n\n    if (!commandLine || !caretPosition) {\n      yield* this._getAllActions();\n      return;\n    }\n\n    const tokens: string[] = Array.from(this.tokenizeCommandLine(commandLine));\n\n    // offset arguments by the number of global params in the input\n    const globalParameterOffset: number = this._getGlobalParameterOffset(tokens);\n\n    if (tokens.length < 2 + globalParameterOffset) {\n      yield* this._getAllActions();\n      return;\n    }\n\n    const lastToken: string = tokens[tokens.length - 1];\n    const secondLastToken: string = tokens[tokens.length - 2];\n\n    const lastCharacterIsWhitespace: boolean = !commandLine.slice(-1).trim();\n    const completePartialWord: boolean = caretPosition === commandLine.length && !lastCharacterIsWhitespace;\n\n    if (completePartialWord && tokens.length === 2 + globalParameterOffset) {\n      for (const actionName of actions.keys()) {\n        if (actionName.indexOf(tokens[1 + globalParameterOffset]) === 0) {\n          yield actionName;\n        }\n      }\n    } else {\n      for (const actionName of actions.keys()) {\n        if (actionName === tokens[1 + globalParameterOffset]) {\n          const parameterNameMap: Map<string, CommandLineParameter> = actions.get(actionName)!;\n\n          const parameterNames: string[] = Array.from(parameterNameMap.keys());\n\n          if (completePartialWord) {\n            for (const parameterName of parameterNames) {\n              if (parameterName === secondLastToken) {\n                const values: ReadonlyArray<string> = await this._getParameterValueCompletionsAsync(\n                  parameterNameMap.get(parameterName)!\n                );\n                if (values.length > 0) {\n                  yield* this._completeParameterValues(values, lastToken);\n                  return;\n                }\n              }\n            }\n            yield* this._completeParameterValues(parameterNames, lastToken);\n          } else {\n            for (const parameterName of parameterNames) {\n              if (parameterName === lastToken) {\n                const values: ReadonlyArray<string> = await this._getParameterValueCompletionsAsync(\n                  parameterNameMap.get(parameterName)!\n                );\n                if (values.length > 0) {\n                  yield* values;\n                  return;\n                }\n              }\n            }\n            for (const parameterName of parameterNames) {\n              if (\n                parameterName === lastToken &&\n                parameterNameMap.get(parameterName)!.kind !== CommandLineParameterKind.Flag\n              ) {\n                // The parameter is expecting a value, so don't suggest parameter names again\n                return;\n              }\n            }\n\n            yield* parameterNames;\n          }\n\n          break;\n        }\n      }\n    }\n  }\n\n  private *_getAllActions(): IterableIterator<string> {\n    yield* this._actions.keys();\n    yield* this._globalParameters.keys();\n  }\n\n  public tokenizeCommandLine(commandLine: string): string[] {\n    return stringArgv(commandLine);\n  }\n\n  private async _getParameterValueCompletionsAsync(\n    parameter: CommandLineParameter\n  ): Promise<ReadonlyArray<string>> {\n    let choiceParameterValues: ReadonlyArray<string> = [];\n    if (parameter.kind === CommandLineParameterKind.Choice) {\n      choiceParameterValues = parameter.alternatives;\n    } else if (parameter.kind !== CommandLineParameterKind.Flag) {\n      let parameterWithArgumentOrChoices:\n        | CommandLineParameterWithArgument\n        | CommandLineChoiceParameter\n        | undefined = undefined;\n      if (\n        parameter instanceof CommandLineParameterWithArgument ||\n        parameter instanceof CommandLineChoiceParameter\n      ) {\n        parameterWithArgumentOrChoices = parameter;\n      }\n\n      if (parameterWithArgumentOrChoices?.completions) {\n        choiceParameterValues = await parameterWithArgumentOrChoices.completions();\n      }\n    }\n\n    return choiceParameterValues;\n  }\n\n  private _getGlobalParameterOffset(tokens: string[]): number {\n    const globalParameters: Map<string, CommandLineParameter> = this._globalParameters;\n    let count: number = 0;\n\n    outer: for (let i: number = 1; i < tokens.length; i++) {\n      for (const globalParameter of globalParameters.values()) {\n        if (tokens[i] !== globalParameter.longName && tokens[i] !== globalParameter.shortName) {\n          break outer;\n        }\n      }\n      count++;\n    }\n\n    return count;\n  }\n\n  private *_completeParameterValues(\n    choiceParameterValues: ReadonlyArray<string>,\n    lastToken: string\n  ): IterableIterator<string> {\n    for (const choiceParameterValue of choiceParameterValues) {\n      if (choiceParameterValue.indexOf(lastToken) === 0) {\n        yield choiceParameterValue;\n      }\n    }\n  }\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rushstack/ts-command-line",
-  "version": "4.19.5",
+  "version": "4.20.1",
   "description": "An object-oriented command-line parser for TypeScript",
   "repository": {
     "type": "git",
@@ -14,7 +14,7 @@
     "@types/argparse": "1.0.38",
     "argparse": "~1.0.9",
     "string-argv": "~0.3.1",
-    "@rushstack/terminal": "0.10.3"
+    "@rushstack/terminal": "0.11.0"
   },
   "devDependencies": {
     "@rushstack/heft": "0.65.5",