@rushstack/rush-sdk 5.127.0 → 5.128.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -872,8 +872,6 @@ export declare class EventHooks {
872
872
  * @public
873
873
  */
874
874
  export declare class ExperimentsConfiguration {
875
- private static _jsonSchema;
876
- private _jsonFileName;
877
875
  /**
878
876
  * Get the experiments configuration.
879
877
  * @beta
@@ -882,7 +880,7 @@ export declare class ExperimentsConfiguration {
882
880
  /**
883
881
  * @internal
884
882
  */
885
- constructor(jsonFileName: string);
883
+ constructor(jsonFilePath: string);
886
884
  }
887
885
 
888
886
  /**
@@ -972,7 +970,7 @@ declare interface IBaseBuildCacheJson {
972
970
  * - `[arch]`
973
971
  * @privateRemarks
974
972
  * NOTE: If you update this comment, make sure to update build-cache.json in the "rush init" template.
975
- * The token parser is in CachEntryId.ts
973
+ * The token parser is in CacheEntryId.ts
976
974
  */
977
975
  cacheEntryNamePattern?: string;
978
976
  }
@@ -1381,11 +1379,6 @@ export declare interface IExperimentsJson {
1381
1379
  * This will not replay warnings from the skipped build.
1382
1380
  */
1383
1381
  buildSkipWithAllowWarningsInSuccessfulBuild?: boolean;
1384
- /**
1385
- * If true, the phased commands feature is enabled. To use this feature, create a "phased" command
1386
- * in common/config/rush/command-line.json.
1387
- */
1388
- phasedCommands?: boolean;
1389
1382
  /**
1390
1383
  * If true, perform a clean install after when running `rush install` or `rush update` if the
1391
1384
  * `.npmrc` file has changed since the last install.
@@ -1680,9 +1673,13 @@ export declare interface IOperationOptions {
1680
1673
  */
1681
1674
  runner?: IOperationRunner | undefined;
1682
1675
  /**
1683
- * Settings defined in the project configuration for this operation, can be overriden.
1676
+ * Settings defined in the project configuration for this operation, can be overridden.
1684
1677
  */
1685
1678
  settings?: IOperationSettings | undefined;
1679
+ /**
1680
+ * {@inheritDoc Operation.logFilenameIdentifier}
1681
+ */
1682
+ logFilenameIdentifier: string;
1686
1683
  }
1687
1684
 
1688
1685
  /**
@@ -2732,6 +2729,12 @@ export declare class Operation {
2732
2729
  * A set of all dependencies which must be executed before this operation is complete.
2733
2730
  */
2734
2731
  readonly dependencies: ReadonlySet<Operation>;
2732
+ /**
2733
+ * This property is used in the name of the filename for the logs generated by this
2734
+ * operation. This is a filesystem-safe version of the phase name. For example,
2735
+ * an operation for a phase with name `_phase:compile` has a `logFilenameIdentifier` of `_phase_compile`.
2736
+ */
2737
+ logFilenameIdentifier: string;
2735
2738
  /**
2736
2739
  * When the scheduler is ready to process this `Operation`, the `runner` implements the actual work of
2737
2740
  * running the operation.
@@ -2754,7 +2757,7 @@ export declare class Operation {
2754
2757
  * the project configuration.
2755
2758
  */
2756
2759
  settings: IOperationSettings | undefined;
2757
- constructor(options?: IOperationOptions);
2760
+ constructor(options: IOperationOptions);
2758
2761
  /**
2759
2762
  * The name of this operation, for logging.
2760
2763
  */
