@rushstack/ts-command-line 4.9.1

package/lib/providers/CommandLineParameterProvider.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CommandLineParameterProvider.js","sourceRoot":"","sources":["../../src/providers/CommandLineParameterProvider.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D;;;;;;;;;;;;;;;;;;;;;;AAE3D,mDAAqC;AAWrC,2DAImC;AACnC,yFAAsF;AACtF,iGAA8F;AAC9F,2FAAwF;AACxF,mGAAgG;AAChG,qFAAkF;AAClF,yFAAsF;AACtF,iGAA8F;AAC9F,6EAA0E;AAW1E;;;;;GAKG;AACH,MAAsB,4BAA4B;IAQhD,gBAAgB;IAChB,0EAA0E;IAC1E;QACE,IAAI,CAAC,WAAW,GAAG,EAAE,CAAC;QACtB,IAAI,CAAC,qBAAqB,GAAG,IAAI,GAAG,EAAgC,CAAC;IACvE,CAAC;IAED;;OAEG;IACH,IAAW,UAAU;QACnB,OAAO,IAAI,CAAC,WAAW,CAAC;IAC1B,CAAC;IAED;;;OAGG;IACH,IAAW,SAAS;QAClB,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;IAED;;;;;;;;;OASG;IACI,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;QACjD,OAAO,IAAI,CAAC,aAAa,CAAC,iBAAiB,EAAE,sCAAwB,CAAC,MAAM,CAAC,CAAC;IAChF,CAAC;IAED;;;;;;;;;;OAUG;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;;;;OAIG;IACI,sBAAsB,CAAC,iBAAyB;QACrD,OAAO,IAAI,CAAC,aAAa,CAAC,iBAAiB,EAAE,sCAAwB,CAAC,UAAU,CAAC,CAAC;IACpF,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;QAC/C,OAAO,IAAI,CAAC,aAAa,CAAC,iBAAiB,EAAE,sCAAwB,CAAC,IAAI,CAAC,CAAC;IAC9E,CAAC;IAED;;;;;;;;OAQG;IACI,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,CAAC,iBAAyB;QAClD,OAAO,IAAI,CAAC,aAAa,CAAC,iBAAiB,EAAE,sCAAwB,CAAC,OAAO,CAAC,CAAC;IACjF,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,CAAC,iBAAyB;QACtD,OAAO,IAAI,CAAC,aAAa,CAAC,iBAAiB,EAAE,sCAAwB,CAAC,WAAW,CAAC,CAAC;IACrF,CAAC;IACD;;;;;;;;OAQG;IACI,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;QACjD,OAAO,IAAI,CAAC,aAAa,CAAC,iBAAiB,EAAE,sCAAwB,CAAC,MAAM,CAAC,CAAC;IAChF,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;YACnB,MAAM,IAAI,KAAK,CAAC,sEAAsE,CAAC,CAAC;SACzF;QACD,IAAI,CAAC,UAAU,GAAG,IAAI,2CAAoB,CAAC,UAAU,CAAC,CAAC;QAEvD,MAAM,eAAe,GAA6B;YAChD,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,WAAW;YACjC,KAAK,EAAE,QAAQ,CAAC,KAAK,CAAC,SAAS;YAC/B,OAAO,EAAE,OAAO;SACjB,CAAC;QAEF,IAAI,CAAC,kBAAkB,EAAE,CAAC,WAAW,CAAC,QAAQ,CAAC,KAAK,CAAC,SAAS,EAAE,eAAe,CAAC,CAAC;QAEjF,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;IAED;;;;OAIG;IACI,sBAAsB,CAAC,iBAAyB;QACrD,OAAO,IAAI,CAAC,aAAa,CAAC,iBAAiB,EAAE,sCAAwB,CAAC,UAAU,CAAC,CAAC;IACpF,CAAC;IAED;;OAEG;IACI,cAAc;QACnB,OAAO,IAAI,CAAC,kBAAkB,EAAE,CAAC,UAAU,EAAE,CAAC;IAChD,CAAC;IAED;;;;OAIG;IACI,qBAAqB;QAC1B,MAAM,YAAY,GAA2B,EAAE,CAAC;QAChD,KAAK,MAAM,SAAS,IAAI,IAAI,CAAC,UAAU,EAAE;YACvC,QAAQ,SAAS,CAAC,IAAI,EAAE;gBACtB,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,SAAS,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC,SAAS,CAE7C,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,SAAS,CAAC,QAAQ,CAAC,GAAG,UAAU,CAAC,CAAC,CAAC,UAAU,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;oBAC1E,MAAM;aACT;SACF;QACD,OAAO,YAAY,CAAC;IACtB,CAAC;IAcD,gBAAgB;IACN,kBAAkB,CAAC,IAA4B;QACvD,wCAAwC;QACxC,KAAK,MAAM,SAAS,IAAI,IAAI,CAAC,WAAW,EAAE;YACxC,MAAM,KAAK,GAAQ,IAAI,CAAC,SAAS,CAAC,UAAW,CAAC,CAAC,CAAC,yDAAyD;YACzG,SAAS,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;SAC5B;QAED,IAAI,IAAI,CAAC,SAAS,EAAE;YAClB,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC;SAC1D;IACH,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;QAEtC,MAAM,SAAS,GAAqC,IAAI,CAAC,qBAAqB,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC;QACtG,IAAI,CAAC,SAAS,EAAE;YACd,MAAM,IAAI,KAAK,CAAC,kBAAkB,iBAAiB,kBAAkB,CAAC,CAAC;SACxE;QACD,IAAI,SAAS,CAAC,IAAI,KAAK,YAAY,EAAE;YACnC,MAAM,IAAI,KAAK,CACb,kBAAkB,iBAAiB,iBAAiB,sCAAwB,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG;gBAC7F,sCAAsC,sCAAwB,CAAC,YAAY,CAAC,IAAI,CACnF,CAAC;SACH;QACD,OAAO,SAAc,CAAC;IACxB,CAAC;IAEO,gBAAgB,CAAC,SAA+B;QACtD,IAAI,IAAI,CAAC,UAAU,EAAE;YACnB,MAAM,IAAI,KAAK,CACb,oEAAoE;gBAClE,uCAAuC,CAC1C,CAAC;SACH;QAED,MAAM,KAAK,GAAa,EAAE,CAAC;QAC3B,IAAI,SAAS,CAAC,SAAS,EAAE;YACvB,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;SACjC;QACD,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;QAE/B,SAAS,CAAC,UAAU,GAAG,IAAI,CAAC,YAAY,EAAE,CAAC;QAE3C,IAAI,gBAAgB,GAAW,SAAS,CAAC,WAAW,CAAC;QAErD,MAAM,kBAAkB,GAAa,EAAE,CAAC;QACxC,SAAS,CAAC,sBAAsB,CAAC,kBAAkB,CAAC,CAAC;QACrD,IAAI,kBAAkB,CAAC,MAAM,GAAG,CAAC,EAAE;YACjC,uEAAuE;YACvE,IAAI,gBAAgB,CAAC,KAAK,CAAC,iBAAiB,CAAC,EAAE;gBAC7C,gBAAgB,GAAG,gBAAgB,CAAC,SAAS,EAAE,GAAG,GAAG,CAAC;aACvD;YACD,gCAAgC;YAChC,gBAAgB,IAAI,GAAG,GAAG,kBAAkB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;SACxD;QAED,2FAA2F;QAC3F,0CAA0C;QAC1C,MAAM,eAAe,GAA6B;YAChD,IAAI,EAAE,gBAAgB;YACtB,IAAI,EAAE,SAAS,CAAC,UAAU;YAC1B,OAAO,EAAG,SAA8C,CAAC,YAAY,IAAI,SAAS;YAClF,QAAQ,EAAE,SAAS,CAAC,QAAQ;SAC7B,CAAC;QAEF,QAAQ,SAAS,CAAC,IAAI,EAAE;YACtB,KAAK,sCAAwB,CAAC,MAAM,CAAC,CAAC;gBACpC,MAAM,eAAe,GAA+B,SAAuC,CAAC;gBAC5F,eAAe,CAAC,OAAO,GAAG,eAAe,CAAC,YAAwB,CAAC;gBACnE,MAAM;aACP;YACD,KAAK,sCAAwB,CAAC,UAAU,CAAC,CAAC;gBACxC,MAAM,eAAe,GAAmC,SAA2C,CAAC;gBACpG,eAAe,CAAC,OAAO,GAAG,eAAe,CAAC,YAAwB,CAAC;gBACnE,eAAe,CAAC,MAAM,GAAG,QAAQ,CAAC;gBAClC,MAAM;aACP;YACD,KAAK,sCAAwB,CAAC,IAAI;gBAChC,eAAe,CAAC,MAAM,GAAG,WAAW,CAAC;gBACrC,MAAM;YACR,KAAK,sCAAwB,CAAC,OAAO;gBACnC,eAAe,CAAC,IAAI,GAAG,KAAK,CAAC;gBAC7B,MAAM;YACR,KAAK,sCAAwB,CAAC,WAAW;gBACvC,eAAe,CAAC,IAAI,GAAG,KAAK,CAAC;gBAC7B,eAAe,CAAC,MAAM,GAAG,QAAQ,CAAC;gBAClC,MAAM;YACR,KAAK,sCAAwB,CAAC,MAAM;gBAClC,MAAM;YACR,KAAK,sCAAwB,CAAC,UAAU;gBACtC,eAAe,CAAC,MAAM,GAAG,QAAQ,CAAC;gBAClC,MAAM;SACT;QAED,MAAM,cAAc,GAA4B,IAAI,CAAC,kBAAkB,EAAE,CAAC;QAC1E,cAAc,CAAC,WAAW,CAAC,KAAK,oBAAO,eAAe,EAAG,CAAC;QAC1D,IAAI,SAAS,CAAC,oBAAoB,IAAI,SAAS,CAAC,oBAAoB,CAAC,MAAM,GAAG,CAAC,EAAE;YAC/E,cAAc,CAAC,WAAW,CAAC,SAAS,CAAC,oBAAoB,kCACpD,eAAe,KAClB,IAAI,EAAE,QAAQ,CAAC,KAAK,CAAC,QAAQ,IAC7B,CAAC;SACJ;QAED,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QACjC,IAAI,CAAC,qBAAqB,CAAC,GAAG,CAAC,SAAS,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC;IAChE,CAAC;;AA3ZH,oEA4ZC;AA3ZgB,wCAAW,GAAW,CAAC,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.\r\n// See LICENSE in the project root for license information.\r\n\r\nimport * as argparse from 'argparse';\r\nimport {\r\n  ICommandLineChoiceDefinition,\r\n  ICommandLineChoiceListDefinition,\r\n  ICommandLineIntegerDefinition,\r\n  ICommandLineIntegerListDefinition,\r\n  ICommandLineFlagDefinition,\r\n  ICommandLineStringDefinition,\r\n  ICommandLineStringListDefinition,\r\n  ICommandLineRemainderDefinition\r\n} from '../parameters/CommandLineDefinition';\r\nimport {\r\n  CommandLineParameter,\r\n  CommandLineParameterWithArgument,\r\n  CommandLineParameterKind\r\n} from '../parameters/BaseClasses';\r\nimport { CommandLineChoiceParameter } from '../parameters/CommandLineChoiceParameter';\r\nimport { CommandLineChoiceListParameter } from '../parameters/CommandLineChoiceListParameter';\r\nimport { CommandLineIntegerParameter } from '../parameters/CommandLineIntegerParameter';\r\nimport { CommandLineIntegerListParameter } from '../parameters/CommandLineIntegerListParameter';\r\nimport { CommandLineFlagParameter } from '../parameters/CommandLineFlagParameter';\r\nimport { CommandLineStringParameter } from '../parameters/CommandLineStringParameter';\r\nimport { CommandLineStringListParameter } from '../parameters/CommandLineStringListParameter';\r\nimport { CommandLineRemainder } from '../parameters/CommandLineRemainder';\r\n\r\n/**\r\n * This is the argparse result data object\r\n * @internal\r\n */\r\nexport interface ICommandLineParserData {\r\n  action: string;\r\n  [key: string]: any; // eslint-disable-line @typescript-eslint/no-explicit-any\r\n}\r\n\r\n/**\r\n * This is the common base class for CommandLineAction and CommandLineParser\r\n * that provides functionality for defining command-line parameters.\r\n *\r\n * @public\r\n */\r\nexport abstract class CommandLineParameterProvider {\r\n  private static _keyCounter: number = 0;\r\n\r\n  private _parameters: CommandLineParameter[];\r\n  private _parametersByLongName: Map<string, CommandLineParameter>;\r\n\r\n  private _remainder: CommandLineRemainder | undefined;\r\n\r\n  /** @internal */\r\n  // Third party code should not inherit subclasses or call this constructor\r\n  public constructor() {\r\n    this._parameters = [];\r\n    this._parametersByLongName = new Map<string, CommandLineParameter>();\r\n  }\r\n\r\n  /**\r\n   * Returns a collection of the parameters that were defined for this object.\r\n   */\r\n  public get parameters(): ReadonlyArray<CommandLineParameter> {\r\n    return this._parameters;\r\n  }\r\n\r\n  /**\r\n   * If {@link CommandLineParameterProvider.defineCommandLineRemainder} was called,\r\n   * this object captures any remaining command line arguments after the recognized portion.\r\n   */\r\n  public get remainder(): CommandLineRemainder | undefined {\r\n    return this._remainder;\r\n  }\r\n\r\n  /**\r\n   * Defines a command-line parameter whose value must be a string from a fixed set of\r\n   * allowable choices (similar to an enum).\r\n   *\r\n   * @remarks\r\n   * Example of a choice parameter:\r\n   * ```\r\n   * example-tool --log-level warn\r\n   * ```\r\n   */\r\n  public defineChoiceParameter(definition: ICommandLineChoiceDefinition): CommandLineChoiceParameter {\r\n    const parameter: CommandLineChoiceParameter = new CommandLineChoiceParameter(definition);\r\n    this._defineParameter(parameter);\r\n    return parameter;\r\n  }\r\n\r\n  /**\r\n   * Returns the CommandLineChoiceParameter with the specified long name.\r\n   * @remarks\r\n   * This method throws an exception if the parameter is not defined.\r\n   */\r\n  public getChoiceParameter(parameterLongName: string): CommandLineChoiceParameter {\r\n    return this._getParameter(parameterLongName, CommandLineParameterKind.Choice);\r\n  }\r\n\r\n  /**\r\n   * Defines a command-line parameter whose value must be a string from a fixed set of\r\n   * allowable choices (similar to an enum). The parameter can be specified multiple times to\r\n   * build a list.\r\n   *\r\n   * @remarks\r\n   * Example of a choice list parameter:\r\n   * ```\r\n   * example-tool --allow-color red --allow-color green\r\n   * ```\r\n   */\r\n  public defineChoiceListParameter(\r\n    definition: ICommandLineChoiceListDefinition\r\n  ): CommandLineChoiceListParameter {\r\n    const parameter: CommandLineChoiceListParameter = new CommandLineChoiceListParameter(definition);\r\n    this._defineParameter(parameter);\r\n    return parameter;\r\n  }\r\n\r\n  /**\r\n   * Returns the CommandLineChoiceListParameter with the specified long name.\r\n   * @remarks\r\n   * This method throws an exception if the parameter is not defined.\r\n   */\r\n  public getChoiceListParameter(parameterLongName: string): CommandLineChoiceListParameter {\r\n    return this._getParameter(parameterLongName, CommandLineParameterKind.ChoiceList);\r\n  }\r\n\r\n  /**\r\n   * Defines a command-line switch whose boolean value is true if the switch is provided,\r\n   * and false otherwise.\r\n   *\r\n   * @remarks\r\n   * Example usage of a flag parameter:\r\n   * ```\r\n   * example-tool --debug\r\n   * ```\r\n   */\r\n  public defineFlagParameter(definition: ICommandLineFlagDefinition): CommandLineFlagParameter {\r\n    const parameter: CommandLineFlagParameter = new CommandLineFlagParameter(definition);\r\n    this._defineParameter(parameter);\r\n    return parameter;\r\n  }\r\n\r\n  /**\r\n   * Returns the CommandLineFlagParameter with the specified long name.\r\n   * @remarks\r\n   * This method throws an exception if the parameter is not defined.\r\n   */\r\n  public getFlagParameter(parameterLongName: string): CommandLineFlagParameter {\r\n    return this._getParameter(parameterLongName, CommandLineParameterKind.Flag);\r\n  }\r\n\r\n  /**\r\n   * Defines a command-line parameter whose argument is an integer.\r\n   *\r\n   * @remarks\r\n   * Example usage of an integer parameter:\r\n   * ```\r\n   * example-tool --max-attempts 5\r\n   * ```\r\n   */\r\n  public defineIntegerParameter(definition: ICommandLineIntegerDefinition): CommandLineIntegerParameter {\r\n    const parameter: CommandLineIntegerParameter = new CommandLineIntegerParameter(definition);\r\n    this._defineParameter(parameter);\r\n    return parameter;\r\n  }\r\n\r\n  /**\r\n   * Returns the CommandLineIntegerParameter with the specified long name.\r\n   * @remarks\r\n   * This method throws an exception if the parameter is not defined.\r\n   */\r\n  public getIntegerParameter(parameterLongName: string): CommandLineIntegerParameter {\r\n    return this._getParameter(parameterLongName, CommandLineParameterKind.Integer);\r\n  }\r\n\r\n  /**\r\n   * Defines a command-line parameter whose argument is an integer. The parameter can be specified\r\n   * multiple times to build a list.\r\n   *\r\n   * @remarks\r\n   * Example usage of an integer list parameter:\r\n   * ```\r\n   * example-tool --avoid 4 --avoid 13\r\n   * ```\r\n   */\r\n  public defineIntegerListParameter(\r\n    definition: ICommandLineIntegerListDefinition\r\n  ): CommandLineIntegerListParameter {\r\n    const parameter: CommandLineIntegerListParameter = new CommandLineIntegerListParameter(definition);\r\n    this._defineParameter(parameter);\r\n    return parameter;\r\n  }\r\n\r\n  /**\r\n   * Returns the CommandLineIntegerParameter with the specified long name.\r\n   * @remarks\r\n   * This method throws an exception if the parameter is not defined.\r\n   */\r\n  public getIntegerListParameter(parameterLongName: string): CommandLineIntegerListParameter {\r\n    return this._getParameter(parameterLongName, CommandLineParameterKind.IntegerList);\r\n  }\r\n  /**\r\n   * Defines a command-line parameter whose argument is a single text string.\r\n   *\r\n   * @remarks\r\n   * Example usage of a string parameter:\r\n   * ```\r\n   * example-tool --message \"Hello, world!\"\r\n   * ```\r\n   */\r\n  public defineStringParameter(definition: ICommandLineStringDefinition): CommandLineStringParameter {\r\n    const parameter: CommandLineStringParameter = new CommandLineStringParameter(definition);\r\n    this._defineParameter(parameter);\r\n    return parameter;\r\n  }\r\n\r\n  /**\r\n   * Returns the CommandLineStringParameter with the specified long name.\r\n   * @remarks\r\n   * This method throws an exception if the parameter is not defined.\r\n   */\r\n  public getStringParameter(parameterLongName: string): CommandLineStringParameter {\r\n    return this._getParameter(parameterLongName, CommandLineParameterKind.String);\r\n  }\r\n\r\n  /**\r\n   * Defines a command-line parameter whose argument is a single text string.  The parameter can be\r\n   * specified multiple times to build a list.\r\n   *\r\n   * @remarks\r\n   * Example usage of a string list parameter:\r\n   * ```\r\n   * example-tool --add file1.txt --add file2.txt --add file3.txt\r\n   * ```\r\n   */\r\n  public defineStringListParameter(\r\n    definition: ICommandLineStringListDefinition\r\n  ): CommandLineStringListParameter {\r\n    const parameter: CommandLineStringListParameter = new CommandLineStringListParameter(definition);\r\n    this._defineParameter(parameter);\r\n    return parameter;\r\n  }\r\n\r\n  /**\r\n   * Defines a rule that captures any remaining command line arguments after the recognized portion.\r\n   *\r\n   * @remarks\r\n   * This feature is useful for commands that pass their arguments along to an external tool, relying on\r\n   * that tool to perform validation.  (It could also be used to parse parameters without any validation\r\n   * or documentation, but that is not recommended.)\r\n   *\r\n   * Example of capturing the remainder after an optional flag parameter.\r\n   * ```\r\n   * example-tool --my-flag this is the remainder\r\n   * ```\r\n   *\r\n   * In the \"--help\" documentation, the remainder rule will be represented as \"...\".\r\n   */\r\n  public defineCommandLineRemainder(definition: ICommandLineRemainderDefinition): CommandLineRemainder {\r\n    if (this._remainder) {\r\n      throw new Error('defineRemainingArguments() has already been called for this provider');\r\n    }\r\n    this._remainder = new CommandLineRemainder(definition);\r\n\r\n    const argparseOptions: argparse.ArgumentOptions = {\r\n      help: this._remainder.description,\r\n      nargs: argparse.Const.REMAINDER,\r\n      metavar: '\"...\"'\r\n    };\r\n\r\n    this._getArgumentParser().addArgument(argparse.Const.REMAINDER, argparseOptions);\r\n\r\n    return this._remainder;\r\n  }\r\n\r\n  /**\r\n   * Returns the CommandLineStringListParameter with the specified long name.\r\n   * @remarks\r\n   * This method throws an exception if the parameter is not defined.\r\n   */\r\n  public getStringListParameter(parameterLongName: string): CommandLineStringListParameter {\r\n    return this._getParameter(parameterLongName, CommandLineParameterKind.StringList);\r\n  }\r\n\r\n  /**\r\n   * Generates the command-line help text.\r\n   */\r\n  public renderHelpText(): string {\r\n    return this._getArgumentParser().formatHelp();\r\n  }\r\n\r\n  /**\r\n   * Returns a object which maps the long name of each parameter in this.parameters\r\n   * to the stringified form of its value. This is useful for logging telemetry, but\r\n   * it is not the proper way of accessing parameters or their values.\r\n   */\r\n  public getParameterStringMap(): Record<string, string> {\r\n    const parameterMap: Record<string, string> = {};\r\n    for (const parameter of this.parameters) {\r\n      switch (parameter.kind) {\r\n        case CommandLineParameterKind.Flag:\r\n        case CommandLineParameterKind.Choice:\r\n        case CommandLineParameterKind.String:\r\n        case CommandLineParameterKind.Integer:\r\n          parameterMap[parameter.longName] = JSON.stringify(\r\n            (\r\n              parameter as\r\n                | CommandLineFlagParameter\r\n                | CommandLineIntegerParameter\r\n                | CommandLineChoiceParameter\r\n                | CommandLineStringParameter\r\n            ).value\r\n          );\r\n          break;\r\n        case CommandLineParameterKind.StringList:\r\n        case CommandLineParameterKind.IntegerList:\r\n        case CommandLineParameterKind.ChoiceList:\r\n          const arrayValue: ReadonlyArray<string | number> | undefined = (\r\n            parameter as\r\n              | CommandLineIntegerListParameter\r\n              | CommandLineStringListParameter\r\n              | CommandLineChoiceListParameter\r\n          ).values;\r\n          parameterMap[parameter.longName] = arrayValue ? arrayValue.join(',') : '';\r\n          break;\r\n      }\r\n    }\r\n    return parameterMap;\r\n  }\r\n\r\n  /**\r\n   * The child class should implement this hook to define its command-line parameters,\r\n   * e.g. by calling defineFlagParameter().\r\n   */\r\n  protected abstract onDefineParameters(): void;\r\n\r\n  /**\r\n   * Retrieves the argparse object.\r\n   * @internal\r\n   */\r\n  protected abstract _getArgumentParser(): argparse.ArgumentParser;\r\n\r\n  /** @internal */\r\n  protected _processParsedData(data: ICommandLineParserData): void {\r\n    // Fill in the values for the parameters\r\n    for (const parameter of this._parameters) {\r\n      const value: any = data[parameter._parserKey!]; // eslint-disable-line @typescript-eslint/no-explicit-any\r\n      parameter._setValue(value);\r\n    }\r\n\r\n    if (this.remainder) {\r\n      this.remainder._setValue(data[argparse.Const.REMAINDER]);\r\n    }\r\n  }\r\n\r\n  private _generateKey(): string {\r\n    return 'key_' + (CommandLineParameterProvider._keyCounter++).toString();\r\n  }\r\n\r\n  private _getParameter<T extends CommandLineParameter>(\r\n    parameterLongName: string,\r\n    expectedKind: CommandLineParameterKind\r\n  ): T {\r\n    const parameter: CommandLineParameter | undefined = this._parametersByLongName.get(parameterLongName);\r\n    if (!parameter) {\r\n      throw new Error(`The parameter \"${parameterLongName}\" is not defined`);\r\n    }\r\n    if (parameter.kind !== expectedKind) {\r\n      throw new Error(\r\n        `The parameter \"${parameterLongName}\" is of type \"${CommandLineParameterKind[parameter.kind]}\"` +\r\n          ` whereas the caller was expecting \"${CommandLineParameterKind[expectedKind]}\".`\r\n      );\r\n    }\r\n    return parameter as T;\r\n  }\r\n\r\n  private _defineParameter(parameter: CommandLineParameter): void {\r\n    if (this._remainder) {\r\n      throw new Error(\r\n        'defineCommandLineRemainder() was already called for this provider;' +\r\n          ' no further parameters can be defined'\r\n      );\r\n    }\r\n\r\n    const names: string[] = [];\r\n    if (parameter.shortName) {\r\n      names.push(parameter.shortName);\r\n    }\r\n    names.push(parameter.longName);\r\n\r\n    parameter._parserKey = this._generateKey();\r\n\r\n    let finalDescription: string = parameter.description;\r\n\r\n    const supplementaryNotes: string[] = [];\r\n    parameter._getSupplementaryNotes(supplementaryNotes);\r\n    if (supplementaryNotes.length > 0) {\r\n      // If they left the period off the end of their sentence, then add one.\r\n      if (finalDescription.match(/[a-z0-9]\"?\\s*$/i)) {\r\n        finalDescription = finalDescription.trimRight() + '.';\r\n      }\r\n      // Append the supplementary text\r\n      finalDescription += ' ' + supplementaryNotes.join(' ');\r\n    }\r\n\r\n    // NOTE: Our \"environmentVariable\" feature takes precedence over argparse's \"defaultValue\",\r\n    // so we have to reimplement that feature.\r\n    const argparseOptions: argparse.ArgumentOptions = {\r\n      help: finalDescription,\r\n      dest: parameter._parserKey,\r\n      metavar: (parameter as CommandLineParameterWithArgument).argumentName || undefined,\r\n      required: parameter.required\r\n    };\r\n\r\n    switch (parameter.kind) {\r\n      case CommandLineParameterKind.Choice: {\r\n        const choiceParameter: CommandLineChoiceParameter = parameter as CommandLineChoiceParameter;\r\n        argparseOptions.choices = choiceParameter.alternatives as string[];\r\n        break;\r\n      }\r\n      case CommandLineParameterKind.ChoiceList: {\r\n        const choiceParameter: CommandLineChoiceListParameter = parameter as CommandLineChoiceListParameter;\r\n        argparseOptions.choices = choiceParameter.alternatives as string[];\r\n        argparseOptions.action = 'append';\r\n        break;\r\n      }\r\n      case CommandLineParameterKind.Flag:\r\n        argparseOptions.action = 'storeTrue';\r\n        break;\r\n      case CommandLineParameterKind.Integer:\r\n        argparseOptions.type = 'int';\r\n        break;\r\n      case CommandLineParameterKind.IntegerList:\r\n        argparseOptions.type = 'int';\r\n        argparseOptions.action = 'append';\r\n        break;\r\n      case CommandLineParameterKind.String:\r\n        break;\r\n      case CommandLineParameterKind.StringList:\r\n        argparseOptions.action = 'append';\r\n        break;\r\n    }\r\n\r\n    const argumentParser: argparse.ArgumentParser = this._getArgumentParser();\r\n    argumentParser.addArgument(names, { ...argparseOptions });\r\n    if (parameter.undocumentedSynonyms && parameter.undocumentedSynonyms.length > 0) {\r\n      argumentParser.addArgument(parameter.undocumentedSynonyms, {\r\n        ...argparseOptions,\r\n        help: argparse.Const.SUPPRESS\r\n      });\r\n    }\r\n\r\n    this._parameters.push(parameter);\r\n    this._parametersByLongName.set(parameter.longName, parameter);\r\n  }\r\n}\r\n"]}

