Merge pull request #1360 from MasterLambaster/yarn-resolutions

[rush] Copy resolutions section from source package.json for yarn

apps/rundown/bin/rundown

@@ -1,2 +1,2 @@
 #!/usr/bin/env node
-require('../lib/start.js')
+require('../lib/start.js');

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

@@ -2,7 +2,7 @@
 // See LICENSE in the project root for license information.
 
 import * as semver from 'semver';
-import { Import, IPackageJson, JsonFile, Sort } from '@rushstack/node-core-library';
+import { Import, InternalError, IPackageJson, JsonFile, Sort } from '@rushstack/node-core-library';
 
 const lodash: typeof import('lodash') = Import.lazy('lodash', require);
 
@@ -13,7 +13,8 @@ export const enum DependencyType {
   Regular = 'dependencies',
   Dev = 'devDependencies',
   Optional = 'optionalDependencies',
-  Peer = 'peerDependencies'
+  Peer = 'peerDependencies',
+  YarnResolutions = 'resolutions'
 }
 
 /**
@@ -65,6 +66,9 @@ export class PackageJsonEditor {
   // and "peerDependencies" are mutually exclusive, but "devDependencies" is not.
   private readonly _devDependencies: Map<string, PackageJsonDependency>;
 
+  // NOTE: The "resolutions" field is a yarn specific feature that controls package
+  // resolution override within yarn.
+  private readonly _resolutions: Map<string, PackageJsonDependency>;
   private _modified: boolean;
   private _sourceData: IPackageJson;
 
@@ -75,12 +79,14 @@ export class PackageJsonEditor {
 
     this._dependencies = new Map<string, PackageJsonDependency>();
     this._devDependencies = new Map<string, PackageJsonDependency>();
+    this._resolutions = new Map<string, PackageJsonDependency>();
 
     const dependencies: { [key: string]: string } = data.dependencies || {};
     const optionalDependencies: { [key: string]: string } = data.optionalDependencies || {};
     const peerDependencies: { [key: string]: string } = data.peerDependencies || {};
 
     const devDependencies: { [key: string]: string } = data.devDependencies || {};
+    const resolutions: { [key: string]: string } = data.resolutions || {};
 
     const _onChange: () => void = this._onChange.bind(this);
 
@@ -141,6 +147,19 @@ export class PackageJsonEditor {
         );
       });
 
+      Object.keys(resolutions || {}).forEach((packageName: string) => {
+        this._resolutions.set(
+          packageName,
+          new PackageJsonDependency(
+            packageName,
+            resolutions[packageName],
+            DependencyType.YarnResolutions,
+            _onChange
+          )
+        );
+      });
+
+      // (Do not sort this._resolutions because order may be significant; the RFC is unclear about that.)
       Sort.sortMapKeys(this._dependencies);
       Sort.sortMapKeys(this._devDependencies);
     } catch (e) {
@@ -182,6 +201,17 @@ export class PackageJsonEditor {
     return [...this._devDependencies.values()];
   }
 
+  /**
+   * This field is a Yarn-specific feature that allows overriding of package resolution.
+   *
+   * @remarks
+   * See the {@link https://github.com/yarnpkg/rfcs/blob/master/implemented/0000-selective-versions-resolutions.md
+   * | 0000-selective-versions-resolutions.md RFC} for details.
+   */
+  public get resolutionsList(): ReadonlyArray<PackageJsonDependency> {
+    return [...this._resolutions.values()];
+  }
+
   public tryGetDependency(packageName: string): PackageJsonDependency | undefined {
     return this._dependencies.get(packageName);
   }
@@ -203,16 +233,23 @@ export class PackageJsonEditor {
     );
 
     // Rush collapses everything that isn't a devDependency into the dependencies
-    // field, so we need to set the value dependening on dependency type
-    if (
-      dependencyType === DependencyType.Regular ||
-      dependencyType === DependencyType.Optional ||
-      dependencyType === DependencyType.Peer
-    ) {
-      this._dependencies.set(packageName, dependency);
-    } else {
-      this._devDependencies.set(packageName, dependency);
+    // field, so we need to set the value depending on dependency type
+    switch (dependencyType) {
+      case DependencyType.Regular:
+      case DependencyType.Optional:
+      case DependencyType.Peer:
+        this._dependencies.set(packageName, dependency);
+        break;
+      case DependencyType.Dev:
+        this._devDependencies.set(packageName, dependency);
+        break;
+      case DependencyType.YarnResolutions:
+        this._resolutions.set(packageName, dependency);
+        break;
+      default:
+        throw new InternalError('Unsupported DependencyType');
     }
+
     this._modified = true;
   }
 
