bun package manager test

apps/lockfile-explorer/README.md

@@ -33,7 +33,7 @@ Here's how to invoke the **Rush Lockfile Explorer** tool:
 ```bash
 # Install the NPM package globally.
 #
-# (You could substitute "pnpm" or "yarn" instead of "npm" here.  To avoid confusing
+# (You could substitute "bun" or "pnpm" or "yarn" instead of "npm" here.  To avoid confusing
 # duplicate installs, always use the same tool for global installations!)
 npm install -g @rushstack/lockfile-explorer
 

apps/rush/README.md

@@ -13,7 +13,7 @@
 
 - **A single NPM install:** In one step, Rush installs all the dependencies for all your projects into a common folder.  This is not just a "package.json" file at the root of your repo (which might set you up to accidentally `require()` a sibling's dependencies).  Instead, Rush uses symlinks to reconstruct an accurate "node_modules" folder for each project, without any of the limitations or glitches that seem to plague other approaches.
 
-  ⏵ **This algorithm supports the [PNPM, NPM, and Yarn](https://rushjs.io/pages/maintainer/package_managers/) package managers.**
+  ⏵ **This algorithm supports the [Bun, PNPM, NPM, and Yarn](https://rushjs.io/pages/maintainer/package_managers/) package managers.**
 
 - **Automatic local linking:** Inside a Rush repo, all your projects are automatically symlinked to each other. When you make a change, you can see the downstream effects without publishing anything, and without any `npm link` headaches.  If you don't want certain projects to get linked, that's supported, too.
 

apps/rush/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@microsoft/rush",
-  "version": "5.106.0",
+  "version": "5.106.0-bun",
   "description": "A professional solution for consolidating all your JavaScript projects in one Git repo",
   "keywords": [
     "install",

common/reviews/api/rush-lib.api.md

@@ -84,6 +84,13 @@ export enum BumpType {
     'prerelease' = 1
 }
 
+// @public
+export class BunOptionsConfiguration extends PackageManagerOptionsConfigurationBase {
+    // @internal
+    constructor(json: _IBunOptionsJson);
+    readonly useWorkspaces: boolean;
+}
+
 // @public
 export class ChangeManager {
     static createEmptyChangeFiles(rushConfiguration: RushConfiguration, projectName: string, emailAddress: string): string | undefined;
@@ -310,6 +317,11 @@ export interface _IBuiltInPluginConfiguration extends _IRushPluginConfigurationB
     pluginPackageFolder: string;
 }
 
+// @internal
+export interface _IBunOptionsJson extends IPackageManagerOptionsJsonBase {
+    useWorkspaces?: boolean;
+}
+
 // @beta (undocumented)
 export interface ICloudBuildCacheProvider {
     // (undocumented)
@@ -934,7 +946,7 @@ export abstract class PackageManager {
 }
 
 // @public
-export type PackageManagerName = 'pnpm' | 'npm' | 'yarn';
+export type PackageManagerName = 'pnpm' | 'npm' | 'yarn' | 'bun';
 
 // @public
 export abstract class PackageManagerOptionsConfigurationBase implements IPackageManagerOptionsJsonBase {
@@ -1035,6 +1047,8 @@ export class Rush {
 export class RushConfiguration {
     readonly allowMostlyStandardPackageNames: boolean;
     readonly approvedPackagesPolicy: ApprovedPackagesPolicy;
+    readonly bunCacheFolder: string;
+    readonly bunOptions: BunOptionsConfiguration;
     readonly changesFolder: string;
     // @deprecated
     get committedShrinkwrapFilename(): string;
@@ -1179,6 +1193,7 @@ export class RushConstants {
     static readonly buildCacheVersion: number;
     static readonly buildCommandName: string;
     static readonly bulkCommandKind: 'bulk';
+    static readonly bunShrinkwrapFilename: string;
     static readonly bypassPolicyFlagLongName: '--bypass-policy';
     static readonly changeFilesFolderName: string;
     static readonly cobuildFilename: string;

libraries/rush-lib/assets/rush-init/[dot]gitattributes

@@ -4,6 +4,7 @@ pnpm-lock.yaml               merge=text
 shrinkwrap.yaml              merge=binary
 npm-shrinkwrap.json          merge=binary
 yarn.lock                    merge=binary
+*.lockb                      merge=binary diff=lockb
 
 # Rush's JSON config files use JavaScript-style code comments.  The rule below prevents pedantic
 # syntax highlighters such as GitHub's from highlighting these comments as errors.  Your text editor

libraries/rush-lib/assets/rush-init/common/config/rush/bunfig.toml

@@ -0,0 +1,3 @@
+[install]
+# set default registry as a string
+registry = "https://registry.npmjs.org"

libraries/rush-lib/assets/rush-init/rush.json

@@ -23,13 +23,14 @@
    * Rush installs its own local copy of the package manager to ensure that your build process
    * is fully isolated from whatever tools are present in the local environment.
    *
-   * Specify one of: "pnpmVersion", "npmVersion", or "yarnVersion".  See the Rush documentation
+   * Specify one of: "bunVersion", "pnpmVersion", "npmVersion", or "yarnVersion".  See the Rush documentation
    * for details about these alternatives.
    */
   "pnpmVersion": "7.33.5",
 
   /*[LINE "HYPOTHETICAL"]*/ "npmVersion": "6.14.15",
   /*[LINE "HYPOTHETICAL"]*/ "yarnVersion": "1.9.4",
+  /*[LINE "HYPOTHETICAL"]*/ "bunVersion": "1.9.4",
 
   /**
    * Older releases of the Node.js engine may be missing features required by your system.

libraries/rush-lib/src/api/RushConfiguration.ts

@@ -29,6 +29,7 @@ import { PackageManagerName, PackageManager } from './packageManager/PackageMana
 import { NpmPackageManager } from './packageManager/NpmPackageManager';
 import { YarnPackageManager } from './packageManager/YarnPackageManager';
 import { PnpmPackageManager } from './packageManager/PnpmPackageManager';
+import { BunPackageManager } from './packageManager/BunPackageManager';
 import { ExperimentsConfiguration } from './ExperimentsConfiguration';
 import { PackageNameParsers } from './PackageNameParsers';
 import { RepoStateFile } from '../logic/RepoStateFile';
@@ -37,6 +38,7 @@ import { RushPluginsConfiguration } from './RushPluginsConfiguration';
 import { IPnpmOptionsJson, PnpmOptionsConfiguration } from '../logic/pnpm/PnpmOptionsConfiguration';
 import { INpmOptionsJson, NpmOptionsConfiguration } from '../logic/npm/NpmOptionsConfiguration';
 import { IYarnOptionsJson, YarnOptionsConfiguration } from '../logic/yarn/YarnOptionsConfiguration';
+import { IBunOptionsJson, BunOptionsConfiguration } from '../logic/bun/BunOptionsConfiguration';
 import schemaJson from '../schemas/rush.schema.json';
 
 import type * as DependencyAnalyzerModuleType from '../logic/DependencyAnalyzer';
@@ -157,6 +159,7 @@ export interface IRushConfigurationJson {
   npmVersion?: string;
   pnpmVersion?: string;
   yarnVersion?: string;
+  bunVersion?: string;
   rushVersion: string;
   repository?: IRushRepositoryJson;
   nodeSupportedVersionRange?: string;
@@ -175,6 +178,7 @@ export interface IRushConfigurationJson {
   npmOptions?: INpmOptionsJson;
   pnpmOptions?: IPnpmOptionsJson;
   yarnOptions?: IYarnOptionsJson;
+  bunOptions?: IBunOptionsJson;
   ensureConsistentVersions?: boolean;
   variants?: IRushVariantOptionsJson[];
 }
@@ -320,6 +324,13 @@ export class RushConfiguration {
    */
   public readonly yarnCacheFolder: string;
 
+  /**
+   * The local folder that will store the Bun package cache.
+   *
+   * Example: `C:\MyRepo\common\temp\bun-cache`
+   */
+  public readonly bunCacheFolder: string;
+
   /**
    * The filename (without any path) of the shrinkwrap file that is used by the package manager.
    * @remarks
@@ -509,11 +520,17 @@ export class RushConfiguration {
    */
   public readonly yarnOptions: YarnOptionsConfiguration;
 
+  /**
+   * {@inheritDoc YarnOptionsConfiguration}
+   */
+  public readonly bunOptions: BunOptionsConfiguration;
+
   /**
    * The configuration options used by the current package manager.
    * @remarks
    * For package manager specific variants, reference {@link RushConfiguration.npmOptions | npmOptions},
-   * {@link RushConfiguration.pnpmOptions | pnpmOptions}, or {@link RushConfiguration.yarnOptions | yarnOptions}.
+   * {@link RushConfiguration.pnpmOptions | pnpmOptions}, or {@link RushConfiguration.yarnOptions | yarnOptions}
+   * or {@link RushConfiguration.bunOptions | bunOptions}.
    */
   public readonly packageManagerOptions!: PackageManagerOptionsConfigurationBase;
 
@@ -612,6 +629,7 @@ export class RushConfiguration {
     this.npmCacheFolder = path.resolve(path.join(this.commonTempFolder, 'npm-cache'));
     this.npmTmpFolder = path.resolve(path.join(this.commonTempFolder, 'npm-tmp'));
     this.yarnCacheFolder = path.resolve(path.join(this.commonTempFolder, 'yarn-cache'));
+    this.bunCacheFolder = path.resolve(path.join(this.commonTempFolder, 'bun-cache'));
 
     this.changesFolder = path.join(this.commonFolder, RushConstants.changeFilesFolderName);
 
@@ -635,6 +653,7 @@ export class RushConfiguration {
 
     this.npmOptions = new NpmOptionsConfiguration(rushConfigurationJson.npmOptions || {});
     this.yarnOptions = new YarnOptionsConfiguration(rushConfigurationJson.yarnOptions || {});
+    this.bunOptions = new BunOptionsConfiguration(rushConfigurationJson.bunOptions || {});
     try {
       this.pnpmOptions = PnpmOptionsConfiguration.loadFromJsonFileOrThrow(
         `${this.commonRushConfigFolder}/${RushConstants.pnpmConfigFilename}`,
@@ -675,6 +694,11 @@ export class RushConfiguration {
       this.packageManagerOptions = this.yarnOptions;
       packageManagerFields.push('yarnVersion');
     }
+    if (rushConfigurationJson.bunVersion) {
+      this.packageManager = 'bun';
+      this.packageManagerOptions = this.bunOptions;
+      packageManagerFields.push('bunVersion');
+    }
 
     if (packageManagerFields.length === 0) {
       throw new Error(
@@ -695,6 +719,9 @@ export class RushConfiguration {
     } else if (this.packageManager === 'pnpm') {
       this.packageManagerToolVersion = rushConfigurationJson.pnpmVersion!;
       this.packageManagerWrapper = new PnpmPackageManager(this.packageManagerToolVersion);
+    } else if (this.packageManager === 'bun') {
+      this.packageManagerToolVersion = rushConfigurationJson.bunVersion!;
+      this.packageManagerWrapper = new BunPackageManager(this.packageManagerToolVersion);
     } else {
       this.packageManagerToolVersion = rushConfigurationJson.yarnVersion!;
       this.packageManagerWrapper = new YarnPackageManager(this.packageManagerToolVersion);

libraries/rush-lib/src/api/packageManager/BunPackageManager.ts

@@ -0,0 +1,15 @@
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+
+import { RushConstants } from '../../logic/RushConstants';
+import { PackageManager } from './PackageManager';
+
+/**
+ * Support for interacting with the Bun package manager.
+ */
+export class BunPackageManager extends PackageManager {
+  /** @internal */
+  public constructor(version: string) {
+    super(version, 'bun', RushConstants.bunShrinkwrapFilename);
+  }
+}

libraries/rush-lib/src/api/packageManager/PackageManager.ts

@@ -5,10 +5,10 @@
  * This represents the available Package Manager tools as a string
  * @public
  */
-export type PackageManagerName = 'pnpm' | 'npm' | 'yarn';
+export type PackageManagerName = 'pnpm' | 'npm' | 'yarn' | 'bun';
 
 /**
- * An abstraction for controlling the supported package managers: PNPM, NPM, and Yarn.
+ * An abstraction for controlling the supported package managers: PNPM, NPM, Bun, and Yarn.
  * @public
  */
 export abstract class PackageManager {

libraries/rush-lib/src/index.ts

@@ -24,6 +24,10 @@ export {
   IYarnOptionsJson as _IYarnOptionsJson,
   YarnOptionsConfiguration
 } from './logic/yarn/YarnOptionsConfiguration';
+export {
+  IBunOptionsJson as _IBunOptionsJson,
+  BunOptionsConfiguration
+} from './logic/bun/BunOptionsConfiguration';
 export {
   IPnpmOptionsJson as _IPnpmOptionsJson,
   PnpmStoreLocation,

libraries/rush-lib/src/logic/InstallManagerFactory.ts

@@ -24,6 +24,10 @@ export class InstallManagerFactory {
       return new WorkspaceInstallManager(rushConfiguration, rushGlobalFolder, purgeManager, options);
     }
 
+    if (rushConfiguration.packageManager === 'bun' && rushConfiguration.bunOptions?.useWorkspaces) {
+      return new WorkspaceInstallManager(rushConfiguration, rushGlobalFolder, purgeManager, options);
+    }
+
     const rushInstallManagerModule: typeof import('./installManager/RushInstallManager') = await import(
       /* webpackChunkName: 'RushInstallManager' */
       './installManager/RushInstallManager'

libraries/rush-lib/src/logic/LinkManagerFactory.ts

@@ -16,6 +16,9 @@ export class LinkManagerFactory {
       case 'yarn':
         // Yarn uses the same node_modules structure as NPM
         return new NpmLinkManager(rushConfiguration);
+      case 'bun':
+        // Bun uses the same node_modules structure as NPM
+        return new NpmLinkManager(rushConfiguration);
       default:
         throw new Error(`Unsupported package manager: ${rushConfiguration.packageManager}`);
     }

libraries/rush-lib/src/logic/PackageJsonUpdater.ts

@@ -716,6 +716,10 @@ export class PackageJsonUpdater {
         let commandArgs: string[];
         if (this._rushConfiguration.packageManager === 'yarn') {
           commandArgs = ['info', packageName, 'dist-tags.latest', '--silent'];
+        }
+        if (this._rushConfiguration.packageManager === 'bun') {
+          // npm needs to be installed
+          commandArgs = ['run', 'npm', 'view', `${packageName}@latest`, 'version'];
         } else {
           commandArgs = ['view', `${packageName}@latest`, 'version'];
         }

libraries/rush-lib/src/logic/RushConstants.ts

@@ -70,6 +70,11 @@ export class RushConstants {
    */
   public static readonly npmShrinkwrapFilename: string = 'npm-shrinkwrap.json';
 
+  /**
+   * The filename ("bun.lockb") used to store an installation plan for the NPM package manger.
+   */
+  public static readonly bunShrinkwrapFilename: string = 'bun.lockb';
+
   /**
    * Number of installation attempts
    */

libraries/rush-lib/src/logic/ShrinkwrapFileFactory.ts

@@ -7,6 +7,7 @@ import { BaseShrinkwrapFile } from './base/BaseShrinkwrapFile';
 import { NpmShrinkwrapFile } from './npm/NpmShrinkwrapFile';
 import { PnpmShrinkwrapFile } from './pnpm/PnpmShrinkwrapFile';
 import { YarnShrinkwrapFile } from './yarn/YarnShrinkwrapFile';
+import { BunShrinkwrapFile } from './bun/BunShrinkwrapFile';
 
 export class ShrinkwrapFileFactory {
   public static getShrinkwrapFile(
@@ -21,6 +22,8 @@ export class ShrinkwrapFileFactory {
         return PnpmShrinkwrapFile.loadFromFile(shrinkwrapFilename);
       case 'yarn':
         return YarnShrinkwrapFile.loadFromFile(shrinkwrapFilename);
+      case 'bun':
+        return BunShrinkwrapFile.loadFromFile(shrinkwrapFilename);
       default:
         throw new Error(`Invalid package manager: ${packageManager}`);
     }
@@ -36,8 +39,8 @@ export class ShrinkwrapFileFactory {
         return NpmShrinkwrapFile.loadFromString(shrinkwrapContent);
       case 'pnpm':
         return PnpmShrinkwrapFile.loadFromString(shrinkwrapContent);
-      case 'yarn':
-        return YarnShrinkwrapFile.loadFromString(shrinkwrapContent);
+      case 'bun':
+        return BunShrinkwrapFile.loadFromString(shrinkwrapContent);
       default:
         throw new Error(`Invalid package manager: ${packageManager}`);
     }

libraries/rush-lib/src/logic/base/BaseInstallManager.ts

@@ -520,7 +520,9 @@ ${gitLfsHookHandling}
    * to the command-line.
    */
   protected pushConfigurationArgs(args: string[], options: IInstallManagerOptions): void {
-    if (this.rushConfiguration.packageManager === 'npm') {
+    if (this.rushConfiguration.packageManager === 'bun') {
+      args.push('--cache-dir', this.rushConfiguration.bunCacheFolder);
+    } else if (this.rushConfiguration.packageManager === 'npm') {
       if (semver.lt(this.rushConfiguration.packageManagerToolVersion, '5.0.0')) {
         // NOTE:
         //

libraries/rush-lib/src/logic/base/BasePackage.ts

@@ -45,6 +45,8 @@ export interface IRushTempPackageJson extends IPackageJson {
    * references to locally built projects.
    */
   rushDependencies?: { [key: string]: string };
+
+  workspaces?: string[];
 }
 
 /**

libraries/rush-lib/src/logic/bun/BunOptionsConfiguration.ts

@@ -0,0 +1,43 @@
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+
+import {
+  IPackageManagerOptionsJsonBase,
+  PackageManagerOptionsConfigurationBase
+} from '../base/BasePackageManagerOptionsConfiguration';
+
+/**
+ * Part of IRushConfigurationJson.
+ * @internal
+ */
+export interface IBunOptionsJson extends IPackageManagerOptionsJsonBase {
+  /**
+   * {@inheritDoc BunOptionsConfiguration.useWorkspaces}
+   */
+  useWorkspaces?: boolean;
+}
+
+/**
+ * Options that are only used when the bun package manager is selected.
+ *
+ * @remarks
+ * It is valid to define these options in rush.json even if the bun package manager
+ * is not being used.
+ *
+ * @public
+ */
+export class BunOptionsConfiguration extends PackageManagerOptionsConfigurationBase {
+  /**
+   * If true, then Rush will use the workspaces feature to install and link packages when invoking PNPM.
+   *
+   * @remarks
+   * The default value is true.  (For now.)
+   */
+  public readonly useWorkspaces: boolean;
+
+  /** @internal */
+  public constructor(json: IBunOptionsJson) {
+    super(json);
+    this.useWorkspaces = !!json.useWorkspaces;
+  }
+}