@rushstack/rush-sdk 5.97.1 → 5.98.0

package/dist/rush-lib.d.ts

@@ -208,7 +208,7 @@ export declare class ChangeManager {
 /**
  * @beta
  */
-export declare type CloudBuildCacheProviderFactory = (buildCacheJson: IBuildCacheJson) => ICloudBuildCacheProvider;
+export declare type CloudBuildCacheProviderFactory = (buildCacheJson: IBuildCacheJson) => ICloudBuildCacheProvider | Promise<ICloudBuildCacheProvider>;
 
 /**
  * Use this class to load and save the "common/config/rush/common-versions.json" config file.
@@ -896,6 +896,10 @@ export declare interface IExperimentsJson {
      * If true, print the outputs of shell commands defined in event hooks to the console.
      */
     printEventHooksOutputToConsole?: boolean;
+    /**
+     * If true, Rush will not allow node_modules in the repo folder or in parent folders.
+     */
+    forbidPhantomResolvableNodeModulesFolders?: boolean;
 }
 
 /**
@@ -1275,16 +1279,15 @@ export declare interface IPhase {
         self: Set<IPhase>;
         upstream: Set<IPhase>;
     };
-    /**
-     * Normally Rush requires that each project's package.json has a `"scripts"` entry matching the phase name.
-     * To disable this check, set `ignoreMissingScript` to true.
-     */
-    ignoreMissingScript: boolean;
     /**
      * By default, Rush returns a nonzero exit code if errors or warnings occur during a command. If this option is
      * set to `true`, Rush will return a zero exit code if warnings occur during the execution of this phase.
      */
     allowWarningsOnSuccess: boolean;
+    /**
+     * What should happen if the script is not defined in a project's package.json scripts field. Default is "error".
+     */
+    missingScriptBehavior: IPhaseBehaviorForMissingScript;
     /**
      * (Optional) If the `shellCommand` field is set for a bulk command, Rush will invoke it for each
      * selected project; otherwise, Rush will invoke the package.json `"scripts"` entry matching Rush command/phase name.
@@ -1296,6 +1299,12 @@ export declare interface IPhase {
     shellCommand?: string;
 }
 
+/**
+ * The set of valid behaviors for a missing script in a project's package.json scripts for a given phase.
+ * @alpha
+ */
+export declare type IPhaseBehaviorForMissingScript = 'silent' | 'log' | 'error';
+
 /**
  * Information about the currently executing phased script command (as defined in command-line.json, or default "build" or "rebuild") provided to plugins.
  * @beta
@@ -2916,6 +2925,7 @@ export declare class RushConfiguration {
      * an RushConfiguration object.
      */
     static loadFromConfigurationFile(rushJsonFilename: string): RushConfiguration;
+    static tryLoadFromDefaultLocation(options?: ITryFindRushJsonLocationOptions): RushConfiguration | undefined;
     static loadFromDefaultLocation(options?: ITryFindRushJsonLocationOptions): RushConfiguration;
     /**
      * Find the rush.json location and return the path, or undefined if a rush.json can't be found.
@@ -3468,6 +3478,10 @@ export declare class RushConstants {
      * file system event occurs in this interval, the timeout will reset.
      */
     static readonly defaultWatchDebounceMs: number;
+    /**
+     * The name of the parameter that can be used to bypass policies.
+     */
+    static readonly bypassPolicyFlagLongName: '--bypass-policy';
 }
 
 /**

package/lib/api/CommandLineConfiguration.d.ts

@@ -3,6 +3,11 @@ import type { ICommandLineJson, IGlobalCommandJson, IFlagParameterJson, IChoiceP
 export interface IShellCommandTokenContext {
     packageFolder: string;
 }
+/**
+ * The set of valid behaviors for a missing script in a project's package.json scripts for a given phase.
+ * @alpha
+ */
+export declare type PhaseBehaviorForMissingScript = 'silent' | 'log' | 'error';
 /**
  * Metadata about a phase.
  * @alpha
@@ -34,16 +39,15 @@ export interface IPhase {
         self: Set<IPhase>;
         upstream: Set<IPhase>;
     };
-    /**
-     * Normally Rush requires that each project's package.json has a `"scripts"` entry matching the phase name.
-     * To disable this check, set `ignoreMissingScript` to true.
-     */
-    ignoreMissingScript: boolean;
     /**
      * By default, Rush returns a nonzero exit code if errors or warnings occur during a command. If this option is
      * set to `true`, Rush will return a zero exit code if warnings occur during the execution of this phase.
      */
     allowWarningsOnSuccess: boolean;