@@ -255,31 +292,36 @@ export class PackageJsonEditor {
     delete normalizedData.optionalDependencies;
     delete normalizedData.peerDependencies;
     delete normalizedData.devDependencies;
+    delete normalizedData.resolutions;
 
     const keys: string[] = [...this._dependencies.keys()].sort();
 
     for (const packageName of keys) {
       const dependency: PackageJsonDependency = this._dependencies.get(packageName)!;
 
-      if (dependency.dependencyType === DependencyType.Regular) {
-        if (!normalizedData.dependencies) {
-          normalizedData.dependencies = {};
-        }
-        normalizedData.dependencies[dependency.name] = dependency.version;
-      }
-
-      if (dependency.dependencyType === DependencyType.Optional) {
-        if (!normalizedData.optionalDependencies) {
-          normalizedData.optionalDependencies = {};
-        }
-        normalizedData.optionalDependencies[dependency.name] = dependency.version;
-      }
-
-      if (dependency.dependencyType === DependencyType.Peer) {
-        if (!normalizedData.peerDependencies) {
-          normalizedData.peerDependencies = {};
-        }
-        normalizedData.peerDependencies[dependency.name] = dependency.version;
+      switch (dependency.dependencyType) {
+        case DependencyType.Regular:
+          if (!normalizedData.dependencies) {
+            normalizedData.dependencies = {};
+          }
+          normalizedData.dependencies[dependency.name] = dependency.version;
+          break;
+        case DependencyType.Optional:
+          if (!normalizedData.optionalDependencies) {
+            normalizedData.optionalDependencies = {};
+          }
+          normalizedData.optionalDependencies[dependency.name] = dependency.version;
+          break;
+        case DependencyType.Peer:
+          if (!normalizedData.peerDependencies) {
+            normalizedData.peerDependencies = {};
+          }
+          normalizedData.peerDependencies[dependency.name] = dependency.version;
+          break;
+        case DependencyType.Dev: // uses this._devDependencies instead
+        case DependencyType.YarnResolutions: // uses this._resolutions instead
+        default:
+          throw new InternalError('Unsupported DependencyType');
       }
     }
 
@@ -294,6 +336,16 @@ export class PackageJsonEditor {
       normalizedData.devDependencies[dependency.name] = dependency.version;
     }
 
+    // (Do not sort this._resolutions because order may be significant; the RFC is unclear about that.)
+    for (const packageName of this._resolutions.keys()) {
+      const dependency: PackageJsonDependency = this._resolutions.get(packageName)!;
+
+      if (!normalizedData.resolutions) {
+        normalizedData.resolutions = {};
+      }
+      normalizedData.resolutions[dependency.name] = dependency.version;
+    }
+
     return normalizedData;
   }
 }

apps/rush-lib/src/logic/installManager/RushInstallManager.ts

@@ -256,6 +256,13 @@ export class RushInstallManager extends BaseInstallManager {
         }
       }
 
+      if (this.rushConfiguration.packageManager === 'yarn') {
+        // This feature is only implemented by the Yarn package manager
+        if (packageJson.resolutionsList.length > 0) {
+          tempPackageJson.resolutions = packageJson.saveToObject().resolutions;
+        }
+      }
+
       // Example: "C:\MyRepo\common\temp\projects\my-project-2"
       const tempProjectFolder: string = this._tempProjectHelper.getTempProjectFolder(rushProject);
 

common/changes/@microsoft/node-core-library/yarn-resolutions_2019-07-06-07-35.json

@@ -0,0 +1,11 @@
+{
+  "changes": [
+    {
+      "packageName": "@microsoft/node-core-library",
+      "comment": "Include the Yarn \"resolutions\" field in \"IPackageJson\".",
+      "type": "minor"
+    }
+  ],
+  "packageName": "@microsoft/node-core-library",
+  "email": "[email protected]"
+}

common/changes/@microsoft/rush-stack-compiler-3.8/yarn-resolutions_2021-05-14-05-05.json

