[ts-command-line] Remove deprecations and perform updates planned for the next major bump. (#5203)

* Remove deprecated functions.

* Renames.

* fixup! Remove deprecated functions.

* fixup! Remove deprecated functions.

* fixup! Remove deprecated functions.

Author: iclanton

apps/api-documenter/src/cli/BaseAction.ts

@@ -32,7 +32,6 @@ export abstract class BaseAction extends CommandLineAction {
   protected constructor(options: ICommandLineActionOptions) {
     super(options);
 
-    // override
     this._inputFolderParameter = this.defineStringParameter({
       parameterLongName: '--input-folder',
       parameterShortName: '-i',

apps/api-documenter/src/cli/GenerateAction.ts

@@ -22,8 +22,7 @@ export class GenerateAction extends BaseAction {
     });
   }
 
-  protected async onExecute(): Promise<void> {
-    // override
+  protected override async onExecuteAsync(): Promise<void> {
     // Look for the config file under the current folder
 
     let configFilePath: string = path.join(process.cwd(), DocumenterConfig.FILENAME);

apps/api-documenter/src/cli/MarkdownAction.ts

@@ -16,8 +16,7 @@ export class MarkdownAction extends BaseAction {
     });
   }
 
-  protected async onExecute(): Promise<void> {
-    // override
+  protected override async onExecuteAsync(): Promise<void> {
     const { apiModel, outputFolder } = this.buildApiModel();
 
     const markdownDocumenter: MarkdownDocumenter = new MarkdownDocumenter({

apps/api-documenter/src/cli/YamlAction.ts

@@ -50,8 +50,7 @@ export class YamlAction extends BaseAction {
     });
   }
 
-  protected async onExecute(): Promise<void> {
-    // override
+  protected override async onExecuteAsync(): Promise<void> {
     const { apiModel, inputFolder, outputFolder } = this.buildApiModel();
 
     const yamlDocumenter: YamlDocumenter = this._officeParameter.value

apps/api-documenter/src/documenters/OfficeYamlDocumenter.ts

@@ -65,7 +65,6 @@ export class OfficeYamlDocumenter extends YamlDocumenter {
 
   /** @override */
   protected onGetTocRoot(): IYamlTocItem {
-    // override
     return {
       name: 'API reference',
       href: 'overview.md',

apps/api-extractor/src/cli/ApiExtractorCommandLine.ts

@@ -32,21 +32,22 @@ export class ApiExtractorCommandLine extends CommandLineParser {
     });
   }
 
-  protected onExecute(): Promise<void> {
-    // override
+  protected override async onExecuteAsync(): Promise<void> {
     if (this._debugParameter.value) {
       InternalError.breakInDebugger = true;
     }
 
-    return super.onExecute().catch((error) => {
+    process.exitCode = 1;
+    try {
+      await super.onExecuteAsync();
+      process.exitCode = 0;
+    } catch (error) {
       if (this._debugParameter.value) {
         console.error(os.EOL + error.stack);
       } else {
         console.error(os.EOL + Colorize.red('ERROR: ' + error.message.trim()));
       }
-
-      process.exitCode = 1;
-    });
+    }
   }
 
   private _populateActions(): void {

apps/api-extractor/src/cli/InitAction.ts

@@ -21,8 +21,7 @@ export class InitAction extends CommandLineAction {
     });
   }
 
-  protected async onExecute(): Promise<void> {
-    // override
+  protected override async onExecuteAsync(): Promise<void> {
     const inputFilePath: string = path.resolve(__dirname, '../schemas/api-extractor-template.json');
     const outputFilePath: string = path.resolve(ExtractorConfig.FILENAME);
 

apps/api-extractor/src/cli/RunAction.ts

@@ -71,8 +71,7 @@ export class RunAction extends CommandLineAction {
     });
   }
 
-  protected async onExecute(): Promise<void> {
-    // override
+  protected override async onExecuteAsync(): Promise<void> {
     const lookup: PackageJsonLookup = new PackageJsonLookup();
     let configFilename: string;
 

apps/cpu-profile-summarizer/src/start.ts

@@ -147,7 +147,7 @@ class CpuProfileSummarizerCommandLineParser extends CommandLineParser {
     });
   }
 
-  protected async onExecute(): Promise<void> {
+  protected override async onExecuteAsync(): Promise<void> {
     const input: readonly string[] = this._inputParameter.values;
     const output: string = this._outputParameter.value;
 

apps/heft/src/cli/HeftCommandLineParser.ts

@@ -176,7 +176,7 @@ export class HeftCommandLineParser extends CommandLineParser {
     }
   }
 
-  protected async onExecute(): Promise<void> {
+  protected override async onExecuteAsync(): Promise<void> {
     try {
       const selectedAction: CommandLineAction | undefined = this.selectedAction;
 
@@ -196,7 +196,7 @@ export class HeftCommandLineParser extends CommandLineParser {
         commandName,
         unaliasedCommandName
       };
-      await super.onExecute();
+      await super.onExecuteAsync();
     } catch (e) {
       await this._reportErrorAndSetExitCodeAsync(e as Error);
     }
@@ -228,7 +228,7 @@ export class HeftCommandLineParser extends CommandLineParser {
       // try to evaluate any parameters. This is to ensure that the
       // `--debug` flag is defined correctly before we do this not-so-rigorous
       // parameter parsing.
-      throw new InternalError('onDefineParameters() has not yet been called.');
+      throw new InternalError('parameters have not yet been defined.');
     }
 
     const toolParameters: Set<string> = getToolParameterNamesFromArgs(args);

apps/heft/src/cli/actions/AliasAction.ts

@@ -22,7 +22,7 @@ export class AliasAction extends AliasCommandLineAction {
     this._terminal = options.terminal;
   }
 
-  protected async onExecute(): Promise<void> {
+  protected override async onExecuteAsync(): Promise<void> {
     const toolFilename: string = this._toolFilename;
     const actionName: string = this.actionName;
     const targetAction: CommandLineAction = this.targetAction;
@@ -34,6 +34,6 @@ export class AliasAction extends AliasCommandLineAction {
         `${defaultParametersString ? ` ${defaultParametersString}` : ''}".`
     );
 
-    await super.onExecute();
+    await super.onExecuteAsync();
   }
 }

apps/heft/src/cli/actions/CleanAction.ts

@@ -76,7 +76,7 @@ export class CleanAction extends CommandLineAction implements IHeftAction {
     return this._selectedPhases;
   }
 
-  protected async onExecute(): Promise<void> {
+  protected override async onExecuteAsync(): Promise<void> {
     const { heftConfiguration } = this._internalHeftSession;
     const abortSignal: AbortSignal = ensureCliAbortSignal(this._terminal);
 

apps/heft/src/cli/actions/PhaseAction.ts

@@ -47,7 +47,7 @@ export class PhaseAction extends CommandLineAction implements IHeftAction {
     return this._selectedPhases;
   }
 
-  protected async onExecute(): Promise<void> {
+  protected override async onExecuteAsync(): Promise<void> {
     await this._actionRunner.executeAsync();
   }
 }

apps/heft/src/cli/actions/RunAction.ts

@@ -145,7 +145,7 @@ export class RunAction extends ScopedCommandLineAction implements IHeftAction {
     this._actionRunner.defineParameters(scopedParameterProvider);
   }
 
-  protected async onExecute(): Promise<void> {
+  protected override async onExecuteAsync(): Promise<void> {
     await this._actionRunner.executeAsync();
   }
 }

apps/lockfile-explorer/src/cli/explorer/ExplorerCommandLineParser.ts

@@ -59,7 +59,7 @@ export class ExplorerCommandLineParser extends CommandLineParser {
     return this._debugParameter.value;
   }
 
-  protected async onExecute(): Promise<void> {
+  protected override async onExecuteAsync(): Promise<void> {
     const lockfileExplorerProjectRoot: string = PackageJsonLookup.instance.tryGetPackageFolderFor(__dirname)!;
     const lockfileExplorerPackageJson: IPackageJson = JsonFile.load(
       `${lockfileExplorerProjectRoot}/package.json`

apps/lockfile-explorer/src/cli/lint/LintCommandLineParser.ts

@@ -26,7 +26,7 @@ export class LintCommandLineParser extends CommandLineParser {
     this._populateActions();
   }
 
-  protected override async onExecute(): Promise<void> {
+  protected override async onExecuteAsync(): Promise<void> {
     const lockfileExplorerProjectRoot: string = PackageJsonLookup.instance.tryGetPackageFolderFor(__dirname)!;
     const lockfileExplorerPackageJson: IPackageJson = JsonFile.load(
       `${lockfileExplorerProjectRoot}/package.json`
@@ -37,7 +37,7 @@ export class LintCommandLineParser extends CommandLineParser {
       Colorize.bold(`\nRush Lockfile Lint ${appVersion}`) + Colorize.cyan(' - https://lfx.rushstack.io/\n')
     );
 
-    await super.onExecute();
+    await super.onExecuteAsync();
   }
 
   private _populateActions(): void {

apps/lockfile-explorer/src/cli/lint/actions/CheckAction.ts

@@ -174,7 +174,7 @@ export class CheckAction extends CommandLineAction {
     }
   }
 
-  protected async onExecute(): Promise<void> {
+  protected override async onExecuteAsync(): Promise<void> {
     const rushConfiguration: RushConfiguration | undefined = RushConfiguration.tryLoadFromDefaultLocation();
     if (!rushConfiguration) {
       throw new Error(

apps/lockfile-explorer/src/cli/lint/actions/InitAction.ts

@@ -25,7 +25,7 @@ export class InitAction extends CommandLineAction {
     this._terminal = parser.globalTerminal;
   }
 
-  protected async onExecute(): Promise<void> {
+  protected override async onExecuteAsync(): Promise<void> {
     const rushConfiguration: RushConfiguration | undefined = RushConfiguration.tryLoadFromDefaultLocation();
     if (!rushConfiguration) {
       throw new Error(

apps/rundown/src/cli/InspectAction.ts

@@ -25,7 +25,7 @@ export class InspectAction extends BaseReportAction {
     });
   }
 
-  protected async onExecute(): Promise<void> {
+  protected override async onExecuteAsync(): Promise<void> {
     const rundown: Rundown = new Rundown();
     await rundown.invokeAsync(
       this.scriptParameter.value,

apps/rundown/src/cli/SnapshotAction.ts

@@ -16,7 +16,7 @@ export class SnapshotAction extends BaseReportAction {
     });
   }
 
-  protected async onExecute(): Promise<void> {
+  protected override async onExecuteAsync(): Promise<void> {
     const rundown: Rundown = new Rundown();
     await rundown.invokeAsync(
       this.scriptParameter.value,

apps/trace-import/src/TraceImportCommandLineParser.ts

@@ -66,8 +66,7 @@ export class TraceImportCommandLineParser extends CommandLineParser {
     });
   }
 
-  protected async onExecute(): Promise<void> {
-    // override
+  protected override async onExecuteAsync(): Promise<void> {
     if (this._debugParameter.value) {
       InternalError.breakInDebugger = true;
     }

build-tests/api-extractor-test-05/dist/tsdoc-metadata.json

@@ -5,7 +5,7 @@
   "toolPackages": [
     {
       "packageName": "@microsoft/api-extractor",
-      "packageVersion": "7.51.1"
+      "packageVersion": "7.52.4"
     }
   ]
 }

common/changes/@microsoft/api-documenter/remove-deprecations_2025-04-21-18-08.json

@@ -0,0 +1,10 @@
+{
+  "changes": [
+    {
+      "packageName": "@microsoft/api-documenter",
+      "comment": "",
+      "type": "none"
+    }
+  ],
+  "packageName": "@microsoft/api-documenter"
+}

common/changes/@microsoft/api-extractor/remove-deprecations_2025-04-21-18-08.json

@@ -0,0 +1,10 @@
+{
+  "changes": [
+    {
+      "packageName": "@microsoft/api-extractor",
+      "comment": "",
+      "type": "none"
+    }
+  ],
+  "packageName": "@microsoft/api-extractor"
+}

common/changes/@microsoft/rush/remove-deprecations_2025-04-21-18-08.json

@@ -0,0 +1,10 @@
+{
+  "changes": [
+    {
+      "packageName": "@microsoft/rush",
+      "comment": "",
+      "type": "none"
+    }
+  ],
+  "packageName": "@microsoft/rush"
+}

common/changes/@rushstack/cpu-profile-summarizer/remove-deprecations_2025-04-21-18-08.json

@@ -0,0 +1,10 @@
+{
+  "changes": [
+    {
+      "packageName": "@rushstack/cpu-profile-summarizer",
+      "comment": "",
+      "type": "none"
+    }
+  ],
+  "packageName": "@rushstack/cpu-profile-summarizer"
+}

common/changes/@rushstack/heft/remove-deprecations_2025-04-21-02-44.json

@@ -0,0 +1,10 @@
+{
+  "changes": [
+    {
+      "packageName": "@rushstack/heft",
+      "comment": "",
+      "type": "none"
+    }
+  ],
+  "packageName": "@rushstack/heft"
+}

common/changes/@rushstack/lockfile-explorer/remove-deprecations_2025-04-21-18-08.json

@@ -0,0 +1,10 @@
+{
+  "changes": [
+    {
+      "packageName": "@rushstack/lockfile-explorer",
+      "comment": "",
+      "type": "none"
+    }
+  ],
+  "packageName": "@rushstack/lockfile-explorer"
+}

common/changes/@rushstack/node-core-library/remove-deprecations_2025-04-21-18-08.json

@@ -0,0 +1,10 @@
+{
+  "changes": [
+    {
+      "packageName": "@rushstack/node-core-library",
+      "comment": "",
+      "type": "none"
+    }
+  ],
+  "packageName": "@rushstack/node-core-library"
+}

common/changes/@rushstack/package-extractor/remove-deprecations_2025-04-21-18-08.json

@@ -0,0 +1,10 @@
+{
+  "changes": [
+    {
+      "packageName": "@rushstack/package-extractor",
+      "comment": "",
+      "type": "none"
+    }
+  ],
+  "packageName": "@rushstack/package-extractor"
+}

common/changes/@rushstack/rundown/remove-deprecations_2025-04-21-18-08.json

@@ -0,0 +1,10 @@
+{
+  "changes": [
+    {
+      "packageName": "@rushstack/rundown",
+      "comment": "",
+      "type": "none"
+    }
+  ],
+  "packageName": "@rushstack/rundown"
+}

common/changes/@rushstack/trace-import/remove-deprecations_2025-04-21-18-08.json

@@ -0,0 +1,10 @@
+{
+  "changes": [
+    {
+      "packageName": "@rushstack/trace-import",
+      "comment": "",
+      "type": "none"
+    }
+  ],
+  "packageName": "@rushstack/trace-import"
+}

common/changes/@rushstack/ts-command-line/remove-deprecations_2025-04-21-02-44.json

@@ -0,0 +1,10 @@
+{
+  "changes": [
+    {
+      "packageName": "@rushstack/ts-command-line",
+      "comment": "Remove the deprecated `onDefineParameters`, `execute`, `executeWithoutErrorHandling`, and `onDefineUnscopedParameters` functions.",
+      "type": "major"
+    }
+  ],
+  "packageName": "@rushstack/ts-command-line"
+}