[rush] Support PNPM workspaces

apps/rush-lib/package.json

@@ -41,7 +41,7 @@
     "npm-packlist": "~2.1.2",
     "read-package-tree": "~5.1.5",
     "resolve": "~1.17.0",
-    "semver": "~5.3.0",
+    "semver": "~7.3.0",
     "strict-uri-encode": "~2.0.0",
     "tar": "~5.0.5",
     "true-case-path": "~2.2.1",
@@ -64,7 +64,7 @@
     "@types/npm-packlist": "~1.1.1",
     "@types/read-package-tree": "5.1.0",
     "@types/resolve": "1.17.1",
-    "@types/semver": "5.3.33",
+    "@types/semver": "~7.2.0",
     "@types/strict-uri-encode": "2.0.0",
     "@types/tar": "4.0.3",
     "@types/wordwrap": "1.0.0",

apps/rush-lib/src/api/CommonVersionsConfiguration.ts

@@ -1,13 +1,15 @@
 // Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
 // See LICENSE in the project root for license information.
 
+import * as crypto from 'crypto';
 import * as path from 'path';
 import {
   JsonFile,
   JsonSchema,
   MapExtensions,
   ProtectableMap,
-  FileSystem
+  FileSystem,
+  Sort
 } from '@rushstack/node-core-library';
 import { PackageNameParsers } from './PackageNameParsers';
 import { JsonSchemaUrls } from '../logic/JsonSchemaUrls';
@@ -148,6 +150,18 @@ export class CommonVersionsConfiguration {
     return this._filePath;
   }
 
+  /**
+   * Get a sha1 hash of the preferred versions.
+   */
+  public get preferredVersionsHash(): string {
+    // Sort so that the hash is stable
+    const preferredVersionsToHash: Map<string, string> = new Map<string, string>(
+      this._preferredVersions.protectedView
+    );
+    Sort.sortMapKeys(preferredVersionsToHash);
+    return crypto.createHash('sha1').update(JSON.stringify(preferredVersionsToHash)).digest('hex');
+  }
+
   /**
    * Writes the "common-versions.json" file to disk, using the filename that was passed to loadFromFile().
    */

apps/rush-lib/src/api/PackageJsonEditor.ts

@@ -201,7 +201,11 @@ export class PackageJsonEditor {
       this._onChange.bind(this)
     );
 
