@rushstack/rush-sdk 5.78.1 → 5.80.0

package/dist/rush-lib.d.ts

@@ -1086,6 +1086,10 @@ export declare interface IOperationExecutionResult {
      * Object used to report a summary at the end of the Rush invocation.
      */
     readonly stdioSummarizer: StdioSummarizer;
+    /**
+     * The value indicates the duration of the same operation without cache hit.
+     */
+    readonly nonCachedDurationMs: number | undefined;
 }
 
 /**
@@ -1169,6 +1173,31 @@ export declare interface IOperationRunnerContext {
      * Object used to report a summary at the end of the Rush invocation.
      */
     stdioSummarizer: StdioSummarizer;
+    /**
+     * Object used to record state of the operation.
+     *
+     * @internal
+     */
+    _operationStateFile?: _OperationStateFile;
+    /**
+     * Object used to track elapsed time.
+     */
+    stopwatch: IStopwatchResult;
+}
+
+/**
+ * @internal
+ */
+export declare interface _IOperationStateFileOptions {
+    rushProject: RushConfigurationProject;
+    phase: IPhase;
+}
+
+/**
+ * @internal
+ */
+export declare interface _IOperationStateJson {
+    nonCachedDurationMs: number;
 }
 
 /**
@@ -1241,11 +1270,11 @@ export declare interface IPhasedCommand extends IRushCommand {
  */
 export declare interface _IPnpmOptionsJson extends IPackageManagerOptionsJsonBase {
     /**
-     * The store resolution method for PNPM to use
+     * {@inheritDoc PnpmOptionsConfiguration.pnpmStore}
      */
     pnpmStore?: PnpmStoreOptions;
     /**
-     * Should PNPM fail if peer dependencies aren't installed?
+     * {@inheritDoc PnpmOptionsConfiguration.strictPeerDependencies}
      */
     strictPeerDependencies?: boolean;
     /**
@@ -1256,6 +1285,52 @@ export declare interface _IPnpmOptionsJson extends IPackageManagerOptionsJsonBas
      * {@inheritDoc PnpmOptionsConfiguration.useWorkspaces}
      */
     useWorkspaces?: boolean;
+    /**
+     * {@inheritDoc PnpmOptionsConfiguration.globalOverrides}
+     */
+    globalOverrides?: Record<string, string>;
+    /**
+     * {@inheritDoc PnpmOptionsConfiguration.globalPeerDependencyRules}
+     */
+    globalPeerDependencyRules?: IPnpmPeerDependencyRules;
+    /**
+     * {@inheritDoc PnpmOptionsConfiguration.globalPackageExtensions}
+     */
+    globalPackageExtensions?: Record<string, IPnpmPackageExtension>;
+    /**
+     * {@inheritDoc PnpmOptionsConfiguration.globalNeverBuiltDependencies}
+     */
+    globalNeverBuiltDependencies?: string[];
+    /**
+     * {@inheritDoc PnpmOptionsConfiguration.globalAllowedDeprecatedVersions}
+     */
+    globalAllowedDeprecatedVersions?: Record<string, string>;
+    /**
+     * {@inheritDoc PnpmOptionsConfiguration.unsupportedPackageJsonSettings}
+     */
+    unsupportedPackageJsonSettings?: unknown;
+}
+
+declare interface IPnpmPackageExtension {
+    dependencies?: Record<string, string>;
+    optionalDependencies?: Record<string, string>;
+    peerDependencies?: Record<string, string>;
+    peerDependenciesMeta?: IPnpmPeerDependenciesMeta;
+}
+
+declare interface IPnpmPeerDependenciesMeta {
+    [packageName: string]: {
+        optional?: boolean;
+    };
+}
+
+/**
+ * @beta
+ */
+declare interface IPnpmPeerDependencyRules {
+    ignoreMissing?: string[];
+    allowAny?: string[];
+    allowedVersions?: Record<string, string>;
 }
 
 declare interface IRawRepoState {
@@ -1350,6 +1425,7 @@ declare interface IRushGitPolicyJson {
     sampleEmail?: string;
     versionBumpCommitMessage?: string;
     changeLogUpdateCommitMessage?: string;
+    changefilesCommitMessage?: string;
     tagSeparator?: string;
 }
 
@@ -1431,7 +1507,7 @@ declare interface IRushVariantOptionsJson {
 
 /**
  * Represents a readonly view of a `Stopwatch`.
- * @alpha
+ * @beta
  */
 export declare interface IStopwatchResult {
     /**
@@ -1548,6 +1624,10 @@ export declare interface ITelemetryOperationResult {
      * If the operation was blocked, will be `undefined`.
      */
     endTimestampMs?: number;
+    /**
+     * Duration in milliseconds when the operation does not hit cache
+     */
+    nonCachedDurationMs?: number;
 }
 
 /**
@@ -1619,7 +1699,7 @@ export declare class _LastInstallFlag {
      *
      * @internal
      */
-    checkValidAndReportStoreIssues(): boolean;
+    checkValidAndReportStoreIssues(rushVerb: string): boolean;
     private _isValid;
     /**
      * Writes the flag file to disk with the current state
@@ -1860,6 +1940,32 @@ export declare class Operation {
     deleteDependency(dependency: Operation): void;
 }
 
+/**
+ * A helper class for managing the state file of a operation.
+ *
+ * @internal
+ */
+export declare class _OperationStateFile {
+    private readonly _rushProject;
+    private readonly _filename;
+    private _state;
+    constructor(options: _IOperationStateFileOptions);
+    private static _getFilename;
+    /**
+     * ProjectBuildCache expects the relative path for better logging
+     *
+     * @internal
+     */
+    static getFilenameRelativeToProjectRoot(phase: IPhase): string;
+    /**
+     * Returns the filename of the metadata file.
+     */
+    get filename(): string;
+    get state(): _IOperationStateJson | undefined;
+    writeAsync(json: _IOperationStateJson): Promise<void>;
+    tryRestoreAsync(): Promise<_IOperationStateJson | undefined>;
+}
+
 /**
  * Enumeration defining potential states of an operation
  * @beta
@@ -2042,6 +2148,8 @@ export declare class PhasedCommandHooks {
 
 /**
  * Options that are only used when the PNPM package manager is selected.
+ * Use this class to load "common/config/rush/pnpm-config.json" file,
+ * or, load json from "pnpmOptions" field in "rush.json" for legacy support.
  *
  * @remarks
  * It is valid to define these options in rush.json even if the PNPM package manager
@@ -2050,6 +2158,7 @@ export declare class PhasedCommandHooks {
  * @public
  */
 export declare class PnpmOptionsConfiguration extends PackageManagerOptionsConfigurationBase {
+    private static _jsonSchema;
     /**
      * The method used to resolve the store used by PNPM.
      *
@@ -2099,11 +2208,92 @@ export declare class PnpmOptionsConfiguration extends PackageManagerOptionsConfi
      * If true, then Rush will use the workspaces feature to install and link packages when invoking PNPM.
      *
      * @remarks
-     * The default value is false.  (For now.)
+     * The default value is true.  (For now.)
      */
     readonly useWorkspaces: boolean;
+    /**
+     * The "globalOverrides" setting provides a simple mechanism for overriding version selections
+     * for all dependencies of all projects in the monorepo workspace.  The settings are copied
+     * into the `pnpm.overrides` field of the `common/temp/package.json` file that is generated
+     * by Rush during installation.
+     *
+     * Order of precedence: `.pnpmfile.cjs` has the highest precedence, followed by
+     * `unsupportedPackageJsonSettings`, `globalPeerDependencyRules`, `globalPackageExtensions`,
+     * and `globalOverrides` has lowest precedence.
+     *
+     * PNPM documentation: https://pnpm.io/package_json#pnpmoverrides
+     */
+    readonly globalOverrides: Record<string, string> | undefined;
+    /**
+     * The `globalPeerDependencyRules` setting provides various settings for suppressing validation errors
+     * that are reported during installation with `strictPeerDependencies=true`.  The settings are copied
+     * into the `pnpm.peerDependencyRules` field of the `common/temp/package.json` file that is generated
+     * by Rush during installation.
+     *
+     * Order of precedence: `.pnpmfile.cjs` has the highest precedence, followed by
+     * `unsupportedPackageJsonSettings`, `globalPeerDependencyRules`, `globalPackageExtensions`,
+     * and `globalOverrides` has lowest precedence.
+     *
+     * https://pnpm.io/package_json#pnpmpeerdependencyrules
+     */
+    readonly globalPeerDependencyRules: IPnpmPeerDependencyRules | undefined;
+    /**
+     * The `globalPackageExtension` setting provides a way to patch arbitrary package.json fields
+     * for any PNPM dependency of the monorepo.  The settings are copied into the `pnpm.packageExtensions`
+     * field of the `common/temp/package.json` file that is generated by Rush during installation.
+     * The `globalPackageExtension` setting has similar capabilities as `.pnpmfile.cjs` but without
+     * the downsides of an executable script (nondeterminism, unreliable caching, performance concerns).
+     *
+     * Order of precedence: `.pnpmfile.cjs` has the highest precedence, followed by
+     * `unsupportedPackageJsonSettings`, `globalPeerDependencyRules`, `globalPackageExtensions`,
+     * and `globalOverrides` has lowest precedence.
+     *
+     * PNPM documentation: https://pnpm.io/package_json#pnpmpackageextensions
+     */
+    readonly globalPackageExtensions: Record<string, IPnpmPackageExtension> | undefined;
+    /**
+     * The `globalNeverBuiltDependencies` setting suppresses the `preinstall`, `install`, and `postinstall`
+     * lifecycle events for the specified NPM dependencies.  This is useful for scripts with poor practices
+     * such as downloading large binaries without retries or attempting to invoke OS tools such as
+     * a C++ compiler.  (PNPM's terminology refers to these lifecycle events as "building" a package;
+     * it has nothing to do with build system operations such as `rush build` or `rushx build`.)
+     * The settings are copied into the `pnpm.neverBuiltDependencies` field of the `common/temp/package.json`
+     * file that is generated by Rush during installation.
+     *
+     * PNPM documentation: https://pnpm.io/package_json#pnpmneverbuiltdependencies
+     */
+    readonly globalNeverBuiltDependencies: string[] | undefined;
+    /**
+     * The `globalAllowedDeprecatedVersions` setting suppresses installation warnings for package
+     * versions that the NPM registry reports as being deprecated.  This is useful if the
+     * deprecated package is an indirect dependency of an external package that has not released a fix.
+     * The settings are copied into the `pnpm.allowedDeprecatedVersions` field of the `common/temp/package.json`
+     * file that is generated by Rush during installation.
+     *
+     * PNPM documentation: https://pnpm.io/package_json#pnpmalloweddeprecatedversions
+     *
+     * If you are working to eliminate a deprecated version, it's better to specify `allowedDeprecatedVersions`
+     * in the package.json file for individual Rush projects.
+     */
+    readonly globalAllowedDeprecatedVersions: Record<string, string> | undefined;
+    /**
+     * (USE AT YOUR OWN RISK)  This is a free-form property bag that will be copied into
+     * the `common/temp/package.json` file that is generated by Rush during installation.
+     * This provides a way to experiment with new PNPM features.  These settings will override
+     * any other Rush configuration associated with a given JSON field except for `.pnpmfile.cjs`.
+     *
+     * USAGE OF THIS SETTING IS NOT SUPPORTED BY THE RUSH MAINTAINERS AND MAY CAUSE RUSH
+     * TO MALFUNCTION.  If you encounter a missing PNPM setting that you believe should
+     * be supported, please create a GitHub issue or PR.  Note that Rush does not aim to
+     * support every possible PNPM setting, but rather to promote a battle-tested installation
+     * strategy that is known to provide a good experience for large teams with lots of projects.
+     */
+    readonly unsupportedPackageJsonSettings: unknown | undefined;
+    private constructor();
+    /** @internal */
+    static loadFromJsonFileOrThrow(jsonFilename: string, commonTempFolder: string): PnpmOptionsConfiguration;
     /** @internal */
-    constructor(json: _IPnpmOptionsJson, commonTempFolder: string);
+    static loadFromJsonObject(json: _IPnpmOptionsJson, commonTempFolder: string): PnpmOptionsConfiguration;
 }
 
 /**
@@ -2310,6 +2500,7 @@ export declare class RushConfiguration {
     private _gitSampleEmail;
     private _gitVersionBumpCommitMessage;
     private _gitChangeLogUpdateCommitMessage;
+    private _gitChangefilesCommitMessage;
     private _gitTagSeparator;
     private _hotfixChangeEnabled;
     private _repositoryUrls;
@@ -2582,6 +2773,11 @@ export declare class RushConfiguration {
      * The commit message to use when committing change log files 'rush version'
      */
     get gitChangeLogUpdateCommitMessage(): string | undefined;
+    /**
+     * [Part of the "gitPolicy" feature.]
+     * The commit message to use when committing change log files 'rush version'
+     */
+    get gitChangefilesCommitMessage(): string | undefined;
     /**
      * [Part of the "gitPolicy" feature.]
      * The separator between package name and version in git tag.
@@ -3086,6 +3282,10 @@ export declare class RushConstants {
      * Experiments configuration file.
      */
     static readonly experimentsFilename: string;
+    /**
+     * Pnpm configuration file
+     */
+    static readonly pnpmConfigFilename: string;
     /**
      * Rush plugins configuration file name.
      */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rushstack/rush-sdk",
-  "version": "5.78.1",
+  "version": "5.80.0",
   "description": "An API for interacting with the Rush engine",
   "repository": {
     "type": "git",
@@ -12,18 +12,18 @@
   "typings": "dist/rush-lib.d.ts",
   "license": "MIT",
   "dependencies": {
-    "@rushstack/node-core-library": "3.52.0",
+    "@rushstack/node-core-library": "3.53.0",
     "@types/node-fetch": "1.6.9",
     "tapable": "2.2.1"
   },
   "devDependencies": {
-    "@microsoft/rush-lib": "5.78.1",
-    "@rushstack/eslint-config": "3.0.1",
-    "@rushstack/heft": "0.47.10",
-    "@rushstack/heft-node-rig": "1.10.12",
-    "@rushstack/stream-collator": "4.0.205",
-    "@rushstack/ts-command-line": "4.12.3",
-    "@rushstack/terminal": "0.3.74",
+    "@microsoft/rush-lib": "5.80.0",
+    "@rushstack/eslint-config": "3.1.0",
+    "@rushstack/heft": "0.48.0",
+    "@rushstack/heft-node-rig": "1.11.0",
+    "@rushstack/stream-collator": "4.0.207",
+    "@rushstack/ts-command-line": "4.12.4",
+    "@rushstack/terminal": "0.3.76",
     "@types/heft-jest": "1.0.1",
     "@types/semver": "7.3.5",
     "@types/webpack-env": "1.13.0"