package/lib/providers/CommandLineParser.d.ts

@@ -0,0 +1,100 @@
+import * as argparse from 'argparse';
+import { CommandLineAction } from './CommandLineAction';
+import { CommandLineParameterProvider } from './CommandLineParameterProvider';
+/**
+ * Options for the {@link CommandLineParser} constructor.
+ * @public
+ */
+export interface ICommandLineParserOptions {
+    /**
+     * The name of your tool when invoked from the command line
+     */
+    toolFilename: string;
+    /**
+     * General documentation that is included in the "--help" main page
+     */
+    toolDescription: string;
+    /**
+     * Set to true to auto-define a tab completion action. False by default.
+     */
+    enableTabCompletionAction?: boolean;
+}
+/**
+ * The "argparse" library is a relatively advanced command-line parser with features such
+ * as word-wrapping and intelligible error messages (that are lacking in other similar
+ * libraries such as commander, yargs, and nomnom).  Unfortunately, its ruby-inspired API
+ * is awkward to use.  The abstract base classes CommandLineParser and CommandLineAction
+ * provide a wrapper for "argparse" that makes defining and consuming arguments quick
+ * and simple, and enforces that appropriate documentation is provided for each parameter.
+ *
+ * @public
+ */
+export declare abstract class CommandLineParser extends CommandLineParameterProvider {
+    /**
+     * Reports which CommandLineAction was specified on the command line.
+     * @remarks
+     * The value will be assigned before onExecute() is invoked.
+     */
+    selectedAction: CommandLineAction | undefined;
+    private _argumentParser;
+    private _actionsSubParser;
+    private _options;
+    private _actions;
+    private _actionsByName;
+    private _executed;
+    private _tabCompleteActionWasAdded;
+    constructor(options: ICommandLineParserOptions);
+    /**
+     * Returns the list of actions that were defined for this CommandLineParser object.
+     */
+    get actions(): ReadonlyArray<CommandLineAction>;
+    /**
+     * Defines a new action that can be used with the CommandLineParser instance.
+     */
+    addAction(action: CommandLineAction): void;
+    /**
+     * Retrieves the action with the specified name.  If no matching action is found,
+     * an exception is thrown.
+     */
+    getAction(actionName: string): CommandLineAction;
+    /**
+     * Retrieves the action with the specified name.  If no matching action is found,
+     * undefined is returned.
+     */
+    tryGetAction(actionName: string): CommandLineAction | undefined;
+    /**
+     * The program entry point will call this method to begin parsing command-line arguments
+     * and executing the corresponding action.
+     *
+     * @remarks
+     * The returned promise will never reject:  If an error occurs, it will be printed
+     * to stderr, process.exitCode will be set to 1, and the promise will resolve to false.
+     * This simplifies the most common usage scenario where the program entry point doesn't
+     * 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}
+     * instead.
+     *
+     * @param args - the command-line arguments to be parsed; if omitted, then
+     *               the process.argv will be used
+     */
+    execute(args?: string[]): Promise<boolean>;
+    /**
+     * This is similar to {@link CommandLineParser.execute}, except that execution errors
+     * simply cause the promise to reject.  It is the caller's responsibility to trap
+     */
+    executeWithoutErrorHandling(args?: string[]): Promise<void>;
+    private _validateDefinitions;
+    /**
+     * {@inheritDoc CommandLineParameterProvider._getArgumentParser}
+     * @internal
+     */
+    protected _getArgumentParser(): argparse.ArgumentParser;
+    /**
+     * This hook allows the subclass to perform additional operations before or after
+     * the chosen action is executed.
+     */
+    protected onExecute(): Promise<void>;
+}
+//# sourceMappingURL=CommandLineParser.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"CommandLineParser.d.ts","sourceRoot":"","sources":["../../src/providers/CommandLineParser.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,QAAQ,MAAM,UAAU,CAAC;AAGrC,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AACxD,OAAO,EAAE,4BAA4B,EAA0B,MAAM,gCAAgC,CAAC;AAItG;;;GAGG;AACH,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;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,eAAe,CAA0B;IACjD,OAAO,CAAC,iBAAiB,CAAiC;IAC1D,OAAO,CAAC,QAAQ,CAA4B;IAC5C,OAAO,CAAC,QAAQ,CAAsB;IACtC,OAAO,CAAC,cAAc,CAAiC;IACvD,OAAO,CAAC,SAAS,CAAkB;IACnC,OAAO,CAAC,0BAA0B,CAAkB;gBAEjC,OAAO,EAAE,yBAAyB;IAmBrD;;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;IAuCvD;;;OAGG;IACU,2BAA2B,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAsDxE,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

