@rushstack/rush-sdk 5.126.0 → 5.127.1

package/dist/rush-lib.d.ts

@@ -972,7 +972,7 @@ declare interface IBaseBuildCacheJson {
      * - `[arch]`
      * @privateRemarks
      * NOTE: If you update this comment, make sure to update build-cache.json in the "rush init" template.
-     * The token parser is in CachEntryId.ts
+     * The token parser is in CacheEntryId.ts
      */
     cacheEntryNamePattern?: string;
 }
@@ -1680,9 +1680,13 @@ export declare interface IOperationOptions {
      */
     runner?: IOperationRunner | undefined;
     /**
-     * Settings defined in the project configuration for this operation, can be overriden.
+     * Settings defined in the project configuration for this operation, can be overridden.
      */
     settings?: IOperationSettings | undefined;
+    /**
+     * {@inheritDoc Operation.logFilenameIdentifier}
+     */
+    logFilenameIdentifier: string;
 }
 
 /**
@@ -2732,6 +2736,12 @@ export declare class Operation {
      * A set of all dependencies which must be executed before this operation is complete.
      */
     readonly dependencies: ReadonlySet<Operation>;
+    /**
+     * This property is used in the name of the filename for the logs generated by this
+     * operation. This is a filesystem-safe version of the phase name. For example,
+     * an operation for a phase with name `_phase:compile` has a `logFilenameIdentifier` of `_phase_compile`.
+     */
+    logFilenameIdentifier: string;
     /**
      * When the scheduler is ready to process this `Operation`, the `runner` implements the actual work of
      * running the operation.
@@ -2754,7 +2764,7 @@ export declare class Operation {
      *  the project configuration.
      */
     settings: IOperationSettings | undefined;
-    constructor(options?: IOperationOptions);
+    constructor(options: IOperationOptions);
     /**
      * The name of this operation, for logging.
      */