+    /**
+     * What should happen if the script is not defined in a project's package.json scripts field. Default is "error".
+     */
+    missingScriptBehavior: PhaseBehaviorForMissingScript;
     /**
      * (Optional) If the `shellCommand` field is set for a bulk command, Rush will invoke it for each
      * selected project; otherwise, Rush will invoke the package.json `"scripts"` entry matching Rush command/phase name.

package/lib/api/CommandLineJson.d.ts

@@ -88,6 +88,10 @@ export interface IPhaseJson {
      * Normally Rush requires that each project's package.json has a \"scripts\" entry matching the phase name. To disable this check, set \"ignoreMissingScript\" to true.
      */
     ignoreMissingScript?: boolean;
+    /**
+     * What should happen if the script is not defined in a project's package.json scripts field. Default is "error". Supersedes \"ignoreMissingScript\".
+     */
+    missingScriptBehavior?: 'silent' | 'log' | 'error';
     /**
      * By default, Rush returns a nonzero exit code if errors or warnings occur during a command. If this option is set to \"true\", Rush will return a zero exit code if warnings occur during the execution of this phase.
      */

package/lib/api/ExperimentsConfiguration.d.ts

@@ -44,6 +44,10 @@ export interface IExperimentsJson {
      * If true, print the outputs of shell commands defined in event hooks to the console.
      */
     printEventHooksOutputToConsole?: boolean;
+    /**
+     * If true, Rush will not allow node_modules in the repo folder or in parent folders.
+     */
+    forbidPhantomResolvableNodeModulesFolders?: boolean;
 }
 /**
  * Use this class to load the "common/config/rush/experiments.json" config file.

package/lib/api/RushConfiguration.d.ts

@@ -435,6 +435,7 @@ export declare class RushConfiguration {
      * an RushConfiguration object.
      */
     static loadFromConfigurationFile(rushJsonFilename: string): RushConfiguration;
+    static tryLoadFromDefaultLocation(options?: ITryFindRushJsonLocationOptions): RushConfiguration | undefined;
     static loadFromDefaultLocation(options?: ITryFindRushJsonLocationOptions): RushConfiguration;
     /**
      * Find the rush.json location and return the path, or undefined if a rush.json can't be found.

package/lib/cli/RushPnpmCommandLineParser.d.ts

@@ -9,18 +9,17 @@ export interface IRushPnpmCommandLineParserOptions {
     terminalProvider?: ITerminalProvider;
 }
 export declare class RushPnpmCommandLineParser {
-    private _terminal;
-    private _rushConfiguration;
-    private _pnpmArgs;
+    private readonly _terminal;
+    private readonly _rushConfiguration;
+    private readonly _pnpmArgs;
     private _commandName;
-    private _debugEnabled;
-    private _verboseEnabled;
-    constructor(options: IRushPnpmCommandLineParserOptions);
+    private readonly _debugEnabled;
+    private constructor();
+    static initializeAsync(options: IRushPnpmCommandLineParserOptions): Promise<RushPnpmCommandLineParser>;
     executeAsync(): Promise<void>;
-    private _validatePnpmUsage;
+    private _validatePnpmUsageAsync;
     private _execute;
     private _postExecuteAsync;
     private _doRushUpdateAsync;
-    private _reportErrorAndSetExitCode;
 }
 //# sourceMappingURL=RushPnpmCommandLineParser.d.ts.map

package/lib/cli/actions/DeployAction.d.ts

@@ -1,11 +1,13 @@
 import { BaseRushAction } from './BaseRushAction';
-import { RushCommandLineParser } from '../RushCommandLineParser';
+import type { RushCommandLineParser } from '../RushCommandLineParser';
 export declare class DeployAction extends BaseRushAction {
+    private readonly _logger;
     private readonly _scenario;
     private readonly _project;
     private readonly _overwrite;
     private readonly _targetFolder;
     private readonly _createArchivePath;
+    private readonly _createArchiveOnly;
     constructor(parser: RushCommandLineParser);
     protected runAsync(): Promise<void>;
 }

package/lib/cli/actions/PublishAction.d.ts

@@ -34,7 +34,7 @@ export declare class PublishAction extends BaseRushAction {
      * Validate some input parameters
      */
     private _validate;
-    private _publishChanges;
+    private _publishChangesAsync;
     private _publishAll;
     private _gitAddTags;
     private _npmPublish;

package/lib/index.d.ts

