@rushstack/rush-sdk 5.100.2 → 5.101.0

package/README.md

@@ -4,18 +4,110 @@ This is a companion package for the Rush tool. See the [@microsoft/rush](https:/
 
 ⚠ **_THIS PACKAGE IS EXPERIMENTAL_** ⚠
 
-The **@rushstack/rush-sdk** package acts as a lightweight proxy for accessing the APIs of the **@microsoft/rush-lib** engine. It is intended to support three different use cases:
+The **@rushstack/rush-sdk** package acts as a lightweight proxy for accessing the APIs of the **@microsoft/rush-lib** engine. It is intended to support five different use cases:
 
-1. Rush plugins should import from **@rushstack/rush-sdk** instead of **@microsoft/rush-lib**. This gives plugins full access to Rush APIs while avoiding a redundant installation of those packages. At runtime, the APIs will be bound to the correct `rushVersion` from **rush.json**, and guaranteed to be the same **@microsoft/rush-lib** module instance as the plugin host.
+1. **Rush plugins:** Rush plugins should import from **@rushstack/rush-sdk** instead of **@microsoft/rush-lib**. This gives plugins full access to Rush APIs while avoiding a redundant installation of those packages. At runtime, the APIs will be bound to the correct `rushVersion` from **rush.json**, and guaranteed to be the same **@microsoft/rush-lib** module instance as the plugin host.
 
-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.
+2. **Unit tests:** When authoring unit tests (for a Rush plugin, for example), developers should add **@microsoft/rush-lib** to their **package.json** `devDependencies` and add **@rushstack/rush-sdk** to the regular `dependencies`. In this context, **@rushstack/rush-sdk** will resolve to the locally installed instance for testing purposes.
 
-3. For projects within a monorepo that use **@rushstack/rush-sdk** during their build process, child processes will inherit the installation of Rush that invoked them. This is communicated using the `_RUSH_LIB_PATH` environment variable.
+3. **Rush subprocesses:** For tools within a monorepo that import **@rushstack/rush-sdk** during their build process, child processes will inherit the installation of Rush that invoked them. This is communicated using the `_RUSH_LIB_PATH` environment variable.
 
-4. 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.
+4. **Monorepo tools:** For scripts and tools that are designed to be used in a Rush monorepo, **@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.
+
+5. **Advanced scenarios:** The secondary `@rushstack/rush-sdk/loader` entry point can be imported by tools that need to explicitly control where **@microsoft/rush-lib** gets loaded from. This API also allows monitoring installation and canceling the operation.  This API is used by the Rush Stack VS Code extension, for example.
 
 The **@rushstack/rush-sdk** API declarations are identical to the corresponding version of **@microsoft/rush-lib**.
 
+## Basic usage
+
+Here's an example of basic usage that works with cases 1-4 above:
+
+```ts
+// CommonJS notation:
+const { RushConfiguration } = require('@rushstack/rush-sdk');
+
+const config = RushConfiguration.loadFromDefaultLocation();
+console.log(config.commonFolder);
+```
+
+```ts
+// TypeScript notation:
+import { RushConfiguration } from '@rushstack/rush-sdk';
+
+const config = RushConfiguration.loadFromDefaultLocation();
+console.log(config.commonFolder);
+```
+
+## Loader API
+
+Here's a basic example of how to manually load **@rushstack/rush-sdk** and monitor installation progress:
+
+```ts
+import { RushSdkLoader, ISdkCallbackEvent } from '@rushstack/rush-sdk/loader';
+
+if (!RushSdkLoader.isLoaded) {
+  await RushSdkLoader.loadAsync({
+    // the search for rush.json starts here:
+    rushJsonSearchFolder: "path/to/my-repo/apps/my-app",
+
+    onNotifyEvent: (event: ISdkCallbackEvent) => {
+      if (event.logMessage) {
+        // Your tool can show progress about the loading:
+        if (event.logMessage.kind === 'info') {
+          console.log(event.logMessage.text);
+        }
+      }
+    }
+  });
+}
+
+// Any subsequent attempts to call require() will return the same instance
+// that was loaded above.
+const rushSdk = require('@rushstack/rush-sdk');
+const config = rushSdk.RushConfiguration.loadFromDefaultLocation();
+```
+
+Here's a more elaborate example illustrating other API features:
+
+```ts
+import { RushSdkLoader, ISdkCallbackEvent } from '@rushstack/rush-sdk/loader';
+
+// Use an AbortController to cancel the operation after a certain time period
+const abortController = new AbortController();
+setTimeout(() => {
+  abortController.abort();
+}, 1000);
+
+if (!RushSdkLoader.isLoaded) {
+  await RushSdkLoader.loadAsync({
+    // the search for rush.json starts here:
+    rushJsonSearchFolder: "path/to/my-repo/apps/my-app",
+
+    abortSignal: abortController.signal,
+
+    onNotifyEvent: (event: ISdkCallbackEvent) => {
+      if (event.logMessage) {
+        // Your tool can show progress about the loading:
+        if (event.logMessage.kind === 'info') {
+          console.log(event.logMessage.text);
+        }
+      }
+
+      if (event.progressPercent !== undefined) {
+        // If installation takes a long time, your tool can display a progress bar
+        displayYourProgressBar(event.progressPercent);
+      }
+    }
+  });
+}
+
+// Any subsequent attempts to call require() will return the same instance
+// that was loaded above.
+const rushSdk = require('@rushstack/rush-sdk');
+const config = rushSdk.RushConfiguration.loadFromDefaultLocation();
+```
+
+
 ## Importing internal APIs
 
 Backwards compatibility is only guaranteed for the APIs marked as `@public` in the official `rush-lib.d.ts` entry point.

package/dist/loader.d.ts

@@ -0,0 +1,92 @@
+/// <reference types="node" />
+
+/**
+ * Options for {@link RushSdkLoader.loadAsync}
+ * @public
+ */
+export declare interface ILoadSdkAsyncOptions {
+    /**
+     * The folder to start from when searching for the Rush workspace configuration.
+     * If this folder does not contain a `rush.json` file, then each parent folder
+     * will be searched.  If `rush.json` is not found, then the SDK fails to load.
+     */
+    rushJsonSearchFolder?: string;
+    /**
+     * A cancellation token that the caller can use to prematurely abort the operation.
+     */
+    abortSignal?: AbortSignal;
+    /**
+     * Allows the caller to monitor the progress of the operation.
+     */
+    onNotifyEvent?: SdkNotifyEventCallback;
+}
+
+/**
+ * Type of {@link ISdkCallbackEvent.logMessage}
+ * @public
+ */
+export declare interface IProgressBarCallbackLogMessage {
+    /**
+     * A status message to print in the log window, or `undefined` if there are
+     * no further messages.  This string may contain newlines.
+     */
+    text: string;
+    /**
+     * The type of message.  More message types may be added in the future.
+     */
+    kind: 'info' | 'debug';
+}
+
+/**
+ * Event options for {@link ILoadSdkAsyncOptions.onNotifyEvent}
+ * @public
+ */
+export declare interface ISdkCallbackEvent {
+    /**
+     * Allows the caller to display log information about the operation.
+     */
+    logMessage: IProgressBarCallbackLogMessage | undefined;
+    /**
+     * Allows the caller to display a progress bar for long-running operations.
+     *
+     * @remarks
+     * If a long-running operation is required, then `progressPercent` will
+     * start at 0.0 and count upwards and finish at 100.0 if the operation completes
+     * successfully.  If the long-running operation has not yet started, or
+     * is not required, then the value will be `undefined`.
+     */
+    progressPercent: number | undefined;
+}
+
+/**
+ * Exposes operations that control how the `@microsoft/rush-lib` engine is
+ * located and loaded.
+ * @public
+ */
+export declare class RushSdkLoader {
+    /**
+     * Throws an "AbortError" exception if abortSignal.aborted is true.
+     */
+    private static _checkForCancel;
+    /**
+     * Returns true if the Rush engine has already been loaded.
+     */
+    static get isLoaded(): boolean;
+    /**
+     * 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 loadAsync(options?: ILoadSdkAsyncOptions): Promise<void>;
+}
+
+/**
+ * Type of {@link ILoadSdkAsyncOptions.onNotifyEvent}
+ * @public
+ */
+export declare type SdkNotifyEventCallback = (sdkEvent: ISdkCallbackEvent) => void;
+
+export { }

package/dist/rush-sdk.d.ts

@@ -0,0 +1,92 @@
+/// <reference types="node" />
+
+/**
+ * Options for {@link RushSdkLoader.loadAsync}
+ * @public
+ */
+export declare interface ILoadSdkAsyncOptions {
+    /**
+     * The folder to start from when searching for the Rush workspace configuration.
+     * If this folder does not contain a `rush.json` file, then each parent folder
+     * will be searched.  If `rush.json` is not found, then the SDK fails to load.
+     */
+    rushJsonSearchFolder?: string;
+    /**
+     * A cancellation token that the caller can use to prematurely abort the operation.
+     */
+    abortSignal?: AbortSignal;
+    /**
+     * Allows the caller to monitor the progress of the operation.
+     */
+    onNotifyEvent?: SdkNotifyEventCallback;
+}
+
+/**
+ * Type of {@link ISdkCallbackEvent.logMessage}
+ * @public
+ */
+export declare interface IProgressBarCallbackLogMessage {
+    /**
+     * A status message to print in the log window, or `undefined` if there are
+     * no further messages.  This string may contain newlines.
+     */
+    text: string;
+    /**
+     * The type of message.  More message types may be added in the future.
+     */
+    kind: 'info' | 'debug';
+}
+
+/**
+ * Event options for {@link ILoadSdkAsyncOptions.onNotifyEvent}
+ * @public
+ */
+export declare interface ISdkCallbackEvent {
+    /**
+     * Allows the caller to display log information about the operation.
+     */
+    logMessage: IProgressBarCallbackLogMessage | undefined;
+    /**
+     * Allows the caller to display a progress bar for long-running operations.
+     *
+     * @remarks
+     * If a long-running operation is required, then `progressPercent` will
+     * start at 0.0 and count upwards and finish at 100.0 if the operation completes
+     * successfully.  If the long-running operation has not yet started, or
+     * is not required, then the value will be `undefined`.
+     */
+    progressPercent: number | undefined;
+}
+
+/**
+ * Exposes operations that control how the `@microsoft/rush-lib` engine is
+ * located and loaded.
+ * @public
+ */
+export declare class RushSdkLoader {
+    /**
+     * Throws an "AbortError" exception if abortSignal.aborted is true.
+     */
+    private static _checkForCancel;
+    /**
+     * Returns true if the Rush engine has already been loaded.
+     */
+    static get isLoaded(): boolean;
+    /**
+     * 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 loadAsync(options?: ILoadSdkAsyncOptions): Promise<void>;
+}
+
+/**
+ * Type of {@link ILoadSdkAsyncOptions.onNotifyEvent}
+ * @public
+ */
+export declare type SdkNotifyEventCallback = (sdkEvent: ISdkCallbackEvent) => void;
+
+export { }

package/dist/tsdoc-metadata.json

@@ -0,0 +1,11 @@
+// This file is read by tools that parse documentation comments conforming to the TSDoc standard.
+// It should be published with your NPM package.  It should not be tracked by Git.
+{
+  "tsdocVersion": "0.12",
+  "toolPackages": [
+    {
+      "packageName": "@microsoft/api-extractor",
+      "packageVersion": "7.36.3"
+    }
+  ]
+}

package/lib/logic/deploy/DeployScenarioConfiguration.d.ts

@@ -5,6 +5,8 @@ export interface IDeployScenarioProjectJson {
     additionalProjectsToInclude?: string[];
     additionalDependenciesToInclude?: string[];
     dependenciesToExclude?: string[];
+    patternsToInclude?: string[];
+    patternsToExclude?: string[];
 }
 export interface IDeployScenarioJson {
     deploymentProjectNames: string[];

package/lib/logic/pnpm/PnpmShrinkwrapFile.d.ts

@@ -94,6 +94,10 @@ export interface IPnpmShrinkwrapYaml {
     registry: string;
     /** The list of specifiers used to resolve direct dependency versions */
     specifiers: Record<string, string>;
+    /** The list of override version number for dependencies */
+    overrides?: {
+        [dependency: string]: string;
+    };
 }
 /**
  * Given an encoded "dependency key" from the PNPM shrinkwrap file, this parses it into an equivalent
@@ -111,6 +115,7 @@ export declare class PnpmShrinkwrapFile extends BaseShrinkwrapFile {
     readonly importers: ReadonlyMap<string, IPnpmShrinkwrapImporterYaml>;
     readonly specifiers: ReadonlyMap<string, string>;
     readonly packages: ReadonlyMap<string, IPnpmShrinkwrapDependencyYaml>;
+    readonly overrides: ReadonlyMap<string, string>;
     private readonly _shrinkwrapJson;
     private readonly _integrities;
     private _pnpmfileConfiguration;

package/lib-shim/helpers.d.ts

@@ -0,0 +1,21 @@
+import type { EnvironmentVariableNames } from '@microsoft/rush-lib';
+export declare const RUSH_LIB_NAME: '@microsoft/rush-lib';
+export declare const RUSH_LIB_PATH_ENV_VAR_NAME: typeof EnvironmentVariableNames.RUSH_LIB_PATH;
+export type RushLibModuleType = Record<string, unknown>;
+export interface ISdkContext {
+    rushLibModule: RushLibModuleType | undefined;
+}
+export declare const sdkContext: ISdkContext;
+/**
+ * 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`.
+ */
+export declare function tryFindRushJsonLocation(startingFolder: string): string | undefined;
+export declare function _require<TResult>(moduleName: string): TResult;
+/**
+ * Require `@microsoft/rush-lib` under the specified folder path.
+ */
+export declare function requireRushLibUnderFolderPath(folderPath: string): RushLibModuleType;
+//# sourceMappingURL=helpers.d.ts.map

package/lib-shim/helpers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"helpers.d.ts","sourceRoot":"","sources":["../src/helpers.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,qBAAqB,CAAC;AAEpE,eAAO,MAAM,aAAa,EAAE,qBAA6C,CAAC;AAC1E,eAAO,MAAM,0BAA0B,EAAE,OAAO,wBAAwB,CAAC,aAAgC,CAAC;AAE1G,MAAM,MAAM,iBAAiB,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AAExD,MAAM,WAAW,WAAW;IAC1B,aAAa,EAAE,iBAAiB,GAAG,SAAS,CAAC;CAC9C;AAED,eAAO,MAAM,UAAU,EAAE,WAExB,CAAC;AAEF;;;;;GAKG;AACH,wBAAgB,uBAAuB,CAAC,cAAc,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAoBlF;AAED,wBAAgB,QAAQ,CAAC,OAAO,EAAE,UAAU,EAAE,MAAM,GAAG,OAAO,CAU7D;AAED;;GAEG;AACH,wBAAgB,6BAA6B,CAAC,UAAU,EAAE,MAAM,GAAG,iBAAiB,CAOnF"}

package/lib-shim/helpers.js

@@ -0,0 +1,83 @@
+"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.requireRushLibUnderFolderPath = exports._require = exports.tryFindRushJsonLocation = exports.sdkContext = exports.RUSH_LIB_PATH_ENV_VAR_NAME = exports.RUSH_LIB_NAME = void 0;
+const path = __importStar(require("path"));
+const node_core_library_1 = require("@rushstack/node-core-library");
+exports.RUSH_LIB_NAME = '@microsoft/rush-lib';
+exports.RUSH_LIB_PATH_ENV_VAR_NAME = '_RUSH_LIB_PATH';
+exports.sdkContext = {
+    rushLibModule: undefined
+};
+/**
+ * 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;
+}
+exports.tryFindRushJsonLocation = tryFindRushJsonLocation;
+function _require(moduleName) {
+    if (typeof __non_webpack_require__ === 'function') {
+        // If this library has been bundled with Webpack, we need to call the real `require` function
+        // that doesn't get turned into a `__webpack_require__` statement.
+        // `__non_webpack_require__` is a Webpack macro that gets turned into a `require` statement
+        // during bundling.
+        return __non_webpack_require__(moduleName);
+    }
+    else {
+        return require(moduleName);
+    }
+}
+exports._require = _require;
+/**
+ * Require `@microsoft/rush-lib` under the specified folder path.
+ */
+function requireRushLibUnderFolderPath(folderPath) {
+    const rushLibModulePath = node_core_library_1.Import.resolveModule({
+        modulePath: exports.RUSH_LIB_NAME,
+        baseFolderPath: folderPath
+    });
+    return _require(rushLibModulePath);
+}
+exports.requireRushLibUnderFolderPath = requireRushLibUnderFolderPath;
+//# sourceMappingURL=helpers.js.map

package/lib-shim/helpers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"helpers.js","sourceRoot":"","sources":["../src/helpers.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D;;;;;;;;;;;;;;;;;;;;;;;;;;AAE3D,2CAA6B;AAC7B,oEAAkE;AAGrD,QAAA,aAAa,GAA0B,qBAAqB,CAAC;AAC7D,QAAA,0BAA0B,GAAkD,gBAAgB,CAAC;AAQ7F,QAAA,UAAU,GAAgB;IACrC,aAAa,EAAE,SAAS;CACzB,CAAC;AAEF;;;;;GAKG;AACH,SAAgB,uBAAuB,CAAC,cAAsB;IAC5D,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;AApBD,0DAoBC;AAED,SAAgB,QAAQ,CAAU,UAAkB;IAClD,IAAI,OAAO,uBAAuB,KAAK,UAAU,EAAE;QACjD,6FAA6F;QAC7F,kEAAkE;QAClE,2FAA2F;QAC3F,mBAAmB;QACnB,OAAO,uBAAuB,CAAC,UAAU,CAAC,CAAC;KAC5C;SAAM;QACL,OAAO,OAAO,CAAC,UAAU,CAAC,CAAC;KAC5B;AACH,CAAC;AAVD,4BAUC;AAED;;GAEG;AACH,SAAgB,6BAA6B,CAAC,UAAkB;IAC9D,MAAM,iBAAiB,GAAW,0BAAM,CAAC,aAAa,CAAC;QACrD,UAAU,EAAE,qBAAa;QACzB,cAAc,EAAE,UAAU;KAC3B,CAAC,CAAC;IAEH,OAAO,QAAQ,CAAC,iBAAiB,CAAC,CAAC;AACrC,CAAC;AAPD,sEAOC","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, FileSystem } from '@rushstack/node-core-library';\nimport type { EnvironmentVariableNames } from '@microsoft/rush-lib';\n\nexport const RUSH_LIB_NAME: '@microsoft/rush-lib' = '@microsoft/rush-lib';\nexport const RUSH_LIB_PATH_ENV_VAR_NAME: typeof EnvironmentVariableNames.RUSH_LIB_PATH = '_RUSH_LIB_PATH';\n\nexport type RushLibModuleType = Record<string, unknown>;\n\nexport interface ISdkContext {\n  rushLibModule: RushLibModuleType | undefined;\n}\n\nexport const sdkContext: ISdkContext = {\n  rushLibModule: undefined\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 */\nexport function 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\nexport function _require<TResult>(moduleName: string): TResult {\n  if (typeof __non_webpack_require__ === 'function') {\n    // If this library has been bundled with Webpack, we need to call the real `require` function\n    // that doesn't get turned into a `__webpack_require__` statement.\n    // `__non_webpack_require__` is a Webpack macro that gets turned into a `require` statement\n    // during bundling.\n    return __non_webpack_require__(moduleName);\n  } else {\n    return require(moduleName);\n  }\n}\n\n/**\n * Require `@microsoft/rush-lib` under the specified folder path.\n */\nexport function 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"]}

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

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

package/lib-shim/index.js

@@ -29,59 +29,49 @@ 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 RUSH_LIB_NAME = '@microsoft/rush-lib';
-const RUSH_LIB_PATH_ENV_VAR_NAME = '_RUSH_LIB_PATH';
+const helpers_1 = require("./helpers");
 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
 }));
