Introduce a Heft SWC plugin. (#5149)

* Introduce a Heft SWC plugin.

* Updates from testing repo.

* Refactor tsconfig loading.

* Remove an unused module.

* fixup! Refactor tsconfig loading.

* fixup! Introduce a Heft SWC plugin.

* fixup! Introduce a Heft SWC plugin.

* Introduce an accessor for tweaking the SWC options.

* Rename heft-isolated-transpile-plugin to heft-isolated-typescript-transpile-plugin.

* fixup! Rename heft-isolated-transpile-plugin to heft-isolated-typescript-transpile-plugin.

* Convert to using child_process.

* Add a 'numberOfCores' property to 'HeftConfiguration'

* fixup! Introduce a Heft SWC plugin.

* fixup! Add a 'numberOfCores' property to 'HeftConfiguration'

* Include missing package.json properties.

* Remove a ts-ignore

Author: iclanton

README.md

@@ -194,6 +194,7 @@ These GitHub repositories provide supplementary resources for Rush Stack:
 | [/build-tests/rush-redis-cobuild-plugin-integration-test](./build-tests/rush-redis-cobuild-plugin-integration-test/) | Tests connecting to an redis server |
 | [/build-tests/set-webpack-public-path-plugin-test](./build-tests/set-webpack-public-path-plugin-test/) | Building this project tests the set-webpack-public-path-plugin |
 | [/eslint/local-eslint-config](./eslint/local-eslint-config/) | An ESLint configuration consumed projects inside the rushstack repo. |
+| [/heft-plugins/heft-isolated-typescript-transpile-plugin](./heft-plugins/heft-isolated-typescript-transpile-plugin/) | Heft plugin for transpiling TypeScript with SWC |
 | [/libraries/rush-themed-ui](./libraries/rush-themed-ui/) | Rush Component Library: a set of themed components for rush projects |
 | [/libraries/rushell](./libraries/rushell/) | Execute shell commands using a consistent syntax on every platform |
 | [/repo-scripts/doc-plugin-rush-stack](./repo-scripts/doc-plugin-rush-stack/) | API Documenter plugin used with the rushstack.io website |

apps/heft/src/cli/HeftActionRunner.ts

@@ -188,14 +188,16 @@ export class HeftActionRunner {
   private readonly _parallelism: number;
 
   public constructor(options: IHeftActionRunnerOptions) {
-    this._action = options.action;
-    this._internalHeftSession = options.internalHeftSession;
-    this._heftConfiguration = options.heftConfiguration;
-    this._loggingManager = options.loggingManager;
-    this._terminal = options.terminal;
-    this._metricsCollector = options.metricsCollector;
-
-    const numberOfCores: number = os.availableParallelism?.() ?? os.cpus().length;
+    const { action, internalHeftSession, heftConfiguration, loggingManager, terminal, metricsCollector } =
+      options;
+    this._action = action;
+    this._internalHeftSession = internalHeftSession;
+    this._heftConfiguration = heftConfiguration;
+    this._loggingManager = loggingManager;
+    this._terminal = terminal;
+    this._metricsCollector = metricsCollector;
+
+    const numberOfCores: number = heftConfiguration.numberOfCores;
 
     // If an explicit parallelism number wasn't provided, then choose a sensible
     // default.

apps/heft/src/cli/HeftCommandLineParser.ts

@@ -1,6 +1,7 @@
 // Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
 // See LICENSE in the project root for license information.
 
+import os from 'node:os';
 import {
   CommandLineParser,
   type AliasCommandLineAction,
@@ -87,9 +88,11 @@ export class HeftCommandLineParser extends CommandLineParser {
       InternalError.breakInDebugger = true;
     }
 
+    const numberOfCores: number = os.availableParallelism?.() ?? os.cpus().length;
     this._heftConfiguration = HeftConfiguration.initialize({
       cwd: process.cwd(),
-      terminalProvider: this._terminalProvider
+      terminalProvider: this._terminalProvider,
+      numberOfCores
     });
 
     this._metricsCollector = new MetricsCollector();

apps/heft/src/configuration/HeftConfiguration.ts

@@ -22,27 +22,31 @@ export interface IHeftConfigurationInitializationOptions {
    * Terminal instance to facilitate logging.
    */
   terminalProvider: ITerminalProvider;
+
+  /**
+   * The number of CPU cores available to the process. This is used to determine how many tasks can be run in parallel.
+   */
+  numberOfCores: number;
+}
+
+interface IHeftConfigurationOptions extends IHeftConfigurationInitializationOptions {
+  buildFolderPath: string;
 }
 
 /**
  * @public
  */
 export class HeftConfiguration {
-  private _buildFolderPath!: string;
   private _slashNormalizedBuildFolderPath: string | undefined;
   private _projectConfigFolderPath: string | undefined;
   private _tempFolderPath: string | undefined;
   private _rigConfig: IRigConfig | undefined;
-  private _globalTerminal!: Terminal;
-  private _terminalProvider!: ITerminalProvider;
-  private _rigPackageResolver!: RigPackageResolver;
+  private _rigPackageResolver: RigPackageResolver | undefined;
 
   /**
    * Project build folder path. This is the folder containing the project's package.json file.
    */
-  public get buildFolderPath(): string {
-    return this._buildFolderPath;
-  }
+  public readonly buildFolderPath: string;
 
   /**
    * {@link HeftConfiguration.buildFolderPath} with all path separators converted to forward slashes.
@@ -75,7 +79,7 @@ export class HeftConfiguration {
    */
   public get tempFolderPath(): string {
     if (!this._tempFolderPath) {
-      this._tempFolderPath = path.join(this._buildFolderPath, Constants.tempFolderName);
+      this._tempFolderPath = path.join(this.buildFolderPath, Constants.tempFolderName);
     }
 
     return this._tempFolderPath;
@@ -104,22 +108,19 @@ export class HeftConfiguration {
         rigConfig: this.rigConfig
       });
     }
+
     return this._rigPackageResolver;
   }
 
   /**
    * Terminal instance to facilitate logging.
    */
-  public get globalTerminal(): ITerminal {
-    return this._globalTerminal;
-  }
+  public readonly globalTerminal: ITerminal;
 
   /**
    * Terminal provider for the provided terminal.
    */
-  public get terminalProvider(): ITerminalProvider {
-    return this._terminalProvider;
-  }
+  public readonly terminalProvider: ITerminalProvider;
 
   /**
    * The Heft tool's package.json
@@ -135,7 +136,18 @@ export class HeftConfiguration {
     return PackageJsonLookup.instance.tryLoadPackageJsonFor(this.buildFolderPath)!;
   }
 
-  private constructor() {}
+  /**
+   * The number of CPU cores available to the process. This can be used to determine how many tasks can be run
+   * in parallel.
+   */
+  public readonly numberOfCores: number;
+
+  private constructor({ terminalProvider, buildFolderPath, numberOfCores }: IHeftConfigurationOptions) {
+    this.buildFolderPath = buildFolderPath;
+    this.terminalProvider = terminalProvider;
+    this.numberOfCores = numberOfCores;
+    this.globalTerminal = new Terminal(terminalProvider);
+  }
 
   /**
    * Performs the search for rig.json and initializes the `HeftConfiguration.rigConfig` object.
@@ -144,7 +156,7 @@ export class HeftConfiguration {
   public async _checkForRigAsync(): Promise<void> {
     if (!this._rigConfig) {
       this._rigConfig = await RigConfig.loadForProjectFolderAsync({
-        projectFolderPath: this._buildFolderPath
+        projectFolderPath: this.buildFolderPath
       });
     }
   }
@@ -153,26 +165,26 @@ export class HeftConfiguration {
    * @internal
    */
   public static initialize(options: IHeftConfigurationInitializationOptions): HeftConfiguration {
-    const configuration: HeftConfiguration = new HeftConfiguration();
-
     const packageJsonPath: string | undefined = PackageJsonLookup.instance.tryGetPackageJsonFilePathFor(
       options.cwd
     );
+    let buildFolderPath: string;
     if (packageJsonPath) {
-      let buildFolderPath: string = path.dirname(packageJsonPath);
+      buildFolderPath = path.dirname(packageJsonPath);
       // On Windows it is possible for the drive letter in the CWD to be lowercase, but the normalized naming is uppercase
       // Force it to always be uppercase for consistency.
       buildFolderPath =
         process.platform === 'win32'
           ? buildFolderPath.charAt(0).toUpperCase() + buildFolderPath.slice(1)
           : buildFolderPath;
-      configuration._buildFolderPath = buildFolderPath;
     } else {
       throw new Error('No package.json file found. Are you in a project folder?');
     }
 
-    configuration._terminalProvider = options.terminalProvider;
-    configuration._globalTerminal = new Terminal(options.terminalProvider);
+    const configuration: HeftConfiguration = new HeftConfiguration({
+      ...options,
+      buildFolderPath
+    });
     return configuration;
   }
 }

common/changes/@rushstack/heft-isolated-typescript-transpile-plugin/main_2025-03-06-00-32.json

@@ -0,0 +1,10 @@
+{
+  "changes": [
+    {
+      "packageName": "@rushstack/heft-isolated-typescript-transpile-plugin",
+      "comment": "Initial release.",
+      "type": "minor"
+    }
+  ],
+  "packageName": "@rushstack/heft-isolated-typescript-transpile-plugin"
+}

common/changes/@rushstack/heft-typescript-plugin/swc-plugin_2025-03-06-20-09.json

@@ -0,0 +1,10 @@
+{
+  "changes": [
+    {
+      "packageName": "@rushstack/heft-typescript-plugin",
+      "comment": "Expose some internal APIs to be used by `@rushstack/heft-isolated-typescript-transpile-plugin`.",
+      "type": "minor"
+    }
+  ],
+  "packageName": "@rushstack/heft-typescript-plugin"
+}

common/changes/@rushstack/heft/swc-plugin_2025-03-10-23-30.json

@@ -0,0 +1,10 @@
+{
+  "changes": [
+    {
+      "packageName": "@rushstack/heft",
+      "comment": "Add a `numberOfCores` property to `HeftConfiguration`.",
+      "type": "minor"
+    }
+  ],
+  "packageName": "@rushstack/heft"
+}

common/config/rush/nonbrowser-approved-packages.json

@@ -366,6 +366,10 @@
       "name": "@storybook/theming",
       "allowedCategories": [ "tests" ]
     },
+    {
+      "name": "@swc/core",
+      "allowedCategories": [ "libraries" ]
+    },
     {
       "name": "@tsconfig/node14",
       "allowedCategories": [ "tests" ]