@rushstack/rush-sdk 5.61.3 → 5.62.1

package/README.md

@@ -10,11 +10,15 @@ The **@rushstack/rush-sdk** package acts as a lightweight proxy for accessing th
 
 2. When authoring unit tests for a Rush plugin, developers should add **@microsoft/rush-lib** to their **package.json** `devDependencies`.  In this context, **@rushstack/rush-sdk** will resolve to that instance for testing purposes.
 
-3. **(Not implemented yet)** For scripts and tools that are designed to be used in a Rush monorepo, in the future **@rushstack/rush-sdk** will automatically invoke **install-run-rush.js** and load the local installation.  This ensures that tools load a compatible version of the Rush engine for the given branch.  Once this is implemented, **@rushstack/rush-sdk** can replace **@microsoft/rush-lib** entirely as the official API interface, with the latter serving as the underlying implementation.
+3. For scripts and tools that are designed to be used in a Rush monorepo, in the future **@rushstack/rush-sdk** will automatically invoke **install-run-rush.js** and load the local installation.  This ensures that tools load a compatible version of the Rush engine for the given branch.  Once this is implemented, **@rushstack/rush-sdk** can replace **@microsoft/rush-lib** entirely as the official API interface, with the latter serving as the underlying implementation.
 
 
 The **@rushstack/rush-sdk** API declarations are identical to the corresponding version of **@microsoft/rush-lib**.
 
+## Debugging
+
+Verbose logging can be turn on by set environment variable `RUSH_SDK_DEBUG` to `1`
+
 
 ## Links
 

package/dist/rush-lib.d.ts