-function _require(moduleName) {
-    if (typeof __non_webpack_require__ === 'function') {
-        // If this library has been bundled with Webpack, we need to call the real `require` function
-        // that doesn't get turned into a `__webpack_require__` statement.
-        // `__non_webpack_require__` is a Webpack macro that gets turned into a `require` statement
-        // during bundling.
-        return __non_webpack_require__(moduleName);
-    }
-    else {
-        return require(moduleName);
-    }
-}
+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.
-let rushLibModule = global.___rush___rushLibModule ||
-    global.___rush___rushLibModuleFromEnvironment ||
-    global.___rush___rushLibModuleFromInstallAndRunRush;
-let errorMessage = '';
+if (helpers_1.sdkContext.rushLibModule === undefined) {
+    helpers_1.sdkContext.rushLibModule =
+        global.___rush___rushLibModule ||
+            global.___rush___rushLibModuleFromEnvironment ||
+            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 (rushLibModule === undefined) {
+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 = _require(path.join(callerPackageFolder, 'package.json'));
+            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[RUSH_LIB_NAME] !== undefined) ||
+            if ((callerPackageJson.dependencies && callerPackageJson.dependencies[helpers_1.RUSH_LIB_NAME] !== undefined) ||
                 (callerPackageJson.devDependencies &&
-                    callerPackageJson.devDependencies[RUSH_LIB_NAME] !== undefined) ||
+                    callerPackageJson.devDependencies[helpers_1.RUSH_LIB_NAME] !== undefined) ||
                 (callerPackageJson.peerDependencies &&
-                    callerPackageJson.peerDependencies[RUSH_LIB_NAME] !== undefined)) {
+                    callerPackageJson.peerDependencies[helpers_1.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`);
+                terminal.writeVerboseLine(`Try to load ${helpers_1.RUSH_LIB_NAME} from caller package`);
                 try {
-                    rushLibModule = requireRushLibUnderFolderPath(callerPackageFolder);
+                    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 ${RUSH_LIB_NAME} from caller package`);
+                    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 (rushLibModule !== undefined) {
+                if (helpers_1.sdkContext.rushLibModule !== undefined) {
                     // to track which scenario is active and how it got initialized.
-                    global.___rush___rushLibModule = rushLibModule;
-                    terminal.writeVerboseLine(`Loaded ${RUSH_LIB_NAME} from caller`);
+                    global.___rush___rushLibModule = helpers_1.sdkContext.rushLibModule;
+                    terminal.writeVerboseLine(`Loaded ${helpers_1.RUSH_LIB_NAME} from caller`);
                 }
             }
         }
