@rushstack/rush-sdk 5.83.0-pr3481.9 → 5.83.1
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.
- package/dist/rush-lib.d.ts +21 -167
- package/package.json +2 -2
package/dist/rush-lib.d.ts
CHANGED
|
@@ -136,59 +136,6 @@ export declare class ApprovedPackagesPolicy {
|
|
|
136
136
|
get nonbrowserApprovedPackages(): ApprovedPackagesConfiguration;
|
|
137
137
|
}
|
|
138
138
|
|
|
139
|
-
/**
|
|
140
|
-
* A base class for flag file.
|
|
141
|
-
* @internal
|
|
142
|
-
*/
|
|
143
|
-
export declare class _BaseFlag<T extends object = JsonObject> {
|
|
144
|
-
/**
|
|
145
|
-
* Flag file path
|
|
146
|
-
*/
|
|
147
|
-
protected _path: string;
|
|
148
|
-
/**
|
|
149
|
-
* Content of the flag
|
|
150
|
-
*/
|
|
151
|
-
protected _state: T;
|
|
152
|
-
/**
|
|
153
|
-
* Whether the current state is modified
|
|
154
|
-
*/
|
|
155
|
-
protected _isModified: boolean;
|
|
156
|
-
/**
|
|
157
|
-
* Creates a new flag file
|
|
158
|
-
* @param folderPath - the folder that this flag is managing
|
|
159
|
-
* @param state - optional, the state that should be managed or compared
|
|
160
|
-
*/
|
|
161
|
-
constructor(folderPath: string, state?: Partial<T>);
|
|
162
|
-
/**
|
|
163
|
-
* Returns true if the file exists and the contents match the current state.
|
|
164
|
-
*/
|
|
165
|
-
isValid(): boolean;
|
|
166
|
-
/**
|
|
167
|
-
* Writes the flag file to disk with the current state
|
|
168
|
-
*/
|
|
169
|
-
create(): void;
|
|
170
|
-
/**
|
|
171
|
-
* Merge new data into current state by lodash "merge"
|
|
172
|
-
*/
|
|
173
|
-
mergeFromObject(data: JsonObject): void;
|
|
174
|
-
/**
|
|
175
|
-
* Writes the flag file to disk with the current state if modified
|
|
176
|
-
*/
|
|
177
|
-
saveIfModified(): void;
|
|
178
|
-
/**
|
|
179
|
-
* Removes the flag file
|
|
180
|
-
*/
|
|
181
|
-
clear(): void;
|
|
182
|
-
/**
|
|
183
|
-
* Returns the full path to the flag file
|
|
184
|
-
*/
|
|
185
|
-
get path(): string;
|
|
186
|
-
/**
|
|
187
|
-
* Returns the name of the flag file
|
|
188
|
-
*/
|
|
189
|
-
protected get flagName(): string;
|
|
190
|
-
}
|
|
191
|
-
|
|
192
139
|
/**
|
|
193
140
|
* Use this class to load and save the "common/config/rush/build-cache.json" config file.
|
|
194
141
|
* This file provides configuration options for cached project build output.
|
|
@@ -940,11 +887,6 @@ export declare interface IExperimentsJson {
|
|
|
940
887
|
* in common/config/rush/command-line.json.
|
|
941
888
|
*/
|
|
942
889
|
phasedCommands?: boolean;
|
|
943
|
-
/**
|
|
944
|
-
* If true, rush install or rush update implicitly specify --ignore-scripts during pnpm install,
|
|
945
|
-
* and run install lifecycle scripts by pnpm rebuild --pending after pnpm install successfully.
|
|
946
|
-
*/
|
|
947
|
-
deferredInstallationScripts?: boolean;
|
|
948
890
|
}
|
|
949
891
|
|
|
950
892
|
/**
|
|
@@ -1011,50 +953,6 @@ declare interface IIndividualVersionJson extends IVersionPolicyJson {
|
|
|
1011
953
|
lockedMajor?: number;
|
|
1012
954
|
}
|
|
1013
955
|
|
|
1014
|
-
/**
|
|
1015
|
-
* This represents the JSON data structure for the "last-install.flag" file.
|
|
1016
|
-
* @internal
|
|
1017
|
-
*/
|
|
1018
|
-
export declare interface _ILastInstallFlagJson {
|
|
1019
|
-
/**
|
|
1020
|
-
* Current node version
|
|
1021
|
-
*/
|
|
1022
|
-
node: string;
|
|
1023
|
-
/**
|
|
1024
|
-
* Current package manager name
|
|
1025
|
-
*/
|
|
1026
|
-
packageManager: PackageManagerName;
|
|
1027
|
-
/**
|
|
1028
|
-
* Current package manager version
|
|
1029
|
-
*/
|
|
1030
|
-
packageManagerVersion: string;
|
|
1031
|
-
/**
|
|
1032
|
-
* Current rush json folder
|
|
1033
|
-
*/
|
|
1034
|
-
rushJsonFolder: string;
|
|
1035
|
-
/**
|
|
1036
|
-
* The content of package.json, used in the flag file of autoinstaller
|
|
1037
|
-
*/
|
|
1038
|
-
packageJson?: IPackageJson;
|
|
1039
|
-
/**
|
|
1040
|
-
* Same with pnpmOptions.pnpmStorePath in rush.json
|
|
1041
|
-
*/
|
|
1042
|
-
storePath?: string;
|
|
1043
|
-
/**
|
|
1044
|
-
* True when "useWorkspaces" is true in rush.json
|
|
1045
|
-
*/
|
|
1046
|
-
workspaces?: true;
|
|
1047
|
-
/**
|
|
1048
|
-
* True when user explicitly specify "--ignore-scripts" CLI parameter or deferredInstallationScripts
|
|
1049
|
-
*/
|
|
1050
|
-
ignoreScripts?: true;
|
|
1051
|
-
/**
|
|
1052
|
-
* When specified, it is a list of selected projects during partial install
|
|
1053
|
-
* It is undefined when full install
|
|
1054
|
-
*/
|
|
1055
|
-
selectedProjectNames?: string[];
|
|
1056
|
-
}
|
|
1057
|
-
|
|
1058
956
|
/**
|
|
1059
957
|
* Options to pass to the rush "launch" functions.
|
|
1060
958
|
*
|
|
@@ -1495,7 +1393,6 @@ declare interface IRushConfigurationProjectJson {
|
|
|
1495
1393
|
skipRushCheck?: boolean;
|
|
1496
1394
|
publishFolder?: string;
|
|
1497
1395
|
tags?: string[];
|
|
1498
|
-
splitWorkspace?: boolean;
|
|
1499
1396
|
}
|
|
1500
1397
|
|
|
1501
1398
|
/**
|
|
@@ -1520,16 +1417,6 @@ declare interface IRushConfigurationProjectOptions {
|
|
|
1520
1417
|
allowedProjectTags: Set<string> | undefined;
|
|
1521
1418
|
}
|
|
1522
1419
|
|
|
1523
|
-
/**
|
|
1524
|
-
* The filter parameters to search from all projects.
|
|
1525
|
-
*/
|
|
1526
|
-
declare interface IRushConfigurationProjectsFilter {
|
|
1527
|
-
/**
|
|
1528
|
-
* If true, filter out projects that specify splitWorkspace as true.
|
|
1529
|
-
*/
|
|
1530
|
-
splitWorkspace: boolean;
|
|
1531
|
-
}
|
|
1532
|
-
|
|
1533
1420
|
/**
|
|
1534
1421
|
* Part of IRushConfigurationJson.
|
|
1535
1422
|
*/
|
|
@@ -1793,9 +1680,16 @@ export declare interface _IYarnOptionsJson extends IPackageManagerOptionsJsonBas
|
|
|
1793
1680
|
* it can invalidate the last install.
|
|
1794
1681
|
* @internal
|
|
1795
1682
|
*/
|
|
1796
|
-
export declare class _LastInstallFlag
|
|
1683
|
+
export declare class _LastInstallFlag {
|
|
1684
|
+
private _path;
|
|
1685
|
+
private _state;
|
|
1686
|
+
/**
|
|
1687
|
+
* Creates a new LastInstall flag
|
|
1688
|
+
* @param folderPath - the folder that this flag is managing
|
|
1689
|
+
* @param state - optional, the state that should be managed or compared
|
|
1690
|
+
*/
|
|
1691
|
+
constructor(folderPath: string, state?: JsonObject);
|
|
1797
1692
|
/**
|
|
1798
|
-
* @override
|
|
1799
1693
|
* Returns true if the file exists and the contents match the current state.
|
|
1800
1694
|
*/
|
|
1801
1695
|
isValid(): boolean;
|
|
@@ -1807,6 +1701,18 @@ export declare class _LastInstallFlag extends _BaseFlag<_ILastInstallFlagJson> {
|
|
|
1807
1701
|
*/
|
|
1808
1702
|
checkValidAndReportStoreIssues(rushVerb: string): boolean;
|
|
1809
1703
|
private _isValid;
|
|
1704
|
+
/**
|
|
1705
|
+
* Writes the flag file to disk with the current state
|
|
1706
|
+
*/
|
|
1707
|
+
create(): void;
|
|
1708
|
+
/**
|
|
1709
|
+
* Removes the flag file
|
|
1710
|
+
*/
|
|
1711
|
+
clear(): void;
|
|
1712
|
+
/**
|
|
1713
|
+
* Returns the full path to the flag file
|
|
1714
|
+
*/
|
|
1715
|
+
get path(): string;
|
|
1810
1716
|
/**
|
|
1811
1717
|
* Returns the name of the flag file
|
|
1812
1718
|
*/
|
|
@@ -2570,7 +2476,6 @@ export declare class RushConfiguration {
|
|
|
2570
2476
|
private _changesFolder;
|
|
2571
2477
|
private _commonFolder;
|
|
2572
2478
|
private _commonTempFolder;
|
|
2573
|
-
private _commonTempSplitFolder;
|
|
2574
2479
|
private _commonScriptsFolder;
|
|
2575
2480
|
private _commonRushConfigFolder;
|
|
2576
2481
|
private _packageManager;
|
|
@@ -2579,10 +2484,8 @@ export declare class RushConfiguration {
|
|
|
2579
2484
|
private _npmTmpFolder;
|
|
2580
2485
|
private _yarnCacheFolder;
|
|
2581
2486
|
private _shrinkwrapFilename;
|
|
2582
|
-
private _splitWorkspaceShrinkwrapFilename;
|
|
2583
2487
|
private _tempShrinkwrapFilename;
|
|
2584
2488
|
private _tempShrinkwrapPreinstallFilename;
|
|
2585
|
-
private _tempSplitWorkspaceShrinkwrapFilename;
|
|
2586
2489
|
private _currentVariantJsonFilename;
|
|
2587
2490
|
private _packageManagerToolVersion;
|
|
2588
2491
|
private _packageManagerToolFilename;
|
|
@@ -2614,8 +2517,6 @@ export declare class RushConfiguration {
|
|
|
2614
2517
|
private _projects;
|
|
2615
2518
|
private _projectsByName;
|
|
2616
2519
|
private _projectsByTag;
|
|
2617
|
-
private _filteredProjectsCache;
|
|
2618
|
-
private _hasSplitWorkspaceProject;
|
|
2619
2520
|
private _commonVersionsConfigurationsByVariant;
|
|
2620
2521
|
private _versionPolicyConfiguration;
|
|
2621
2522
|
private _versionPolicyConfigurationFilePath;
|
|
@@ -2708,12 +2609,6 @@ export declare class RushConfiguration {
|
|
|
2708
2609
|
* Example: `C:\MyRepo\common\temp`
|
|
2709
2610
|
*/
|
|
2710
2611
|
get commonTempFolder(): string;
|
|
2711
|
-
/**
|
|
2712
|
-
* The folder where temporary files will be stored. This is always a subfolder called "temp"
|
|
2713
|
-
* under the common folder.
|
|
2714
|
-
* Example: `C:\MyRepo\common\temp-split`
|
|
2715
|
-
*/
|
|
2716
|
-
get commonTempSplitFolder(): string;
|
|
2717
2612
|
/**
|
|
2718
2613
|
* The folder where automation scripts are stored. This is always a subfolder called "scripts"
|
|
2719
2614
|
* under the common folder.
|
|
@@ -2771,7 +2666,6 @@ export declare class RushConfiguration {
|
|
|
2771
2666
|
* Example: `npm-shrinkwrap.json` or `pnpm-lock.yaml`
|
|
2772
2667
|
*/
|
|
2773
2668
|
get shrinkwrapFilename(): string;
|
|
2774
|
-
get splitWorkspaceShrinkwrapFilename(): string;
|
|
2775
2669
|
/**
|
|
2776
2670
|
* The full path of the temporary shrinkwrap file that is used during "rush install".
|
|
2777
2671
|
* This file may get rewritten by the package manager during installation.
|
|
@@ -2780,14 +2674,6 @@ export declare class RushConfiguration {
|
|
|
2780
2674
|
* Example: `C:\MyRepo\common\temp\npm-shrinkwrap.json` or `C:\MyRepo\common\temp\pnpm-lock.yaml`
|
|
2781
2675
|
*/
|
|
2782
2676
|
get tempShrinkwrapFilename(): string;
|
|
2783
|
-
/**
|
|
2784
|
-
* The full path of the temporary shrinkwrap file for split workspace that is used during
|
|
2785
|
-
* "rush install". This file may get rewritten by the package manager during installation.
|
|
2786
|
-
* @remarks
|
|
2787
|
-
* This property merely reports the filename; the file itself may not actually exist.
|
|
2788
|
-
* Example: `C:\MyRepo\common\temp-split\pnpm-lock.yaml`
|
|
2789
|
-
*/
|
|
2790
|
-
get tempSplitWorkspaceShrinkwrapFilename(): string;
|
|
2791
2677
|
/**
|
|
2792
2678
|
* The full path of a backup copy of tempShrinkwrapFilename. This backup copy is made
|
|
2793
2679
|
* before installation begins, and can be compared to determine how the package manager
|
|
@@ -2952,11 +2838,6 @@ export declare class RushConfiguration {
|
|
|
2952
2838
|
* @beta
|
|
2953
2839
|
*/
|
|
2954
2840
|
get projectsByTag(): ReadonlyMap<string, ReadonlySet<RushConfigurationProject>>;
|
|
2955
|
-
/**
|
|
2956
|
-
* Search for projects according to filter
|
|
2957
|
-
* @beta
|
|
2958
|
-
*/
|
|
2959
|
-
getFilteredProjects(filter: IRushConfigurationProjectsFilter): RushConfigurationProject[];
|
|
2960
2841
|
/**
|
|
2961
2842
|
* {@inheritDoc NpmOptionsConfiguration}
|
|
2962
2843
|
*/
|
|
@@ -3003,10 +2884,6 @@ export declare class RushConfiguration {
|
|
|
3003
2884
|
* The rush hooks. It allows customized scripts to run at the specified point.
|
|
3004
2885
|
*/
|
|
3005
2886
|
get packageNameParser(): PackageNameParser;
|
|
3006
|
-
/**
|
|
3007
|
-
* Is there any split workspace project.
|
|
3008
|
-
*/
|
|
3009
|
-
get hasSplitWorkspaceProject(): boolean;
|
|
3010
2887
|
/**
|
|
3011
2888
|
* Gets the path to the common-versions.json config file for a specific variant.
|
|
3012
2889
|
* @param variant - The name of the current variant in use by the active command.
|
|
@@ -3039,11 +2916,6 @@ export declare class RushConfiguration {
|
|
|
3039
2916
|
* @param variant - The name of the current variant in use by the active command.
|
|
3040
2917
|
*/
|
|
3041
2918
|
getCommittedShrinkwrapFilename(variant?: string | undefined): string;
|
|
3042
|
-
/**
|
|
3043
|
-
* Gets the committed shrinkwrap file name for split workspace.
|
|
3044
|
-
* @param variant - The name of the current variant in use by the active command.
|
|
3045
|
-
*/
|
|
3046
|
-
getCommittedSplitWorkspaceShrinkwrapFilename(): string;
|
|
3047
2919
|
/**
|
|
3048
2920
|
* Gets the absolute path for "pnpmfile.js" for a specific variant.
|
|
3049
2921
|
* @param variant - The name of the current variant in use by the active command.
|
|
@@ -3098,12 +2970,6 @@ export declare class RushConfiguration {
|
|
|
3098
2970
|
*/
|
|
3099
2971
|
tryGetProjectForPath(currentFolderPath: string): RushConfigurationProject | undefined;
|
|
3100
2972
|
private _getVariantConfigFolderPath;
|
|
3101
|
-
/**
|
|
3102
|
-
* Split workspace can only works on PNPM with "useWorkspaces" enabled.
|
|
3103
|
-
* The workspace project can NOT depend on a split workspace project.
|
|
3104
|
-
* The split workspace project CAN depend on a workspace project.
|
|
3105
|
-
*/
|
|
3106
|
-
private _validateSplitWorkspaceRelationships;
|
|
3107
2973
|
}
|
|
3108
2974
|
|
|
3109
2975
|
/**
|
|
@@ -3129,7 +2995,6 @@ export declare class RushConfigurationProject {
|
|
|
3129
2995
|
private readonly _publishFolder;
|
|
3130
2996
|
private readonly _rushConfiguration;
|
|
3131
2997
|
private readonly _tags;
|
|
3132
|
-
private readonly _splitWorkspace;
|
|
3133
2998
|
private _versionPolicy;
|
|
3134
2999
|
private _dependencyProjects;
|
|
3135
3000
|
private _consumingProjects;
|
|
@@ -3297,11 +3162,6 @@ export declare class RushConfigurationProject {
|
|
|
3297
3162
|
* @beta
|
|
3298
3163
|
*/
|
|
3299
3164
|
get tags(): ReadonlySet<string>;
|
|
3300
|
-
/**
|
|
3301
|
-
* Whether this project is a split workspace project.
|
|
3302
|
-
* @beta
|
|
3303
|
-
*/
|
|
3304
|
-
get splitWorkspace(): boolean;
|
|
3305
3165
|
}
|
|
3306
3166
|
|
|
3307
3167
|
/**
|
|
@@ -3349,12 +3209,6 @@ export declare class RushConstants {
|
|
|
3349
3209
|
* Example: `C:\MyRepo\common\temp`
|
|
3350
3210
|
*/
|
|
3351
3211
|
static readonly rushTempFolderName: string;
|
|
3352
|
-
/**
|
|
3353
|
-
* The folder name ("temp-split") under the common folder, or under the .rush folder in each project's directory where
|
|
3354
|
-
* temporary files will be stored.
|
|
3355
|
-
* Example: `C:\MyRepo\common\temp-split`
|
|
3356
|
-
*/
|
|
3357
|
-
static readonly rushTempSplitFolderName: string;
|
|
3358
3212
|
/**
|
|
3359
3213
|
* The folder name ("projects") where temporary projects will be stored.
|
|
3360
3214
|
* Example: `C:\MyRepo\common\temp\projects`
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@rushstack/rush-sdk",
|
|
3
|
-
"version": "5.83.
|
|
3
|
+
"version": "5.83.1",
|
|
4
4
|
"description": "An API for interacting with the Rush engine",
|
|
5
5
|
"repository": {
|
|
6
6
|
"type": "git",
|
|
@@ -17,7 +17,7 @@
|
|
|
17
17
|
"tapable": "2.2.1"
|
|
18
18
|
},
|
|
19
19
|
"devDependencies": {
|
|
20
|
-
"@microsoft/rush-lib": "5.83.
|
|
20
|
+
"@microsoft/rush-lib": "5.83.1",
|
|
21
21
|
"@rushstack/eslint-config": "3.1.1",
|
|
22
22
|
"@rushstack/heft": "0.48.8",
|
|
23
23
|
"@rushstack/heft-node-rig": "1.11.8",
|