@rushstack/rush-sdk - npm Package Compare versions

Comparing version 5.155.1 to 5.156.0

lib/api/BuildCacheConfiguration.d.ts

@@ -57,3 +57,2 @@ import { type JsonObject } from '@rushstack/node-core-library';
 export declare class BuildCacheConfiguration {
-    private static _jsonSchema;
     /**
@@ -99,4 +98,5 @@ * Indicates whether the build cache feature is enabled.
     static getBuildCacheConfigFilePath(rushConfiguration: RushConfiguration): string;
-    private static _loadAsync;
+    private static _tryLoadInternalAsync;
+    private static _tryLoadAsync;
 }
 //# sourceMappingURL=BuildCacheConfiguration.d.ts.map

lib/api/EnvironmentConfiguration.d.ts

@@ -124,2 +124,28 @@ import type { IEnvironment } from '../utilities/Utilities';
     /**
+     * Set this environment variable to a JSON string to override the build cache configuration that normally lives
+     * at `common/config/rush/build-cache.json`.
+     *
+     * This is useful for testing purposes, or for OSS repos that are have a local-only cache, but can have
+     * a different cache configuration in CI/CD pipelines.
+     *
+     * @remarks
+     * This is similar to {@link EnvironmentVariableNames.RUSH_BUILD_CACHE_OVERRIDE_JSON_FILE_PATH}, but it allows you to specify
+     * a JSON string instead of a file path. The two environment variables are mutually exclusive, meaning you can
+     * only use one of them at a time.
+     */
+    readonly RUSH_BUILD_CACHE_OVERRIDE_JSON: "RUSH_BUILD_CACHE_OVERRIDE_JSON";
+    /**
+     * Set this environment variable to the path to a `build-cache.json` file to override the build cache configuration
+     * that normally lives at `common/config/rush/build-cache.json`.
+     *
+     * This is useful for testing purposes, or for OSS repos that are have a local-only cache, but can have
+     * a different cache configuration in CI/CD pipelines.
+     *
+     * @remarks
+     * This is similar to {@link EnvironmentVariableNames.RUSH_BUILD_CACHE_OVERRIDE_JSON}, but it allows you to specify
+     * a file path instead of a JSON string. The two environment variables are mutually exclusive, meaning you can
+     * only use one of them at a time.
+     */
+    readonly RUSH_BUILD_CACHE_OVERRIDE_JSON_FILE_PATH: "RUSH_BUILD_CACHE_OVERRIDE_JSON_FILE_PATH";
+    /**
      * Setting this environment variable opts into running with cobuilds. The context id should be the same across
@@ -210,2 +236,4 @@ * multiple VMs, but changed when it is a new round of cobuilds.
     private static _buildCacheWriteAllowed;
+    private static _buildCacheOverrideJson;
+    private static _buildCacheOverrideJsonFilePath;
     private static _cobuildContextId;
@@ -217,2 +245,6 @@ private static _cobuildRunnerId;
     /**
+     * If true, the environment configuration has been validated and initialized.
+     */
+    static get hasBeenValidated(): boolean;
+    /**
      * An override for the common/temp folder path.
@@ -271,2 +303,12 @@ */
     /**
+     * If set, overrides the build cache configuration that normally lives at `common/config/rush/build-cache.json`.
+     * See {@link EnvironmentVariableNames.RUSH_BUILD_CACHE_OVERRIDE_JSON}
+     */
+    static get buildCacheOverrideJson(): string | undefined;
+    /**
+     * If set, overrides the build cache configuration that normally lives at `common/config/rush/build-cache.json`.
+     * See {@link EnvironmentVariableNames.RUSH_BUILD_CACHE_OVERRIDE_JSON_FILE_PATH}
+     */
+    static get buildCacheOverrideJsonFilePath(): string | undefined;
+    /**
      * Provides a determined cobuild context id if configured
@@ -273,0 +315,0 @@ * See {@link EnvironmentVariableNames.RUSH_COBUILD_CONTEXT_ID}

lib/logic/Telemetry.d.ts

@@ -0,1 +1,2 @@
+import type { PerformanceEntry } from 'node:perf_hooks';
 import type { RushConfiguration } from '../api/RushConfiguration';
@@ -106,2 +107,7 @@ import type { RushSession } from '../pluginFramework/RushSession';
     };
+    /**
+     * Performance marks and measures collected during the execution of this command.
+     * This is an array of `PerformanceEntry` objects, which can include marks, measures, and function timings.
+     */
+    readonly performanceEntries?: readonly PerformanceEntry[];
 }