@@ -791,7 +791,7 @@ declare interface ILocalBuildCacheJson extends IBaseBuildCacheJson {
 
 declare interface ILockStepVersionJson extends IVersionPolicyJson {
     version: string;
-    nextBump: string;
+    nextBump?: string;
     mainProject?: string;
 }
 
@@ -1151,7 +1151,7 @@ export declare class LockStepVersionPolicy extends VersionPolicy {
     /**
      * The type of bump for next bump.
      */
-    get nextBump(): BumpType;
+    get nextBump(): BumpType | undefined;
     /**
      * The main project for the version policy.
      *
@@ -1707,6 +1707,9 @@ export declare class RushConfiguration {
     static loadFromDefaultLocation(options?: ITryFindRushJsonLocationOptions): RushConfiguration;
     /**
      * Find the rush.json location and return the path, or undefined if a rush.json can't be found.
+     *
+     * @privateRemarks
+     * Keep this in sync with `findRushJsonLocation` in `rush-sdk/src/index.ts`.
      */
     static tryFindRushJsonLocation(options?: ITryFindRushJsonLocationOptions): string | undefined;
     /**
@@ -2715,7 +2718,7 @@ export declare class VersionPolicyConfiguration {
      * @param versionPolicyName - version policy name
      * @param newVersion - new version
      */
-    update(versionPolicyName: string, newVersion: string): void;
+    update(versionPolicyName: string, newVersion: string, shouldCommit?: boolean): void;
     private _loadFile;
     private _saveFile;
 }

package/lib/index.js

@@ -25,9 +25,14 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const path = __importStar(require("path"));
 const node_core_library_1 = require("@rushstack/node-core-library");
 const RUSH_LIB_NAME = '@microsoft/rush-lib';
+const verboseEnabled = typeof process !== 'undefined' && process.env.RUSH_SDK_DEBUG === '1';
+const terminal = new node_core_library_1.Terminal(new node_core_library_1.ConsoleTerminalProvider({
+    verboseEnabled
+}));
 // SCENARIO 1:  Rush's PluginManager has initialized "rush-sdk" with Rush's own instance of rush-lib.
 // The Rush host process will assign "global.___rush___rushLibModule" before loading the plugin.
-let rushLibModule = global.___rush___rushLibModule;
+let rushLibModule = global.___rush___rushLibModule || global.___rush___rushLibModuleFromInstallAndRunRush;
+let errorMessage = '';
 // SCENARIO 2:  The project importing "rush-sdk" has installed its own instance of "rush-lib"
 // as a package.json dependency.  For example, this is used by the Jest tests for Rush plugins.
 if (rushLibModule === undefined) {
@@ -43,22 +48,20 @@ if (rushLibModule === undefined) {
                 (callerPackageJson.peerDependencies &&
                     callerPackageJson.peerDependencies[RUSH_LIB_NAME] !== undefined)) {
                 // Try to resolve rush-lib from the caller's folder
+                terminal.writeVerboseLine(`Try to load ${RUSH_LIB_NAME} from caller package`);
                 try {
-                    const rushLibModulePath = node_core_library_1.Import.resolveModule({
-                        modulePath: RUSH_LIB_NAME,
-                        baseFolderPath: callerPackageFolder
-                    });
-                    rushLibModule = require(rushLibModulePath);
+                    rushLibModule = requireRushLibUnderFolderPath(callerPackageFolder);
                 }
                 catch (error) {
                     // If we fail to resolve it, ignore the error
+                    terminal.writeVerboseLine(`Failed to load ${RUSH_LIB_NAME} from caller package`);
                 }
                 // If two different libraries invoke `rush-sdk`, and one of them provides "rush-lib"
                 // then the first version to be loaded wins.  We do not support side-by-side instances of "rush-lib".
                 if (rushLibModule !== undefined) {
-                    // TODO: When we implement Scenario 3, we should also add some diagnostic state
                     // to track which scenario is active and how it got initialized.
                     global.___rush___rushLibModule = rushLibModule;
+                    terminal.writeVerboseLine(`Loaded ${RUSH_LIB_NAME} from caller`);
                 }
             }
         }
@@ -66,13 +69,62 @@ if (rushLibModule === undefined) {
 }
 // SCENARIO 3:  A tool or script depends on "rush-sdk", and is meant to be used inside a monorepo folder.
 // In this case, we can use install-run-rush.js to obtain the appropriate rush-lib version for the monorepo.
-//
-// NOT IMPLEMENTED YET
+if (rushLibModule === undefined) {
+    try {
+        const rushJsonPath = tryFindRushJsonLocation(process.cwd());
+        if (!rushJsonPath) {
+            throw new Error('Unable to find rush.json in the current folder or its parent folders.\n' +
+                'This tool is meant to be invoked from a working directory inside a Rush repository.');
+        }
+        const monorepoRoot = path.dirname(rushJsonPath);
+        const rushJson = node_core_library_1.JsonFile.load(rushJsonPath);
+        const { rushVersion } = rushJson;
+        const installRunNodeModuleFolder = path.join(monorepoRoot, `common/temp/install-run/@microsoft+rush@${rushVersion}`);
+        try {
+            // First, try to load the version of "rush-lib" that was installed by install-run-rush.js
+            terminal.writeVerboseLine(`Trying to load  ${RUSH_LIB_NAME} installed by install-run-rush`);
+            rushLibModule = requireRushLibUnderFolderPath(installRunNodeModuleFolder);
+        }
+        catch (e) {
+            let installAndRunRushStderrContent = '';
+            try {
+                const installAndRunRushJSPath = path.join(monorepoRoot, 'common/scripts/install-run-rush.js');
+                terminal.writeLine('The Rush engine has not been installed yet. Invoking install-run-rush.js...');
+                const installAndRuhRushProcess = node_core_library_1.Executable.spawnSync('node', [installAndRunRushJSPath, '--help'], {
+                    stdio: 'pipe'
+                });
+                installAndRunRushStderrContent = installAndRuhRushProcess.stderr;
+                if (installAndRuhRushProcess.status !== 0) {
+                    throw new Error(`The ${RUSH_LIB_NAME} package failed to install`);
+                }
+                // Retry to load "rush-lib" after install-run-rush run
+                terminal.writeVerboseLine(`Trying to load  ${RUSH_LIB_NAME} installed by install-run-rush a second time`);
+                rushLibModule = requireRushLibUnderFolderPath(installRunNodeModuleFolder);
+            }
+            catch (e) {
+                console.error(`${installAndRunRushStderrContent}`);
+                throw new Error(`The ${RUSH_LIB_NAME} package failed to load`);
+            }
+        }
+        if (rushLibModule !== undefined) {
+            // to track which scenario is active and how it got initialized.
+            global.___rush___rushLibModuleFromInstallAndRunRush = rushLibModule;
+            terminal.writeVerboseLine(`Loaded ${RUSH_LIB_NAME} installed by install-run-rush`);
+        }
+    }
+    catch (e) {
+        // no-catch
+        errorMessage = e.message;
+    }
+}
 if (rushLibModule === undefined) {
     // This error indicates that a project is trying to import "@rushstack/rush-sdk", but the Rush engine
     // instance cannot be found.  If you are writing Jest tests for a Rush plugin, add "@microsoft/rush-lib"
     // to the devDependencies for your project.
-    throw new Error('The "@rushstack/rush-sdk" package context has not been initialized.');
+    console.error(`Error: The @rushstack/rush-sdk package was not able to load the Rush engine:
+${errorMessage}
+`);
+    process.exit(1);
 }
 // Based on TypeScript's __exportStar()
 for (const property in rushLibModule) {
@@ -87,4 +139,36 @@ for (const property in rushLibModule) {
         });
     }
 }