@@ -0,0 +1,204 @@
+"use strict";
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CommandLineParser = void 0;
+const colors_1 = __importDefault(require("colors"));
+const CommandLineParameterProvider_1 = require("./CommandLineParameterProvider");
+const CommandLineParserExitError_1 = require("./CommandLineParserExitError");
+const TabCompletionAction_1 = require("./TabCompletionAction");
+/**
+ * The "argparse" library is a relatively advanced command-line parser with features such
+ * as word-wrapping and intelligible error messages (that are lacking in other similar
+ * libraries such as commander, yargs, and nomnom).  Unfortunately, its ruby-inspired API
+ * is awkward to use.  The abstract base classes CommandLineParser and CommandLineAction
+ * provide a wrapper for "argparse" that makes defining and consuming arguments quick
+ * and simple, and enforces that appropriate documentation is provided for each parameter.
+ *
+ * @public
+ */
+class CommandLineParser extends CommandLineParameterProvider_1.CommandLineParameterProvider {
+    constructor(options) {
+        super();
+        this._executed = false;
+        this._tabCompleteActionWasAdded = false;
+        this._options = options;
+        this._actions = [];
+        this._actionsByName = new Map();
+        this._argumentParser = new CommandLineParserExitError_1.CustomArgumentParser({
+            addHelp: true,
+            prog: this._options.toolFilename,
+            description: this._options.toolDescription,
+            epilog: colors_1.default.bold(`For detailed help about a specific command, use: ${this._options.toolFilename} <command> -h`)
+        });
+        this.onDefineParameters();
+    }
+    /**
+     * Returns the list of actions that were defined for this CommandLineParser object.
+     */
+    get actions() {
+        return this._actions;
+    }
+    /**
+     * Defines a new action that can be used with the CommandLineParser instance.
+     */
+    addAction(action) {
+        if (!this._actionsSubParser) {
+            this._actionsSubParser = this._argumentParser.addSubparsers({
+                metavar: '<command>',
+                dest: 'action'
+            });
+        }
+        action._buildParser(this._actionsSubParser);
+        this._actions.push(action);
+        this._actionsByName.set(action.actionName, action);
+    }
+    /**
+     * Retrieves the action with the specified name.  If no matching action is found,
+     * an exception is thrown.
+     */
+    getAction(actionName) {
+        const action = this.tryGetAction(actionName);
+        if (!action) {
+            throw new Error(`The action "${actionName}" was not defined`);
+        }
+        return action;
+    }
+    /**
+     * Retrieves the action with the specified name.  If no matching action is found,
+     * undefined is returned.
+     */
+    tryGetAction(actionName) {
+        return this._actionsByName.get(actionName);
+    }
+    /**
+     * The program entry point will call this method to begin parsing command-line arguments
+     * and executing the corresponding action.
+     *
+     * @remarks
+     * The returned promise will never reject:  If an error occurs, it will be printed
+     * to stderr, process.exitCode will be set to 1, and the promise will resolve to false.
+     * This simplifies the most common usage scenario where the program entry point doesn't
+     * 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}
+     * instead.
+     *
+     * @param args - the command-line arguments to be parsed; if omitted, then
+     *               the process.argv will be used
+     */
+    async execute(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);
+            return true;
+        }
+        catch (err) {
+            if (err instanceof CommandLineParserExitError_1.CommandLineParserExitError) {
+                // executeWithoutErrorHandling() handles the successful cases,
+                // so here we can assume err has a nonzero exit code
+                if (err.message) {
+                    console.error(err.message);
+                }
+                if (!process.exitCode) {
+                    process.exitCode = err.exitCode;
+                }
+            }
+            else {
+                let message = (err.message || 'An unknown error occurred').trim();
+                // If the message doesn't already start with "Error:" then add a prefix
+                if (!/^(error|internal error|warning)\b/i.test(message)) {
+                    message = 'Error: ' + message;
+                }
+                console.error();
+                console.error(colors_1.default.red(message));
+                if (!process.exitCode) {
+                    process.exitCode = 1;
+                }
+            }
+            return false;
+        }
+    }
+    /**
+     * This is similar to {@link CommandLineParser.execute}, except that execution errors
+     * simply cause the promise to reject.  It is the caller's responsibility to trap
+     */
+    async executeWithoutErrorHandling(args) {
+        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');
+            }
+            this._executed = true;
+            this._validateDefinitions();
+            if (!args) {
+                // 0=node.exe, 1=script name
+                args = process.argv.slice(2);
+            }
+            if (args.length === 0) {
+                this._argumentParser.printHelp();
+                return;
+            }
+            const data = this._argumentParser.parseArgs(args);
+            this._processParsedData(data);
+            for (const action of this._actions) {
+                if (action.actionName === data.action) {
+                    this.selectedAction = action;
+                    action._processParsedData(data);
+                    break;
+                }
+            }
+            if (this.actions.length > 0 && !this.selectedAction) {
+                const actions = this.actions.map((x) => x.actionName);
+                throw new Error(`An action must be specified (${actions.join(', ')})`);
+            }
+            return this.onExecute();
+        }
+        catch (err) {
+            if (err instanceof CommandLineParserExitError_1.CommandLineParserExitError) {
+                if (!err.exitCode) {
+                    // non-error exit modeled using exception handling
+                    if (err.message) {
+                        console.log(err.message);
+                    }
+                    return;
+                }
+            }
+            throw err;
+        }
+    }
+    _validateDefinitions() {
+        if (this.remainder && this.actions.length > 0) {
+            // This is apparently not supported by argparse
+            throw new Error('defineCommandLineRemainder() cannot be called for a CommandLineParser with actions');
+        }
+    }
+    /**
+     * {@inheritDoc CommandLineParameterProvider._getArgumentParser}
+     * @internal
+     */
+    _getArgumentParser() {
+        // override
+        return this._argumentParser;
+    }
+    /**
+     * This hook allows the subclass to perform additional operations before or after
+     * the chosen action is executed.
+     */
+    async onExecute() {
+        if (this.selectedAction) {
+            await this.selectedAction._execute();
+        }
+    }
+}
+exports.CommandLineParser = CommandLineParser;
+//# sourceMappingURL=CommandLineParser.js.map