@@ -115,2 +121,3 @@ export declare class Telemetry {
     private _flushAsyncTasks;
+    private _telemetryStartTime;
     constructor(rushConfiguration: RushConfiguration, rushSession: RushSession);
@@ -117,0 +124,0 @@ log(telemetryData: ITelemetryData): void;

lib/pluginFramework/PhasedCommandHooks.d.ts

@@ -65,2 +65,6 @@ import { AsyncParallelHook, AsyncSeriesBailHook, AsyncSeriesHook, AsyncSeriesWaterfallHook, SyncHook, SyncWaterfallHook } from 'tapable';
     /**
+     * The currently configured maximum parallelism for the command.
+     */
+    readonly parallelism: number;
+    /**
      * The set of phases original for the current command execution.
@@ -67,0 +71,0 @@ */

lib/utilities/Utilities.d.ts

@@ -92,2 +92,3 @@ import * as child_process from 'child_process';
     static syncNpmrc: typeof syncNpmrc;
+    private static _homeFolder;
     /**
@@ -94,0 +95,0 @@ * Get the user's home directory. On windows this looks something like "C:\users\username\" and on UNIX

package.json

 {
   "name": "@rushstack/rush-sdk",
-  "version": "5.155.1",
+  "version": "5.156.0",
   "description": "An API for interacting with the Rush engine",
@@ -39,6 +39,6 @@ "repository": {
     "tapable": "2.2.1",
-    "@rushstack/lookup-by-path": "0.7.1",
-    "@rushstack/package-deps-hash": "4.4.2",
-    "@rushstack/node-core-library": "5.13.1",
-    "@rushstack/terminal": "0.15.3"
+    "@rushstack/lookup-by-path": "0.7.2",
+    "@rushstack/node-core-library": "5.14.0",
+    "@rushstack/terminal": "0.15.4",
+    "@rushstack/package-deps-hash": "4.4.3"
   },
@@ -50,9 +50,9 @@ "devDependencies": {
     "webpack": "~5.98.0",
-    "@rushstack/heft": "0.74.0",
-    "@microsoft/rush-lib": "5.155.1",
-    "@rushstack/ts-command-line": "5.0.1",
-    "@rushstack/heft-webpack5-plugin": "0.11.34",
-    "@rushstack/webpack-preserve-dynamic-require-plugin": "0.11.103",
-    "@rushstack/stream-collator": "4.1.104",
-    "local-node-rig": "1.0.0"
+    "@microsoft/rush-lib": "5.156.0",
+    "@rushstack/stream-collator": "4.1.105",
+    "@rushstack/webpack-preserve-dynamic-require-plugin": "0.11.104",
+    "@rushstack/ts-command-line": "5.0.2",
+    "local-node-rig": "1.0.0",
+    "@rushstack/heft": "0.74.1",
+    "@rushstack/heft-webpack5-plugin": "0.11.35"
   },
@@ -59,0 +59,0 @@ "scripts": {

No alert changes

Improved metrics

Total package byte prevSize

979299

1.59%

Number of package files

485

0.83%

Lines of code

19264

1.05%

Dependency changes

• + Added

  @rushstack/lookup-by-path@0.7.2
  (transitive)

• + Added

  @rushstack/node-core-library@5.14.0
  (transitive)

• + Added

  @rushstack/package-deps-hash@4.4.3
  (transitive)

• + Added

  @rushstack/terminal@0.15.4
  (transitive)

• - Removed

  @rushstack/lookup-by-path@0.7.1
  (transitive)

• - Removed

  @rushstack/node-core-library@5.13.1
  (transitive)

• - Removed

  @rushstack/package-deps-hash@4.4.2
  (transitive)

• - Removed

  @rushstack/terminal@0.15.3
  (transitive)

• Updated

  @rushstack/lookup-by-path@0.7.2

• Updated

  @rushstack/node-core-library@5.14.0

• Updated

  @rushstack/package-deps-hash@4.4.3

• Updated

  @rushstack/terminal@0.15.4