-    if (dependencyType === DependencyType.Regular || dependencyType === DependencyType.Optional) {
+    if (
+      dependencyType === DependencyType.Regular ||
+      dependencyType === DependencyType.Optional ||
+      dependencyType === DependencyType.Peer
+    ) {
       this._dependencies.set(packageName, dependency);
     } else {
       this._devDependencies.set(packageName, dependency);

apps/rush-lib/src/api/RepoStateFile.ts

@@ -0,0 +1,91 @@
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+
+import * as path from 'path';
+import { FileSystem, JsonFile, JsonSchema } from '@rushstack/node-core-library';
+
+/**
+ * This interface represents the raw pnpm-workspace.YAML file
+ * Example:
+ *  {
+ *    "preferredVersionsHash": "..."
+ *  }
+ */
+interface IRepoStateJson {
+  /** A hash of the CommonVersionsConfiguration.preferredVersions field */
+  preferredVersionsHash?: string;
+}
+
+/**
+ * Th
+ */
+export class RepoStateFile {
+  private static _jsonSchema: JsonSchema = JsonSchema.fromFile(
+    path.join(__dirname, '../schemas/repo-state.schema.json')
+  );
+  private _repoStateFilePath: string;
+  private _preferredVersionsHash: string | undefined;
+  private _modified: boolean = false;
+
+  private constructor(repoStateJson: IRepoStateJson | undefined, filePath: string) {
+    this._repoStateFilePath = filePath;
+
+    if (repoStateJson) {
+      this._preferredVersionsHash = repoStateJson.preferredVersionsHash;
+    }
+  }
+
+  /**
+   * Get the absolute file path of the repo-state.json file.
+   */
+  public get filePath(): string {
+    return this._repoStateFilePath;
+  }
+
+  /**
+   * The hash of all preferred versions at the end of the last update.
+   */
+  public get preferredVersionsHash(): string | undefined {
+    return this._preferredVersionsHash;
+  }
+
+  public set preferredVersionsHash(hash: string | undefined) {
+    if (this._preferredVersionsHash !== hash) {
+      this._preferredVersionsHash = hash;
+      this._modified = true;
+    }
+  }
+
+  /**
+   * Loads the repo-state.json data from the specified file path.
+   * If the file has not been created yet, then an empty object is returned.
+   */
+  public static loadFromFile(jsonFilename: string): RepoStateFile {
+    let repoStateJson: IRepoStateJson | undefined = undefined;
+
+    if (FileSystem.exists(jsonFilename)) {
+      repoStateJson = JsonFile.loadAndValidate(jsonFilename, RepoStateFile._jsonSchema);
+    }
+    return new RepoStateFile(repoStateJson, jsonFilename);
+  }
+
+  /**
+   * Writes the "repo-state.json" file to disk, using the filename that was passed to loadFromFile().
+   */
+  public saveIfModified(): boolean {
+    if (this._modified) {
+      JsonFile.save(this._serialize(), this._repoStateFilePath, { updateExistingFile: true });
+      this._modified = false;
+      return true;
+    }
+
+    return false;
+  }
+
+  private _serialize(): IRepoStateJson {
+    const repoStateJson: IRepoStateJson = {
+      preferredVersionsHash: this.preferredVersionsHash
+    };
+    return repoStateJson;
+  }
+}

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

@@ -24,6 +24,7 @@ import { YarnPackageManager } from './packageManager/YarnPackageManager';
 import { PnpmPackageManager } from './packageManager/PnpmPackageManager';
 import { ExperimentsConfiguration } from './ExperimentsConfiguration';
 import { PackageNameParsers } from './PackageNameParsers';
+import { RepoStateFile } from './RepoStateFile';
 
 const MINIMUM_SUPPORTED_RUSH_JSON_VERSION: string = '0.0.0';
 const DEFAULT_BRANCH: string = 'master';
@@ -38,6 +39,7 @@ const knownRushConfigFilenames: string[] = [
   '.npmrc-publish',
   RushConstants.pinnedVersionsFilename,
   RushConstants.commonVersionsFilename,
+  RushConstants.repoStateFilename,
   RushConstants.browserApprovedPackagesFilename,
   RushConstants.nonbrowserApprovedPackagesFilename,
   RushConstants.versionPoliciesFilename,
@@ -168,6 +170,10 @@ export interface IPnpmOptionsJson extends IPackageManagerOptionsJsonBase {
    * {@inheritDoc PnpmOptionsConfiguration.preventManualShrinkwrapChanges}
    */
   preventManualShrinkwrapChanges?: boolean;
+  /**
+   * {@inheritDoc PnpmOptionsConfiguration.useWorkspaces}
+   */
+  useWorkspaces?: boolean;
 }
 
 /**
@@ -346,6 +352,14 @@ export class PnpmOptionsConfiguration extends PackageManagerOptionsConfiguration
    */
   public readonly preventManualShrinkwrapChanges: boolean;
 
+  /**
+   * If true, then Rush will use the workspaces feature to install and link packages when invoking PNPM.
+   *
+   * @remarks
+   * The default value is false.  (For now.)
+   */
+  public readonly useWorkspaces: boolean;
+
   /** @internal */
   public constructor(json: IPnpmOptionsJson, commonTempFolder: string) {
     super(json);
@@ -360,6 +374,7 @@ export class PnpmOptionsConfiguration extends PackageManagerOptionsConfiguration
     this.strictPeerDependencies = !!json.strictPeerDependencies;
     this.resolutionStrategy = json.resolutionStrategy || 'fewer-dependencies';
     this.preventManualShrinkwrapChanges = !!json.preventManualShrinkwrapChanges;
+    this.useWorkspaces = !!json.useWorkspaces;
   }
 }
 
@@ -1425,6 +1440,28 @@ export class RushConfiguration {
     return CommonVersionsConfiguration.loadFromFile(commonVersionsFilename);
   }
 
+  /**
+   * Gets the path to the repo-state.json file for a specific variant.
+   * @param variant - The name of the current variant in use by the active command.
+   */
+  public getRepoStateFilePath(variant?: string | undefined): string {
+    const repoStateFilename: string = path.join(
+      this.commonRushConfigFolder,
+      ...(variant ? [RushConstants.rushVariantsFolderName, variant] : []),
+      RushConstants.repoStateFilename
+    );
+    return repoStateFilename;
+  }
+
+  /**
+   * Gets the contents from the repo-state.json file for a specific variant.
+   * @param variant - The name of the current variant in use by the active command.
+   */
+  public getRepoState(variant?: string | undefined): RepoStateFile {
+    const repoStateFilename: string = this.getRepoStateFilePath(variant);
+    return RepoStateFile.loadFromFile(repoStateFilename);
+  }
+
   /**
    * Gets the committed shrinkwrap file name for a specific variant.
    * @param variant - The name of the current variant in use by the active command.

apps/rush-lib/src/cli/actions/AddAction.ts

@@ -10,6 +10,7 @@ import { RushConfigurationProject } from '../../api/RushConfigurationProject';
 import { BaseRushAction } from './BaseRushAction';
 import { RushCommandLineParser } from '../RushCommandLineParser';
 import { PackageJsonUpdater, SemVerStyle } from '../../logic/PackageJsonUpdater';
+import { DependencySpecifier } from '../../logic/DependencySpecifier';
 
 export class AddAction extends BaseRushAction {
   private _allFlag: CommandLineFlagParameter;
@@ -128,8 +129,11 @@ export class AddAction extends BaseRushAction {
       throw new Error(`The package name "${packageName}" is not valid.`);
     }
 
-    if (version && version !== 'latest' && !semver.validRange(version) && !semver.valid(version)) {
-      throw new Error(`The SemVer specifier "${version}" is not valid.`);
+    if (version && version !== 'latest') {
+      const specifier: DependencySpecifier = new DependencySpecifier(packageName, version);
+      if (!semver.validRange(specifier.versionSpecifier) && !semver.valid(specifier.versionSpecifier)) {
+        throw new Error(`The SemVer specifier "${version}" is not valid.`);
+      }
     }
 
     const updater: PackageJsonUpdater = new PackageJsonUpdater(this.rushConfiguration, this.rushGlobalFolder);

apps/rush-lib/src/cli/actions/BaseInstallAction.ts

@@ -12,7 +12,8 @@ import {
 
 import { BaseRushAction } from './BaseRushAction';
 import { Event } from '../../api/EventHooks';
-import { InstallManager, IInstallManagerOptions } from '../../logic/InstallManager';
+import { BaseInstallManager, IInstallManagerOptions } from '../../logic/base/BaseInstallManager';
+import { InstallManagerFactory } from '../../logic/InstallManagerFactory';
 import { PurgeManager } from '../../logic/PurgeManager';
 import { SetupChecks } from '../../logic/SetupChecks';
 import { StandardScriptUpdater } from '../../logic/StandardScriptUpdater';
@@ -117,7 +118,7 @@ export abstract class BaseInstallAction extends BaseRushAction {
 
     const installManagerOptions: IInstallManagerOptions = this.buildInstallOptions();
 
-    const installManager: InstallManager = new InstallManager(
+    const installManager: BaseInstallManager = InstallManagerFactory.getInstallManager(
       this.rushConfiguration,
       this.rushGlobalFolder,
       purgeManager,

apps/rush-lib/src/cli/actions/InstallAction.ts

@@ -2,7 +2,7 @@
 // See LICENSE in the project root for license information.
 
 import { BaseInstallAction } from './BaseInstallAction';
-import { IInstallManagerOptions } from '../../logic/InstallManager';
+import { IInstallManagerOptions } from '../../logic/base/BaseInstallManager';
 import { RushCommandLineParser } from '../RushCommandLineParser';
 
 export class InstallAction extends BaseInstallAction {

apps/rush-lib/src/cli/actions/UpdateAction.ts

@@ -4,7 +4,7 @@
 import { CommandLineFlagParameter } from '@rushstack/ts-command-line';
 
 import { BaseInstallAction } from './BaseInstallAction';
-import { IInstallManagerOptions } from '../../logic/InstallManager';
+import { IInstallManagerOptions } from '../../logic/base/BaseInstallManager';
 import { RushCommandLineParser } from '../RushCommandLineParser';
 
 export class UpdateAction extends BaseInstallAction {

apps/rush-lib/src/cli/actions/VersionAction.ts

@@ -154,10 +154,16 @@ export class VersionAction extends BaseRushAction {
         const newPolicyVersion: semver.SemVer = new semver.SemVer(policy.version);
         if (newPolicyVersion.prerelease.length) {
           // Update 1.5.0-alpha.10 to 1.5.0-beta.10
-          newPolicyVersion.prerelease[0] = this._prereleaseIdentifier.value;
+          // For example, if we are parsing "1.5.0-alpha.10" then the newPolicyVersion.prerelease array
+          // would contain [ "alpha", 10 ], so we would replace "alpha" with "beta"
+          newPolicyVersion.prerelease = [
+            this._prereleaseIdentifier.value,
+            ...newPolicyVersion.prerelease.slice(1)
+          ];
         } else {
           // Update 1.5.0 to 1.5.0-beta
-          newPolicyVersion.prerelease.push(this._prereleaseIdentifier.value);
+          // Since there is no length, we can just set to a new array
+          newPolicyVersion.prerelease = [this._prereleaseIdentifier.value];
         }
         newVersion = newPolicyVersion.format();
       }

apps/rush-lib/src/cli/scriptActions/GlobalScriptAction.ts

@@ -9,7 +9,7 @@ import { BaseScriptAction, IBaseScriptActionOptions } from './BaseScriptAction';
 import { Utilities } from '../../utilities/Utilities';
 import { AlreadyReportedError } from '../../utilities/AlreadyReportedError';
 import { FileSystem, LockFile, IPackageJson, JsonFile, PackageName } from '@rushstack/node-core-library';
-import { InstallHelpers } from '../../logic/InstallHelpers';
+import { InstallHelpers } from '../../logic/installManager/InstallHelpers';
 import { RushConstants } from '../../logic/RushConstants';
 import { LastInstallFlag } from '../../api/LastInstallFlag';
 

apps/rush-lib/src/logic/DependencySpecifier.ts

@@ -32,6 +32,7 @@ export class DependencySpecifier {
    * directory - A local directory
    * remote - An HTTP url to a .tar.gz, .tar or .tgz file
    * alias - A package alias such as "npm:other-package@^1.2.3"
+   * workspace - A package specified using workspace protocol such as "workspace:^1.2.3"
    */
   public readonly specifierType: string;
 
@@ -46,6 +47,15 @@ export class DependencySpecifier {
     this.packageName = packageName;
     this.versionSpecifier = versionSpecifier;
 
+    // Workspace ranges are a feature from PNPM and Yarn. Set the version specifier
+    // to the trimmed version range.
+    if (versionSpecifier.startsWith('workspace:')) {
+      this.specifierType = 'workspace';
+      this.versionSpecifier = versionSpecifier.slice(this.specifierType.length + 1).trim();
+      this.aliasTarget = undefined;
+      return;
+    }
+
     const result: npmPackageArg.AliasResult = npmPackageArg.resolve(
       packageName,
       versionSpecifier