package/lib/providers/CommandLineParser.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CommandLineParser.js","sourceRoot":"","sources":["../../src/providers/CommandLineParser.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D;;;;;;AAG3D,oDAA4B;AAG5B,iFAAsG;AACtG,6EAAgG;AAChG,+DAA0D;AAuB1D;;;;;;;;;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,gBAAM,CAAC,IAAI,CACjB,oDAAoD,IAAI,CAAC,QAAQ,CAAC,YAAY,eAAe,CAC9F;SACF,CAAC,CAAC;QAEH,IAAI,CAAC,kBAAkB,EAAE,CAAC;IAC5B,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;YAC3B,IAAI,CAAC,iBAAiB,GAAG,IAAI,CAAC,eAAe,CAAC,aAAa,CAAC;gBAC1D,OAAO,EAAE,WAAW;gBACpB,IAAI,EAAE,QAAQ;aACf,CAAC,CAAC;SACJ;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;YACX,MAAM,IAAI,KAAK,CAAC,eAAe,UAAU,mBAAmB,CAAC,CAAC;SAC/D;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;YAC/E,IAAI,CAAC,SAAS,CAAC,IAAI,uCAAiB,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC;YACrE,IAAI,CAAC,0BAA0B,GAAG,IAAI,CAAC;SACxC;QAED,IAAI;YACF,MAAM,IAAI,CAAC,2BAA2B,CAAC,IAAI,CAAC,CAAC;YAC7C,OAAO,IAAI,CAAC;SACb;QAAC,OAAO,GAAG,EAAE;YACZ,IAAI,GAAG,YAAY,uDAA0B,EAAE;gBAC7C,8DAA8D;gBAC9D,oDAAoD;gBACpD,IAAI,GAAG,CAAC,OAAO,EAAE;oBACf,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;iBAC5B;gBACD,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE;oBACrB,OAAO,CAAC,QAAQ,GAAG,GAAG,CAAC,QAAQ,CAAC;iBACjC;aACF;iBAAM;gBACL,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;oBACvD,OAAO,GAAG,SAAS,GAAG,OAAO,CAAC;iBAC/B;gBAED,OAAO,CAAC,KAAK,EAAE,CAAC;gBAChB,OAAO,CAAC,KAAK,CAAC,gBAAM,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC;gBAEnC,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE;oBACrB,OAAO,CAAC,QAAQ,GAAG,CAAC,CAAC;iBACtB;aACF;YAED,OAAO,KAAK,CAAC;SACd;IACH,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,2BAA2B,CAAC,IAAe;QACtD,IAAI;YACF,IAAI,IAAI,CAAC,SAAS,EAAE;gBAClB,4EAA4E;gBAC5E,8EAA8E;gBAC9E,4BAA4B;gBAC5B,MAAM,IAAI,KAAK,CAAC,uDAAuD,CAAC,CAAC;aAC1E;YACD,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;YAEtB,IAAI,CAAC,oBAAoB,EAAE,CAAC;YAE5B,IAAI,CAAC,IAAI,EAAE;gBACT,4BAA4B;gBAC5B,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;aAC9B;YACD,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE;gBACrB,IAAI,CAAC,eAAe,CAAC,SAAS,EAAE,CAAC;gBACjC,OAAO;aACR;YAED,MAAM,IAAI,GAA2B,IAAI,CAAC,eAAe,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;YAE1E,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAAC;YAE9B,KAAK,MAAM,MAAM,IAAI,IAAI,CAAC,QAAQ,EAAE;gBAClC,IAAI,MAAM,CAAC,UAAU,KAAK,IAAI,CAAC,MAAM,EAAE;oBACrC,IAAI,CAAC,cAAc,GAAG,MAAM,CAAC;oBAC7B,MAAM,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAAC;oBAChC,MAAM;iBACP;aACF;YACD,IAAI,IAAI,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE;gBACnD,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;aACxE;YAED,OAAO,IAAI,CAAC,SAAS,EAAE,CAAC;SACzB;QAAC,OAAO,GAAG,EAAE;YACZ,IAAI,GAAG,YAAY,uDAA0B,EAAE;gBAC7C,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE;oBACjB,kDAAkD;oBAClD,IAAI,GAAG,CAAC,OAAO,EAAE;wBACf,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;qBAC1B;oBAED,OAAO;iBACR;aACF;YAED,MAAM,GAAG,CAAC;SACX;IACH,CAAC;IAEO,oBAAoB;QAC1B,IAAI,IAAI,CAAC,SAAS,IAAI,IAAI,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE;YAC7C,+CAA+C;YAC/C,MAAM,IAAI,KAAK,CAAC,oFAAoF,CAAC,CAAC;SACvG;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;YACvB,MAAM,IAAI,CAAC,cAAc,CAAC,QAAQ,EAAE,CAAC;SACtC;IACH,CAAC;CACF;AAzND,8CAyNC","sourcesContent":["// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.\r\n// See LICENSE in the project root for license information.\r\n\r\nimport * as argparse from 'argparse';\r\nimport colors from 'colors';\r\n\r\nimport { CommandLineAction } from './CommandLineAction';\r\nimport { CommandLineParameterProvider, ICommandLineParserData } from './CommandLineParameterProvider';\r\nimport { CommandLineParserExitError, CustomArgumentParser } from './CommandLineParserExitError';\r\nimport { TabCompleteAction } from './TabCompletionAction';\r\n\r\n/**\r\n * Options for the {@link CommandLineParser} constructor.\r\n * @public\r\n */\r\nexport interface ICommandLineParserOptions {\r\n  /**\r\n   * The name of your tool when invoked from the command line\r\n   */\r\n  toolFilename: string;\r\n\r\n  /**\r\n   * General documentation that is included in the \"--help\" main page\r\n   */\r\n  toolDescription: string;\r\n\r\n  /**\r\n   * Set to true to auto-define a tab completion action. False by default.\r\n   */\r\n  enableTabCompletionAction?: boolean;\r\n}\r\n\r\n/**\r\n * The \"argparse\" library is a relatively advanced command-line parser with features such\r\n * as word-wrapping and intelligible error messages (that are lacking in other similar\r\n * libraries such as commander, yargs, and nomnom).  Unfortunately, its ruby-inspired API\r\n * is awkward to use.  The abstract base classes CommandLineParser and CommandLineAction\r\n * provide a wrapper for \"argparse\" that makes defining and consuming arguments quick\r\n * and simple, and enforces that appropriate documentation is provided for each parameter.\r\n *\r\n * @public\r\n */\r\nexport abstract class CommandLineParser extends CommandLineParameterProvider {\r\n  /**\r\n   * Reports which CommandLineAction was specified on the command line.\r\n   * @remarks\r\n   * The value will be assigned before onExecute() is invoked.\r\n   */\r\n  public selectedAction: CommandLineAction | undefined;\r\n\r\n  private _argumentParser: argparse.ArgumentParser;\r\n  private _actionsSubParser: argparse.SubParser | undefined;\r\n  private _options: ICommandLineParserOptions;\r\n  private _actions: CommandLineAction[];\r\n  private _actionsByName: Map<string, CommandLineAction>;\r\n  private _executed: boolean = false;\r\n  private _tabCompleteActionWasAdded: boolean = false;\r\n\r\n  public constructor(options: ICommandLineParserOptions) {\r\n    super();\r\n\r\n    this._options = options;\r\n    this._actions = [];\r\n    this._actionsByName = new Map<string, CommandLineAction>();\r\n\r\n    this._argumentParser = new CustomArgumentParser({\r\n      addHelp: true,\r\n      prog: this._options.toolFilename,\r\n      description: this._options.toolDescription,\r\n      epilog: colors.bold(\r\n        `For detailed help about a specific command, use: ${this._options.toolFilename} <command> -h`\r\n      )\r\n    });\r\n\r\n    this.onDefineParameters();\r\n  }\r\n\r\n  /**\r\n   * Returns the list of actions that were defined for this CommandLineParser object.\r\n   */\r\n  public get actions(): ReadonlyArray<CommandLineAction> {\r\n    return this._actions;\r\n  }\r\n\r\n  /**\r\n   * Defines a new action that can be used with the CommandLineParser instance.\r\n   */\r\n  public addAction(action: CommandLineAction): void {\r\n    if (!this._actionsSubParser) {\r\n      this._actionsSubParser = this._argumentParser.addSubparsers({\r\n        metavar: '<command>',\r\n        dest: 'action'\r\n      });\r\n    }\r\n\r\n    action._buildParser(this._actionsSubParser);\r\n    this._actions.push(action);\r\n    this._actionsByName.set(action.actionName, action);\r\n  }\r\n\r\n  /**\r\n   * Retrieves the action with the specified name.  If no matching action is found,\r\n   * an exception is thrown.\r\n   */\r\n  public getAction(actionName: string): CommandLineAction {\r\n    const action: CommandLineAction | undefined = this.tryGetAction(actionName);\r\n    if (!action) {\r\n      throw new Error(`The action \"${actionName}\" was not defined`);\r\n    }\r\n    return action;\r\n  }\r\n\r\n  /**\r\n   * Retrieves the action with the specified name.  If no matching action is found,\r\n   * undefined is returned.\r\n   */\r\n  public tryGetAction(actionName: string): CommandLineAction | undefined {\r\n    return this._actionsByName.get(actionName);\r\n  }\r\n\r\n  /**\r\n   * The program entry point will call this method to begin parsing command-line arguments\r\n   * and executing the corresponding action.\r\n   *\r\n   * @remarks\r\n   * The returned promise will never reject:  If an error occurs, it will be printed\r\n   * to stderr, process.exitCode will be set to 1, and the promise will resolve to false.\r\n   * This simplifies the most common usage scenario where the program entry point doesn't\r\n   * want to be involved with the command-line logic, and will discard the promise without\r\n   * a then() or catch() block.\r\n   *\r\n   * If your caller wants to trap and handle errors, use {@link CommandLineParser.executeWithoutErrorHandling}\r\n   * instead.\r\n   *\r\n   * @param args - the command-line arguments to be parsed; if omitted, then\r\n   *               the process.argv will be used\r\n   */\r\n  public async execute(args?: string[]): Promise<boolean> {\r\n    if (this._options.enableTabCompletionAction && !this._tabCompleteActionWasAdded) {\r\n      this.addAction(new TabCompleteAction(this.actions, this.parameters));\r\n      this._tabCompleteActionWasAdded = true;\r\n    }\r\n\r\n    try {\r\n      await this.executeWithoutErrorHandling(args);\r\n      return true;\r\n    } catch (err) {\r\n      if (err instanceof CommandLineParserExitError) {\r\n        // executeWithoutErrorHandling() handles the successful cases,\r\n        // so here we can assume err has a nonzero exit code\r\n        if (err.message) {\r\n          console.error(err.message);\r\n        }\r\n        if (!process.exitCode) {\r\n          process.exitCode = err.exitCode;\r\n        }\r\n      } else {\r\n        let message: string = ((err as Error).message || 'An unknown error occurred').trim();\r\n\r\n        // If the message doesn't already start with \"Error:\" then add a prefix\r\n        if (!/^(error|internal error|warning)\\b/i.test(message)) {\r\n          message = 'Error: ' + message;\r\n        }\r\n\r\n        console.error();\r\n        console.error(colors.red(message));\r\n\r\n        if (!process.exitCode) {\r\n          process.exitCode = 1;\r\n        }\r\n      }\r\n\r\n      return false;\r\n    }\r\n  }\r\n\r\n  /**\r\n   * This is similar to {@link CommandLineParser.execute}, except that execution errors\r\n   * simply cause the promise to reject.  It is the caller's responsibility to trap\r\n   */\r\n  public async executeWithoutErrorHandling(args?: string[]): Promise<void> {\r\n    try {\r\n      if (this._executed) {\r\n        // In the future we could allow the same parser to be invoked multiple times\r\n        // with different arguments.  We'll do that work as soon as someone encounters\r\n        // a real world need for it.\r\n        throw new Error('execute() was already called for this parser instance');\r\n      }\r\n      this._executed = true;\r\n\r\n      this._validateDefinitions();\r\n\r\n      if (!args) {\r\n        // 0=node.exe, 1=script name\r\n        args = process.argv.slice(2);\r\n      }\r\n      if (args.length === 0) {\r\n        this._argumentParser.printHelp();\r\n        return;\r\n      }\r\n\r\n      const data: ICommandLineParserData = this._argumentParser.parseArgs(args);\r\n\r\n      this._processParsedData(data);\r\n\r\n      for (const action of this._actions) {\r\n        if (action.actionName === data.action) {\r\n          this.selectedAction = action;\r\n          action._processParsedData(data);\r\n          break;\r\n        }\r\n      }\r\n      if (this.actions.length > 0 && !this.selectedAction) {\r\n        const actions: string[] = this.actions.map((x) => x.actionName);\r\n        throw new Error(`An action must be specified (${actions.join(', ')})`);\r\n      }\r\n\r\n      return this.onExecute();\r\n    } catch (err) {\r\n      if (err instanceof CommandLineParserExitError) {\r\n        if (!err.exitCode) {\r\n          // non-error exit modeled using exception handling\r\n          if (err.message) {\r\n            console.log(err.message);\r\n          }\r\n\r\n          return;\r\n        }\r\n      }\r\n\r\n      throw err;\r\n    }\r\n  }\r\n\r\n  private _validateDefinitions(): void {\r\n    if (this.remainder && this.actions.length > 0) {\r\n      // This is apparently not supported by argparse\r\n      throw new Error('defineCommandLineRemainder() cannot be called for a CommandLineParser with actions');\r\n    }\r\n  }\r\n\r\n  /**\r\n   * {@inheritDoc CommandLineParameterProvider._getArgumentParser}\r\n   * @internal\r\n   */\r\n  protected _getArgumentParser(): argparse.ArgumentParser {\r\n    // override\r\n    return this._argumentParser;\r\n  }\r\n\r\n  /**\r\n   * This hook allows the subclass to perform additional operations before or after\r\n   * the chosen action is executed.\r\n   */\r\n  protected async onExecute(): Promise<void> {\r\n    if (this.selectedAction) {\r\n      await this.selectedAction._execute();\r\n    }\r\n  }\r\n}\r\n"]}