@@ -11,7 +11,7 @@ export { IPnpmOptionsJson as _IPnpmOptionsJson, PnpmStoreOptions, PnpmOptionsCon
 export { BuildCacheConfiguration } from './api/BuildCacheConfiguration';
 export { GetCacheEntryIdFunction, IGenerateCacheEntryIdOptions } from './logic/buildCache/CacheEntryId';
 export { FileSystemBuildCacheProvider, IFileSystemBuildCacheProviderOptions } from './logic/buildCache/FileSystemBuildCacheProvider';
-export { IPhase } from './api/CommandLineConfiguration';
+export { IPhase, PhaseBehaviorForMissingScript as IPhaseBehaviorForMissingScript } from './api/CommandLineConfiguration';
 export { EnvironmentConfiguration, EnvironmentVariableNames, IEnvironmentConfigurationInitializeOptions } from './api/EnvironmentConfiguration';
 export { RushConstants } from './logic/RushConstants';
 export { PackageManagerName, PackageManager } from './api/packageManager/PackageManager';

package/lib/logic/ChangeFiles.d.ts

@@ -19,7 +19,7 @@ export declare class ChangeFiles {
     /**
      * Get the array of absolute paths of change files.
      */
-    getFiles(): string[];
+    getFilesAsync(): Promise<string[]>;
     /**
      * Get the path of changes folder.
      */
@@ -27,7 +27,7 @@ export declare class ChangeFiles {
     /**
      * Delete all change files
      */
-    deleteAll(shouldDelete: boolean, updatedChangelogs?: IChangelog[]): number;
-    private _deleteFiles;
+    deleteAllAsync(shouldDelete: boolean, updatedChangelogs?: IChangelog[]): Promise<number>;
+    private _deleteFilesAsync;
 }
 //# sourceMappingURL=ChangeFiles.d.ts.map

package/lib/logic/ChangeManager.d.ts

@@ -23,7 +23,7 @@ export declare class ChangeManager {
      * @param prereleaseToken - prerelease token
      * @param includeCommitDetails - whether commit details need to be included in changes
      */
-    load(changesPath: string, prereleaseToken?: PrereleaseToken, includeCommitDetails?: boolean): void;
+    loadAsync(changesPath: string, prereleaseToken?: PrereleaseToken, includeCommitDetails?: boolean): Promise<void>;
     hasChanges(): boolean;
     get packageChanges(): IChangeInfo[];
     get allPackages(): Map<string, RushConfigurationProject>;
@@ -34,6 +34,6 @@ export declare class ChangeManager {
      * If the value is false, package.json and change logs will not be updated. It will only do a dry-run.
      */
     apply(shouldCommit: boolean): Map<string, IPackageJson> | undefined;
-    updateChangelog(shouldCommit: boolean): void;
+    updateChangelogAsync(shouldCommit: boolean): Promise<void>;
 }
 //# sourceMappingURL=ChangeManager.d.ts.map

package/lib/logic/PublishUtilities.d.ts

@@ -15,7 +15,7 @@ export declare class PublishUtilities {
      * @param changesPath Path to the changes folder.
      * @returns Dictionary of all change requests, keyed by package name.
      */
-    static findChangeRequests(allPackages: Map<string, RushConfigurationProject>, rushConfiguration: RushConfiguration, changeFiles: ChangeFiles, includeCommitDetails?: boolean, prereleaseToken?: PrereleaseToken, projectsToExclude?: Set<string>): IChangeRequests;
+    static findChangeRequestsAsync(allPackages: Map<string, RushConfigurationProject>, rushConfiguration: RushConfiguration, changeFiles: ChangeFiles, includeCommitDetails?: boolean, prereleaseToken?: PrereleaseToken, projectsToExclude?: Set<string>): Promise<IChangeRequests>;
     /**
      * Given the changes hash, flattens them into a sorted array based on their dependency order.
      * @params packageChanges - hash of change requests.

package/lib/logic/RushConstants.d.ts

@@ -215,5 +215,9 @@ export declare class RushConstants {
      * file system event occurs in this interval, the timeout will reset.
      */
     static readonly defaultWatchDebounceMs: number;
+    /**
+     * The name of the parameter that can be used to bypass policies.
+     */
+    static readonly bypassPolicyFlagLongName: '--bypass-policy';
 }
 //# sourceMappingURL=RushConstants.d.ts.map

package/lib/logic/base/BaseInstallManagerTypes.d.ts

@@ -12,6 +12,10 @@ export interface IInstallManagerOptions {
      * Whether to check the validation before install only, without actually installing anything.
      */
     checkOnly: boolean;
+    /**
+     * Whether a "--bypass-policy" flag can be specified.
+     */
+    bypassPolicyAllowed?: boolean;
     /**
      * Whether to skip policy checks.
      */

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

@@ -1,4 +1,5 @@
-import { RushConfiguration } from '../../api/RushConfiguration';
+import { type ITerminal } from '@rushstack/node-core-library';
+import type { RushConfiguration } from '../../api/RushConfiguration';
 export interface IDeployScenarioProjectJson {
     projectName: string;
     additionalProjectsToInclude?: string[];
@@ -34,6 +35,6 @@ export declare class DeployScenarioConfiguration {
      * Example: undefined --> "...common/config/rush/deploy.json"
      */
     static getConfigFilePath(scenarioName: string | undefined, rushConfiguration: RushConfiguration): string;
-    static loadFromFile(scenarioFilePath: string, rushConfiguration: RushConfiguration): DeployScenarioConfiguration;
+    static loadFromFile(terminal: ITerminal, scenarioFilePath: string, rushConfiguration: RushConfiguration): DeployScenarioConfiguration;
 }
 //# sourceMappingURL=DeployScenarioConfiguration.d.ts.map

package/lib/logic/policy/EnvironmentPolicy.d.ts

@@ -0,0 +1,7 @@
+import type { RushConfiguration } from '../../api/RushConfiguration';
+import type { IPolicyValidatorOptions } from './PolicyValidator';
+/**
+ * Ensures the environment where the Rush repo exists is valid
+ */
+export declare function validateAsync(rushConfiguration: RushConfiguration, options: IPolicyValidatorOptions): Promise<void>;
+//# sourceMappingURL=EnvironmentPolicy.d.ts.map

package/lib/logic/policy/EnvironmentPolicy.js

@@ -0,0 +1 @@
+module.exports = require("../../../lib-shim/index")._rushSdk_loadInternalModule("logic/policy/EnvironmentPolicy");

package/lib/logic/policy/GitEmailPolicy.d.ts

@@ -1,6 +1,5 @@
-import { RushConfiguration } from '../../api/RushConfiguration';
-export declare class GitEmailPolicy {
-    static validate(rushConfiguration: RushConfiguration): void;
-    static getEmailExampleLines(rushConfiguration: RushConfiguration): string[];
-}
+import type { RushConfiguration } from '../../api/RushConfiguration';
+import type { IPolicyValidatorOptions } from './PolicyValidator';
+export declare function validate(rushConfiguration: RushConfiguration, options: IPolicyValidatorOptions): void;
+export declare function getEmailExampleLines(rushConfiguration: RushConfiguration): string[];
 //# sourceMappingURL=GitEmailPolicy.d.ts.map

package/lib/logic/policy/PolicyValidator.d.ts

@@ -1,10 +1,9 @@
-import { RushConfiguration } from '../../api/RushConfiguration';
+import type { RushConfiguration } from '../../api/RushConfiguration';
 export interface IPolicyValidatorOptions {
+    bypassPolicyAllowed?: boolean;
     bypassPolicy?: boolean;
     allowShrinkwrapUpdates?: boolean;
     shrinkwrapVariant?: string;
 }
-export declare class PolicyValidator {
-    static validatePolicy(rushConfiguration: RushConfiguration, options: IPolicyValidatorOptions): void;
-}
+export declare function validatePolicyAsync(rushConfiguration: RushConfiguration, options: IPolicyValidatorOptions): Promise<void>;
 //# sourceMappingURL=PolicyValidator.d.ts.map

package/lib/logic/policy/ShrinkwrapFilePolicy.d.ts

@@ -1,13 +1,11 @@
-import { RushConfiguration } from '../../api/RushConfiguration';
-import { IPolicyValidatorOptions } from './PolicyValidator';
-import { RepoStateFile } from '../RepoStateFile';
+import type { RushConfiguration } from '../../api/RushConfiguration';
+import type { IPolicyValidatorOptions } from './PolicyValidator';
+import type { RepoStateFile } from '../RepoStateFile';
 export interface IShrinkwrapFilePolicyValidatorOptions extends IPolicyValidatorOptions {
     repoState: RepoStateFile;
 }
 /**
  *  A policy that validates shrinkwrap files used by package managers.
  */
-export declare class ShrinkwrapFilePolicy {
-    static validate(rushConfiguration: RushConfiguration, options: IPolicyValidatorOptions): void;
-}
+export declare function validate(rushConfiguration: RushConfiguration, options: IPolicyValidatorOptions): void;
 //# sourceMappingURL=ShrinkwrapFilePolicy.d.ts.map

package/lib/pluginFramework/RushSession.d.ts

@@ -13,7 +13,7 @@ export interface IRushSessionOptions {
 /**
  * @beta
  */
-export declare type CloudBuildCacheProviderFactory = (buildCacheJson: IBuildCacheJson) => ICloudBuildCacheProvider;
+export declare type CloudBuildCacheProviderFactory = (buildCacheJson: IBuildCacheJson) => ICloudBuildCacheProvider | Promise<ICloudBuildCacheProvider>;
 /**
  * @beta
  */

package/lib/utilities/PathConstants.d.ts

@@ -15,7 +15,6 @@ export declare const installRunScriptFilename: string;
 export declare const installRunRushScriptFilename: string;
 export declare const installRunRushxScriptFilename: string;
 export declare const installRunRushPnpmScriptFilename: string;
-export declare const createLinksScriptFilename: string;
 /**
  * The path to the scripts folder in rush-lib/dist.
  */

package/lib/utilities/Utilities.d.ts

@@ -1,8 +1,5 @@
 /// <reference types="node" />
-/// <reference types="node" />
-/// <reference types="node" />
 import * as child_process from 'child_process';
-import type * as stream from 'stream';
 import { RushConfiguration } from '../api/RushConfiguration';
 import { syncNpmrc } from './npmrcUtilities';
 export declare type UNINITIALIZED = 'UNINITIALIZED';
@@ -84,10 +81,6 @@ export declare class Utilities {
      * Node.js equivalent of performance.now().
      */
     static getTimeInMs(): number;
-    /**
-     * Returns the values from a Set<T>
-     */
-    static getSetAsArray<T>(set: Set<T> | ReadonlySet<T>): T[];
     /**
      * Retries a function until a timeout is reached. The function is expected to throw if it failed and
      *  should be retried.
@@ -99,10 +92,6 @@ export declare class Utilities {
      * If the folder already exists, no error occurs.
      */
     static createFolderWithRetry(folderName: string): void;
-    /**
-     * Determines if the path points to a file and that it exists.
-     */
-    static fileExists(filePath: string): boolean;
     /**
      * Determines if a path points to a directory and that it exists.
      */
@@ -113,10 +102,6 @@ export declare class Utilities {
      * hard disk.
      */
     static dangerouslyDeletePath(folderPath: string): void;
-    /**
-     * Attempts to delete a file. If it does not exist, or the path is not a file, it no-ops.
-     */
-    static deleteFile(filePath: string): void;
     static isFileTimestampCurrent(dateToCompare: Date, inputFilenames: string[]): boolean;
     /**
      * Executes the command with the specified command-line parameters, and waits for it to complete.
@@ -162,7 +147,6 @@ export declare class Utilities {
     static syncFile(sourcePath: string, destinationPath: string): void;
     static getRushConfigNotFoundError(): Error;
     static usingAsync<TDisposable extends IDisposable>(getDisposableAsync: () => Promise<TDisposable> | IDisposable, doActionAsync: (disposable: TDisposable) => Promise<void> | void): Promise<void>;
-    static readStreamToBufferAsync(stream: stream.Readable): Promise<Buffer>;
     private static _executeLifecycleCommandInternal;
     /**
      * Returns a process.env environment suitable for executing lifecycle scripts.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rushstack/rush-sdk",
-  "version": "5.97.1",
+  "version": "5.98.0",
   "description": "An API for interacting with the Rush engine",
   "repository": {
     "type": "git",
@@ -14,19 +14,19 @@
   "dependencies": {
     "@types/node-fetch": "2.6.2",
     "tapable": "2.2.1",
-    "@rushstack/node-core-library": "3.55.2"
+    "@rushstack/node-core-library": "3.59.0"
   },
   "devDependencies": {
     "@types/heft-jest": "1.0.1",
     "@types/semver": "7.3.5",
     "@types/webpack-env": "1.18.0",
-    "@microsoft/rush-lib": "5.97.1",
+    "@microsoft/rush-lib": "5.98.0",
     "@rushstack/eslint-config": "3.2.0",
-    "@rushstack/heft": "0.50.0",
-    "@rushstack/heft-node-rig": "1.12.6",
-    "@rushstack/stream-collator": "4.0.229",
+    "@rushstack/heft": "0.50.5",
+    "@rushstack/heft-node-rig": "1.12.11",
+    "@rushstack/stream-collator": "4.0.234",
     "@rushstack/ts-command-line": "4.13.2",
-    "@rushstack/terminal": "0.5.4"
+    "@rushstack/terminal": "0.5.9"
   },
   "scripts": {
     "build": "heft build --clean",