@@ -89,29 +79,29 @@ if (rushLibModule === undefined) {
 }
 // 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 (rushLibModule === undefined) {
-    const rushLibPath = process.env[RUSH_LIB_PATH_ENV_VAR_NAME];
+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 ${RUSH_LIB_NAME} from process.env.${RUSH_LIB_PATH_ENV_VAR_NAME} from caller package`);
+        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 {
-            rushLibModule = _require(rushLibPath);
+            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 ${RUSH_LIB_NAME} via process.env.${RUSH_LIB_PATH_ENV_VAR_NAME}`);
+            terminal.writeWarningLine(`Failed to load ${helpers_1.RUSH_LIB_NAME} via process.env.${helpers_1.RUSH_LIB_PATH_ENV_VAR_NAME}`);
         }
-        if (rushLibModule !== undefined) {
+        if (helpers_1.sdkContext.rushLibModule !== undefined) {
             // to track which scenario is active and how it got initialized.
-            global.___rush___rushLibModuleFromEnvironment = rushLibModule;
-            terminal.writeVerboseLine(`Loaded ${RUSH_LIB_NAME} from process.env.${RUSH_LIB_PATH_ENV_VAR_NAME}`);
+            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 use install-run-rush.js to obtain the appropriate rush-lib version for the monorepo.
-if (rushLibModule === undefined) {
+if (helpers_1.sdkContext.rushLibModule === undefined) {
     try {
-        const rushJsonPath = tryFindRushJsonLocation(process.cwd());
+        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.');
@@ -122,34 +112,34 @@ if (rushLibModule === undefined) {
         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);
+            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 (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'], {
+                const installAndRunRushProcess = 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`);
+                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  ${RUSH_LIB_NAME} installed by install-run-rush a second time`);
-                rushLibModule = requireRushLibUnderFolderPath(installRunNodeModuleFolder);
+                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 (e) {
                 console.error(`${installAndRunRushStderrContent}`);
-                throw new Error(`The ${RUSH_LIB_NAME} package failed to load`);
+                throw new Error(`The ${helpers_1.RUSH_LIB_NAME} package failed to load`);
             }
         }
-        if (rushLibModule !== undefined) {
+        if (helpers_1.sdkContext.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`);
+            global.___rush___rushLibModuleFromInstallAndRunRush = helpers_1.sdkContext.rushLibModule;
+            terminal.writeVerboseLine(`Loaded ${helpers_1.RUSH_LIB_NAME} installed by install-run-rush`);
         }
     }
     catch (e) {
@@ -157,7 +147,7 @@ if (rushLibModule === undefined) {
         errorMessage = e.message;
     }
 }
-if (rushLibModule === undefined) {
+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.
@@ -167,9 +157,9 @@ ${errorMessage}
     process.exit(1);
 }
 // Based on TypeScript's __exportStar()
-for (const property in rushLibModule) {
+for (const property in helpers_1.sdkContext.rushLibModule) {
     if (property !== 'default' && !exports.hasOwnProperty(property)) {
-        const rushLibModuleForClosure = rushLibModule;
+        const rushLibModuleForClosure = helpers_1.sdkContext.rushLibModule;
         // Based on TypeScript's __createBinding()
         Object.defineProperty(exports, property, {
             enumerable: true,
@@ -189,36 +179,4 @@ function _rushSdk_loadInternalModule(srcImportPath) {
     return exports._RushInternals.loadModule(srcImportPath);
 }
 exports._rushSdk_loadInternalModule = _rushSdk_loadInternalModule;
-/**
- * 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-shim/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D;;;;;;;;;;;;;;;;;;;;;;;;;;;AAE3D,2CAA6B;AAC7B,oEAUsC;AAItC,MAAM,aAAa,GAA0B,qBAAqB,CAAC;AACnE,MAAM,0BAA0B,GAAkD,gBAAgB,CAAC;AAEnG,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;AAUF,SAAS,QAAQ,CAAU,UAAkB;IAC3C,IAAI,OAAO,uBAAuB,KAAK,UAAU,EAAE;QACjD,6FAA6F;QAC7F,kEAAkE;QAClE,2FAA2F;QAC3F,mBAAmB;QACnB,OAAO,uBAAuB,CAAC,UAAU,CAAC,CAAC;KAC5C;SAAM;QACL,OAAO,OAAO,CAAC,UAAU,CAAC,CAAC;KAC5B;AACH,CAAC;AAED,qGAAqG;AACrG,gGAAgG;AAChG,IAAI,aAAa,GACf,MAAM,CAAC,uBAAuB;IAC9B,MAAM,CAAC,sCAAsC;IAC7C,MAAM,CAAC,4CAA4C,CAAC;AACtD,IAAI,YAAY,GAAW,EAAE,CAAC;AAE9B,6FAA6F;AAC7F,+FAA+F;AAC/F,IAAI,aAAa,KAAK,SAAS,EAAE;IAC/B,MAAM,aAAa,GAA8B,MAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,MAAM,0CAAE,QAAQ,CAAC;IAC1E,IAAI,aAAa,EAAE;QACjB,MAAM,mBAAmB,GACvB,qCAAiB,CAAC,QAAQ,CAAC,sBAAsB,CAAC,aAAa,CAAC,CAAC;QAEnE,IAAI,mBAAmB,KAAK,SAAS,EAAE;YACrC,MAAM,iBAAiB,GAAiB,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,mBAAmB,EAAE,cAAc,CAAC,CAAC,CAAC;YAEjG,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,gHAAgH;AAChH,4FAA4F;AAC5F,IAAI,aAAa,KAAK,SAAS,EAAE;IAC/B,MAAM,WAAW,GAAuB,OAAO,CAAC,GAAG,CAAC,0BAA0B,CAAC,CAAC;IAChF,IAAI,WAAW,EAAE;QACf,QAAQ,CAAC,gBAAgB,CACvB,eAAe,aAAa,qBAAqB,0BAA0B,sBAAsB,CAClG,CAAC;QACF,IAAI;YACF,aAAa,GAAG,QAAQ,CAAC,WAAW,CAAC,CAAC;SACvC;QAAC,OAAO,KAAK,EAAE;YACd,8FAA8F;YAC9F,QAAQ,CAAC,gBAAgB,CACvB,kBAAkB,aAAa,oBAAoB,0BAA0B,EAAE,CAChF,CAAC;SACH;QAED,IAAI,aAAa,KAAK,SAAS,EAAE;YAC/B,gEAAgE;YAChE,MAAM,CAAC,sCAAsC,GAAG,aAAa,CAAC;YAC9D,QAAQ,CAAC,gBAAgB,CAAC,UAAU,aAAa,qBAAqB,0BAA0B,EAAE,CAAC,CAAC;SACrG;KACF;CACF;AAED,oHAAoH;AACpH,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,CACvB,mBAAmB,aAAa,8CAA8C,CAC/E,CAAC;gBACF,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,SAAgB,2BAA2B,CAAC,aAAqB;IAC/D,IAAI,CAAC,OAAO,CAAC,cAAc,EAAE;QAC3B,MAAM,IAAI,KAAK,CACb,gBAAgB,OAAO,CAAC,IAAI,CAAC,OAAO,qDAAqD,CAC1F,CAAC;KACH;IACD,OAAO,OAAO,CAAC,cAAc,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC;AAC1D,CAAC;AAPD,kEAOC;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,QAAQ,CAAC,iBAAiB,CAAC,CAAC;AACrC,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';\nimport type { EnvironmentVariableNames } from '@microsoft/rush-lib';\n\nconst RUSH_LIB_NAME: '@microsoft/rush-lib' = '@microsoft/rush-lib';\nconst RUSH_LIB_PATH_ENV_VAR_NAME: typeof EnvironmentVariableNames.RUSH_LIB_PATH = '_RUSH_LIB_PATH';\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___rushLibModuleFromEnvironment?: RushLibModuleType;\n    ___rush___rushLibModuleFromInstallAndRunRush?: RushLibModuleType;\n  };\n\nfunction _require<TResult>(moduleName: string): TResult {\n  if (typeof __non_webpack_require__ === 'function') {\n    // If this library has been bundled with Webpack, we need to call the real `require` function\n    // that doesn't get turned into a `__webpack_require__` statement.\n    // `__non_webpack_require__` is a Webpack macro that gets turned into a `require` statement\n    // during bundling.\n    return __non_webpack_require__(moduleName);\n  } else {\n    return require(moduleName);\n  }\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 ||\n  global.___rush___rushLibModuleFromEnvironment ||\n  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 | 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          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 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 (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      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 (rushLibModule !== undefined) {\n      // to track which scenario is active and how it got initialized.\n      global.___rush___rushLibModuleFromEnvironment = 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 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(\n          `Trying to load  ${RUSH_LIB_NAME} installed by install-run-rush a second time`\n        );\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 * 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\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"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D;;;;;;;;;;;;;;;;;;;;;;;;;;;AAE3D,2CAA6B;AAC7B,oEAQsC;AAEtC,uCAQmB;AAEnB,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,IAAI,YAAY,GAAW,EAAE,CAAC;AAE9B,qGAAqG;AACrG,gGAAgG;AAChG,IAAI,oBAAU,CAAC,aAAa,KAAK,SAAS,EAAE;IAC1C,oBAAU,CAAC,aAAa;QACtB,MAAM,CAAC,uBAAuB;YAC9B,MAAM,CAAC,sCAAsC;YAC7C,MAAM,CAAC,4CAA4C,CAAC;CACvD;AAED,6FAA6F;AAC7F,+FAA+F;AAC/F,IAAI,oBAAU,CAAC,aAAa,KAAK,SAAS,EAAE;IAC1C,MAAM,aAAa,GAA8B,MAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,MAAM,0CAAE,QAAQ,CAAC;IAC1E,IAAI,aAAa,EAAE;QACjB,MAAM,mBAAmB,GACvB,qCAAiB,CAAC,QAAQ,CAAC,sBAAsB,CAAC,aAAa,CAAC,CAAC;QAEnE,IAAI,mBAAmB,KAAK,SAAS,EAAE;YACrC,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;gBACA,mDAAmD;gBACnD,QAAQ,CAAC,gBAAgB,CAAC,eAAe,uBAAa,sBAAsB,CAAC,CAAC;gBAC9E,IAAI;oBACF,oBAAU,CAAC,aAAa,GAAG,IAAA,uCAA6B,EAAC,mBAAmB,CAAC,CAAC;iBAC/E;gBAAC,OAAO,KAAK,EAAE;oBACd,6CAA6C;oBAC7C,QAAQ,CAAC,gBAAgB,CAAC,kBAAkB,uBAAa,sBAAsB,CAAC,CAAC;iBAClF;gBAED,oFAAoF;gBACpF,qGAAqG;gBACrG,IAAI,oBAAU,CAAC,aAAa,KAAK,SAAS,EAAE;oBAC1C,gEAAgE;oBAChE,MAAM,CAAC,uBAAuB,GAAG,oBAAU,CAAC,aAAa,CAAC;oBAC1D,QAAQ,CAAC,gBAAgB,CAAC,UAAU,uBAAa,cAAc,CAAC,CAAC;iBAClE;aACF;SACF;KACF;CACF;AAED,gHAAgH;AAChH,4FAA4F;AAC5F,IAAI,oBAAU,CAAC,aAAa,KAAK,SAAS,EAAE;IAC1C,MAAM,WAAW,GAAuB,OAAO,CAAC,GAAG,CAAC,oCAA0B,CAAC,CAAC;IAChF,IAAI,WAAW,EAAE;QACf,QAAQ,CAAC,gBAAgB,CACvB,eAAe,uBAAa,qBAAqB,oCAA0B,sBAAsB,CAClG,CAAC;QACF,IAAI;YACF,oBAAU,CAAC,aAAa,GAAG,IAAA,kBAAQ,EAAC,WAAW,CAAC,CAAC;SAClD;QAAC,OAAO,KAAK,EAAE;YACd,8FAA8F;YAC9F,QAAQ,CAAC,gBAAgB,CACvB,kBAAkB,uBAAa,oBAAoB,oCAA0B,EAAE,CAChF,CAAC;SACH;QAED,IAAI,oBAAU,CAAC,aAAa,KAAK,SAAS,EAAE;YAC1C,gEAAgE;YAChE,MAAM,CAAC,sCAAsC,GAAG,oBAAU,CAAC,aAAa,CAAC;YACzE,QAAQ,CAAC,gBAAgB,CAAC,UAAU,uBAAa,qBAAqB,oCAA0B,EAAE,CAAC,CAAC;SACrG;KACF;CACF;AAED,oHAAoH;AACpH,4GAA4G;AAC5G,IAAI,oBAAU,CAAC,aAAa,KAAK,SAAS,EAAE;IAC1C,IAAI;QACF,MAAM,YAAY,GAAuB,IAAA,iCAAuB,EAAC,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,uBAAa,gCAAgC,CAAC,CAAC;YAC5F,oBAAU,CAAC,aAAa,GAAG,IAAA,uCAA6B,EAAC,0BAA0B,CAAC,CAAC;SACtF;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,uBAAa,4BAA4B,CAAC,CAAC;iBACnE;gBAED,sDAAsD;gBACtD,QAAQ,CAAC,gBAAgB,CACvB,mBAAmB,uBAAa,8CAA8C,CAC/E,CAAC;gBACF,oBAAU,CAAC,aAAa,GAAG,IAAA,uCAA6B,EAAC,0BAA0B,CAAC,CAAC;aACtF;YAAC,OAAO,CAAC,EAAE;gBACV,OAAO,CAAC,KAAK,CAAC,GAAG,8BAA8B,EAAE,CAAC,CAAC;gBACnD,MAAM,IAAI,KAAK,CAAC,OAAO,uBAAa,yBAAyB,CAAC,CAAC;aAChE;SACF;QAED,IAAI,oBAAU,CAAC,aAAa,KAAK,SAAS,EAAE;YAC1C,gEAAgE;YAChE,MAAM,CAAC,4CAA4C,GAAG,oBAAU,CAAC,aAAa,CAAC;YAC/E,QAAQ,CAAC,gBAAgB,CAAC,UAAU,uBAAa,gCAAgC,CAAC,CAAC;SACpF;KACF;IAAC,OAAO,CAAC,EAAE;QACV,WAAW;QACX,YAAY,GAAI,CAAW,CAAC,OAAO,CAAC;KACrC;CACF;AAED,IAAI,oBAAU,CAAC,aAAa,KAAK,SAAS,EAAE;IAC1C,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,oBAAU,CAAC,aAAa,EAAE;IAC/C,IAAI,QAAQ,KAAK,SAAS,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,QAAQ,CAAC,EAAE;QAC/D,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;KACJ;CACF;AAED;;GAEG;AACH,SAAgB,2BAA2B,CAAC,aAAqB;IAC/D,IAAI,CAAC,OAAO,CAAC,cAAc,EAAE;QAC3B,MAAM,IAAI,KAAK,CACb,gBAAgB,OAAO,CAAC,IAAI,CAAC,OAAO,qDAAqD,CAC1F,CAAC;KACH;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  JsonObject,\n  IPackageJson,\n  PackageJsonLookup,\n  Executable,\n  Terminal,\n  ConsoleTerminalProvider\n} from '@rushstack/node-core-library';\nimport type { SpawnSyncReturns } from 'child_process';\nimport {\n  RUSH_LIB_NAME,\n  RUSH_LIB_PATH_ENV_VAR_NAME,\n  RushLibModuleType,\n  _require,\n  requireRushLibUnderFolderPath,\n  tryFindRushJsonLocation,\n  sdkContext\n} from './helpers';\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\ndeclare const global: NodeJS.Global &\n  typeof globalThis & {\n    ___rush___rushLibModule?: RushLibModuleType;\n    ___rush___rushLibModuleFromEnvironment?: 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___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 use 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    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      sdkContext.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 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 (e) {\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  } 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  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-shim/loader.d.ts

@@ -0,0 +1,86 @@
+/// <reference types="node" />
+/**
+ * Type of {@link ISdkCallbackEvent.logMessage}
+ * @public
+ */
+export interface IProgressBarCallbackLogMessage {
+    /**
+     * A status message to print in the log window, or `undefined` if there are
+     * no further messages.  This string may contain newlines.
+     */
+    text: string;
+    /**
+     * The type of message.  More message types may be added in the future.
+     */
+    kind: 'info' | 'debug';
+}
+/**
+ * Event options for {@link ILoadSdkAsyncOptions.onNotifyEvent}
+ * @public
+ */
+export interface ISdkCallbackEvent {
+    /**
+     * Allows the caller to display log information about the operation.
+     */
+    logMessage: IProgressBarCallbackLogMessage | undefined;
+    /**
+     * Allows the caller to display a progress bar for long-running operations.
+     *
+     * @remarks
+     * If a long-running operation is required, then `progressPercent` will
+     * start at 0.0 and count upwards and finish at 100.0 if the operation completes
+     * successfully.  If the long-running operation has not yet started, or
+     * is not required, then the value will be `undefined`.
+     */
+    progressPercent: number | undefined;
+}
+/**
+ * Type of {@link ILoadSdkAsyncOptions.onNotifyEvent}
+ * @public
+ */
+export type SdkNotifyEventCallback = (sdkEvent: ISdkCallbackEvent) => void;
+/**
+ * Options for {@link RushSdkLoader.loadAsync}
+ * @public
+ */
+export interface ILoadSdkAsyncOptions {
+    /**
+     * The folder to start from when searching for the Rush workspace configuration.
+     * If this folder does not contain a `rush.json` file, then each parent folder
+     * will be searched.  If `rush.json` is not found, then the SDK fails to load.
+     */
+    rushJsonSearchFolder?: string;
+    /**
+     * A cancellation token that the caller can use to prematurely abort the operation.
+     */
+    abortSignal?: AbortSignal;
+    /**
+     * Allows the caller to monitor the progress of the operation.
+     */
+    onNotifyEvent?: SdkNotifyEventCallback;
+}
+/**
+ * Exposes operations that control how the `@microsoft/rush-lib` engine is
+ * located and loaded.
+ * @public
+ */
+export declare class RushSdkLoader {
+    /**
+     * Throws an "AbortError" exception if abortSignal.aborted is true.
+     */
+    private static _checkForCancel;
+    /**
+     * Returns true if the Rush engine has already been loaded.
+     */
+    static get isLoaded(): boolean;
+    /**
+     * 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 loadAsync(options?: ILoadSdkAsyncOptions): Promise<void>;
+}
+//# sourceMappingURL=loader.d.ts.map

package/lib-shim/loader.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"loader.d.ts","sourceRoot":"","sources":["../src/loader.ts"],"names":[],"mappings":";AAsBA;;;GAGG;AACH,MAAM,WAAW,8BAA8B;IAC7C;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AAED;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,UAAU,EAAE,8BAA8B,GAAG,SAAS,CAAC;IAEvD;;;;;;;;OAQG;IACH,eAAe,EAAE,MAAM,GAAG,SAAS,CAAC;CACrC;AAED;;;GAGG;AACH,MAAM,MAAM,sBAAsB,GAAG,CAAC,QAAQ,EAAE,iBAAiB,KAAK,IAAI,CAAC;AAE3E;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACnC;;;;OAIG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B;;OAEG;IACH,WAAW,CAAC,EAAE,WAAW,CAAC;IAE1B;;OAEG;IACH,aAAa,CAAC,EAAE,sBAAsB,CAAC;CACxC;AAED;;;;GAIG;AACH,qBAAa,aAAa;IACxB;;OAEG;IACH,OAAO,CAAC,MAAM,CAAC,eAAe;IAwB9B;;OAEG;IACH,WAAkB,QAAQ,IAAI,OAAO,CAEpC;IAED;;;;;;;OAOG;WACiB,SAAS,CAAC,OAAO,CAAC,EAAE,oBAAoB,GAAG,OAAO,CAAC,IAAI,CAAC;CA+I7E"}

package/lib-shim/loader.js

@@ -0,0 +1,189 @@
+"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.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, _c;
+        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 = (_a = options.abortSignal) !== null && _a !== void 0 ? _a : { aborted: false };
+        try {
+            const rushJsonSearchFolder = (_b = options.rushJsonSearchFolder) !== null && _b !== void 0 ? _b : 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 (e) {
+                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`);
+                    }
+                    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 (e) {
+                    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: ' + ((_c = e.message) !== null && _c !== void 0 ? _c : 'An unknown error occurred')
+                    },
+                    progressPercent
+                });
+            }
+            throw e;
+        }
+    }
+}
+exports.RushSdkLoader = RushSdkLoader;
+//# sourceMappingURL=loader.js.map