package/lib/providers/CommandLineParserExitError.d.ts

@@ -0,0 +1,10 @@
+import * as argparse from 'argparse';
+export declare class CommandLineParserExitError extends Error {
+    readonly exitCode: number;
+    constructor(exitCode: number, message: string);
+}
+export declare class CustomArgumentParser extends argparse.ArgumentParser {
+    exit(status: number, message: string): void;
+    error(err: Error | string): void;
+}
+//# sourceMappingURL=CommandLineParserExitError.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"CommandLineParserExitError.d.ts","sourceRoot":"","sources":["../../src/providers/CommandLineParserExitError.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,QAAQ,MAAM,UAAU,CAAC;AAErC,qBAAa,0BAA2B,SAAQ,KAAK;IACnD,SAAgB,QAAQ,EAAE,MAAM,CAAC;gBAEd,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM;CAWrD;AAED,qBAAa,oBAAqB,SAAQ,QAAQ,CAAC,cAAc;IACxD,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,IAAI;IAK3C,KAAK,CAAC,GAAG,EAAE,KAAK,GAAG,MAAM,GAAG,IAAI;CASxC"}

package/lib/providers/CommandLineParserExitError.js

@@ -0,0 +1,53 @@
+"use strict";
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CustomArgumentParser = exports.CommandLineParserExitError = void 0;
+const argparse = __importStar(require("argparse"));
+class CommandLineParserExitError extends Error {
+    constructor(exitCode, message) {
+        super(message);
+        // Manually set the prototype, as we can no longer extend built-in classes like Error, Array, Map, etc
+        // https://github.com/microsoft/TypeScript-wiki/blob/master/Breaking-Changes.md#extending-built-ins-like-error-array-and-map-may-no-longer-work
+        //
+        // Note: the prototype must also be set on any classes which extend this one
+        this.__proto__ = CommandLineParserExitError.prototype; // eslint-disable-line @typescript-eslint/no-explicit-any
+        this.exitCode = exitCode;
+    }
+}
+exports.CommandLineParserExitError = CommandLineParserExitError;
+class CustomArgumentParser extends argparse.ArgumentParser {
+    exit(status, message) {
+        // override
+        throw new CommandLineParserExitError(status, message);
+    }
+    error(err) {
+        // override
+        // Ensure the ParserExitError bubbles up to the top without any special processing
+        if (err instanceof CommandLineParserExitError) {
+            throw err;
+        }
+        super.error(err);
+    }
+}
+exports.CustomArgumentParser = CustomArgumentParser;
+//# sourceMappingURL=CommandLineParserExitError.js.map