@@ -0,0 +1,11 @@
+{
+  "changes": [
+    {
+      "packageName": "@microsoft/rush-stack-compiler-3.8",
+      "comment": "",
+      "type": "none"
+    }
+  ],
+  "packageName": "@microsoft/rush-stack-compiler-3.8",
+  "email": "[email protected]"
+}

common/changes/@microsoft/rush-stack-compiler-3.9/yarn-resolutions_2021-05-14-05-05.json

@@ -0,0 +1,11 @@
+{
+  "changes": [
+    {
+      "packageName": "@microsoft/rush-stack-compiler-3.9",
+      "comment": "",
+      "type": "none"
+    }
+  ],
+  "packageName": "@microsoft/rush-stack-compiler-3.9",
+  "email": "[email protected]"
+}

common/changes/@microsoft/rush/yarn-resolutions_2019-07-06-07-35.json

@@ -0,0 +1,11 @@
+{
+  "changes": [
+    {
+      "comment": "Add support for the Yarn \"resolutions\" package.json feature.",
+      "packageName": "@microsoft/rush",
+      "type": "none"
+    }
+  ],
+  "packageName": "@microsoft/rush",
+  "email": "[email protected]"
+}

common/changes/@rushstack/node-core-library/yarn-resolutions_2021-05-14-05-05.json

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

common/changes/@rushstack/rundown/yarn-resolutions_2021-05-14-05-05.json

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

common/reviews/api/node-core-library.api.md

@@ -465,6 +465,7 @@ export interface INodePackageJson {
     peerDependencies?: IPackageJsonDependencyTable;
     private?: boolean;
     repository?: string;
+    resolutions?: Record<string, string>;
     scripts?: IPackageJsonScriptTable;
     // @beta
     tsdocMetadata?: string;

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

@@ -87,7 +87,9 @@ export const enum DependencyType {
     // (undocumented)
     Peer = "peerDependencies",
     // (undocumented)
-    Regular = "dependencies"
+    Regular = "dependencies",
+    // (undocumented)
+    YarnResolutions = "resolutions"
 }
 
 // @public
@@ -260,6 +262,7 @@ export class PackageJsonEditor {
     static load(filePath: string): PackageJsonEditor;
     // (undocumented)
     get name(): string;
+    get resolutionsList(): ReadonlyArray<PackageJsonDependency>;
     // (undocumented)
     saveIfModified(): boolean;
     saveToObject(): IPackageJson;

libraries/node-core-library/src/IPackageJson.ts

@@ -137,6 +137,15 @@ export interface INodePackageJson {
    * A table of script hooks that a package manager or build tool may invoke.
    */
   scripts?: IPackageJsonScriptTable;
+
+  /**
+   * A table of package version resolutions. This feature is only implemented by the Yarn package manager.
+   *
+   * @remarks
+   * See the {@link https://github.com/yarnpkg/rfcs/blob/master/implemented/0000-selective-versions-resolutions.md
+   * | 0000-selective-versions-resolutions.md RFC} for details.
+   */
+  resolutions?: Record<string, string>;
 }
 
 /**

stack/rush-stack-compiler-3.8/bin/rush-api-extractor

@@ -1,2 +1,2 @@
 #!/usr/bin/env node
-require("@microsoft/api-extractor/bin/api-extractor");
+require('@microsoft/api-extractor/bin/api-extractor');

stack/rush-stack-compiler-3.8/bin/rush-eslint

@@ -1,2 +1,2 @@
 #!/usr/bin/env node
-require("eslint/bin/eslint");
+require('eslint/bin/eslint');

stack/rush-stack-compiler-3.8/bin/rush-tslint

@@ -1,2 +1,2 @@
 #!/usr/bin/env node
-require("tslint/bin/tslint");
+require('tslint/bin/tslint');

stack/rush-stack-compiler-3.9/bin/rush-api-extractor

@@ -1,2 +1,2 @@
 #!/usr/bin/env node
-require("@microsoft/api-extractor/bin/api-extractor");
+require('@microsoft/api-extractor/bin/api-extractor');

stack/rush-stack-compiler-3.9/bin/rush-eslint

@@ -1,2 +1,2 @@
 #!/usr/bin/env node
-require("eslint/bin/eslint");
+require('eslint/bin/eslint');

stack/rush-stack-compiler-3.9/bin/rush-tslint

@@ -1,2 +1,2 @@
 #!/usr/bin/env node
-require("tslint/bin/tslint");
+require('tslint/bin/tslint');