@rushstack/rush-sdk 5.129.5 → 5.129.7

package/dist/rush-lib.d.ts

@@ -302,7 +302,7 @@ export declare class CommonVersionsConfiguration {
      * If true, then consistent version specifiers for dependencies will be enforced.
      * I.e. "rush check" is run before some commands.
      */
-    readonly ensureConsistentVersions: boolean | undefined;
+    readonly ensureConsistentVersions: boolean;
     /**
      * A table that specifies a "preferred version" for a given NPM package.  This feature is typically used
      * to hold back an indirect dependency to a specific older version, or to reduce duplication of indirect dependencies.
@@ -336,7 +336,7 @@ export declare class CommonVersionsConfiguration {
      * Loads the common-versions.json data from the specified file path.
      * If the file has not been created yet, then an empty object is returned.
      */
-    static loadFromFile(jsonFilename: string): CommonVersionsConfiguration;
+    static loadFromFile(jsonFilename: string, rushConfiguration?: RushConfiguration): CommonVersionsConfiguration;
     private static _deserializeTable;
     private static _serializeTable;
     /**
@@ -3733,6 +3733,12 @@ export declare class RushConfiguration {
      * to disable Rush's warning.
      */
     readonly suppressNodeLtsWarning: boolean;
+    /**
+     * The raw value of `ensureConsistentVersions` from the `rush.json` file.
+     *
+     * @internal
+     */
+    readonly _ensureConsistentVersionsJsonValue: boolean | undefined;
     /**
      * If true, then consistent version specifiers for dependencies will be enforced.
      * I.e. "rush check" is run before some commands.

package/{lib-shim → dist}/tsdoc-metadata.json

@@ -5,7 +5,7 @@
   "toolPackages": [
     {
       "packageName": "@microsoft/api-extractor",
-      "packageVersion": "7.47.0"
+      "packageVersion": "7.47.1"
     }
   ]
 }

package/lib/api/CommonVersionsConfiguration.d.ts

@@ -1,3 +1,4 @@
+import type { RushConfiguration } from './RushConfiguration';
 /**
  * Part of the ICommonVersionsJson structure.
  */
@@ -45,7 +46,7 @@ export declare class CommonVersionsConfiguration {
      * If true, then consistent version specifiers for dependencies will be enforced.
      * I.e. "rush check" is run before some commands.
      */
-    readonly ensureConsistentVersions: boolean | undefined;
+    readonly ensureConsistentVersions: boolean;
     /**
      * A table that specifies a "preferred version" for a given NPM package.  This feature is typically used
      * to hold back an indirect dependency to a specific older version, or to reduce duplication of indirect dependencies.
@@ -79,7 +80,7 @@ export declare class CommonVersionsConfiguration {
      * Loads the common-versions.json data from the specified file path.
      * If the file has not been created yet, then an empty object is returned.
      */
-    static loadFromFile(jsonFilename: string): CommonVersionsConfiguration;
+    static loadFromFile(jsonFilename: string, rushConfiguration?: RushConfiguration): CommonVersionsConfiguration;
     private static _deserializeTable;
     private static _serializeTable;
     /**

package/lib/api/RushConfiguration.d.ts

@@ -356,6 +356,12 @@ export declare class RushConfiguration {
      * to disable Rush's warning.
      */
     readonly suppressNodeLtsWarning: boolean;
+    /**
+     * The raw value of `ensureConsistentVersions` from the `rush.json` file.
+     *
+     * @internal
+     */
+    readonly _ensureConsistentVersionsJsonValue: boolean | undefined;
     /**
      * If true, then consistent version specifiers for dependencies will be enforced.
      * I.e. "rush check" is run before some commands.

package/lib-commonjs/generate-stubs.d.ts

@@ -0,0 +1,2 @@
+export declare function runAsync(): Promise<void>;
+//# sourceMappingURL=generate-stubs.d.ts.map

package/lib-commonjs/generate-stubs.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"generate-stubs.d.ts","sourceRoot":"","sources":["../src/generate-stubs.ts"],"names":[],"mappings":"AAkDA,wBAAsB,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC,CAiB9C"}

package/lib-commonjs/generate-stubs.js

@@ -0,0 +1,84 @@
+"use strict";
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.runAsync = void 0;
+const path = __importStar(require("path"));
+const node_core_library_1 = require("@rushstack/node-core-library");
+function generateLibFilesRecursively(options) {
+    for (const folderItem of node_core_library_1.FileSystem.readFolderItems(options.parentSourcePath)) {
+        const sourcePath = path.join(options.parentSourcePath, folderItem.name);
+        const targetPath = path.join(options.parentTargetPath, folderItem.name);
+        if (folderItem.isDirectory()) {
+            // create destination folder
+            node_core_library_1.FileSystem.ensureEmptyFolder(targetPath);
+            generateLibFilesRecursively({
+                parentSourcePath: sourcePath,
+                parentTargetPath: targetPath,
+                parentSrcImportPathWithSlash: options.parentSrcImportPathWithSlash + folderItem.name + '/',
+                libShimIndexPath: options.libShimIndexPath
+            });
+        }
+        else {
+            if (folderItem.name.endsWith('.d.ts')) {
+                node_core_library_1.FileSystem.copyFile({
+                    sourcePath: sourcePath,
+                    destinationPath: targetPath
+                });
+            }
+            else if (folderItem.name.endsWith('.js')) {
+                const srcImportPath = options.parentSrcImportPathWithSlash + path.parse(folderItem.name).name;
+                const shimPath = path.relative(options.parentTargetPath, options.libShimIndexPath);
+                const shimPathLiteral = JSON.stringify(node_core_library_1.Path.convertToSlashes(shimPath));
+                const srcImportPathLiteral = JSON.stringify(srcImportPath);
+                node_core_library_1.FileSystem.writeFile(targetPath, 
+                // Example:
+                // module.exports = require("../../../lib-shim/index")._rushSdk_loadInternalModule("logic/policy/GitEmailPolicy");
+                `module.exports = require(${shimPathLiteral})._rushSdk_loadInternalModule(${srcImportPathLiteral});`);
+            }
+        }
+    }
+}
+// Entry point invoked by "runScript" action from config/heft.json
+async function runAsync() {
+    const rushLibFolder = node_core_library_1.Import.resolvePackage({
+        baseFolderPath: __dirname,
+        packageName: '@microsoft/rush-lib'
+    });
+    const stubsTargetPath = path.resolve(__dirname, '../lib');
+    // eslint-disable-next-line no-console
+    console.log('generate-stubs: Generating stub files under: ' + stubsTargetPath);
+    generateLibFilesRecursively({
+        parentSourcePath: path.join(rushLibFolder, 'lib'),
+        parentTargetPath: stubsTargetPath,
+        parentSrcImportPathWithSlash: '',
+        libShimIndexPath: path.join(__dirname, '../lib-shim/index')
+    });
+    // eslint-disable-next-line no-console
+    console.log('generate-stubs: Completed successfully.');
+}
+exports.runAsync = runAsync;
+//# sourceMappingURL=generate-stubs.js.map

package/lib-commonjs/generate-stubs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"generate-stubs.js","sourceRoot":"","sources":["../src/generate-stubs.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D;;;;;;;;;;;;;;;;;;;;;;;;;;AAE3D,2CAA6B;AAE7B,oEAAwE;AAExE,SAAS,2BAA2B,CAAC,OAKpC;IACC,KAAK,MAAM,UAAU,IAAI,8BAAU,CAAC,eAAe,CAAC,OAAO,CAAC,gBAAgB,CAAC,EAAE,CAAC;QAC9E,MAAM,UAAU,GAAW,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,gBAAgB,EAAE,UAAU,CAAC,IAAI,CAAC,CAAC;QAChF,MAAM,UAAU,GAAW,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,gBAAgB,EAAE,UAAU,CAAC,IAAI,CAAC,CAAC;QAEhF,IAAI,UAAU,CAAC,WAAW,EAAE,EAAE,CAAC;YAC7B,4BAA4B;YAC5B,8BAAU,CAAC,iBAAiB,CAAC,UAAU,CAAC,CAAC;YACzC,2BAA2B,CAAC;gBAC1B,gBAAgB,EAAE,UAAU;gBAC5B,gBAAgB,EAAE,UAAU;gBAC5B,4BAA4B,EAAE,OAAO,CAAC,4BAA4B,GAAG,UAAU,CAAC,IAAI,GAAG,GAAG;gBAC1F,gBAAgB,EAAE,OAAO,CAAC,gBAAgB;aAC3C,CAAC,CAAC;QACL,CAAC;aAAM,CAAC;YACN,IAAI,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC;gBACtC,8BAAU,CAAC,QAAQ,CAAC;oBAClB,UAAU,EAAE,UAAU;oBACtB,eAAe,EAAE,UAAU;iBAC5B,CAAC,CAAC;YACL,CAAC;iBAAM,IAAI,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;gBAC3C,MAAM,aAAa,GAAW,OAAO,CAAC,4BAA4B,GAAG,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC;gBACtG,MAAM,QAAQ,GAAW,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,gBAAgB,EAAE,OAAO,CAAC,gBAAgB,CAAC,CAAC;gBAC3F,MAAM,eAAe,GAAW,IAAI,CAAC,SAAS,CAAC,wBAAI,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC,CAAC;gBAChF,MAAM,oBAAoB,GAAW,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC;gBAEnE,8BAAU,CAAC,SAAS,CAClB,UAAU;gBACV,WAAW;gBACX,kHAAkH;gBAClH,4BAA4B,eAAe,iCAAiC,oBAAoB,IAAI,CACrG,CAAC;YACJ,CAAC;QACH,CAAC;IACH,CAAC;AACH,CAAC;AAED,kEAAkE;AAC3D,KAAK,UAAU,QAAQ;IAC5B,MAAM,aAAa,GAAW,0BAAM,CAAC,cAAc,CAAC;QAClD,cAAc,EAAE,SAAS;QACzB,WAAW,EAAE,qBAAqB;KACnC,CAAC,CAAC;IAEH,MAAM,eAAe,GAAW,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;IAClE,sCAAsC;IACtC,OAAO,CAAC,GAAG,CAAC,+CAA+C,GAAG,eAAe,CAAC,CAAC;IAC/E,2BAA2B,CAAC;QAC1B,gBAAgB,EAAE,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,KAAK,CAAC;QACjD,gBAAgB,EAAE,eAAe;QACjC,4BAA4B,EAAE,EAAE;QAChC,gBAAgB,EAAE,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,mBAAmB,CAAC;KAC5D,CAAC,CAAC;IACH,sCAAsC;IACtC,OAAO,CAAC,GAAG,CAAC,yCAAyC,CAAC,CAAC;AACzD,CAAC;AAjBD,4BAiBC","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';\n\nimport { FileSystem, Import, Path } from '@rushstack/node-core-library';\n\nfunction generateLibFilesRecursively(options: {\n  parentSourcePath: string;\n  parentTargetPath: string;\n  parentSrcImportPathWithSlash: string;\n  libShimIndexPath: string;\n}): void {\n  for (const folderItem of FileSystem.readFolderItems(options.parentSourcePath)) {\n    const sourcePath: string = path.join(options.parentSourcePath, folderItem.name);\n    const targetPath: string = path.join(options.parentTargetPath, folderItem.name);\n\n    if (folderItem.isDirectory()) {\n      // create destination folder\n      FileSystem.ensureEmptyFolder(targetPath);\n      generateLibFilesRecursively({\n        parentSourcePath: sourcePath,\n        parentTargetPath: targetPath,\n        parentSrcImportPathWithSlash: options.parentSrcImportPathWithSlash + folderItem.name + '/',\n        libShimIndexPath: options.libShimIndexPath\n      });\n    } else {\n      if (folderItem.name.endsWith('.d.ts')) {\n        FileSystem.copyFile({\n          sourcePath: sourcePath,\n          destinationPath: targetPath\n        });\n      } else if (folderItem.name.endsWith('.js')) {\n        const srcImportPath: string = options.parentSrcImportPathWithSlash + path.parse(folderItem.name).name;\n        const shimPath: string = path.relative(options.parentTargetPath, options.libShimIndexPath);\n        const shimPathLiteral: string = JSON.stringify(Path.convertToSlashes(shimPath));\n        const srcImportPathLiteral: string = JSON.stringify(srcImportPath);\n\n        FileSystem.writeFile(\n          targetPath,\n          // Example:\n          // module.exports = require(\"../../../lib-shim/index\")._rushSdk_loadInternalModule(\"logic/policy/GitEmailPolicy\");\n          `module.exports = require(${shimPathLiteral})._rushSdk_loadInternalModule(${srcImportPathLiteral});`\n        );\n      }\n    }\n  }\n}\n\n// Entry point invoked by \"runScript\" action from config/heft.json\nexport async function runAsync(): Promise<void> {\n  const rushLibFolder: string = Import.resolvePackage({\n    baseFolderPath: __dirname,\n    packageName: '@microsoft/rush-lib'\n  });\n\n  const stubsTargetPath: string = path.resolve(__dirname, '../lib');\n  // eslint-disable-next-line no-console\n  console.log('generate-stubs: Generating stub files under: ' + stubsTargetPath);\n  generateLibFilesRecursively({\n    parentSourcePath: path.join(rushLibFolder, 'lib'),\n    parentTargetPath: stubsTargetPath,\n    parentSrcImportPathWithSlash: '',\n    libShimIndexPath: path.join(__dirname, '../lib-shim/index')\n  });\n  // eslint-disable-next-line no-console\n  console.log('generate-stubs: Completed successfully.');\n}\n"]}

package/lib-commonjs/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAoOA;;GAEG;AACH,wBAAgB,2BAA2B,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAO1E"}

package/lib-commonjs/index.js

@@ -0,0 +1,207 @@
+"use strict";
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var _a;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports._rushSdk_loadInternalModule = void 0;
+const path = __importStar(require("path"));
+const node_core_library_1 = require("@rushstack/node-core-library");
+const terminal_1 = require("@rushstack/terminal");
+const RushGlobalFolder_1 = require("@microsoft/rush-lib/lib-esnext/api/RushGlobalFolder");
+const helpers_1 = require("./helpers");
+const verboseEnabled = typeof process !== 'undefined' &&
+    (process.env.RUSH_SDK_DEBUG === '1' || process.env._RUSH_SDK_DEBUG === '1');
+const terminal = new terminal_1.Terminal(new terminal_1.ConsoleTerminalProvider({
+    verboseEnabled
+}));
+let errorMessage = '';
+// 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.
+if (helpers_1.sdkContext.rushLibModule === undefined) {
+    helpers_1.sdkContext.rushLibModule =
+        global.___rush___rushLibModule ||
+            global.___rush___rushLibModuleFromEnvironment ||
+            global.___rush___rushLibModuleFromRushGlobalFolder ||
+            global.___rush___rushLibModuleFromInstallAndRunRush;
+}
+// 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 (helpers_1.sdkContext.rushLibModule === undefined) {
+    const importingPath = (_a = module === null || module === void 0 ? void 0 : module.parent) === null || _a === void 0 ? void 0 : _a.filename;
+    if (importingPath) {
+        const callerPackageFolder = node_core_library_1.PackageJsonLookup.instance.tryGetPackageFolderFor(importingPath);
+        if (callerPackageFolder !== undefined) {
+            const callerPackageJson = (0, helpers_1._require)(path.join(callerPackageFolder, 'package.json'));
+            // Does the caller properly declare a dependency on rush-lib?
+            if ((callerPackageJson.dependencies && callerPackageJson.dependencies[helpers_1.RUSH_LIB_NAME] !== undefined) ||
+                (callerPackageJson.devDependencies &&
+                    callerPackageJson.devDependencies[helpers_1.RUSH_LIB_NAME] !== undefined) ||
+                (callerPackageJson.peerDependencies &&
+                    callerPackageJson.peerDependencies[helpers_1.RUSH_LIB_NAME] !== undefined)) {
+                // Try to resolve rush-lib from the caller's folder
+                terminal.writeVerboseLine(`Try to load ${helpers_1.RUSH_LIB_NAME} from caller package`);
+                try {
+                    helpers_1.sdkContext.rushLibModule = (0, helpers_1.requireRushLibUnderFolderPath)(callerPackageFolder);
+                }
+                catch (error) {
+                    // If we fail to resolve it, ignore the error
+                    terminal.writeVerboseLine(`Failed to load ${helpers_1.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 (helpers_1.sdkContext.rushLibModule !== undefined) {
+                    // to track which scenario is active and how it got initialized.
+                    global.___rush___rushLibModule = helpers_1.sdkContext.rushLibModule;
+                    terminal.writeVerboseLine(`Loaded ${helpers_1.RUSH_LIB_NAME} from caller`);
+                }
+            }
+        }
+    }
+}
+// SCENARIO 3: A tool or script has been invoked as a child process by an instance of "rush-lib" and can use the
+// version that invoked it. In this case, use process.env._RUSH_LIB_PATH to find "rush-lib".
+if (helpers_1.sdkContext.rushLibModule === undefined) {
+    const rushLibPath = process.env[helpers_1.RUSH_LIB_PATH_ENV_VAR_NAME];
+    if (rushLibPath) {
+        terminal.writeVerboseLine(`Try to load ${helpers_1.RUSH_LIB_NAME} from process.env.${helpers_1.RUSH_LIB_PATH_ENV_VAR_NAME} from caller package`);
+        try {
+            helpers_1.sdkContext.rushLibModule = (0, helpers_1._require)(rushLibPath);
+        }
+        catch (error) {
+            // Log this as a warning, since it is unexpected to define an incorrect value of the variable.
+            terminal.writeWarningLine(`Failed to load ${helpers_1.RUSH_LIB_NAME} via process.env.${helpers_1.RUSH_LIB_PATH_ENV_VAR_NAME}`);
+        }
+        if (helpers_1.sdkContext.rushLibModule !== undefined) {
+            // to track which scenario is active and how it got initialized.
+            global.___rush___rushLibModuleFromEnvironment = helpers_1.sdkContext.rushLibModule;
+            terminal.writeVerboseLine(`Loaded ${helpers_1.RUSH_LIB_NAME} from process.env.${helpers_1.RUSH_LIB_PATH_ENV_VAR_NAME}`);
+        }
+    }
+}
+// SCENARIO 4:  A standalone tool or script depends on "rush-sdk", and is meant to be used inside a monorepo folder.
+// In this case, we can first load the rush-lib version in rush global folder. If the expected version is not installed,
+// using install-run-rush.js to obtain the appropriate rush-lib version for the monorepo.
+if (helpers_1.sdkContext.rushLibModule === undefined) {
+    try {
+        const rushJsonPath = (0, helpers_1.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;
+        try {
+            terminal.writeVerboseLine(`Try to load ${helpers_1.RUSH_LIB_NAME} from rush global folder`);
+            const rushGlobalFolder = new RushGlobalFolder_1.RushGlobalFolder();
+            // The path needs to keep align with the logic inside RushVersionSelector
+            const expectedGlobalRushInstalledFolder = `${rushGlobalFolder.nodeSpecificPath}/rush-${rushVersion}`;
+            terminal.writeVerboseLine(`The expected global rush installed folder is "${expectedGlobalRushInstalledFolder}"`);
+            helpers_1.sdkContext.rushLibModule = (0, helpers_1.requireRushLibUnderFolderPath)(expectedGlobalRushInstalledFolder);
+        }
+        catch (e) {
+            terminal.writeVerboseLine(`Failed to load ${helpers_1.RUSH_LIB_NAME} from rush global folder: ${e.message}`);
+        }
+        if (helpers_1.sdkContext.rushLibModule !== undefined) {
+            // to track which scenario is active and how it got initialized.
+            global.___rush___rushLibModuleFromRushGlobalFolder = helpers_1.sdkContext.rushLibModule;
+            terminal.writeVerboseLine(`Loaded ${helpers_1.RUSH_LIB_NAME} installed from rush global folder`);
+        }
+        else {
+            const installRunNodeModuleFolder = `${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  ${helpers_1.RUSH_LIB_NAME} installed by install-run-rush`);
+                helpers_1.sdkContext.rushLibModule = (0, helpers_1.requireRushLibUnderFolderPath)(installRunNodeModuleFolder);
+            }
+            catch (e1) {
+                let installAndRunRushStderrContent = '';
+                try {
+                    const installAndRunRushJSPath = `${monorepoRoot}/common/scripts/install-run-rush.js`;
+                    terminal.writeLine('The Rush engine has not been installed yet. Invoking install-run-rush.js...');
+                    const installAndRunRushProcess = node_core_library_1.Executable.spawnSync('node', [installAndRunRushJSPath, '--help'], {
+                        stdio: 'pipe'
+                    });
+                    installAndRunRushStderrContent = installAndRunRushProcess.stderr;
+                    if (installAndRunRushProcess.status !== 0) {
+                        throw new Error(`The ${helpers_1.RUSH_LIB_NAME} package failed to install`);
+                    }
+                    // Retry to load "rush-lib" after install-run-rush run
+                    terminal.writeVerboseLine(`Trying to load  ${helpers_1.RUSH_LIB_NAME} installed by install-run-rush a second time`);
+                    helpers_1.sdkContext.rushLibModule = (0, helpers_1.requireRushLibUnderFolderPath)(installRunNodeModuleFolder);
+                }
+                catch (e2) {
+                    // eslint-disable-next-line no-console
+                    console.error(`${installAndRunRushStderrContent}`);
+                    throw new Error(`The ${helpers_1.RUSH_LIB_NAME} package failed to load`);
+                }
+            }
+            if (helpers_1.sdkContext.rushLibModule !== undefined) {
+                // to track which scenario is active and how it got initialized.
+                global.___rush___rushLibModuleFromInstallAndRunRush = helpers_1.sdkContext.rushLibModule;
+                terminal.writeVerboseLine(`Loaded ${helpers_1.RUSH_LIB_NAME} installed by install-run-rush`);
+            }
+        }
+    }
+    catch (e) {
+        // no-catch
+        errorMessage = e.message;
+    }
+}
+if (helpers_1.sdkContext.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.
+    // eslint-disable-next-line no-console
+    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 helpers_1.sdkContext.rushLibModule) {
+    if (property !== 'default' && !exports.hasOwnProperty(property)) {
+        const rushLibModuleForClosure = helpers_1.sdkContext.rushLibModule;
+        // Based on TypeScript's __createBinding()
+        Object.defineProperty(exports, property, {
+            enumerable: true,
+            get: function () {
+                return rushLibModuleForClosure[property];
+            }
+        });
+    }
+}
+/**
+ * Used by the .js stubs for path-based imports of `@microsoft/rush-lib` internal APIs.
+ */
+function _rushSdk_loadInternalModule(srcImportPath) {
+    if (!exports._RushInternals) {
+        throw new Error(`Rush version ${exports.Rush.version} does not support internal API imports via rush-sdk`);
+    }
+    return exports._RushInternals.loadModule(srcImportPath);
+}
+exports._rushSdk_loadInternalModule = _rushSdk_loadInternalModule;
+//# sourceMappingURL=index.js.map

package/lib-commonjs/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D;;;;;;;;;;;;;;;;;;;;;;;;;;;AAE3D,2CAA6B;AAC7B,oEAMsC;AACtC,kDAAwE;AACxE,0FAAuF;AAEvF,uCAQmB;AAEnB,MAAM,cAAc,GAClB,OAAO,OAAO,KAAK,WAAW;IAC9B,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,KAAK,GAAG,IAAI,OAAO,CAAC,GAAG,CAAC,eAAe,KAAK,GAAG,CAAC,CAAC;AAC9E,MAAM,QAAQ,GAAa,IAAI,mBAAQ,CACrC,IAAI,kCAAuB,CAAC;IAC1B,cAAc;CACf,CAAC,CACH,CAAC;AASF,IAAI,YAAY,GAAW,EAAE,CAAC;AAE9B,qGAAqG;AACrG,gGAAgG;AAChG,IAAI,oBAAU,CAAC,aAAa,KAAK,SAAS,EAAE,CAAC;IAC3C,oBAAU,CAAC,aAAa;QACtB,MAAM,CAAC,uBAAuB;YAC9B,MAAM,CAAC,sCAAsC;YAC7C,MAAM,CAAC,2CAA2C;YAClD,MAAM,CAAC,4CAA4C,CAAC;AACxD,CAAC;AAED,6FAA6F;AAC7F,+FAA+F;AAC/F,IAAI,oBAAU,CAAC,aAAa,KAAK,SAAS,EAAE,CAAC;IAC3C,MAAM,aAAa,GAA8B,MAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,MAAM,0CAAE,QAAQ,CAAC;IAC1E,IAAI,aAAa,EAAE,CAAC;QAClB,MAAM,mBAAmB,GACvB,qCAAiB,CAAC,QAAQ,CAAC,sBAAsB,CAAC,aAAa,CAAC,CAAC;QAEnE,IAAI,mBAAmB,KAAK,SAAS,EAAE,CAAC;YACtC,MAAM,iBAAiB,GAAiB,IAAA,kBAAQ,EAAC,IAAI,CAAC,IAAI,CAAC,mBAAmB,EAAE,cAAc,CAAC,CAAC,CAAC;YAEjG,6DAA6D;YAC7D,IACE,CAAC,iBAAiB,CAAC,YAAY,IAAI,iBAAiB,CAAC,YAAY,CAAC,uBAAa,CAAC,KAAK,SAAS,CAAC;gBAC/F,CAAC,iBAAiB,CAAC,eAAe;oBAChC,iBAAiB,CAAC,eAAe,CAAC,uBAAa,CAAC,KAAK,SAAS,CAAC;gBACjE,CAAC,iBAAiB,CAAC,gBAAgB;oBACjC,iBAAiB,CAAC,gBAAgB,CAAC,uBAAa,CAAC,KAAK,SAAS,CAAC,EAClE,CAAC;gBACD,mDAAmD;gBACnD,QAAQ,CAAC,gBAAgB,CAAC,eAAe,uBAAa,sBAAsB,CAAC,CAAC;gBAC9E,IAAI,CAAC;oBACH,oBAAU,CAAC,aAAa,GAAG,IAAA,uCAA6B,EAAC,mBAAmB,CAAC,CAAC;gBAChF,CAAC;gBAAC,OAAO,KAAK,EAAE,CAAC;oBACf,6CAA6C;oBAC7C,QAAQ,CAAC,gBAAgB,CAAC,kBAAkB,uBAAa,sBAAsB,CAAC,CAAC;gBACnF,CAAC;gBAED,oFAAoF;gBACpF,qGAAqG;gBACrG,IAAI,oBAAU,CAAC,aAAa,KAAK,SAAS,EAAE,CAAC;oBAC3C,gEAAgE;oBAChE,MAAM,CAAC,uBAAuB,GAAG,oBAAU,CAAC,aAAa,CAAC;oBAC1D,QAAQ,CAAC,gBAAgB,CAAC,UAAU,uBAAa,cAAc,CAAC,CAAC;gBACnE,CAAC;YACH,CAAC;QACH,CAAC;IACH,CAAC;AACH,CAAC;AAED,gHAAgH;AAChH,4FAA4F;AAC5F,IAAI,oBAAU,CAAC,aAAa,KAAK,SAAS,EAAE,CAAC;IAC3C,MAAM,WAAW,GAAuB,OAAO,CAAC,GAAG,CAAC,oCAA0B,CAAC,CAAC;IAChF,IAAI,WAAW,EAAE,CAAC;QAChB,QAAQ,CAAC,gBAAgB,CACvB,eAAe,uBAAa,qBAAqB,oCAA0B,sBAAsB,CAClG,CAAC;QACF,IAAI,CAAC;YACH,oBAAU,CAAC,aAAa,GAAG,IAAA,kBAAQ,EAAC,WAAW,CAAC,CAAC;QACnD,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,8FAA8F;YAC9F,QAAQ,CAAC,gBAAgB,CACvB,kBAAkB,uBAAa,oBAAoB,oCAA0B,EAAE,CAChF,CAAC;QACJ,CAAC;QAED,IAAI,oBAAU,CAAC,aAAa,KAAK,SAAS,EAAE,CAAC;YAC3C,gEAAgE;YAChE,MAAM,CAAC,sCAAsC,GAAG,oBAAU,CAAC,aAAa,CAAC;YACzE,QAAQ,CAAC,gBAAgB,CAAC,UAAU,uBAAa,qBAAqB,oCAA0B,EAAE,CAAC,CAAC;QACtG,CAAC;IACH,CAAC;AACH,CAAC;AAED,oHAAoH;AACpH,wHAAwH;AACxH,yFAAyF;AACzF,IAAI,oBAAU,CAAC,aAAa,KAAK,SAAS,EAAE,CAAC;IAC3C,IAAI,CAAC;QACH,MAAM,YAAY,GAAuB,IAAA,iCAAuB,EAAC,OAAO,CAAC,GAAG,EAAE,CAAC,CAAC;QAChF,IAAI,CAAC,YAAY,EAAE,CAAC;YAClB,MAAM,IAAI,KAAK,CACb,yEAAyE;gBACvE,qFAAqF,CACxF,CAAC;QACJ,CAAC;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,IAAI,CAAC;YACH,QAAQ,CAAC,gBAAgB,CAAC,eAAe,uBAAa,0BAA0B,CAAC,CAAC;YAClF,MAAM,gBAAgB,GAAqB,IAAI,mCAAgB,EAAE,CAAC;YAClE,yEAAyE;YACzE,MAAM,iCAAiC,GAAW,GAAG,gBAAgB,CAAC,gBAAgB,SAAS,WAAW,EAAE,CAAC;YAC7G,QAAQ,CAAC,gBAAgB,CACvB,iDAAiD,iCAAiC,GAAG,CACtF,CAAC;YACF,oBAAU,CAAC,aAAa,GAAG,IAAA,uCAA6B,EAAC,iCAAiC,CAAC,CAAC;QAC9F,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,QAAQ,CAAC,gBAAgB,CAAC,kBAAkB,uBAAa,6BAA6B,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC;QACrG,CAAC;QAED,IAAI,oBAAU,CAAC,aAAa,KAAK,SAAS,EAAE,CAAC;YAC3C,gEAAgE;YAChE,MAAM,CAAC,2CAA2C,GAAG,oBAAU,CAAC,aAAa,CAAC;YAC9E,QAAQ,CAAC,gBAAgB,CAAC,UAAU,uBAAa,oCAAoC,CAAC,CAAC;QACzF,CAAC;aAAM,CAAC;YACN,MAAM,0BAA0B,GAAW,GAAG,YAAY,4CAA4C,WAAW,EAAE,CAAC;YAEpH,IAAI,CAAC;gBACH,yFAAyF;gBACzF,QAAQ,CAAC,gBAAgB,CAAC,mBAAmB,uBAAa,gCAAgC,CAAC,CAAC;gBAC5F,oBAAU,CAAC,aAAa,GAAG,IAAA,uCAA6B,EAAC,0BAA0B,CAAC,CAAC;YACvF,CAAC;YAAC,OAAO,EAAE,EAAE,CAAC;gBACZ,IAAI,8BAA8B,GAAW,EAAE,CAAC;gBAChD,IAAI,CAAC;oBACH,MAAM,uBAAuB,GAAW,GAAG,YAAY,qCAAqC,CAAC;oBAE7F,QAAQ,CAAC,SAAS,CAAC,6EAA6E,CAAC,CAAC;oBAElG,MAAM,wBAAwB,GAA6B,8BAAU,CAAC,SAAS,CAC7E,MAAM,EACN,CAAC,uBAAuB,EAAE,QAAQ,CAAC,EACnC;wBACE,KAAK,EAAE,MAAM;qBACd,CACF,CAAC;oBAEF,8BAA8B,GAAG,wBAAwB,CAAC,MAAM,CAAC;oBACjE,IAAI,wBAAwB,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;wBAC1C,MAAM,IAAI,KAAK,CAAC,OAAO,uBAAa,4BAA4B,CAAC,CAAC;oBACpE,CAAC;oBAED,sDAAsD;oBACtD,QAAQ,CAAC,gBAAgB,CACvB,mBAAmB,uBAAa,8CAA8C,CAC/E,CAAC;oBACF,oBAAU,CAAC,aAAa,GAAG,IAAA,uCAA6B,EAAC,0BAA0B,CAAC,CAAC;gBACvF,CAAC;gBAAC,OAAO,EAAE,EAAE,CAAC;oBACZ,sCAAsC;oBACtC,OAAO,CAAC,KAAK,CAAC,GAAG,8BAA8B,EAAE,CAAC,CAAC;oBACnD,MAAM,IAAI,KAAK,CAAC,OAAO,uBAAa,yBAAyB,CAAC,CAAC;gBACjE,CAAC;YACH,CAAC;YAED,IAAI,oBAAU,CAAC,aAAa,KAAK,SAAS,EAAE,CAAC;gBAC3C,gEAAgE;gBAChE,MAAM,CAAC,4CAA4C,GAAG,oBAAU,CAAC,aAAa,CAAC;gBAC/E,QAAQ,CAAC,gBAAgB,CAAC,UAAU,uBAAa,gCAAgC,CAAC,CAAC;YACrF,CAAC;QACH,CAAC;IACH,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACX,WAAW;QACX,YAAY,GAAI,CAAW,CAAC,OAAO,CAAC;IACtC,CAAC;AACH,CAAC;AAED,IAAI,oBAAU,CAAC,aAAa,KAAK,SAAS,EAAE,CAAC;IAC3C,qGAAqG;IACrG,wGAAwG;IACxG,2CAA2C;IAC3C,sCAAsC;IACtC,OAAO,CAAC,KAAK,CAAC;EACd,YAAY;CACb,CAAC,CAAC;IACD,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AAClB,CAAC;AAED,uCAAuC;AACvC,KAAK,MAAM,QAAQ,IAAI,oBAAU,CAAC,aAAa,EAAE,CAAC;IAChD,IAAI,QAAQ,KAAK,SAAS,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,QAAQ,CAAC,EAAE,CAAC;QAChE,MAAM,uBAAuB,GAAsB,oBAAU,CAAC,aAAa,CAAC;QAE5E,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;IACL,CAAC;AACH,CAAC;AAED;;GAEG;AACH,SAAgB,2BAA2B,CAAC,aAAqB;IAC/D,IAAI,CAAC,OAAO,CAAC,cAAc,EAAE,CAAC;QAC5B,MAAM,IAAI,KAAK,CACb,gBAAgB,OAAO,CAAC,IAAI,CAAC,OAAO,qDAAqD,CAC1F,CAAC;IACJ,CAAC;IACD,OAAO,OAAO,CAAC,cAAc,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC;AAC1D,CAAC;AAPD,kEAOC","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  type JsonObject,\n  type IPackageJson,\n  PackageJsonLookup,\n  Executable\n} from '@rushstack/node-core-library';\nimport { Terminal, ConsoleTerminalProvider } from '@rushstack/terminal';\nimport { RushGlobalFolder } from '@microsoft/rush-lib/lib-esnext/api/RushGlobalFolder';\nimport type { SpawnSyncReturns } from 'child_process';\nimport {\n  RUSH_LIB_NAME,\n  RUSH_LIB_PATH_ENV_VAR_NAME,\n  type RushLibModuleType,\n  _require,\n  requireRushLibUnderFolderPath,\n  tryFindRushJsonLocation,\n  sdkContext\n} from './helpers';\n\nconst verboseEnabled: boolean =\n  typeof process !== 'undefined' &&\n  (process.env.RUSH_SDK_DEBUG === '1' || process.env._RUSH_SDK_DEBUG === '1');\nconst terminal: Terminal = new Terminal(\n  new ConsoleTerminalProvider({\n    verboseEnabled\n  })\n);\n\ndeclare const global: typeof globalThis & {\n  ___rush___rushLibModule?: RushLibModuleType;\n  ___rush___rushLibModuleFromEnvironment?: RushLibModuleType;\n  ___rush___rushLibModuleFromRushGlobalFolder?: RushLibModuleType;\n  ___rush___rushLibModuleFromInstallAndRunRush?: RushLibModuleType;\n};\n\nlet errorMessage: string = '';\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.\nif (sdkContext.rushLibModule === undefined) {\n  sdkContext.rushLibModule =\n    global.___rush___rushLibModule ||\n    global.___rush___rushLibModuleFromEnvironment ||\n    global.___rush___rushLibModuleFromRushGlobalFolder ||\n    global.___rush___rushLibModuleFromInstallAndRunRush;\n}\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 (sdkContext.rushLibModule === undefined) {\n  const importingPath: string | null | undefined = module?.parent?.filename;\n  if (importingPath) {\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          sdkContext.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 (sdkContext.rushLibModule !== undefined) {\n          // to track which scenario is active and how it got initialized.\n          global.___rush___rushLibModule = sdkContext.rushLibModule;\n          terminal.writeVerboseLine(`Loaded ${RUSH_LIB_NAME} from caller`);\n        }\n      }\n    }\n  }\n}\n\n// SCENARIO 3: A tool or script has been invoked as a child process by an instance of \"rush-lib\" and can use the\n// version that invoked it. In this case, use process.env._RUSH_LIB_PATH to find \"rush-lib\".\nif (sdkContext.rushLibModule === undefined) {\n  const rushLibPath: string | undefined = process.env[RUSH_LIB_PATH_ENV_VAR_NAME];\n  if (rushLibPath) {\n    terminal.writeVerboseLine(\n      `Try to load ${RUSH_LIB_NAME} from process.env.${RUSH_LIB_PATH_ENV_VAR_NAME} from caller package`\n    );\n    try {\n      sdkContext.rushLibModule = _require(rushLibPath);\n    } catch (error) {\n      // Log this as a warning, since it is unexpected to define an incorrect value of the variable.\n      terminal.writeWarningLine(\n        `Failed to load ${RUSH_LIB_NAME} via process.env.${RUSH_LIB_PATH_ENV_VAR_NAME}`\n      );\n    }\n\n    if (sdkContext.rushLibModule !== undefined) {\n      // to track which scenario is active and how it got initialized.\n      global.___rush___rushLibModuleFromEnvironment = sdkContext.rushLibModule;\n      terminal.writeVerboseLine(`Loaded ${RUSH_LIB_NAME} from process.env.${RUSH_LIB_PATH_ENV_VAR_NAME}`);\n    }\n  }\n}\n\n// SCENARIO 4:  A standalone tool or script depends on \"rush-sdk\", and is meant to be used inside a monorepo folder.\n// In this case, we can first load the rush-lib version in rush global folder. If the expected version is not installed,\n// using install-run-rush.js to obtain the appropriate rush-lib version for the monorepo.\nif (sdkContext.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    try {\n      terminal.writeVerboseLine(`Try to load ${RUSH_LIB_NAME} from rush global folder`);\n      const rushGlobalFolder: RushGlobalFolder = new RushGlobalFolder();\n      // The path needs to keep align with the logic inside RushVersionSelector\n      const expectedGlobalRushInstalledFolder: string = `${rushGlobalFolder.nodeSpecificPath}/rush-${rushVersion}`;\n      terminal.writeVerboseLine(\n        `The expected global rush installed folder is \"${expectedGlobalRushInstalledFolder}\"`\n      );\n      sdkContext.rushLibModule = requireRushLibUnderFolderPath(expectedGlobalRushInstalledFolder);\n    } catch (e) {\n      terminal.writeVerboseLine(`Failed to load ${RUSH_LIB_NAME} from rush global folder: ${e.message}`);\n    }\n\n    if (sdkContext.rushLibModule !== undefined) {\n      // to track which scenario is active and how it got initialized.\n      global.___rush___rushLibModuleFromRushGlobalFolder = sdkContext.rushLibModule;\n      terminal.writeVerboseLine(`Loaded ${RUSH_LIB_NAME} installed from rush global folder`);\n    } else {\n      const installRunNodeModuleFolder: string = `${monorepoRoot}/common/temp/install-run/@microsoft+rush@${rushVersion}`;\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        sdkContext.rushLibModule = requireRushLibUnderFolderPath(installRunNodeModuleFolder);\n      } catch (e1) {\n        let installAndRunRushStderrContent: string = '';\n        try {\n          const installAndRunRushJSPath: string = `${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 installAndRunRushProcess: SpawnSyncReturns<string> = Executable.spawnSync(\n            'node',\n            [installAndRunRushJSPath, '--help'],\n            {\n              stdio: 'pipe'\n            }\n          );\n\n          installAndRunRushStderrContent = installAndRunRushProcess.stderr;\n          if (installAndRunRushProcess.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(\n            `Trying to load  ${RUSH_LIB_NAME} installed by install-run-rush a second time`\n          );\n          sdkContext.rushLibModule = requireRushLibUnderFolderPath(installRunNodeModuleFolder);\n        } catch (e2) {\n          // eslint-disable-next-line no-console\n          console.error(`${installAndRunRushStderrContent}`);\n          throw new Error(`The ${RUSH_LIB_NAME} package failed to load`);\n        }\n      }\n\n      if (sdkContext.rushLibModule !== undefined) {\n        // to track which scenario is active and how it got initialized.\n        global.___rush___rushLibModuleFromInstallAndRunRush = sdkContext.rushLibModule;\n        terminal.writeVerboseLine(`Loaded ${RUSH_LIB_NAME} installed by install-run-rush`);\n      }\n    }\n  } catch (e) {\n    // no-catch\n    errorMessage = (e as Error).message;\n  }\n}\n\nif (sdkContext.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  // eslint-disable-next-line no-console\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 sdkContext.rushLibModule) {\n  if (property !== 'default' && !exports.hasOwnProperty(property)) {\n    const rushLibModuleForClosure: RushLibModuleType = sdkContext.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 * Used by the .js stubs for path-based imports of `@microsoft/rush-lib` internal APIs.\n */\nexport function _rushSdk_loadInternalModule(srcImportPath: string): unknown {\n  if (!exports._RushInternals) {\n    throw new Error(\n      `Rush version ${exports.Rush.version} does not support internal API imports via rush-sdk`\n    );\n  }\n  return exports._RushInternals.loadModule(srcImportPath);\n}\n"]}

package/lib-commonjs/loader.js

@@ -0,0 +1,192 @@
+"use strict";
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RushSdkLoader = void 0;
+const path = __importStar(require("path"));
+const node_core_library_1 = require("@rushstack/node-core-library");
+const helpers_1 = require("./helpers");
+/**
+ * Exposes operations that control how the `@microsoft/rush-lib` engine is
+ * located and loaded.
+ * @public
+ */
+class RushSdkLoader {
+    /**
+     * Throws an "AbortError" exception if abortSignal.aborted is true.
+     */
+    static _checkForCancel(abortSignal, onNotifyEvent, progressPercent) {
+        if (!(abortSignal === null || abortSignal === void 0 ? void 0 : abortSignal.aborted)) {
+            return;
+        }
+        if (onNotifyEvent) {
+            onNotifyEvent({
+                logMessage: {
+                    kind: 'info',
+                    text: `The operation was canceled`
+                },
+                progressPercent
+            });
+        }
+        const error = new Error('The operation was canceled');
+        error.name = 'AbortError';
+        throw error;
+    }
+    /**
+     * Returns true if the Rush engine has already been loaded.
+     */
+    static get isLoaded() {
+        return helpers_1.sdkContext.rushLibModule !== undefined;
+    }
+    /**
+     * Manually load the Rush engine based on rush.json found for `rushJsonSearchFolder`.
+     * Throws an exception if {@link RushSdkLoader.isLoaded} is already `true`.
+     *
+     * @remarks
+     * This API supports an callback that can be used display a progress bar,
+     * log of operations, and allow the operation to be canceled prematurely.
+     */
+    static async loadAsync(options) {
+        // SCENARIO 5: The rush-lib engine is loaded manually using rushSdkLoader.loadAsync().
+        var _a, _b;
+        if (!options) {
+            options = {};
+        }
+        if (RushSdkLoader.isLoaded) {
+            throw new Error('RushSdkLoader.loadAsync() failed because the Rush engine has already been loaded');
+        }
+        const onNotifyEvent = options.onNotifyEvent;
+        let progressPercent = undefined;
+        const abortSignal = options.abortSignal;
+        try {
+            const rushJsonSearchFolder = (_a = options.rushJsonSearchFolder) !== null && _a !== void 0 ? _a : process.cwd();
+            if (onNotifyEvent) {
+                onNotifyEvent({
+                    logMessage: {
+                        kind: 'debug',
+                        text: `Searching for rush.json starting from: ` + rushJsonSearchFolder
+                    },
+                    progressPercent
+                });
+            }
+            const rushJsonPath = (0, helpers_1.tryFindRushJsonLocation)(rushJsonSearchFolder);
+            if (!rushJsonPath) {
+                throw new Error('Unable to find rush.json in the specified folder or its parent folders:\n' +
+                    `${rushJsonSearchFolder}\n`);
+            }
+            const monorepoRoot = path.dirname(rushJsonPath);
+            const rushJson = await node_core_library_1.JsonFile.loadAsync(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
+                if (onNotifyEvent) {
+                    onNotifyEvent({
+                        logMessage: {
+                            kind: 'info',
+                            text: `Trying to load  ${helpers_1.RUSH_LIB_NAME} installed by install-run-rush`
+                        },
+                        progressPercent
+                    });
+                }
+                helpers_1.sdkContext.rushLibModule = (0, helpers_1.requireRushLibUnderFolderPath)(installRunNodeModuleFolder);
+            }
+            catch (e1) {
+                let installAndRunRushStderrContent = '';
+                try {
+                    const installAndRunRushJSPath = path.join(monorepoRoot, 'common/scripts/install-run-rush.js');
+                    if (onNotifyEvent) {
+                        onNotifyEvent({
+                            logMessage: {
+                                kind: 'info',
+                                text: 'The Rush engine has not been installed yet. Invoking install-run-rush.js...'
+                            },
+                            progressPercent
+                        });
+                    }
+                    // Start the installation
+                    progressPercent = 0;
+                    const installAndRunRushProcess = node_core_library_1.Executable.spawnSync('node', [installAndRunRushJSPath, '--help'], {
+                        stdio: 'pipe'
+                    });
+                    installAndRunRushStderrContent = installAndRunRushProcess.stderr;
+                    if (installAndRunRushProcess.status !== 0) {
+                        throw new Error(`The ${helpers_1.RUSH_LIB_NAME} package failed to install`);
+                    }
+                    if (abortSignal) {
+                        RushSdkLoader._checkForCancel(abortSignal, onNotifyEvent, progressPercent);
+                    }
+                    // TODO: Implement incremental progress updates
+                    progressPercent = 90;
+                    // Retry to load "rush-lib" after install-run-rush run
+                    if (onNotifyEvent) {
+                        onNotifyEvent({
+                            logMessage: {
+                                kind: 'debug',
+                                text: `Trying to load  ${helpers_1.RUSH_LIB_NAME} installed by install-run-rush a second time`
+                            },
+                            progressPercent
+                        });
+                    }
+                    helpers_1.sdkContext.rushLibModule = (0, helpers_1.requireRushLibUnderFolderPath)(installRunNodeModuleFolder);
+                    progressPercent = 100;
+                }
+                catch (e2) {
+                    // eslint-disable-next-line no-console
+                    console.error(`${installAndRunRushStderrContent}`);
+                    throw new Error(`The ${helpers_1.RUSH_LIB_NAME} package failed to load`);
+                }
+            }
+            if (helpers_1.sdkContext.rushLibModule !== undefined) {
+                // to track which scenario is active and how it got initialized.
+                global.___rush___rushLibModuleFromInstallAndRunRush = helpers_1.sdkContext.rushLibModule;
+                if (onNotifyEvent) {
+                    onNotifyEvent({
+                        logMessage: {
+                            kind: 'debug',
+                            text: `Loaded ${helpers_1.RUSH_LIB_NAME} installed by install-run-rush`
+                        },
+                        progressPercent
+                    });
+                }
+            }
+        }
+        catch (e) {
+            if (onNotifyEvent) {
+                onNotifyEvent({
+                    logMessage: {
+                        kind: 'info',
+                        text: 'The operation failed: ' + ((_b = e.message) !== null && _b !== void 0 ? _b : 'An unknown error occurred')
+                    },
+                    progressPercent
+                });
+            }
+            throw e;
+        }
+    }
+}
+exports.RushSdkLoader = RushSdkLoader;
+//# sourceMappingURL=loader.js.map