package/lib/providers/CommandLineParserExitError.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CommandLineParserExitError.js","sourceRoot":"","sources":["../../src/providers/CommandLineParserExitError.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D;;;;;;;;;;;;;;;;;;;;;;AAE3D,mDAAqC;AAErC,MAAa,0BAA2B,SAAQ,KAAK;IAGnD,YAAmB,QAAgB,EAAE,OAAe;QAClD,KAAK,CAAC,OAAO,CAAC,CAAC;QAEf,sGAAsG;QACtG,+IAA+I;QAC/I,EAAE;QACF,4EAA4E;QAC3E,IAAY,CAAC,SAAS,GAAG,0BAA0B,CAAC,SAAS,CAAC,CAAC,yDAAyD;QAEzH,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAC3B,CAAC;CACF;AAdD,gEAcC;AAED,MAAa,oBAAqB,SAAQ,QAAQ,CAAC,cAAc;IACxD,IAAI,CAAC,MAAc,EAAE,OAAe;QACzC,WAAW;QACX,MAAM,IAAI,0BAA0B,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACxD,CAAC;IAEM,KAAK,CAAC,GAAmB;QAC9B,WAAW;QACX,kFAAkF;QAClF,IAAI,GAAG,YAAY,0BAA0B,EAAE;YAC7C,MAAM,GAAG,CAAC;SACX;QAED,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IACnB,CAAC;CACF;AAfD,oDAeC","sourcesContent":["// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.\r\n// See LICENSE in the project root for license information.\r\n\r\nimport * as argparse from 'argparse';\r\n\r\nexport class CommandLineParserExitError extends Error {\r\n  public readonly exitCode: number;\r\n\r\n  public constructor(exitCode: number, message: string) {\r\n    super(message);\r\n\r\n    // Manually set the prototype, as we can no longer extend built-in classes like Error, Array, Map, etc\r\n    // https://github.com/microsoft/TypeScript-wiki/blob/master/Breaking-Changes.md#extending-built-ins-like-error-array-and-map-may-no-longer-work\r\n    //\r\n    // Note: the prototype must also be set on any classes which extend this one\r\n    (this as any).__proto__ = CommandLineParserExitError.prototype; // eslint-disable-line @typescript-eslint/no-explicit-any\r\n\r\n    this.exitCode = exitCode;\r\n  }\r\n}\r\n\r\nexport class CustomArgumentParser extends argparse.ArgumentParser {\r\n  public exit(status: number, message: string): void {\r\n    // override\r\n    throw new CommandLineParserExitError(status, message);\r\n  }\r\n\r\n  public error(err: Error | string): void {\r\n    // override\r\n    // Ensure the ParserExitError bubbles up to the top without any special processing\r\n    if (err instanceof CommandLineParserExitError) {\r\n      throw err;\r\n    }\r\n\r\n    super.error(err);\r\n  }\r\n}\r\n"]}