+/**
+ * Require `@microsoft/rush-lib` under the specified folder path.
+ */
+function requireRushLibUnderFolderPath(folderPath) {
+    const rushLibModulePath = node_core_library_1.Import.resolveModule({
+        modulePath: RUSH_LIB_NAME,
+        baseFolderPath: folderPath
+    });
+    return require(rushLibModulePath);
+}
+/**
+ * Find the rush.json location and return the path, or undefined if a rush.json can't be found.
+ *
+ * @privateRemarks
+ * Keep this in sync with `RushConfiguration.tryFindRushJsonLocation`.
+ */
+function tryFindRushJsonLocation(startingFolder) {
+    let currentFolder = startingFolder;
+    // Look upwards at parent folders until we find a folder containing rush.json
+    for (let i = 0; i < 10; ++i) {
+        const rushJsonFilename = path.join(currentFolder, 'rush.json');
+        if (node_core_library_1.FileSystem.exists(rushJsonFilename)) {
+            return rushJsonFilename;
+        }
+        const parentFolder = path.dirname(currentFolder);
+        if (parentFolder === currentFolder) {
+            break;
+        }
+        currentFolder = parentFolder;
+    }
+    return undefined;
+}
 //# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D;;;;;;;;;;;;;;;;;;;;;;AAE3D,2CAA6B;AAC7B,oEAAuF;AAEvF,MAAM,aAAa,GAAW,qBAAqB,CAAC;AAQpD,qGAAqG;AACrG,gGAAgG;AAChG,IAAI,aAAa,GAAkC,MAAM,CAAC,uBAAuB,CAAC;AAElF,6FAA6F;AAC7F,+FAA+F;AAC/F,IAAI,aAAa,KAAK,SAAS,EAAE;IAC/B,MAAM,aAAa,GAAuB,MAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,MAAM,0CAAE,QAAQ,CAAC;IACnE,IAAI,aAAa,KAAK,SAAS,EAAE;QAC/B,MAAM,mBAAmB,GACvB,qCAAiB,CAAC,QAAQ,CAAC,sBAAsB,CAAC,aAAa,CAAC,CAAC;QAEnE,IAAI,mBAAmB,KAAK,SAAS,EAAE;YACrC,MAAM,iBAAiB,GAAiB,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,mBAAmB,EAAE,cAAc,CAAC,CAAC,CAAC;YAEhG,6DAA6D;YAC7D,IACE,CAAC,iBAAiB,CAAC,YAAY,IAAI,iBAAiB,CAAC,YAAY,CAAC,aAAa,CAAC,KAAK,SAAS,CAAC;gBAC/F,CAAC,iBAAiB,CAAC,eAAe;oBAChC,iBAAiB,CAAC,eAAe,CAAC,aAAa,CAAC,KAAK,SAAS,CAAC;gBACjE,CAAC,iBAAiB,CAAC,gBAAgB;oBACjC,iBAAiB,CAAC,gBAAgB,CAAC,aAAa,CAAC,KAAK,SAAS,CAAC,EAClE;gBACA,mDAAmD;gBACnD,IAAI;oBACF,MAAM,iBAAiB,GAAW,0BAAM,CAAC,aAAa,CAAC;wBACrD,UAAU,EAAE,aAAa;wBACzB,cAAc,EAAE,mBAAmB;qBACpC,CAAC,CAAC;oBAEH,aAAa,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAAC;iBAC5C;gBAAC,OAAO,KAAK,EAAE;oBACd,6CAA6C;iBAC9C;gBAED,oFAAoF;gBACpF,qGAAqG;gBACrG,IAAI,aAAa,KAAK,SAAS,EAAE;oBAC/B,+EAA+E;oBAC/E,gEAAgE;oBAChE,MAAM,CAAC,uBAAuB,GAAG,aAAa,CAAC;iBAChD;aACF;SACF;KACF;CACF;AAED,yGAAyG;AACzG,4GAA4G;AAC5G,EAAE;AACF,sBAAsB;AACtB,IAAI,aAAa,KAAK,SAAS,EAAE;IAC/B,qGAAqG;IACrG,wGAAwG;IACxG,2CAA2C;IAC3C,MAAM,IAAI,KAAK,CAAC,qEAAqE,CAAC,CAAC;CACxF;AAED,uCAAuC;AACvC,KAAK,MAAM,QAAQ,IAAI,aAAa,EAAE;IACpC,IAAI,QAAQ,KAAK,SAAS,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,QAAQ,CAAC,EAAE;QAC/D,MAAM,uBAAuB,GAAsB,aAAa,CAAC;QAEjE,0CAA0C;QAC1C,MAAM,CAAC,cAAc,CAAC,OAAO,EAAE,QAAQ,EAAE;YACvC,UAAU,EAAE,IAAI;YAChB,GAAG,EAAE;gBACH,OAAO,uBAAuB,CAAC,QAAQ,CAAC,CAAC;YAC3C,CAAC;SACF,CAAC,CAAC;KACJ;CACF","sourcesContent":["// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.\n// See LICENSE in the project root for license information.\n\nimport * as path from 'path';\nimport { Import, IPackageJson, PackageJsonLookup } from '@rushstack/node-core-library';\n\nconst RUSH_LIB_NAME: string = '@microsoft/rush-lib';\n\ntype RushLibModuleType = Record<string, unknown>;\ndeclare const global: NodeJS.Global &\n  typeof globalThis & {\n    ___rush___rushLibModule?: RushLibModuleType;\n  };\n\n// SCENARIO 1:  Rush's PluginManager has initialized \"rush-sdk\" with Rush's own instance of rush-lib.\n// The Rush host process will assign \"global.___rush___rushLibModule\" before loading the plugin.\nlet rushLibModule: RushLibModuleType | undefined = global.___rush___rushLibModule;\n\n// SCENARIO 2:  The project importing \"rush-sdk\" has installed its own instance of \"rush-lib\"\n// as a package.json dependency.  For example, this is used by the Jest tests for Rush plugins.\nif (rushLibModule === undefined) {\n  const importingPath: string | undefined = module?.parent?.filename;\n  if (importingPath !== undefined) {\n    const callerPackageFolder: string | undefined =\n      PackageJsonLookup.instance.tryGetPackageFolderFor(importingPath);\n\n    if (callerPackageFolder !== undefined) {\n      const callerPackageJson: IPackageJson = require(path.join(callerPackageFolder, 'package.json'));\n\n      // Does the caller properly declare a dependency on rush-lib?\n      if (\n        (callerPackageJson.dependencies && callerPackageJson.dependencies[RUSH_LIB_NAME] !== undefined) ||\n        (callerPackageJson.devDependencies &&\n          callerPackageJson.devDependencies[RUSH_LIB_NAME] !== undefined) ||\n        (callerPackageJson.peerDependencies &&\n          callerPackageJson.peerDependencies[RUSH_LIB_NAME] !== undefined)\n      ) {\n        // Try to resolve rush-lib from the caller's folder\n        try {\n          const rushLibModulePath: string = Import.resolveModule({\n            modulePath: RUSH_LIB_NAME,\n            baseFolderPath: callerPackageFolder\n          });\n\n          rushLibModule = require(rushLibModulePath);\n        } catch (error) {\n          // If we fail to resolve it, ignore the error\n        }\n\n        // If two different libraries invoke `rush-sdk`, and one of them provides \"rush-lib\"\n        // then the first version to be loaded wins.  We do not support side-by-side instances of \"rush-lib\".\n        if (rushLibModule !== undefined) {\n          // TODO: When we implement Scenario 3, we should also add some diagnostic state\n          // to track which scenario is active and how it got initialized.\n          global.___rush___rushLibModule = rushLibModule;\n        }\n      }\n    }\n  }\n}\n\n// SCENARIO 3:  A tool or script depends on \"rush-sdk\", and is meant to be used inside a monorepo folder.\n// In this case, we can use install-run-rush.js to obtain the appropriate rush-lib version for the monorepo.\n//\n// NOT IMPLEMENTED YET\nif (rushLibModule === undefined) {\n  // This error indicates that a project is trying to import \"@rushstack/rush-sdk\", but the Rush engine\n  // instance cannot be found.  If you are writing Jest tests for a Rush plugin, add \"@microsoft/rush-lib\"\n  // to the devDependencies for your project.\n  throw new Error('The \"@rushstack/rush-sdk\" package context has not been initialized.');\n}\n\n// Based on TypeScript's __exportStar()\nfor (const property in rushLibModule) {\n  if (property !== 'default' && !exports.hasOwnProperty(property)) {\n    const rushLibModuleForClosure: RushLibModuleType = rushLibModule;\n\n    // Based on TypeScript's __createBinding()\n    Object.defineProperty(exports, property, {\n      enumerable: true,\n      get: function () {\n        return rushLibModuleForClosure[property];\n      }\n    });\n  }\n}\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D;;;;;;;;;;;;;;;;;;;;;;AAE3D,2CAA6B;AAC7B,oEAUsC;AAGtC,MAAM,aAAa,GAAW,qBAAqB,CAAC;AAEpD,MAAM,cAAc,GAAY,OAAO,OAAO,KAAK,WAAW,IAAI,OAAO,CAAC,GAAG,CAAC,cAAc,KAAK,GAAG,CAAC;AACrG,MAAM,QAAQ,GAAa,IAAI,4BAAQ,CACrC,IAAI,2CAAuB,CAAC;IAC1B,cAAc;CACf,CAAC,CACH,CAAC;AASF,qGAAqG;AACrG,gGAAgG;AAChG,IAAI,aAAa,GACf,MAAM,CAAC,uBAAuB,IAAI,MAAM,CAAC,4CAA4C,CAAC;AACxF,IAAI,YAAY,GAAW,EAAE,CAAC;AAE9B,6FAA6F;AAC7F,+FAA+F;AAC/F,IAAI,aAAa,KAAK,SAAS,EAAE;IAC/B,MAAM,aAAa,GAAuB,MAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,MAAM,0CAAE,QAAQ,CAAC;IACnE,IAAI,aAAa,KAAK,SAAS,EAAE;QAC/B,MAAM,mBAAmB,GACvB,qCAAiB,CAAC,QAAQ,CAAC,sBAAsB,CAAC,aAAa,CAAC,CAAC;QAEnE,IAAI,mBAAmB,KAAK,SAAS,EAAE;YACrC,MAAM,iBAAiB,GAAiB,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,mBAAmB,EAAE,cAAc,CAAC,CAAC,CAAC;YAEhG,6DAA6D;YAC7D,IACE,CAAC,iBAAiB,CAAC,YAAY,IAAI,iBAAiB,CAAC,YAAY,CAAC,aAAa,CAAC,KAAK,SAAS,CAAC;gBAC/F,CAAC,iBAAiB,CAAC,eAAe;oBAChC,iBAAiB,CAAC,eAAe,CAAC,aAAa,CAAC,KAAK,SAAS,CAAC;gBACjE,CAAC,iBAAiB,CAAC,gBAAgB;oBACjC,iBAAiB,CAAC,gBAAgB,CAAC,aAAa,CAAC,KAAK,SAAS,CAAC,EAClE;gBACA,mDAAmD;gBACnD,QAAQ,CAAC,gBAAgB,CAAC,eAAe,aAAa,sBAAsB,CAAC,CAAC;gBAC9E,IAAI;oBACF,aAAa,GAAG,6BAA6B,CAAC,mBAAmB,CAAC,CAAC;iBACpE;gBAAC,OAAO,KAAK,EAAE;oBACd,6CAA6C;oBAC7C,QAAQ,CAAC,gBAAgB,CAAC,kBAAkB,aAAa,sBAAsB,CAAC,CAAC;iBAClF;gBAED,oFAAoF;gBACpF,qGAAqG;gBACrG,IAAI,aAAa,KAAK,SAAS,EAAE;oBAC/B,gEAAgE;oBAChE,MAAM,CAAC,uBAAuB,GAAG,aAAa,CAAC;oBAC/C,QAAQ,CAAC,gBAAgB,CAAC,UAAU,aAAa,cAAc,CAAC,CAAC;iBAClE;aACF;SACF;KACF;CACF;AAED,yGAAyG;AACzG,4GAA4G;AAC5G,IAAI,aAAa,KAAK,SAAS,EAAE;IAC/B,IAAI;QACF,MAAM,YAAY,GAAuB,uBAAuB,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,CAAC;QAChF,IAAI,CAAC,YAAY,EAAE;YACjB,MAAM,IAAI,KAAK,CACb,yEAAyE;gBACvE,qFAAqF,CACxF,CAAC;SACH;QACD,MAAM,YAAY,GAAW,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;QAExD,MAAM,QAAQ,GAAe,4BAAQ,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QACzD,MAAM,EAAE,WAAW,EAAE,GAAG,QAAQ,CAAC;QAEjC,MAAM,0BAA0B,GAAW,IAAI,CAAC,IAAI,CAClD,YAAY,EACZ,2CAA2C,WAAW,EAAE,CACzD,CAAC;QAEF,IAAI;YACF,yFAAyF;YACzF,QAAQ,CAAC,gBAAgB,CAAC,mBAAmB,aAAa,gCAAgC,CAAC,CAAC;YAC5F,aAAa,GAAG,6BAA6B,CAAC,0BAA0B,CAAC,CAAC;SAC3E;QAAC,OAAO,CAAC,EAAE;YACV,IAAI,8BAA8B,GAAW,EAAE,CAAC;YAChD,IAAI;gBACF,MAAM,uBAAuB,GAAW,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,oCAAoC,CAAC,CAAC;gBAEtG,QAAQ,CAAC,SAAS,CAAC,6EAA6E,CAAC,CAAC;gBAElG,MAAM,wBAAwB,GAA6B,8BAAU,CAAC,SAAS,CAC7E,MAAM,EACN,CAAC,uBAAuB,EAAE,QAAQ,CAAC,EACnC;oBACE,KAAK,EAAE,MAAM;iBACd,CACF,CAAC;gBAEF,8BAA8B,GAAG,wBAAwB,CAAC,MAAM,CAAC;gBACjE,IAAI,wBAAwB,CAAC,MAAM,KAAK,CAAC,EAAE;oBACzC,MAAM,IAAI,KAAK,CAAC,OAAO,aAAa,4BAA4B,CAAC,CAAC;iBACnE;gBAED,sDAAsD;gBACtD,QAAQ,CAAC,gBAAgB,CAAC,mBAAmB,aAAa,8CAA8C,CAAC,CAAC;gBAC1G,aAAa,GAAG,6BAA6B,CAAC,0BAA0B,CAAC,CAAC;aAC3E;YAAC,OAAO,CAAC,EAAE;gBACV,OAAO,CAAC,KAAK,CAAC,GAAG,8BAA8B,EAAE,CAAC,CAAC;gBACnD,MAAM,IAAI,KAAK,CAAC,OAAO,aAAa,yBAAyB,CAAC,CAAC;aAChE;SACF;QAED,IAAI,aAAa,KAAK,SAAS,EAAE;YAC/B,gEAAgE;YAChE,MAAM,CAAC,4CAA4C,GAAG,aAAa,CAAC;YACpE,QAAQ,CAAC,gBAAgB,CAAC,UAAU,aAAa,gCAAgC,CAAC,CAAC;SACpF;KACF;IAAC,OAAO,CAAC,EAAE;QACV,WAAW;QACX,YAAY,GAAI,CAAW,CAAC,OAAO,CAAC;KACrC;CACF;AAED,IAAI,aAAa,KAAK,SAAS,EAAE;IAC/B,qGAAqG;IACrG,wGAAwG;IACxG,2CAA2C;IAC3C,OAAO,CAAC,KAAK,CAAC;EACd,YAAY;CACb,CAAC,CAAC;IACD,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;CACjB;AAED,uCAAuC;AACvC,KAAK,MAAM,QAAQ,IAAI,aAAa,EAAE;IACpC,IAAI,QAAQ,KAAK,SAAS,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,QAAQ,CAAC,EAAE;QAC/D,MAAM,uBAAuB,GAAsB,aAAa,CAAC;QAEjE,0CAA0C;QAC1C,MAAM,CAAC,cAAc,CAAC,OAAO,EAAE,QAAQ,EAAE;YACvC,UAAU,EAAE,IAAI;YAChB,GAAG,EAAE;gBACH,OAAO,uBAAuB,CAAC,QAAQ,CAAC,CAAC;YAC3C,CAAC;SACF,CAAC,CAAC;KACJ;CACF;AAED;;GAEG;AACH,SAAS,6BAA6B,CAAC,UAAkB;IACvD,MAAM,iBAAiB,GAAW,0BAAM,CAAC,aAAa,CAAC;QACrD,UAAU,EAAE,aAAa;QACzB,cAAc,EAAE,UAAU;KAC3B,CAAC,CAAC;IAEH,OAAO,OAAO,CAAC,iBAAiB,CAAC,CAAC;AACpC,CAAC;AAED;;;;;GAKG;AACH,SAAS,uBAAuB,CAAC,cAAsB;IACrD,IAAI,aAAa,GAAW,cAAc,CAAC;IAE3C,6EAA6E;IAC7E,KAAK,IAAI,CAAC,GAAW,CAAC,EAAE,CAAC,GAAG,EAAE,EAAE,EAAE,CAAC,EAAE;QACnC,MAAM,gBAAgB,GAAW,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,WAAW,CAAC,CAAC;QAEvE,IAAI,8BAAU,CAAC,MAAM,CAAC,gBAAgB,CAAC,EAAE;YACvC,OAAO,gBAAgB,CAAC;SACzB;QAED,MAAM,YAAY,GAAW,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC;QACzD,IAAI,YAAY,KAAK,aAAa,EAAE;YAClC,MAAM;SACP;QAED,aAAa,GAAG,YAAY,CAAC;KAC9B;IAED,OAAO,SAAS,CAAC;AACnB,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.\n// See LICENSE in the project root for license information.\n\nimport * as path from 'path';\nimport {\n  JsonFile,\n  JsonObject,\n  Import,\n  IPackageJson,\n  PackageJsonLookup,\n  Executable,\n  FileSystem,\n  Terminal,\n  ConsoleTerminalProvider\n} from '@rushstack/node-core-library';\nimport type { SpawnSyncReturns } from 'child_process';\n\nconst RUSH_LIB_NAME: string = '@microsoft/rush-lib';\n\nconst verboseEnabled: boolean = typeof process !== 'undefined' && process.env.RUSH_SDK_DEBUG === '1';\nconst terminal: Terminal = new Terminal(\n  new ConsoleTerminalProvider({\n    verboseEnabled\n  })\n);\n\ntype RushLibModuleType = Record<string, unknown>;\ndeclare const global: NodeJS.Global &\n  typeof globalThis & {\n    ___rush___rushLibModule?: RushLibModuleType;\n    ___rush___rushLibModuleFromInstallAndRunRush?: RushLibModuleType;\n  };\n\n// SCENARIO 1:  Rush's PluginManager has initialized \"rush-sdk\" with Rush's own instance of rush-lib.\n// The Rush host process will assign \"global.___rush___rushLibModule\" before loading the plugin.\nlet rushLibModule: RushLibModuleType | undefined =\n  global.___rush___rushLibModule || global.___rush___rushLibModuleFromInstallAndRunRush;\nlet errorMessage: string = '';\n\n// SCENARIO 2:  The project importing \"rush-sdk\" has installed its own instance of \"rush-lib\"\n// as a package.json dependency.  For example, this is used by the Jest tests for Rush plugins.\nif (rushLibModule === undefined) {\n  const importingPath: string | undefined = module?.parent?.filename;\n  if (importingPath !== undefined) {\n    const callerPackageFolder: string | undefined =\n      PackageJsonLookup.instance.tryGetPackageFolderFor(importingPath);\n\n    if (callerPackageFolder !== undefined) {\n      const callerPackageJson: IPackageJson = require(path.join(callerPackageFolder, 'package.json'));\n\n      // Does the caller properly declare a dependency on rush-lib?\n      if (\n        (callerPackageJson.dependencies && callerPackageJson.dependencies[RUSH_LIB_NAME] !== undefined) ||\n        (callerPackageJson.devDependencies &&\n          callerPackageJson.devDependencies[RUSH_LIB_NAME] !== undefined) ||\n        (callerPackageJson.peerDependencies &&\n          callerPackageJson.peerDependencies[RUSH_LIB_NAME] !== undefined)\n      ) {\n        // Try to resolve rush-lib from the caller's folder\n        terminal.writeVerboseLine(`Try to load ${RUSH_LIB_NAME} from caller package`);\n        try {\n          rushLibModule = requireRushLibUnderFolderPath(callerPackageFolder);\n        } catch (error) {\n          // If we fail to resolve it, ignore the error\n          terminal.writeVerboseLine(`Failed to load ${RUSH_LIB_NAME} from caller package`);\n        }\n\n        // If two different libraries invoke `rush-sdk`, and one of them provides \"rush-lib\"\n        // then the first version to be loaded wins.  We do not support side-by-side instances of \"rush-lib\".\n        if (rushLibModule !== undefined) {\n          // to track which scenario is active and how it got initialized.\n          global.___rush___rushLibModule = rushLibModule;\n          terminal.writeVerboseLine(`Loaded ${RUSH_LIB_NAME} from caller`);\n        }\n      }\n    }\n  }\n}\n\n// SCENARIO 3:  A tool or script depends on \"rush-sdk\", and is meant to be used inside a monorepo folder.\n// In this case, we can use install-run-rush.js to obtain the appropriate rush-lib version for the monorepo.\nif (rushLibModule === undefined) {\n  try {\n    const rushJsonPath: string | undefined = tryFindRushJsonLocation(process.cwd());\n    if (!rushJsonPath) {\n      throw new Error(\n        'Unable to find rush.json in the current folder or its parent folders.\\n' +\n          'This tool is meant to be invoked from a working directory inside a Rush repository.'\n      );\n    }\n    const monorepoRoot: string = path.dirname(rushJsonPath);\n\n    const rushJson: JsonObject = JsonFile.load(rushJsonPath);\n    const { rushVersion } = rushJson;\n\n    const installRunNodeModuleFolder: string = path.join(\n      monorepoRoot,\n      `common/temp/install-run/@microsoft+rush@${rushVersion}`\n    );\n\n    try {\n      // First, try to load the version of \"rush-lib\" that was installed by install-run-rush.js\n      terminal.writeVerboseLine(`Trying to load  ${RUSH_LIB_NAME} installed by install-run-rush`);\n      rushLibModule = requireRushLibUnderFolderPath(installRunNodeModuleFolder);\n    } catch (e) {\n      let installAndRunRushStderrContent: string = '';\n      try {\n        const installAndRunRushJSPath: string = path.join(monorepoRoot, 'common/scripts/install-run-rush.js');\n\n        terminal.writeLine('The Rush engine has not been installed yet. Invoking install-run-rush.js...');\n\n        const installAndRuhRushProcess: SpawnSyncReturns<string> = Executable.spawnSync(\n          'node',\n          [installAndRunRushJSPath, '--help'],\n          {\n            stdio: 'pipe'\n          }\n        );\n\n        installAndRunRushStderrContent = installAndRuhRushProcess.stderr;\n        if (installAndRuhRushProcess.status !== 0) {\n          throw new Error(`The ${RUSH_LIB_NAME} package failed to install`);\n        }\n\n        // Retry to load \"rush-lib\" after install-run-rush run\n        terminal.writeVerboseLine(`Trying to load  ${RUSH_LIB_NAME} installed by install-run-rush a second time`);\n        rushLibModule = requireRushLibUnderFolderPath(installRunNodeModuleFolder);\n      } catch (e) {\n        console.error(`${installAndRunRushStderrContent}`);\n        throw new Error(`The ${RUSH_LIB_NAME} package failed to load`);\n      }\n    }\n\n    if (rushLibModule !== undefined) {\n      // to track which scenario is active and how it got initialized.\n      global.___rush___rushLibModuleFromInstallAndRunRush = rushLibModule;\n      terminal.writeVerboseLine(`Loaded ${RUSH_LIB_NAME} installed by install-run-rush`);\n    }\n  } catch (e) {\n    // no-catch\n    errorMessage = (e as Error).message;\n  }\n}\n\nif (rushLibModule === undefined) {\n  // This error indicates that a project is trying to import \"@rushstack/rush-sdk\", but the Rush engine\n  // instance cannot be found.  If you are writing Jest tests for a Rush plugin, add \"@microsoft/rush-lib\"\n  // to the devDependencies for your project.\n  console.error(`Error: The @rushstack/rush-sdk package was not able to load the Rush engine:\n${errorMessage}\n`);\n  process.exit(1);\n}\n\n// Based on TypeScript's __exportStar()\nfor (const property in rushLibModule) {\n  if (property !== 'default' && !exports.hasOwnProperty(property)) {\n    const rushLibModuleForClosure: RushLibModuleType = rushLibModule;\n\n    // Based on TypeScript's __createBinding()\n    Object.defineProperty(exports, property, {\n      enumerable: true,\n      get: function () {\n        return rushLibModuleForClosure[property];\n      }\n    });\n  }\n}\n\n/**\n * Require `@microsoft/rush-lib` under the specified folder path.\n */\nfunction requireRushLibUnderFolderPath(folderPath: string): RushLibModuleType {\n  const rushLibModulePath: string = Import.resolveModule({\n    modulePath: RUSH_LIB_NAME,\n    baseFolderPath: folderPath\n  });\n\n  return require(rushLibModulePath);\n}\n\n/**\n * Find the rush.json location and return the path, or undefined if a rush.json can't be found.\n *\n * @privateRemarks\n * Keep this in sync with `RushConfiguration.tryFindRushJsonLocation`.\n */\nfunction tryFindRushJsonLocation(startingFolder: string): string | undefined {\n  let currentFolder: string = startingFolder;\n\n  // Look upwards at parent folders until we find a folder containing rush.json\n  for (let i: number = 0; i < 10; ++i) {\n    const rushJsonFilename: string = path.join(currentFolder, 'rush.json');\n\n    if (FileSystem.exists(rushJsonFilename)) {\n      return rushJsonFilename;\n    }\n\n    const parentFolder: string = path.dirname(currentFolder);\n    if (parentFolder === currentFolder) {\n      break;\n    }\n\n    currentFolder = parentFolder;\n  }\n\n  return undefined;\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@rushstack/rush-sdk",
-	"version": "5.61.3",
+	"version": "5.62.1",
 	"description": "An API for interacting with the Rush engine",
 	"repository": {
 		"type": "git",
@@ -17,7 +17,7 @@
 		"tapable": "2.2.1"
 	},
 	"devDependencies": {
-		"@microsoft/rush-lib": "5.61.3",
+		"@microsoft/rush-lib": "5.62.1",
 		"@rushstack/eslint-config": "2.5.1",
 		"@rushstack/heft": "0.44.2",
 		"@rushstack/heft-node-rig": "1.7.1",