@@ -2781,7 +2791,7 @@ export declare class Operation {
 export declare class _OperationMetadataManager {
     readonly stateFile: _OperationStateFile;
     readonly logFilenameIdentifier: string;
-    private readonly _metadataFolder;
+    private readonly _metadataFolderPath;
     private readonly _logPath;
     private readonly _errorLogPath;
     private readonly _logChunksPath;
@@ -4552,6 +4562,17 @@ export declare class RushProjectConfiguration {
      * why the project cannot enable the build cache for that phase, or undefined if it is safe to so do.
      */
     getCacheDisabledReason(trackedFileNames: Iterable<string>, phaseName: string, isNoOp: boolean): string | undefined;
+    /**
+     * Source of truth for whether a project is unable to use the build cache for a given phase.
+     * As some operations may not have a rush-project.json file defined at all, but may be no-op operations
+     *  we'll want to ignore those completely.
+     */
+    static getCacheDisabledReasonForProject(options: {
+        projectConfiguration: RushProjectConfiguration | undefined;
+        trackedFileNames: Iterable<string>;
+        phaseName: string;
+        isNoOp: boolean;
+    }): string | undefined;
     /**
      * Loads the rush-project.json data for the specified project.
      */

package/lib/api/BuildCacheConfiguration.d.ts

@@ -23,7 +23,7 @@ export interface IBaseBuildCacheJson {
      * - `[arch]`
      * @privateRemarks
      * NOTE: If you update this comment, make sure to update build-cache.json in the "rush init" template.
-     * The token parser is in CachEntryId.ts
+     * The token parser is in CacheEntryId.ts
      */
     cacheEntryNamePattern?: string;
 }

package/lib/api/RushProjectConfiguration.d.ts

@@ -149,6 +149,17 @@ export declare class RushProjectConfiguration {
      * why the project cannot enable the build cache for that phase, or undefined if it is safe to so do.
      */
     getCacheDisabledReason(trackedFileNames: Iterable<string>, phaseName: string, isNoOp: boolean): string | undefined;
+    /**
+     * Source of truth for whether a project is unable to use the build cache for a given phase.
+     * As some operations may not have a rush-project.json file defined at all, but may be no-op operations
+     *  we'll want to ignore those completely.
+     */
+    static getCacheDisabledReasonForProject(options: {
+        projectConfiguration: RushProjectConfiguration | undefined;
+        trackedFileNames: Iterable<string>;
+        phaseName: string;
+        isNoOp: boolean;
+    }): string | undefined;
     /**
      * Loads the rush-project.json data for the specified project.
      */

package/lib/logic/operations/CacheableOperationPlugin.d.ts

@@ -1,7 +1,7 @@
 import { type ITerminal } from '@rushstack/terminal';
 import { CobuildLock } from '../cobuild/CobuildLock';
 import { ProjectBuildCache } from '../buildCache/ProjectBuildCache';
-import type { IOperationSettings } from '../../api/RushProjectConfiguration';
+import { type IOperationSettings } from '../../api/RushProjectConfiguration';
 import { ProjectLogWritable } from './ProjectLogWritable';
 import type { CobuildConfiguration } from '../../api/CobuildConfiguration';
 import { DisjointSet } from '../cobuild/DisjointSet';

package/lib/logic/operations/Operation.d.ts

@@ -21,9 +21,13 @@ export interface IOperationOptions {
      */
     runner?: IOperationRunner | undefined;
     /**
-     * Settings defined in the project configuration for this operation, can be overriden.
+     * Settings defined in the project configuration for this operation, can be overridden.
      */
     settings?: IOperationSettings | undefined;
+    /**
+     * {@inheritDoc Operation.logFilenameIdentifier}
+     */
+    logFilenameIdentifier: string;
 }
 /**
  * The `Operation` class is a node in the dependency graph of work that needs to be scheduled by the
@@ -51,6 +55,12 @@ export declare class Operation {
      * A set of all dependencies which must be executed before this operation is complete.
      */
     readonly dependencies: ReadonlySet<Operation>;
+    /**
+     * This property is used in the name of the filename for the logs generated by this
+     * operation. This is a filesystem-safe version of the phase name. For example,
+     * an operation for a phase with name `_phase:compile` has a `logFilenameIdentifier` of `_phase_compile`.
+     */
+    logFilenameIdentifier: string;
     /**
      * When the scheduler is ready to process this `Operation`, the `runner` implements the actual work of
      * running the operation.
@@ -73,7 +83,7 @@ export declare class Operation {
      *  the project configuration.
      */
     settings: IOperationSettings | undefined;
-    constructor(options?: IOperationOptions);
+    constructor(options: IOperationOptions);
     /**
      * The name of this operation, for logging.
      */

package/lib/logic/operations/OperationMetadataManager.d.ts

@@ -33,7 +33,7 @@ export interface ILogChunkStorage {
 export declare class OperationMetadataManager {
     readonly stateFile: OperationStateFile;
     readonly logFilenameIdentifier: string;
-    private readonly _metadataFolder;
+    private readonly _metadataFolderPath;
     private readonly _logPath;
     private readonly _errorLogPath;
     private readonly _logChunksPath;
@@ -56,5 +56,4 @@ export declare class OperationMetadataManager {
         errorLogPath: string;
     }): Promise<void>;
 }
-export declare function normalizeNameForLogFilenameIdentifiers(name: string): string;
 //# sourceMappingURL=OperationMetadataManager.d.ts.map

package/lib-shim/tsdoc-metadata.json

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rushstack/rush-sdk",
-  "version": "5.126.0",
+  "version": "5.127.1",
   "description": "An API for interacting with the Rush engine",
   "repository": {
     "type": "git",
@@ -31,11 +31,11 @@
   "devDependencies": {
     "@types/semver": "7.5.0",
     "@types/webpack-env": "1.18.0",
-    "@rushstack/ts-command-line": "4.22.0",
-    "@rushstack/heft": "0.66.17",
-    "@microsoft/rush-lib": "5.126.0",
+    "@microsoft/rush-lib": "5.127.1",
     "local-node-rig": "1.0.0",
-    "@rushstack/stream-collator": "4.1.55"
+    "@rushstack/heft": "0.66.18",
+    "@rushstack/stream-collator": "4.1.56",
+    "@rushstack/ts-command-line": "4.22.0"
   },
   "scripts": {
     "build": "heft build --clean",