package/lib/providers/DynamicCommandLineAction.d.ts

@@ -0,0 +1,9 @@
+import { CommandLineAction } from './CommandLineAction';
+/**
+ * @public
+ */
+export declare class DynamicCommandLineAction extends CommandLineAction {
+    protected onDefineParameters(): void;
+    protected onExecute(): Promise<void>;
+}
+//# sourceMappingURL=DynamicCommandLineAction.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"DynamicCommandLineAction.d.ts","sourceRoot":"","sources":["../../src/providers/DynamicCommandLineAction.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAExD;;GAEG;AACH,qBAAa,wBAAyB,SAAQ,iBAAiB;IAC7D,SAAS,CAAC,kBAAkB,IAAI,IAAI;cAKpB,SAAS,IAAI,OAAO,CAAC,IAAI,CAAC;CAI3C"}

package/lib/providers/DynamicCommandLineAction.js

@@ -0,0 +1,21 @@
+"use strict";
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DynamicCommandLineAction = void 0;
+const CommandLineAction_1 = require("./CommandLineAction");
+/**
+ * @public
+ */
+class DynamicCommandLineAction extends CommandLineAction_1.CommandLineAction {
+    onDefineParameters() {
+        // abstract
+        // (handled by the external code)
+    }
+    async onExecute() {
+        // abstract
+        // (handled by the external code)
+    }
+}
+exports.DynamicCommandLineAction = DynamicCommandLineAction;
+//# sourceMappingURL=DynamicCommandLineAction.js.map

