@rushstack/ts-command-line 4.23.7 → 5.0.0

package/lib/providers/ScopedCommandLineAction.js

@@ -45,8 +45,7 @@ class InternalScopedCommandLineParser extends CommandLineParser_1.CommandLinePar
         // from the parent parser.
         super._registerDefinedParameters(this._internalOptions.registerDefinedParametersState);
     }
-    async onExecute() {
-        // override
+    async onExecuteAsync() {
         // Only set if we made it this far, which may not be the case if an error occurred or
         // if '--help' was specified.
         this._canExecute = true;
@@ -75,7 +74,6 @@ class InternalScopedCommandLineParser extends CommandLineParser_1.CommandLinePar
  */
 class ScopedCommandLineAction extends CommandLineAction_1.CommandLineAction {
     constructor(options) {
-        var _a;
         super(options);
         this._options = options;
         this._scopingParameters = [];
@@ -86,13 +84,9 @@ class ScopedCommandLineAction extends CommandLineAction_1.CommandLineAction {
             description: 'Scoped parameters.  Must be prefixed with "--", ex. "-- --scopedParameter ' +
                 'foo --scopedFlag".  For more information on available scoped parameters, use "-- --help".'
         });
-        (_a = this.onDefineUnscopedParameters) === null || _a === void 0 ? void 0 : _a.call(this);
     }
     /**
      * {@inheritDoc CommandLineParameterProvider.parameters}
-     *
-     * @internalremarks
-     * TODO: Replace this type with `CommandLineParameter` in the next major bump.
      */
     get parameters() {
         if (this._scopedCommandLineParser) {
@@ -107,7 +101,6 @@ class ScopedCommandLineAction extends CommandLineAction_1.CommandLineAction {
      * @internal
      */
     _processParsedData(parserOptions, data) {
-        // override
         super._processParsedData(parserOptions, data);
         // This should never happen because the super method should throw if parameters haven't been registered,
         // but guard against this just in-case.
@@ -132,12 +125,11 @@ class ScopedCommandLineAction extends CommandLineAction_1.CommandLineAction {
      * @internal
      */
     async _executeAsync() {
-        // override
         if (!this._unscopedParserOptions || !this._scopedCommandLineParser) {
             throw new Error('The CommandLineAction parameters must be processed before execution.');
         }
         if (!this.remainder) {
-            throw new Error('CommandLineAction.onDefineParameters must be called before execution.');
+            throw new Error('Parameters must be defined before execution.');
         }
         // The '--' argument is required to separate the action parameters from the scoped parameters,
         // so it needs to be trimmed. If remainder values are provided but no '--' is found, then throw.

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;QAE7B,2FAA2F;QAC3F,4FAA4F;QAC5F,mCAAmC;QACnC,IAAI,CAAC,0BAA0B,CAAC;YAC9B,WAAW,EACT,4EAA4E;gBAC5E,2FAA2F;SAC9F,CAAC,CAAC;QAEH,MAAA,IAAI,CAAC,0BAA0B,oDAAI,CAAC;IACtC,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,CAAC;YAClE,GAAG,aAAa;YAChB,aAAa,EAAE,IAAI,CAAC,QAAQ;YAC5B,WAAW,EAAE,IAAI,CAAC,WAAW;YAC7B,kBAAkB,EAAE,IAAI,CAAC,kBAAkB;YAC3C,wBAAwB,EAAE,IAAI,CAAC,UAAoC;YACnE,8BAA8B,EAAE,IAAI,CAAC,eAAe;YACpD,wBAAwB,EAAE,IAAI,CAAC,wBAAwB,CAAC,IAAI,CAAC,IAAI,CAAC;SACnE,CAAC,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,IAAI,CAAC,IAAI,CAAC,kBAAkB,CAAC,MAAM,EAAE,CAAC;YACpC,MAAM,IAAI,KAAK,CACb,iFAAiF;gBAC/E,sEAAsE;gBACtE,oDAAoD,CACvD,CAAC;QACJ,CAAC;QAED,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,GAAG;YACrB,GAAG,KAAK;YACR,oBAAoB,EAAE,2BAA2B;SAClD,CAAC;IACJ,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;;AA9JH,0DAoLC;AA7KC;;;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    // 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    this.onDefineUnscopedParameters?.();\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    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\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   * 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   * @deprecated - Define parameters in the constructor\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;IAEkB,KAAK,CAAC,cAAc;QACrC,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;QAE7B,2FAA2F;QAC3F,4FAA4F;QAC5F,mCAAmC;QACnC,IAAI,CAAC,0BAA0B,CAAC;YAC9B,WAAW,EACT,4EAA4E;gBAC5E,2FAA2F;SAC9F,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;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;IACa,kBAAkB,CAChC,aAAwC,EACxC,IAA4B;QAE5B,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,CAAC;YAClE,GAAG,aAAa;YAChB,aAAa,EAAE,IAAI,CAAC,QAAQ;YAC5B,WAAW,EAAE,IAAI,CAAC,WAAW;YAC7B,kBAAkB,EAAE,IAAI,CAAC,kBAAkB;YAC3C,wBAAwB,EAAE,IAAI,CAAC,UAAoC;YACnE,8BAA8B,EAAE,IAAI,CAAC,eAAe;YACpD,wBAAwB,EAAE,IAAI,CAAC,wBAAwB,CAAC,IAAI,CAAC,IAAI,CAAC;SACnE,CAAC,CAAC;IACL,CAAC;IAED;;;OAGG;IACa,KAAK,CAAC,aAAa;QACjC,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,8CAA8C,CAAC,CAAC;QAClE,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,IAAI,CAAC,IAAI,CAAC,kBAAkB,CAAC,MAAM,EAAE,CAAC;YACpC,MAAM,IAAI,KAAK,CACb,iFAAiF;gBAC/E,sEAAsE;gBACtE,oDAAoD,CACvD,CAAC;QACJ,CAAC;QAED,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,GAAG;YACrB,GAAG,KAAK;YACR,oBAAoB,EAAE,2BAA2B;SAClD,CAAC;IACJ,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;;AA1JH,0DA2KC;AApKC;;;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 } 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 override async onExecuteAsync(): Promise<void> {\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    // 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   * {@inheritDoc CommandLineParameterProvider.parameters}\n   */\n  public get parameters(): ReadonlyArray<CommandLineParameter> {\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 override _processParsedData(\n    parserOptions: ICommandLineParserOptions,\n    data: ICommandLineParserData\n  ): void {\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 override async _executeAsync(): Promise<void> {\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('Parameters must be defined 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    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\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   * 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 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.onExecuteAsync}\n   */\n  protected abstract onExecuteAsync(): Promise<void>;\n}\n"]}

package/lib/providers/TabCompletionAction.d.ts

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

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,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"}
+{"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;cA2ClC,cAAc,IAAI,OAAO,CAAC,IAAI,CAAC;IAU1C,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

@@ -51,7 +51,7 @@ class TabCompleteAction extends CommandLineAction_1.CommandLineAction {
             defaultValue: DEFAULT_POSITION
         });
     }
-    async onExecute() {
+    async onExecuteAsync() {
         const commandLine = this._wordToCompleteParameter.value;
         const caretPosition = this._positionParameter.value || commandLine.length;
         for await (const value of this.getCompletionsAsync(commandLine, caretPosition)) {
@@ -143,7 +143,7 @@ class TabCompleteAction extends CommandLineAction_1.CommandLineAction {
                 parameter instanceof CommandLineChoiceParameter_1.CommandLineChoiceParameter) {
                 parameterWithArgumentOrChoices = parameter;
             }
-            const completionValues = await ((_a = parameterWithArgumentOrChoices === null || parameterWithArgumentOrChoices === void 0 ? void 0 : parameterWithArgumentOrChoices.completions) === null || _a === void 0 ? void 0 : _a.call(parameterWithArgumentOrChoices));
+            const completionValues = await ((_a = parameterWithArgumentOrChoices === null || parameterWithArgumentOrChoices === void 0 ? void 0 : parameterWithArgumentOrChoices.getCompletionsAsync) === null || _a === void 0 ? void 0 : _a.call(parameterWithArgumentOrChoices));
             choiceParameterValues = completionValues instanceof Set ? completionValues : new Set(completionValues);
         }
         return choiceParameterValues !== null && choiceParameterValues !== void 0 ? choiceParameterValues : new Set();

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;AACxD,4CAAoD;AAEpD,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,EAAE,gCAAoB,CAAC,uBAAuB;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;QAElF,IAAI,KAAK,EAAE,MAAM,KAAK,IAAI,IAAI,CAAC,mBAAmB,CAAC,WAAW,EAAE,aAAa,CAAC,EAAE,CAAC;YAC/E,sCAAsC;YACtC,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;QACrB,CAAC;IACH,CAAC;IAEM,KAAK,CAAC,CAAC,mBAAmB,CAC/B,WAAmB,EACnB,gBAAwB,WAAW,CAAC,MAAM;QAE1C,MAAM,OAAO,GAAmD,IAAI,CAAC,QAAQ,CAAC;QAE9E,IAAI,CAAC,WAAW,IAAI,CAAC,aAAa,EAAE,CAAC;YACnC,KAAK,CAAC,CAAC,IAAI,CAAC,cAAc,EAAE,CAAC;YAC7B,OAAO;QACT,CAAC;QAED,MAAM,MAAM,GAAa,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,mBAAmB,CAAC,WAAW,CAAC,CAAC,CAAC;QAE3E,+DAA+D;QAC/D,MAAM,qBAAqB,GAAW,IAAI,CAAC,yBAAyB,CAAC,MAAM,CAAC,CAAC;QAE7E,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,GAAG,qBAAqB,EAAE,CAAC;YAC9C,KAAK,CAAC,CAAC,IAAI,CAAC,cAAc,EAAE,CAAC;YAC7B,OAAO;QACT,CAAC;QAED,MAAM,SAAS,GAAW,MAAM,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;QACpD,MAAM,eAAe,GAAW,MAAM,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;QAE1D,MAAM,yBAAyB,GAAY,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;QACzE,MAAM,mBAAmB,GAAY,aAAa,KAAK,WAAW,CAAC,MAAM,IAAI,CAAC,yBAAyB,CAAC;QAExG,IAAI,mBAAmB,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,GAAG,qBAAqB,EAAE,CAAC;YACvE,KAAK,MAAM,UAAU,IAAI,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC;gBACxC,IAAI,UAAU,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,GAAG,qBAAqB,CAAC,CAAC,KAAK,CAAC,EAAE,CAAC;oBAChE,MAAM,UAAU,CAAC;gBACnB,CAAC;YACH,CAAC;QACH,CAAC;aAAM,CAAC;YACN,KAAK,MAAM,UAAU,IAAI,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC;gBACxC,IAAI,UAAU,KAAK,MAAM,CAAC,CAAC,GAAG,qBAAqB,CAAC,EAAE,CAAC;oBACrD,MAAM,gBAAgB,GAAsC,OAAO,CAAC,GAAG,CAAC,UAAU,CAAE,CAAC;oBAErF,MAAM,cAAc,GAAa,KAAK,CAAC,IAAI,CAAC,gBAAgB,CAAC,IAAI,EAAE,CAAC,CAAC;oBAErE,IAAI,mBAAmB,EAAE,CAAC;wBACxB,KAAK,MAAM,aAAa,IAAI,cAAc,EAAE,CAAC;4BAC3C,IAAI,aAAa,KAAK,eAAe,EAAE,CAAC;gCACtC,MAAM,MAAM,GAAwB,MAAM,IAAI,CAAC,kCAAkC,CAC/E,gBAAgB,CAAC,GAAG,CAAC,aAAa,CAAE,CACrC,CAAC;gCACF,IAAI,MAAM,CAAC,IAAI,GAAG,CAAC,EAAE,CAAC;oCACpB,KAAK,CAAC,CAAC,IAAI,CAAC,wBAAwB,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;oCACxD,OAAO;gCACT,CAAC;4BACH,CAAC;wBACH,CAAC;wBACD,KAAK,CAAC,CAAC,IAAI,CAAC,wBAAwB,CAAC,cAAc,EAAE,SAAS,CAAC,CAAC;oBAClE,CAAC;yBAAM,CAAC;wBACN,KAAK,MAAM,aAAa,IAAI,cAAc,EAAE,CAAC;4BAC3C,IAAI,aAAa,KAAK,SAAS,EAAE,CAAC;gCAChC,MAAM,MAAM,GAAwB,MAAM,IAAI,CAAC,kCAAkC,CAC/E,gBAAgB,CAAC,GAAG,CAAC,aAAa,CAAE,CACrC,CAAC;gCACF,IAAI,MAAM,CAAC,IAAI,GAAG,CAAC,EAAE,CAAC;oCACpB,KAAK,CAAC,CAAC,MAAM,CAAC;oCACd,OAAO;gCACT,CAAC;4BACH,CAAC;wBACH,CAAC;wBACD,KAAK,MAAM,aAAa,IAAI,cAAc,EAAE,CAAC;4BAC3C,IACE,aAAa,KAAK,SAAS;gCAC3B,gBAAgB,CAAC,GAAG,CAAC,aAAa,CAAE,CAAC,IAAI,KAAK,sCAAwB,CAAC,IAAI,EAC3E,CAAC;gCACD,6EAA6E;gCAC7E,OAAO;4BACT,CAAC;wBACH,CAAC;wBAED,KAAK,CAAC,CAAC,cAAc,CAAC;oBACxB,CAAC;oBAED,MAAM;gBACR,CAAC;YACH,CAAC;QACH,CAAC;IACH,CAAC;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,qBAAsD,CAAC;QAC3D,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,MAAM,gBAAgB,GACpB,MAAM,CAAA,MAAA,8BAA8B,aAA9B,8BAA8B,uBAA9B,8BAA8B,CAAE,WAAW,8EAAI,CAAA,CAAC;YACxD,qBAAqB,GAAG,gBAAgB,YAAY,GAAG,CAAC,CAAC,CAAC,gBAAgB,CAAC,CAAC,CAAC,IAAI,GAAG,CAAC,gBAAgB,CAAC,CAAC;QACzG,CAAC;QAED,OAAO,qBAAqB,aAArB,qBAAqB,cAArB,qBAAqB,GAAI,IAAI,GAAG,EAAE,CAAC;IAC5C,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,qBAAkE,EAClE,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: ReadonlySet<string> = await this._getParameterValueCompletionsAsync(\n                  parameterNameMap.get(parameterName)!\n                );\n                if (values.size > 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: ReadonlySet<string> = await this._getParameterValueCompletionsAsync(\n                  parameterNameMap.get(parameterName)!\n                );\n                if (values.size > 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<ReadonlySet<string>> {\n    let choiceParameterValues: ReadonlySet<string> | undefined;\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      const completionValues: ReadonlyArray<string> | ReadonlySet<string> | undefined =\n        await parameterWithArgumentOrChoices?.completions?.();\n      choiceParameterValues = completionValues instanceof Set ? completionValues : new Set(completionValues);\n    }\n\n    return choiceParameterValues ?? new Set();\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> | ReadonlySet<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;AACxD,4CAAoD;AAEpD,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,EAAE,gCAAoB,CAAC,uBAAuB;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;IAEkB,KAAK,CAAC,cAAc;QACrC,MAAM,WAAW,GAAW,IAAI,CAAC,wBAAwB,CAAC,KAAK,CAAC;QAChE,MAAM,aAAa,GAAW,IAAI,CAAC,kBAAkB,CAAC,KAAK,IAAI,WAAW,CAAC,MAAM,CAAC;QAElF,IAAI,KAAK,EAAE,MAAM,KAAK,IAAI,IAAI,CAAC,mBAAmB,CAAC,WAAW,EAAE,aAAa,CAAC,EAAE,CAAC;YAC/E,sCAAsC;YACtC,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;QACrB,CAAC;IACH,CAAC;IAEM,KAAK,CAAC,CAAC,mBAAmB,CAC/B,WAAmB,EACnB,gBAAwB,WAAW,CAAC,MAAM;QAE1C,MAAM,OAAO,GAAmD,IAAI,CAAC,QAAQ,CAAC;QAE9E,IAAI,CAAC,WAAW,IAAI,CAAC,aAAa,EAAE,CAAC;YACnC,KAAK,CAAC,CAAC,IAAI,CAAC,cAAc,EAAE,CAAC;YAC7B,OAAO;QACT,CAAC;QAED,MAAM,MAAM,GAAa,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,mBAAmB,CAAC,WAAW,CAAC,CAAC,CAAC;QAE3E,+DAA+D;QAC/D,MAAM,qBAAqB,GAAW,IAAI,CAAC,yBAAyB,CAAC,MAAM,CAAC,CAAC;QAE7E,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,GAAG,qBAAqB,EAAE,CAAC;YAC9C,KAAK,CAAC,CAAC,IAAI,CAAC,cAAc,EAAE,CAAC;YAC7B,OAAO;QACT,CAAC;QAED,MAAM,SAAS,GAAW,MAAM,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;QACpD,MAAM,eAAe,GAAW,MAAM,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;QAE1D,MAAM,yBAAyB,GAAY,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;QACzE,MAAM,mBAAmB,GAAY,aAAa,KAAK,WAAW,CAAC,MAAM,IAAI,CAAC,yBAAyB,CAAC;QAExG,IAAI,mBAAmB,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,GAAG,qBAAqB,EAAE,CAAC;YACvE,KAAK,MAAM,UAAU,IAAI,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC;gBACxC,IAAI,UAAU,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,GAAG,qBAAqB,CAAC,CAAC,KAAK,CAAC,EAAE,CAAC;oBAChE,MAAM,UAAU,CAAC;gBACnB,CAAC;YACH,CAAC;QACH,CAAC;aAAM,CAAC;YACN,KAAK,MAAM,UAAU,IAAI,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC;gBACxC,IAAI,UAAU,KAAK,MAAM,CAAC,CAAC,GAAG,qBAAqB,CAAC,EAAE,CAAC;oBACrD,MAAM,gBAAgB,GAAsC,OAAO,CAAC,GAAG,CAAC,UAAU,CAAE,CAAC;oBAErF,MAAM,cAAc,GAAa,KAAK,CAAC,IAAI,CAAC,gBAAgB,CAAC,IAAI,EAAE,CAAC,CAAC;oBAErE,IAAI,mBAAmB,EAAE,CAAC;wBACxB,KAAK,MAAM,aAAa,IAAI,cAAc,EAAE,CAAC;4BAC3C,IAAI,aAAa,KAAK,eAAe,EAAE,CAAC;gCACtC,MAAM,MAAM,GAAwB,MAAM,IAAI,CAAC,kCAAkC,CAC/E,gBAAgB,CAAC,GAAG,CAAC,aAAa,CAAE,CACrC,CAAC;gCACF,IAAI,MAAM,CAAC,IAAI,GAAG,CAAC,EAAE,CAAC;oCACpB,KAAK,CAAC,CAAC,IAAI,CAAC,wBAAwB,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;oCACxD,OAAO;gCACT,CAAC;4BACH,CAAC;wBACH,CAAC;wBACD,KAAK,CAAC,CAAC,IAAI,CAAC,wBAAwB,CAAC,cAAc,EAAE,SAAS,CAAC,CAAC;oBAClE,CAAC;yBAAM,CAAC;wBACN,KAAK,MAAM,aAAa,IAAI,cAAc,EAAE,CAAC;4BAC3C,IAAI,aAAa,KAAK,SAAS,EAAE,CAAC;gCAChC,MAAM,MAAM,GAAwB,MAAM,IAAI,CAAC,kCAAkC,CAC/E,gBAAgB,CAAC,GAAG,CAAC,aAAa,CAAE,CACrC,CAAC;gCACF,IAAI,MAAM,CAAC,IAAI,GAAG,CAAC,EAAE,CAAC;oCACpB,KAAK,CAAC,CAAC,MAAM,CAAC;oCACd,OAAO;gCACT,CAAC;4BACH,CAAC;wBACH,CAAC;wBACD,KAAK,MAAM,aAAa,IAAI,cAAc,EAAE,CAAC;4BAC3C,IACE,aAAa,KAAK,SAAS;gCAC3B,gBAAgB,CAAC,GAAG,CAAC,aAAa,CAAE,CAAC,IAAI,KAAK,sCAAwB,CAAC,IAAI,EAC3E,CAAC;gCACD,6EAA6E;gCAC7E,OAAO;4BACT,CAAC;wBACH,CAAC;wBAED,KAAK,CAAC,CAAC,cAAc,CAAC;oBACxB,CAAC;oBAED,MAAM;gBACR,CAAC;YACH,CAAC;QACH,CAAC;IACH,CAAC;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,qBAAsD,CAAC;QAC3D,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,MAAM,gBAAgB,GACpB,MAAM,CAAA,MAAA,8BAA8B,aAA9B,8BAA8B,uBAA9B,8BAA8B,CAAE,mBAAmB,8EAAI,CAAA,CAAC;YAChE,qBAAqB,GAAG,gBAAgB,YAAY,GAAG,CAAC,CAAC,CAAC,gBAAgB,CAAC,CAAC,CAAC,IAAI,GAAG,CAAC,gBAAgB,CAAC,CAAC;QACzG,CAAC;QAED,OAAO,qBAAqB,aAArB,qBAAqB,cAArB,qBAAqB,GAAI,IAAI,GAAG,EAAE,CAAC;IAC5C,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,qBAAkE,EAClE,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 override async onExecuteAsync(): 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: ReadonlySet<string> = await this._getParameterValueCompletionsAsync(\n                  parameterNameMap.get(parameterName)!\n                );\n                if (values.size > 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: ReadonlySet<string> = await this._getParameterValueCompletionsAsync(\n                  parameterNameMap.get(parameterName)!\n                );\n                if (values.size > 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<ReadonlySet<string>> {\n    let choiceParameterValues: ReadonlySet<string> | undefined;\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      const completionValues: ReadonlyArray<string> | ReadonlySet<string> | undefined =\n        await parameterWithArgumentOrChoices?.getCompletionsAsync?.();\n      choiceParameterValues = completionValues instanceof Set ? completionValues : new Set(completionValues);\n    }\n\n    return choiceParameterValues ?? new Set();\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> | ReadonlySet<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.23.7",
+  "version": "5.0.0",
   "description": "An object-oriented command-line parser for TypeScript",
   "repository": {
     "type": "git",
@@ -17,12 +17,10 @@
     "@rushstack/terminal": "0.15.2"
   },
   "devDependencies": {
-    "@rushstack/heft": "0.70.0",
-    "@rushstack/heft-node-rig": "2.8.0",
-    "@types/heft-jest": "1.0.1",
-    "@types/node": "20.17.19",
-    "local-eslint-config": "1.0.0",
-    "@rushstack/node-core-library": "5.13.0"
+    "@rushstack/heft": "0.71.2",
+    "@rushstack/node-core-library": "5.13.0",
+    "decoupled-local-node-rig": "1.0.0",
+    "local-eslint-config": "1.0.0"
   },
   "scripts": {
     "build": "heft build --clean",