package/lib-shim/loader.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"loader.js","sourceRoot":"","sources":["../src/loader.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D;;;;;;;;;;;;;;;;;;;;;;;;;;AAE3D,2CAA6B;AAE7B,oEAAgF;AAEhF,uCAMmB;AA6EnB;;;;GAIG;AACH,MAAa,aAAa;IACxB;;OAEG;IACK,MAAM,CAAC,eAAe,CAC5B,WAAwB,EACxB,aAAiD,EACjD,eAAmC;QAEnC,IAAI,CAAC,WAAW,CAAC,OAAO,EAAE;YACxB,OAAO;SACR;QAED,IAAI,aAAa,EAAE;YACjB,aAAa,CAAC;gBACZ,UAAU,EAAE;oBACV,IAAI,EAAE,MAAM;oBACZ,IAAI,EAAE,4BAA4B;iBACnC;gBACD,eAAe;aAChB,CAAC,CAAC;SACJ;QAED,MAAM,KAAK,GAAU,IAAI,KAAK,CAAC,4BAA4B,CAAC,CAAC;QAC7D,KAAK,CAAC,IAAI,GAAG,YAAY,CAAC;QAC1B,MAAM,KAAK,CAAC;IACd,CAAC;IAED;;OAEG;IACI,MAAM,KAAK,QAAQ;QACxB,OAAO,oBAAU,CAAC,aAAa,KAAK,SAAS,CAAC;IAChD,CAAC;IAED;;;;;;;OAOG;IACI,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC,OAA8B;QAC1D,sFAAsF;;QAEtF,IAAI,CAAC,OAAO,EAAE;YACZ,OAAO,GAAG,EAAE,CAAC;SACd;QAED,IAAI,aAAa,CAAC,QAAQ,EAAE;YAC1B,MAAM,IAAI,KAAK,CAAC,kFAAkF,CAAC,CAAC;SACrG;QAED,MAAM,aAAa,GAAuC,OAAO,CAAC,aAAa,CAAC;QAChF,IAAI,eAAe,GAAuB,SAAS,CAAC;QAEpD,MAAM,WAAW,GAAgB,MAAA,OAAO,CAAC,WAAW,mCAAI,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC;QAE3E,IAAI;YACF,MAAM,oBAAoB,GAAW,MAAA,OAAO,CAAC,oBAAoB,mCAAI,OAAO,CAAC,GAAG,EAAE,CAAC;YAEnF,IAAI,aAAa,EAAE;gBACjB,aAAa,CAAC;oBACZ,UAAU,EAAE;wBACV,IAAI,EAAE,OAAO;wBACb,IAAI,EAAE,yCAAyC,GAAG,oBAAoB;qBACvE;oBACD,eAAe;iBAChB,CAAC,CAAC;aACJ;YAED,MAAM,YAAY,GAAuB,IAAA,iCAAuB,EAAC,oBAAoB,CAAC,CAAC;YACvF,IAAI,CAAC,YAAY,EAAE;gBACjB,MAAM,IAAI,KAAK,CACb,2EAA2E;oBACzE,GAAG,oBAAoB,IAAI,CAC9B,CAAC;aACH;YACD,MAAM,YAAY,GAAW,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;YAExD,MAAM,QAAQ,GAAe,MAAM,4BAAQ,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC;YACpE,MAAM,EAAE,WAAW,EAAE,GAAG,QAAQ,CAAC;YAEjC,MAAM,0BAA0B,GAAW,IAAI,CAAC,IAAI,CAClD,YAAY,EACZ,2CAA2C,WAAW,EAAE,CACzD,CAAC;YAEF,IAAI;gBACF,yFAAyF;gBACzF,IAAI,aAAa,EAAE;oBACjB,aAAa,CAAC;wBACZ,UAAU,EAAE;4BACV,IAAI,EAAE,MAAM;4BACZ,IAAI,EAAE,mBAAmB,uBAAa,gCAAgC;yBACvE;wBACD,eAAe;qBAChB,CAAC,CAAC;iBACJ;gBACD,oBAAU,CAAC,aAAa,GAAG,IAAA,uCAA6B,EAAC,0BAA0B,CAAC,CAAC;aACtF;YAAC,OAAO,CAAC,EAAE;gBACV,IAAI,8BAA8B,GAAW,EAAE,CAAC;gBAChD,IAAI;oBACF,MAAM,uBAAuB,GAAW,IAAI,CAAC,IAAI,CAC/C,YAAY,EACZ,oCAAoC,CACrC,CAAC;oBAEF,IAAI,aAAa,EAAE;wBACjB,aAAa,CAAC;4BACZ,UAAU,EAAE;gCACV,IAAI,EAAE,MAAM;gCACZ,IAAI,EAAE,6EAA6E;6BACpF;4BACD,eAAe;yBAChB,CAAC,CAAC;qBACJ;oBAED,yBAAyB;oBACzB,eAAe,GAAG,CAAC,CAAC;oBAEpB,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;wBACzC,MAAM,IAAI,KAAK,CAAC,OAAO,uBAAa,4BAA4B,CAAC,CAAC;qBACnE;oBAED,aAAa,CAAC,eAAe,CAAC,WAAW,EAAE,aAAa,EAAE,eAAe,CAAC,CAAC;oBAE3E,+CAA+C;oBAC/C,eAAe,GAAG,EAAE,CAAC;oBAErB,sDAAsD;oBACtD,IAAI,aAAa,EAAE;wBACjB,aAAa,CAAC;4BACZ,UAAU,EAAE;gCACV,IAAI,EAAE,OAAO;gCACb,IAAI,EAAE,mBAAmB,uBAAa,8CAA8C;6BACrF;4BACD,eAAe;yBAChB,CAAC,CAAC;qBACJ;oBAED,oBAAU,CAAC,aAAa,GAAG,IAAA,uCAA6B,EAAC,0BAA0B,CAAC,CAAC;oBAErF,eAAe,GAAG,GAAG,CAAC;iBACvB;gBAAC,OAAO,CAAC,EAAE;oBACV,OAAO,CAAC,KAAK,CAAC,GAAG,8BAA8B,EAAE,CAAC,CAAC;oBACnD,MAAM,IAAI,KAAK,CAAC,OAAO,uBAAa,yBAAyB,CAAC,CAAC;iBAChE;aACF;YAED,IAAI,oBAAU,CAAC,aAAa,KAAK,SAAS,EAAE;gBAC1C,gEAAgE;gBAChE,MAAM,CAAC,4CAA4C,GAAG,oBAAU,CAAC,aAAa,CAAC;gBAC/E,IAAI,aAAa,EAAE;oBACjB,aAAa,CAAC;wBACZ,UAAU,EAAE;4BACV,IAAI,EAAE,OAAO;4BACb,IAAI,EAAE,UAAU,uBAAa,gCAAgC;yBAC9D;wBACD,eAAe;qBAChB,CAAC,CAAC;iBACJ;aACF;SACF;QAAC,OAAO,CAAC,EAAE;YACV,IAAI,aAAa,EAAE;gBACjB,aAAa,CAAC;oBACZ,UAAU,EAAE;wBACV,IAAI,EAAE,MAAM;wBACZ,IAAI,EAAE,wBAAwB,GAAG,CAAC,MAAA,CAAC,CAAC,OAAO,mCAAI,2BAA2B,CAAC;qBAC5E;oBACD,eAAe;iBAChB,CAAC,CAAC;aACJ;YACD,MAAM,CAAC,CAAC;SACT;IACH,CAAC;CACF;AA1LD,sCA0LC","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 type { SpawnSyncReturns } from 'child_process';\nimport { JsonFile, JsonObject, Executable } from '@rushstack/node-core-library';\n\nimport {\n  tryFindRushJsonLocation,\n  RUSH_LIB_NAME,\n  RushLibModuleType,\n  requireRushLibUnderFolderPath,\n  sdkContext\n} from './helpers';\n\ndeclare const global: NodeJS.Global &\n  typeof globalThis & {\n    ___rush___rushLibModule?: RushLibModuleType;\n    ___rush___rushLibModuleFromEnvironment?: RushLibModuleType;\n    ___rush___rushLibModuleFromInstallAndRunRush?: RushLibModuleType;\n  };\n\n/**\n * Type of {@link ISdkCallbackEvent.logMessage}\n * @public\n */\nexport interface IProgressBarCallbackLogMessage {\n  /**\n   * A status message to print in the log window, or `undefined` if there are\n   * no further messages.  This string may contain newlines.\n   */\n  text: string;\n\n  /**\n   * The type of message.  More message types may be added in the future.\n   */\n  kind: 'info' | 'debug';\n}\n\n/**\n * Event options for {@link ILoadSdkAsyncOptions.onNotifyEvent}\n * @public\n */\nexport interface ISdkCallbackEvent {\n  /**\n   * Allows the caller to display log information about the operation.\n   */\n  logMessage: IProgressBarCallbackLogMessage | undefined;\n\n  /**\n   * Allows the caller to display a progress bar for long-running operations.\n   *\n   * @remarks\n   * If a long-running operation is required, then `progressPercent` will\n   * start at 0.0 and count upwards and finish at 100.0 if the operation completes\n   * successfully.  If the long-running operation has not yet started, or\n   * is not required, then the value will be `undefined`.\n   */\n  progressPercent: number | undefined;\n}\n\n/**\n * Type of {@link ILoadSdkAsyncOptions.onNotifyEvent}\n * @public\n */\nexport type SdkNotifyEventCallback = (sdkEvent: ISdkCallbackEvent) => void;\n\n/**\n * Options for {@link RushSdkLoader.loadAsync}\n * @public\n */\nexport interface ILoadSdkAsyncOptions {\n  /**\n   * The folder to start from when searching for the Rush workspace configuration.\n   * If this folder does not contain a `rush.json` file, then each parent folder\n   * will be searched.  If `rush.json` is not found, then the SDK fails to load.\n   */\n  rushJsonSearchFolder?: string;\n\n  /**\n   * A cancellation token that the caller can use to prematurely abort the operation.\n   */\n  abortSignal?: AbortSignal;\n\n  /**\n   * Allows the caller to monitor the progress of the operation.\n   */\n  onNotifyEvent?: SdkNotifyEventCallback;\n}\n\n/**\n * Exposes operations that control how the `@microsoft/rush-lib` engine is\n * located and loaded.\n * @public\n */\nexport class RushSdkLoader {\n  /**\n   * Throws an \"AbortError\" exception if abortSignal.aborted is true.\n   */\n  private static _checkForCancel(\n    abortSignal: AbortSignal,\n    onNotifyEvent: SdkNotifyEventCallback | undefined,\n    progressPercent: number | undefined\n  ): void {\n    if (!abortSignal.aborted) {\n      return;\n    }\n\n    if (onNotifyEvent) {\n      onNotifyEvent({\n        logMessage: {\n          kind: 'info',\n          text: `The operation was canceled`\n        },\n        progressPercent\n      });\n    }\n\n    const error: Error = new Error('The operation was canceled');\n    error.name = 'AbortError';\n    throw error;\n  }\n\n  /**\n   * Returns true if the Rush engine has already been loaded.\n   */\n  public static get isLoaded(): boolean {\n    return sdkContext.rushLibModule !== undefined;\n  }\n\n  /**\n   * Manually load the Rush engine based on rush.json found for `rushJsonSearchFolder`.\n   * Throws an exception if {@link RushSdkLoader.isLoaded} is already `true`.\n   *\n   * @remarks\n   * This API supports an callback that can be used display a progress bar,\n   * log of operations, and allow the operation to be canceled prematurely.\n   */\n  public static async loadAsync(options?: ILoadSdkAsyncOptions): Promise<void> {\n    // SCENARIO 5: The rush-lib engine is loaded manually using rushSdkLoader.loadAsync().\n\n    if (!options) {\n      options = {};\n    }\n\n    if (RushSdkLoader.isLoaded) {\n      throw new Error('RushSdkLoader.loadAsync() failed because the Rush engine has already been loaded');\n    }\n\n    const onNotifyEvent: SdkNotifyEventCallback | undefined = options.onNotifyEvent;\n    let progressPercent: number | undefined = undefined;\n\n    const abortSignal: AbortSignal = options.abortSignal ?? { aborted: false };\n\n    try {\n      const rushJsonSearchFolder: string = options.rushJsonSearchFolder ?? process.cwd();\n\n      if (onNotifyEvent) {\n        onNotifyEvent({\n          logMessage: {\n            kind: 'debug',\n            text: `Searching for rush.json starting from: ` + rushJsonSearchFolder\n          },\n          progressPercent\n        });\n      }\n\n      const rushJsonPath: string | undefined = tryFindRushJsonLocation(rushJsonSearchFolder);\n      if (!rushJsonPath) {\n        throw new Error(\n          'Unable to find rush.json in the specified folder or its parent folders:\\n' +\n            `${rushJsonSearchFolder}\\n`\n        );\n      }\n      const monorepoRoot: string = path.dirname(rushJsonPath);\n\n      const rushJson: JsonObject = await JsonFile.loadAsync(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        if (onNotifyEvent) {\n          onNotifyEvent({\n            logMessage: {\n              kind: 'info',\n              text: `Trying to load  ${RUSH_LIB_NAME} installed by install-run-rush`\n            },\n            progressPercent\n          });\n        }\n        sdkContext.rushLibModule = requireRushLibUnderFolderPath(installRunNodeModuleFolder);\n      } catch (e) {\n        let installAndRunRushStderrContent: string = '';\n        try {\n          const installAndRunRushJSPath: string = path.join(\n            monorepoRoot,\n            'common/scripts/install-run-rush.js'\n          );\n\n          if (onNotifyEvent) {\n            onNotifyEvent({\n              logMessage: {\n                kind: 'info',\n                text: 'The Rush engine has not been installed yet. Invoking install-run-rush.js...'\n              },\n              progressPercent\n            });\n          }\n\n          // Start the installation\n          progressPercent = 0;\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          RushSdkLoader._checkForCancel(abortSignal, onNotifyEvent, progressPercent);\n\n          // TODO: Implement incremental progress updates\n          progressPercent = 90;\n\n          // Retry to load \"rush-lib\" after install-run-rush run\n          if (onNotifyEvent) {\n            onNotifyEvent({\n              logMessage: {\n                kind: 'debug',\n                text: `Trying to load  ${RUSH_LIB_NAME} installed by install-run-rush a second time`\n              },\n              progressPercent\n            });\n          }\n\n          sdkContext.rushLibModule = requireRushLibUnderFolderPath(installRunNodeModuleFolder);\n\n          progressPercent = 100;\n        } catch (e) {\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        if (onNotifyEvent) {\n          onNotifyEvent({\n            logMessage: {\n              kind: 'debug',\n              text: `Loaded ${RUSH_LIB_NAME} installed by install-run-rush`\n            },\n            progressPercent\n          });\n        }\n      }\n    } catch (e) {\n      if (onNotifyEvent) {\n        onNotifyEvent({\n          logMessage: {\n            kind: 'info',\n            text: 'The operation failed: ' + (e.message ?? 'An unknown error occurred')\n          },\n          progressPercent\n        });\n      }\n      throw e;\n    }\n  }\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rushstack/rush-sdk",
-  "version": "5.100.2",
+  "version": "5.101.0",
   "description": "An API for interacting with the Rush engine",
   "repository": {
     "type": "git",
@@ -10,22 +10,34 @@
   "homepage": "https://rushjs.io",
   "main": "lib-shim/index.js",
   "typings": "dist/rush-lib.d.ts",
+  "exports": {
+    ".": "./lib-shim/index.js",
+    "./loader": "./lib-shim/loader.js"
+  },
+  "typesVersions": {
+    "*": {
+      "loader": [
+        "./dist/loader.d.ts"
+      ]
+    }
+  },
   "license": "MIT",
   "dependencies": {
     "@types/node-fetch": "2.6.2",
     "tapable": "2.2.1",
-    "@rushstack/node-core-library": "3.59.6"
+    "@rushstack/node-core-library": "3.59.7"
   },
   "devDependencies": {
+    "@types/node": "14.18.36",
     "@types/semver": "7.5.0",
     "@types/webpack-env": "1.18.0",
-    "@microsoft/rush-lib": "5.100.2",
-    "@rushstack/eslint-config": "3.3.2",
-    "@rushstack/heft": "0.58.0",
-    "@rushstack/heft-node-rig": "2.2.19",
-    "@rushstack/stream-collator": "4.0.259",
-    "@rushstack/ts-command-line": "4.15.1",
-    "@rushstack/terminal": "0.5.34"
+    "@microsoft/rush-lib": "5.101.0",
+    "@rushstack/eslint-config": "3.3.3",
+    "@rushstack/heft": "0.58.2",
+    "@rushstack/heft-node-rig": "2.2.22",
+    "@rushstack/stream-collator": "4.0.262",
+    "@rushstack/ts-command-line": "4.15.2",
+    "@rushstack/terminal": "0.5.37"
   },
   "scripts": {
     "build": "heft build --clean",