package/lib/providers/DynamicCommandLineAction.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DynamicCommandLineAction.js","sourceRoot":"","sources":["../../src/providers/DynamicCommandLineAction.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D;;;AAE3D,2DAAwD;AAExD;;GAEG;AACH,MAAa,wBAAyB,SAAQ,qCAAiB;IACnD,kBAAkB;QAC1B,WAAW;QACX,iCAAiC;IACnC,CAAC;IAES,KAAK,CAAC,SAAS;QACvB,WAAW;QACX,iCAAiC;IACnC,CAAC;CACF;AAVD,4DAUC","sourcesContent":["// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.\r\n// See LICENSE in the project root for license information.\r\n\r\nimport { CommandLineAction } from './CommandLineAction';\r\n\r\n/**\r\n * @public\r\n */\r\nexport class DynamicCommandLineAction extends CommandLineAction {\r\n  protected onDefineParameters(): void {\r\n    // abstract\r\n    // (handled by the external code)\r\n  }\r\n\r\n  protected async onExecute(): Promise<void> {\r\n    // abstract\r\n    // (handled by the external code)\r\n  }\r\n}\r\n"]}

package/lib/providers/DynamicCommandLineParser.d.ts

@@ -0,0 +1,8 @@
+import { CommandLineParser } from './CommandLineParser';
+/**
+ * @public
+ */
+export declare class DynamicCommandLineParser extends CommandLineParser {
+    protected onDefineParameters(): void;
+}
+//# sourceMappingURL=DynamicCommandLineParser.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"DynamicCommandLineParser.d.ts","sourceRoot":"","sources":["../../src/providers/DynamicCommandLineParser.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAExD;;GAEG;AACH,qBAAa,wBAAyB,SAAQ,iBAAiB;IAC7D,SAAS,CAAC,kBAAkB,IAAI,IAAI;CAGrC"}

package/lib/providers/DynamicCommandLineParser.js

@@ -0,0 +1,16 @@
+"use strict";
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DynamicCommandLineParser = void 0;
+const CommandLineParser_1 = require("./CommandLineParser");
+/**
+ * @public
+ */
+class DynamicCommandLineParser extends CommandLineParser_1.CommandLineParser {
+    onDefineParameters() {
+        // abstract
+    }
+}
+exports.DynamicCommandLineParser = DynamicCommandLineParser;
+//# sourceMappingURL=DynamicCommandLineParser.js.map

package/lib/providers/DynamicCommandLineParser.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DynamicCommandLineParser.js","sourceRoot":"","sources":["../../src/providers/DynamicCommandLineParser.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D;;;AAE3D,2DAAwD;AAExD;;GAEG;AACH,MAAa,wBAAyB,SAAQ,qCAAiB;IACnD,kBAAkB;QAC1B,WAAW;IACb,CAAC;CACF;AAJD,4DAIC","sourcesContent":["// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.\r\n// See LICENSE in the project root for license information.\r\n\r\nimport { CommandLineParser } from './CommandLineParser';\r\n\r\n/**\r\n * @public\r\n */\r\nexport class DynamicCommandLineParser extends CommandLineParser {\r\n  protected onDefineParameters(): void {\r\n    // abstract\r\n  }\r\n}\r\n"]}

package/lib/providers/TabCompletionAction.d.ts

@@ -0,0 +1,18 @@
+import { CommandLineParameter } from '../parameters/BaseClasses';
+import { CommandLineAction } from './CommandLineAction';
+export declare class TabCompleteAction extends CommandLineAction {
+    private _wordToCompleteParameter;
+    private _positionParameter;
+    private readonly _actions;
+    private readonly _globalParameters;
+    constructor(actions: ReadonlyArray<CommandLineAction>, globalParameters: ReadonlyArray<CommandLineParameter>);
+    protected onDefineParameters(): void;
+    protected onExecute(): Promise<void>;
+    getCompletions(commandLine: string, caretPosition?: number): AsyncIterable<string>;
+    private _getAllActions;
+    tokenizeCommandLine(commandLine: string): string[];
+    private _getParameterValueCompletions;
+    private _getGlobalParameterOffset;
+    private _completeParameterValues;
+}
+//# sourceMappingURL=TabCompletionAction.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"TabCompletionAction.d.ts","sourceRoot":"","sources":["../../src/providers/TabCompletionAction.ts"],"names":[],"mappings":"AAOA,OAAO,EAEL,oBAAoB,EAErB,MAAM,2BAA2B,CAAC;AACnC,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAOxD,qBAAa,iBAAkB,SAAQ,iBAAiB;IACtD,OAAO,CAAC,wBAAwB,CAA8B;IAC9D,OAAO,CAAC,kBAAkB,CAA+B;IACzD,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,oBAAoB,CAAC;IAgCvD,SAAS,CAAC,kBAAkB,IAAI,IAAI;cAgBpB,SAAS,IAAI,OAAO,CAAC,IAAI,CAAC;IAS5B,cAAc,CAC1B,WAAW,EAAE,MAAM,EACnB,aAAa,GAAE,MAA2B,GACzC,aAAa,CAAC,MAAM,CAAC;IAgFxB,OAAO,CAAE,cAAc;IAKhB,mBAAmB,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,EAAE;YAI3C,6BAA6B;IAsB3C,OAAO,CAAC,yBAAyB;IAgBjC,OAAO,CAAE,wBAAwB;CAUlC"}