@@ -2781,7 +2784,7 @@ export declare class Operation {
2781
2784
  export declare class _OperationMetadataManager {
2782
2785
  readonly stateFile: _OperationStateFile;
2783
2786
  readonly logFilenameIdentifier: string;
2784
- private readonly _metadataFolder;
2787
+ private readonly _metadataFolderPath;
2785
2788
  private readonly _logPath;
2786
2789
  private readonly _errorLogPath;
2787
2790
  private readonly _logChunksPath;
@@ -23,7 +23,7 @@ export interface IBaseBuildCacheJson {
23
23
  * - `[arch]`
24
24
  * @privateRemarks
25
25
  * NOTE: If you update this comment, make sure to update build-cache.json in the "rush init" template.
26
- * The token parser is in CachEntryId.ts
26
+ * The token parser is in CacheEntryId.ts
27
27
  */
28
28
  cacheEntryNamePattern?: string;
29
29
  }
@@ -41,11 +41,6 @@ export interface IExperimentsJson {
41
41
  * This will not replay warnings from the skipped build.
42
42
  */
43
43
  buildSkipWithAllowWarningsInSuccessfulBuild?: boolean;
44
- /**
45
- * If true, the phased commands feature is enabled. To use this feature, create a "phased" command
46
- * in common/config/rush/command-line.json.
47
- */
48
- phasedCommands?: boolean;
49
44
  /**
50
45
  * If true, perform a clean install after when running `rush install` or `rush update` if the
51
46
  * `.npmrc` file has changed since the last install.
@@ -88,8 +83,6 @@ export interface IExperimentsJson {
88
83
  * @public
89
84
  */
90
85
  export declare class ExperimentsConfiguration {
91
- private static _jsonSchema;
92
- private _jsonFileName;
93
86
  /**
94
87
  * Get the experiments configuration.
95
88
  * @beta
@@ -98,6 +91,6 @@ export declare class ExperimentsConfiguration {
98
91
  /**
99
92
  * @internal
100
93
  */
101
- constructor(jsonFileName: string);
94
+ constructor(jsonFilePath: string);
102
95
  }
103
96
  //# sourceMappingURL=ExperimentsConfiguration.d.ts.map
@@ -21,9 +21,13 @@ export interface IOperationOptions {
21
21
  */
22
22
  runner?: IOperationRunner | undefined;
23
23
  /**
24
- * Settings defined in the project configuration for this operation, can be overriden.
24
+ * Settings defined in the project configuration for this operation, can be overridden.
25
25
  */
26
26
  settings?: IOperationSettings | undefined;
27
+ /**
28
+ * {@inheritDoc Operation.logFilenameIdentifier}
29
+ */
30
+ logFilenameIdentifier: string;
27
31
  }
28
32
  /**
29
33
  * 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 {
51
55
  * A set of all dependencies which must be executed before this operation is complete.
52
56
  */
53
57
  readonly dependencies: ReadonlySet<Operation>;
58
+ /**
59
+ * This property is used in the name of the filename for the logs generated by this
60
+ * operation. This is a filesystem-safe version of the phase name. For example,
61
+ * an operation for a phase with name `_phase:compile` has a `logFilenameIdentifier` of `_phase_compile`.
62
+ */
63
+ logFilenameIdentifier: string;
54
64
  /**
55
65
  * When the scheduler is ready to process this `Operation`, the `runner` implements the actual work of
56
66
  * running the operation.
@@ -73,7 +83,7 @@ export declare class Operation {
73
83
  * the project configuration.
74
84
  */
75
85
  settings: IOperationSettings | undefined;
76
- constructor(options?: IOperationOptions);
86
+ constructor(options: IOperationOptions);
77
87
  /**
78
88
  * The name of this operation, for logging.
79
89
  */
@@ -33,7 +33,7 @@ export interface ILogChunkStorage {
33
33
  export declare class OperationMetadataManager {
34
34
  readonly stateFile: OperationStateFile;
35
35
  readonly logFilenameIdentifier: string;
36
- private readonly _metadataFolder;
36
+ private readonly _metadataFolderPath;
37
37
  private readonly _logPath;
38
38
  private readonly _errorLogPath;
39
39
  private readonly _logChunksPath;
@@ -56,5 +56,4 @@ export declare class OperationMetadataManager {
56
56
  errorLogPath: string;
57
57
  }): Promise<void>;
58
58
  }
59
- export declare function normalizeNameForLogFilenameIdentifiers(name: string): string;
60
59
  //# sourceMappingURL=OperationMetadataManager.d.ts.map
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@rushstack/rush-sdk",
3
- "version": "5.127.0",
3
+ "version": "5.128.0",
4
4
  "description": "An API for interacting with the Rush engine",
5
5
  "repository": {
6
6
  "type": "git",
@@ -31,10 +31,10 @@
31
31
  "devDependencies": {
32
32
  "@types/semver": "7.5.0",
33
33
  "@types/webpack-env": "1.18.0",
34
+ "@microsoft/rush-lib": "5.128.0",
34
35
  "@rushstack/heft": "0.66.18",
35
- "@microsoft/rush-lib": "5.127.0",
36
- "local-node-rig": "1.0.0",
37
36
  "@rushstack/stream-collator": "4.1.56",
37
+ "local-node-rig": "1.0.0",
38
38
  "@rushstack/ts-command-line": "4.22.0"
39
39
  },
40
40
  "scripts": {