-
Notifications
You must be signed in to change notification settings - Fork 586
/
RushConfiguration.ts
1496 lines (1305 loc) · 55 KB
/
RushConfiguration.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
// See LICENSE in the project root for license information.
/* eslint max-lines: off */
import * as path from 'path';
import * as semver from 'semver';
import {
JsonFile,
JsonSchema,
Path,
FileSystem,
type PackageNameParser,
type FileSystemStats,
InternalError
} from '@rushstack/node-core-library';
import { trueCasePathSync } from 'true-case-path';
import { Rush } from '../api/Rush';
import { RushConfigurationProject, type IRushConfigurationProjectJson } from './RushConfigurationProject';
import { RushConstants } from '../logic/RushConstants';
import { ApprovedPackagesPolicy } from './ApprovedPackagesPolicy';
import { EventHooks } from './EventHooks';
import { VersionPolicyConfiguration } from './VersionPolicyConfiguration';
import { EnvironmentConfiguration } from './EnvironmentConfiguration';
import type { CommonVersionsConfiguration } from './CommonVersionsConfiguration';
import { Utilities } from '../utilities/Utilities';
import type { PackageManagerName, PackageManager } from './packageManager/PackageManager';
import { NpmPackageManager } from './packageManager/NpmPackageManager';
import { YarnPackageManager } from './packageManager/YarnPackageManager';
import { PnpmPackageManager } from './packageManager/PnpmPackageManager';
import { ExperimentsConfiguration } from './ExperimentsConfiguration';
import { PackageNameParsers } from './PackageNameParsers';
import type { RepoStateFile } from '../logic/RepoStateFile';
import { LookupByPath } from '../logic/LookupByPath';
import { RushPluginsConfiguration } from './RushPluginsConfiguration';
import { type IPnpmOptionsJson, PnpmOptionsConfiguration } from '../logic/pnpm/PnpmOptionsConfiguration';
import { type INpmOptionsJson, NpmOptionsConfiguration } from '../logic/npm/NpmOptionsConfiguration';
import { type IYarnOptionsJson, YarnOptionsConfiguration } from '../logic/yarn/YarnOptionsConfiguration';
import schemaJson from '../schemas/rush.schema.json';
import type * as DependencyAnalyzerModuleType from '../logic/DependencyAnalyzer';
import type { PackageManagerOptionsConfigurationBase } from '../logic/base/BasePackageManagerOptionsConfiguration';
import { CustomTipsConfiguration } from './CustomTipsConfiguration';
import { SubspacesConfiguration } from './SubspacesConfiguration';
import { Subspace } from './Subspace';
const MINIMUM_SUPPORTED_RUSH_JSON_VERSION: string = '0.0.0';
const DEFAULT_BRANCH: string = 'main';
const DEFAULT_REMOTE: string = 'origin';
/**
* A list of known config filenames that are expected to appear in the "./common/config/rush" folder.
* To avoid confusion/mistakes, any extra files will be reported as an error.
*/
const knownRushConfigFilenames: string[] = [
'.npmrc-publish',
'.npmrc',
'deploy.json',
RushConstants.artifactoryFilename,
RushConstants.browserApprovedPackagesFilename,
RushConstants.buildCacheFilename,
RushConstants.cobuildFilename,
RushConstants.commandLineFilename,
RushConstants.commonVersionsFilename,
RushConstants.customTipsFilename,
RushConstants.experimentsFilename,
RushConstants.nonbrowserApprovedPackagesFilename,
RushConstants.pinnedVersionsFilename,
RushConstants.repoStateFilename,
RushConstants.versionPoliciesFilename,
RushConstants.rushPluginsConfigFilename,
RushConstants.pnpmConfigFilename,
RushConstants.subspacesConfigFilename
];
/**
* Part of IRushConfigurationJson.
*/
export interface IApprovedPackagesPolicyJson {
reviewCategories?: string[];
ignoredNpmScopes?: string[];
}
/**
* Part of IRushConfigurationJson.
*/
export interface IRushGitPolicyJson {
allowedEmailRegExps?: string[];
sampleEmail?: string;
versionBumpCommitMessage?: string;
changeLogUpdateCommitMessage?: string;
changefilesCommitMessage?: string;
tagSeparator?: string;
}
/**
* Part of IRushConfigurationJson.
* @beta
*/
export interface IEventHooksJson {
/**
* The list of scripts to run after every Rush build command finishes
*/
postRushBuild?: string[];
}
/**
* Part of IRushConfigurationJson.
*/
export interface IRushRepositoryJsonBase {
/**
* The default branch name. This tells "rush change" which remote branch to compare against.
*/
defaultBranch?: string;
/**
* The default remote. This tells "rush change" which remote to compare against if the remote URL is not set
* or if a remote matching the provided remote URL is not found.
*/
defaultRemote?: string;
}
export interface IRushRepositoryJsonSingleUrl extends IRushRepositoryJsonBase {
/**
* The remote url of the repository. If a value is provided,
* \"rush change\" will use it to find the right remote to compare against.
*
* @deprecated Use "urls" instead.
*/
url?: string;
}
export interface IRushRepositoryJsonMultipleUrls extends IRushRepositoryJsonBase {
/**
* Remote url(s) of the repository. If a value is provided, \"rush change\" will
* use one of these to find the right remote to compare against. Specifying multiple URLs
* is useful if a GitHub repository is renamed or for `<projectName>.visualstudio.com` versus
* `dev.azure.com/<projectName>` URLs.
*/
urls?: string[];
}
export type IRushRepositoryJson = IRushRepositoryJsonSingleUrl | IRushRepositoryJsonMultipleUrls;
/**
* This represents the JSON data structure for the "rush.json" configuration file.
* See rush.schema.json for documentation.
*/
export interface IRushConfigurationJson {
$schema: string;
npmVersion?: string;
pnpmVersion?: string;
yarnVersion?: string;
rushVersion: string;
repository?: IRushRepositoryJson;
nodeSupportedVersionRange?: string;
nodeSupportedVersionInstructions?: string;
suppressNodeLtsWarning?: boolean;
projectFolderMinDepth?: number;
projectFolderMaxDepth?: number;
allowMostlyStandardPackageNames?: boolean;
approvedPackagesPolicy?: IApprovedPackagesPolicyJson;
gitPolicy?: IRushGitPolicyJson;
telemetryEnabled?: boolean;
allowedProjectTags?: string[];
projects: IRushConfigurationProjectJson[];
eventHooks?: IEventHooksJson;
hotfixChangeEnabled?: boolean;
npmOptions?: INpmOptionsJson;
pnpmOptions?: IPnpmOptionsJson;
yarnOptions?: IYarnOptionsJson;
ensureConsistentVersions?: boolean;
variants?: unknown;
}
/**
* The filter parameters to search from all projects
*/
export interface IRushConfigurationProjectsFilter {
/**
* A string representation of the subspace to filter for
*/
subspace: string;
}
/**
* Options for `RushConfiguration.tryFindRushJsonLocation`.
* @public
*/
export interface ITryFindRushJsonLocationOptions {
/**
* Whether to show verbose console messages. Defaults to false.
*/
showVerbose?: boolean; // Defaults to false (inverse of old `verbose` parameter)
/**
* The folder path where the search will start. Defaults to the current working directory.
*/
startingFolder?: string; // Defaults to cwd
}
/**
* This represents the Rush configuration for a repository, based on the "rush.json"
* configuration file.
* @public
*/
export class RushConfiguration {
private static _jsonSchema: JsonSchema = JsonSchema.fromLoadedObject(schemaJson);
private readonly _pathTrees: Map<string, LookupByPath<RushConfigurationProject>>;
// Lazily loaded when the projects() getter is called.
private _projects: RushConfigurationProject[] | undefined;
// Lazily loaded when the projectsByName() getter is called.
private _projectsByName: Map<string, RushConfigurationProject> | undefined;
// Lazily loaded when the projectsByTag() getter is called.
private _projectsByTag: ReadonlyMap<string, ReadonlySet<RushConfigurationProject>> | undefined;
// subspaceName -> subspace
private readonly _subspacesByName: Map<string, Subspace>;
private readonly _subspaces: Subspace[] = [];
/**
* The name of the package manager being used to install dependencies
*/
public readonly packageManager!: PackageManagerName;
/**
* {@inheritdoc PackageManager}
*
* @privateremarks
* In the next major breaking API change, we will rename this property to "packageManager" and eliminate the
* old property with that name.
*
* @beta
*/
public readonly packageManagerWrapper: PackageManager;
/**
* Gets the JSON data structure for the "rush.json" configuration file.
*
* @internal
*/
public readonly rushConfigurationJson: IRushConfigurationJson;
/**
* The absolute path to the "rush.json" configuration file that was loaded to construct this object.
*/
public readonly rushJsonFile: string;
/**
* The absolute path of the folder that contains rush.json for this project.
*/
public readonly rushJsonFolder: string;
/**
* The folder that contains all change files.
*/
public readonly changesFolder: string;
/**
* The fully resolved path for the "common" folder where Rush will store settings that
* affect all Rush projects. This is always a subfolder of the folder containing "rush.json".
* Example: `C:\MyRepo\common`
*/
public readonly commonFolder: string;
/**
* The folder where Rush's additional config files are stored. This folder is always a
* subfolder called `config\rush` inside the common folder. (The `common\config` folder
* is reserved for configuration files used by other tools.) To avoid confusion or mistakes,
* Rush will report an error if this this folder contains any unrecognized files.
*
* Example: `C:\MyRepo\common\config\rush`
*/
public readonly commonRushConfigFolder: string;
/**
* The folder where temporary files will be stored. This is always a subfolder called "temp"
* under the common folder.
* Example: `C:\MyRepo\common\temp`
*/
public readonly commonTempFolder: string;
/**
* The folder where automation scripts are stored. This is always a subfolder called "scripts"
* under the common folder.
* Example: `C:\MyRepo\common\scripts`
*/
public readonly commonScriptsFolder: string;
/**
* The local folder that will store the NPM package cache. Rush does not rely on the
* npm's default global cache folder, because npm's caching implementation does not
* reliably handle multiple processes. (For example, if a build box is running
* "rush install" simultaneously for two different working folders, it may fail randomly.)
*
* Example: `C:\MyRepo\common\temp\npm-cache`
*/
public readonly npmCacheFolder: string;
/**
* The local folder where npm's temporary files will be written during installation.
* Rush does not rely on the global default folder, because it may be on a different
* hard disk.
*
* Example: `C:\MyRepo\common\temp\npm-tmp`
*/
public readonly npmTmpFolder: string;
/**
* The local folder that will store the Yarn package cache.
*
* Example: `C:\MyRepo\common\temp\yarn-cache`
*/
public readonly yarnCacheFolder: string;
/**
* The filename (without any path) of the shrinkwrap file that is used by the package manager.
* @remarks
* This property merely reports the filename; the file itself may not actually exist.
* Example: `npm-shrinkwrap.json` or `pnpm-lock.yaml`
*/
public readonly shrinkwrapFilename: string;
/**
* The object that specifies subspace configurations if they are provided in the rush workspace.
* @beta
*/
public readonly subspacesConfiguration: SubspacesConfiguration | undefined;
/**
* Returns true if subspaces.json is present with "subspacesEnabled=true".
*/
public readonly subspacesFeatureEnabled: boolean;
/**
* If true, the `variants` field is present in rush.json.
*
* @internal
* @deprecated - Remove when the field is removed from the rush.json schema.
*/
public readonly _hasVariantsField: boolean;
/**
* The version of the locally package manager tool. (Example: "1.2.3")
*/
public readonly packageManagerToolVersion: string;
/**
* The absolute path to the locally package manager tool. If "rush install" has not
* been run, then this file may not exist yet.
* Example: `C:\MyRepo\common\temp\npm-local\node_modules\.bin\npm`
*/
public readonly packageManagerToolFilename: string;
/**
* The minimum allowable folder depth for the projectFolder field in the rush.json file.
* This setting provides a way for repository maintainers to discourage nesting of project folders
* that makes the directory tree more difficult to navigate. The default value is 2,
* which implements a standard 2-level hierarchy of `<categoryFolder>/<projectFolder>/package.json`.
*/
public readonly projectFolderMinDepth: number;
/**
* The maximum allowable folder depth for the projectFolder field in the rush.json file.
* This setting provides a way for repository maintainers to discourage nesting of project folders
* that makes the directory tree more difficult to navigate. The default value is 2,
* which implements on a standard convention of `<categoryFolder>/<projectFolder>/package.json`.
*/
public readonly projectFolderMaxDepth: number;
/**
* Today the npmjs.com registry enforces fairly strict naming rules for packages, but in the early
* days there was no standard and hardly any enforcement. A few large legacy projects are still using
* nonstandard package names, and private registries sometimes allow it. Set "allowMostlyStandardPackageNames"
* to true to relax Rush's enforcement of package names. This allows upper case letters and in the future may
* relax other rules, however we want to minimize these exceptions. Many popular tools use certain punctuation
* characters as delimiters, based on the assumption that they will never appear in a package name; thus if we relax
* the rules too much it is likely to cause very confusing malfunctions.
*
* The default value is false.
*/
public readonly allowMostlyStandardPackageNames: boolean;
/**
* The "approvedPackagesPolicy" settings.
*/
public readonly approvedPackagesPolicy: ApprovedPackagesPolicy;
/**
* [Part of the "gitPolicy" feature.]
* A list of regular expressions describing allowable email patterns for Git commits.
* They are case-insensitive anchored JavaScript RegExps.
* Example: `".*@example\.com"`
* This array will never be undefined.
*/
public readonly gitAllowedEmailRegExps: string[];
/**
* [Part of the "gitPolicy" feature.]
* An example valid email address that conforms to one of the allowedEmailRegExps.
* Example: `"foxtrot@example\.com"`
* This will never be undefined, and will always be nonempty if gitAllowedEmailRegExps is used.
*/
public readonly gitSampleEmail: string;
/**
* [Part of the "gitPolicy" feature.]
* The commit message to use when committing changes during 'rush publish'
*/
public readonly gitVersionBumpCommitMessage: string | undefined;
/**
* [Part of the "gitPolicy" feature.]
* The commit message to use when committing change log files 'rush version'
*/
public readonly gitChangeLogUpdateCommitMessage: string | undefined;
/**
* [Part of the "gitPolicy" feature.]
* The commit message to use when committing change log files 'rush version'
*/
public readonly gitChangefilesCommitMessage: string | undefined;
/**
* [Part of the "gitPolicy" feature.]
* The separator between package name and version in git tag.
*/
public readonly gitTagSeparator: string | undefined;
/**
* [Part of the "hotfixChange" feature.]
* Enables creating hotfix changes
*/
public readonly hotfixChangeEnabled: boolean;
/**
* Remote URL(s) of the repository. If a value is provided, \"rush change\" will
* use one of these to find the right remote to compare against. Specifying multiple URLs
* is useful if a GitHub repository is renamed or for `<projectName>.visualstudio.com` versus
* `dev.azure.com/<projectName>` URLs.
*/
public readonly repositoryUrls: string[];
/**
* The default branch name. This tells "rush change" which remote branch to compare against.
*/
public readonly repositoryDefaultBranch: string;
/**
* The default remote. This tells "rush change" which remote to compare against if the remote URL is not set
* or if a remote matching the provided remote URL is not found.
*/
public readonly repositoryDefaultRemote: string;
/**
* Odd-numbered major versions of Node.js are experimental. Even-numbered releases
* spend six months in a stabilization period before the first Long Term Support (LTS) version.
* For example, 8.9.0 was the first LTS version of Node.js 8. Pre-LTS versions are not recommended
* for production usage because they frequently have bugs. They may cause Rush itself
* to malfunction.
*
* Rush normally prints a warning if it detects a pre-LTS Node.js version. If you are testing
* pre-LTS versions in preparation for supporting the first LTS version, you can use this setting
* to disable Rush's warning.
*/
public readonly suppressNodeLtsWarning: boolean;
/**
* If true, then consistent version specifiers for dependencies will be enforced.
* I.e. "rush check" is run before some commands.
*/
public readonly ensureConsistentVersions: boolean;
/**
* Indicates whether telemetry collection is enabled for Rush runs.
* @beta
*/
public readonly telemetryEnabled: boolean;
/**
* {@inheritDoc NpmOptionsConfiguration}
*/
public readonly npmOptions: NpmOptionsConfiguration;
/**
* {@inheritDoc PnpmOptionsConfiguration}
*/
public readonly pnpmOptions: PnpmOptionsConfiguration;
/**
* {@inheritDoc YarnOptionsConfiguration}
*/
public readonly yarnOptions: YarnOptionsConfiguration;
/**
* The configuration options used by the current package manager.
* @remarks
* For package manager specific variants, reference {@link RushConfiguration.npmOptions | npmOptions},
* {@link RushConfiguration.pnpmOptions | pnpmOptions}, or {@link RushConfiguration.yarnOptions | yarnOptions}.
*/
public readonly packageManagerOptions!: PackageManagerOptionsConfigurationBase;
/**
* The rush hooks. It allows customized scripts to run at the specified point.
* @beta
*/
public readonly eventHooks: EventHooks;
/**
* The rush hooks. It allows customized scripts to run at the specified point.
*/
public readonly packageNameParser: PackageNameParser;
/**
* @beta
*/
public readonly versionPolicyConfiguration: VersionPolicyConfiguration;
/**
* @beta
*/
public readonly versionPolicyConfigurationFilePath: string;
/**
* Accesses the custom-tips.json configuration.
* @beta
*/
public readonly customTipsConfiguration: CustomTipsConfiguration;
/**
* The absolute path to the custom tips configuration file.
* @beta
*/
public readonly customTipsConfigurationFilePath: string;
/**
* This configuration object contains settings repo maintainers have specified to enable
* and disable experimental Rush features.
*
* @beta
*/
public readonly experimentsConfiguration: ExperimentsConfiguration;
/**
* @internal
*/
public readonly _rushPluginsConfiguration: RushPluginsConfiguration;
/**
* Use RushConfiguration.loadFromConfigurationFile() or Use RushConfiguration.loadFromDefaultLocation()
* instead.
*/
private constructor(rushConfigurationJson: IRushConfigurationJson, rushJsonFilename: string) {
this.rushConfigurationJson = rushConfigurationJson;
EnvironmentConfiguration.validate();
if (rushConfigurationJson.nodeSupportedVersionRange) {
if (!semver.validRange(rushConfigurationJson.nodeSupportedVersionRange)) {
throw new Error(
'Error parsing the node-semver expression in the "nodeSupportedVersionRange"' +
` field from ${RushConstants.rushJsonFilename}: "${rushConfigurationJson.nodeSupportedVersionRange}"`
);
}
if (!semver.satisfies(process.version, rushConfigurationJson.nodeSupportedVersionRange)) {
let message: string =
`Your dev environment is running Node.js version ${process.version} which does` +
` not meet the requirements for building this repository. (The ${RushConstants.rushJsonFilename} configuration` +
` requires nodeSupportedVersionRange="${rushConfigurationJson.nodeSupportedVersionRange}")`;
if (rushConfigurationJson.nodeSupportedVersionInstructions) {
message += '\n\n' + rushConfigurationJson.nodeSupportedVersionInstructions;
}
if (EnvironmentConfiguration.allowUnsupportedNodeVersion) {
// eslint-disable-next-line no-console
console.warn(message);
} else {
throw new Error(message);
}
}
}
this.rushJsonFile = rushJsonFilename;
this.rushJsonFolder = path.dirname(rushJsonFilename);
this.commonFolder = path.resolve(path.join(this.rushJsonFolder, RushConstants.commonFolderName));
this.commonRushConfigFolder = path.join(this.commonFolder, 'config', 'rush');
this.commonTempFolder =
EnvironmentConfiguration.rushTempFolderOverride ||
path.join(this.commonFolder, RushConstants.rushTempFolderName);
this.commonScriptsFolder = path.join(this.commonFolder, 'scripts');
this.npmCacheFolder = path.resolve(path.join(this.commonTempFolder, 'npm-cache'));
this.npmTmpFolder = path.resolve(path.join(this.commonTempFolder, 'npm-tmp'));
this.yarnCacheFolder = path.resolve(path.join(this.commonTempFolder, 'yarn-cache'));
this.changesFolder = path.join(this.commonFolder, RushConstants.changeFilesFolderName);
this.suppressNodeLtsWarning = !!rushConfigurationJson.suppressNodeLtsWarning;
this.ensureConsistentVersions = !!rushConfigurationJson.ensureConsistentVersions;
// Try getting a subspace configuration
this.subspacesConfiguration = SubspacesConfiguration.tryLoadFromDefaultLocation(this);
this.subspacesFeatureEnabled = !!this.subspacesConfiguration?.subspacesEnabled;
this._subspacesByName = new Map();
const experimentsConfigFile: string = path.join(
this.commonRushConfigFolder,
RushConstants.experimentsFilename
);
this.experimentsConfiguration = new ExperimentsConfiguration(experimentsConfigFile);
const rushPluginsConfigFilename: string = path.join(
this.commonRushConfigFolder,
RushConstants.rushPluginsConfigFilename
);
this._rushPluginsConfiguration = new RushPluginsConfiguration(rushPluginsConfigFilename);
this.npmOptions = new NpmOptionsConfiguration(rushConfigurationJson.npmOptions || {});
this.yarnOptions = new YarnOptionsConfiguration(rushConfigurationJson.yarnOptions || {});
try {
this.pnpmOptions = PnpmOptionsConfiguration.loadFromJsonFileOrThrow(
`${this.commonRushConfigFolder}/${RushConstants.pnpmConfigFilename}`,
this.commonTempFolder
);
if (rushConfigurationJson.pnpmOptions) {
throw new Error(
'Because the new config file "common/config/rush/pnpm-config.json" is being used, ' +
`you must remove the old setting "pnpmOptions" from ${RushConstants.rushJsonFilename}`
);
}
} catch (error) {
if (FileSystem.isNotExistError(error as Error)) {
this.pnpmOptions = PnpmOptionsConfiguration.loadFromJsonObject(
rushConfigurationJson.pnpmOptions || {},
this.commonTempFolder
);
} else {
throw error;
}
}
// TODO: Add an actual "packageManager" field in rush.json
const packageManagerFields: string[] = [];
if (rushConfigurationJson.npmVersion) {
this.packageManager = 'npm';
this.packageManagerOptions = this.npmOptions;
packageManagerFields.push('npmVersion');
}
if (rushConfigurationJson.pnpmVersion) {
this.packageManager = 'pnpm';
this.packageManagerOptions = this.pnpmOptions;
packageManagerFields.push('pnpmVersion');
}
if (rushConfigurationJson.yarnVersion) {
this.packageManager = 'yarn';
this.packageManagerOptions = this.yarnOptions;
packageManagerFields.push('yarnVersion');
}
if (packageManagerFields.length === 0) {
throw new Error(
`The ${RushConstants.rushJsonFilename} configuration must specify one of: npmVersion, pnpmVersion, or yarnVersion`
);
}
if (packageManagerFields.length > 1) {
throw new Error(
`The ${RushConstants.rushJsonFilename} configuration cannot specify both ${packageManagerFields[0]}` +
` and ${packageManagerFields[1]} `
);
}
if (this.packageManager === 'npm') {
this.packageManagerToolVersion = rushConfigurationJson.npmVersion!;
this.packageManagerWrapper = new NpmPackageManager(this.packageManagerToolVersion);
} else if (this.packageManager === 'pnpm') {
this.packageManagerToolVersion = rushConfigurationJson.pnpmVersion!;
this.packageManagerWrapper = new PnpmPackageManager(this.packageManagerToolVersion);
} else {
this.packageManagerToolVersion = rushConfigurationJson.yarnVersion!;
this.packageManagerWrapper = new YarnPackageManager(this.packageManagerToolVersion);
}
this.shrinkwrapFilename = this.packageManagerWrapper.shrinkwrapFilename;
this.packageManagerToolFilename = path.resolve(
path.join(
this.commonTempFolder,
`${this.packageManager}-local`,
'node_modules',
'.bin',
`${this.packageManager}`
)
);
RushConfiguration._validateCommonRushConfigFolder(
this.commonRushConfigFolder,
this.packageManagerWrapper,
this.experimentsConfiguration
);
this.projectFolderMinDepth =
rushConfigurationJson.projectFolderMinDepth !== undefined
? rushConfigurationJson.projectFolderMinDepth
: 1;
if (this.projectFolderMinDepth < 1) {
throw new Error('Invalid projectFolderMinDepth; the minimum possible value is 1');
}
this.projectFolderMaxDepth =
rushConfigurationJson.projectFolderMaxDepth !== undefined
? rushConfigurationJson.projectFolderMaxDepth
: 2;
if (this.projectFolderMaxDepth < this.projectFolderMinDepth) {
throw new Error('The projectFolderMaxDepth cannot be smaller than the projectFolderMinDepth');
}
this.allowMostlyStandardPackageNames = !!rushConfigurationJson.allowMostlyStandardPackageNames;
this.packageNameParser = this.allowMostlyStandardPackageNames
? PackageNameParsers.mostlyStandard
: PackageNameParsers.rushDefault;
this.approvedPackagesPolicy = new ApprovedPackagesPolicy(this, rushConfigurationJson);
this.gitAllowedEmailRegExps = [];
this.gitSampleEmail = '';
if (rushConfigurationJson.gitPolicy) {
if (rushConfigurationJson.gitPolicy.sampleEmail) {
this.gitSampleEmail = rushConfigurationJson.gitPolicy.sampleEmail;
}
if (rushConfigurationJson.gitPolicy.allowedEmailRegExps) {
this.gitAllowedEmailRegExps = rushConfigurationJson.gitPolicy.allowedEmailRegExps;
if (this.gitSampleEmail.trim().length < 1) {
throw new Error(
`The ${RushConstants.rushJsonFilename} file is missing the "sampleEmail" option, ` +
'which is required when using "allowedEmailRegExps"'
);
}
}
if (rushConfigurationJson.gitPolicy.versionBumpCommitMessage) {
this.gitVersionBumpCommitMessage = rushConfigurationJson.gitPolicy.versionBumpCommitMessage;
}
if (rushConfigurationJson.gitPolicy.changeLogUpdateCommitMessage) {
this.gitChangeLogUpdateCommitMessage = rushConfigurationJson.gitPolicy.changeLogUpdateCommitMessage;
}
if (rushConfigurationJson.gitPolicy.changefilesCommitMessage) {
this.gitChangefilesCommitMessage = rushConfigurationJson.gitPolicy.changefilesCommitMessage;
}
if (rushConfigurationJson.gitPolicy.tagSeparator) {
this.gitTagSeparator = rushConfigurationJson.gitPolicy.tagSeparator;
}
}
this.hotfixChangeEnabled = false;
if (rushConfigurationJson.hotfixChangeEnabled) {
this.hotfixChangeEnabled = rushConfigurationJson.hotfixChangeEnabled;
}
if (!rushConfigurationJson.repository) {
rushConfigurationJson.repository = {};
}
this.repositoryDefaultBranch = rushConfigurationJson.repository.defaultBranch || DEFAULT_BRANCH;
this.repositoryDefaultRemote = rushConfigurationJson.repository.defaultRemote || DEFAULT_REMOTE;
const repositoryFieldWithMultipleUrls: IRushRepositoryJsonMultipleUrls =
rushConfigurationJson.repository as IRushRepositoryJsonMultipleUrls;
const repositoryFieldWithSingleUrl: IRushRepositoryJsonSingleUrl =
rushConfigurationJson.repository as IRushRepositoryJsonSingleUrl;
if (repositoryFieldWithMultipleUrls.urls) {
if (repositoryFieldWithSingleUrl.url) {
throw new Error("The 'repository.url' field cannot be used when 'repository.urls' is present");
}
this.repositoryUrls = repositoryFieldWithMultipleUrls.urls;
} else if (repositoryFieldWithSingleUrl.url) {
this.repositoryUrls = [repositoryFieldWithSingleUrl.url];
} else {
this.repositoryUrls = [];
}
this.telemetryEnabled = !!rushConfigurationJson.telemetryEnabled;
this.eventHooks = new EventHooks(rushConfigurationJson.eventHooks || {});
this.versionPolicyConfigurationFilePath = path.join(
this.commonRushConfigFolder,
RushConstants.versionPoliciesFilename
);
this.versionPolicyConfiguration = new VersionPolicyConfiguration(this.versionPolicyConfigurationFilePath);
this.customTipsConfigurationFilePath = path.join(
this.commonRushConfigFolder,
RushConstants.customTipsFilename
);
this.customTipsConfiguration = new CustomTipsConfiguration(this.customTipsConfigurationFilePath);
this._hasVariantsField = !!rushConfigurationJson.variants;
this._pathTrees = new Map();
}
private _initializeAndValidateLocalProjects(): void {
this._projects = [];
this._projectsByName = new Map<string, RushConfigurationProject>();
this._subspacesByName.clear();
this._subspaces.length = 0;
// Build the subspaces map
const subspaceNames: string[] = [];
let splitWorkspaceCompatibility: boolean = false;
if (this.subspacesConfiguration?.subspacesEnabled) {
splitWorkspaceCompatibility = this.subspacesConfiguration.splitWorkspaceCompatibility;
subspaceNames.push(...this.subspacesConfiguration.subspaceNames);
}
if (subspaceNames.indexOf(RushConstants.defaultSubspaceName) < 0) {
subspaceNames.push(RushConstants.defaultSubspaceName);
}
// Sort the subspaces in alphabetical order. This ensures that they are processed
// in a deterministic order by the various Rush algorithms.
subspaceNames.sort();
for (const subspaceName of subspaceNames) {
const subspace: Subspace = new Subspace({
subspaceName,
rushConfiguration: this,
splitWorkspaceCompatibility
});
this._subspacesByName.set(subspaceName, subspace);
this._subspaces.push(subspace);
}
const defaultSubspace: Subspace | undefined = this._subspacesByName.get(
RushConstants.defaultSubspaceName
);
if (!defaultSubspace) {
throw new InternalError('The default subspace was not created');
}
// Sort the projects array in alphabetical order. This ensures that the packages
// are processed in a deterministic order by the various Rush algorithms.
const sortedProjectJsons: IRushConfigurationProjectJson[] = this.rushConfigurationJson.projects.slice(0);
sortedProjectJsons.sort((a: IRushConfigurationProjectJson, b: IRushConfigurationProjectJson) =>
a.packageName.localeCompare(b.packageName)
);
const allowedProjectTags: Set<string> | undefined = this.rushConfigurationJson.allowedProjectTags
? new Set(this.rushConfigurationJson.allowedProjectTags)
: undefined;
const usedTempNames: Set<string> = new Set();
for (let i: number = 0, len: number = sortedProjectJsons.length; i < len; i++) {
const projectJson: IRushConfigurationProjectJson = sortedProjectJsons[i];
const tempProjectName: string | undefined = RushConfiguration._generateTempNameForProject(
projectJson,
usedTempNames
);
let subspace: Subspace | undefined = undefined;
if (this.subspacesFeatureEnabled) {
if (projectJson.subspaceName) {
subspace = this._subspacesByName.get(projectJson.subspaceName);
if (subspace === undefined) {
throw new Error(
`The project "${projectJson.packageName}" in ${RushConstants.rushJsonFilename} references` +
` a nonexistent subspace "${projectJson.subspaceName}"`
);
}
}
}
if (subspace === undefined) {
subspace = defaultSubspace;
}
const project: RushConfigurationProject = new RushConfigurationProject({
projectJson,
rushConfiguration: this,
tempProjectName,
allowedProjectTags,
subspace
});
subspace._addProject(project);
this._projects.push(project);
if (this._projectsByName.has(project.packageName)) {
throw new Error(
`The project name "${project.packageName}" was specified more than once` +
` in the ${RushConstants.rushJsonFilename} configuration file.`
);
}
this._projectsByName.set(project.packageName, project);
}
for (const project of this._projects) {
project.decoupledLocalDependencies.forEach((decoupledLocalDependency: string) => {
if (!this.getProjectByName(decoupledLocalDependency)) {
throw new Error(
`In ${RushConstants.rushJsonFilename}, the "${decoupledLocalDependency}" project does not exist,` +
` but was referenced by the decoupledLocalDependencies (previously cyclicDependencyProjects) for ${project.packageName}`
);
}
});
this.versionPolicyConfiguration.validate(this.projectsByName);
// Consumer relationships will be established the first time one is requested
}
}
/**
* Loads the configuration data from an Rush.json configuration file and returns
* an RushConfiguration object.
*/
public static loadFromConfigurationFile(rushJsonFilename: string): RushConfiguration {
let resolvedRushJsonFilename: string = path.resolve(rushJsonFilename);
// Load the rush.json before we fix the casing. If the case is wrong on a case-sensitive filesystem,
// the next line show throw.
const rushConfigurationJson: IRushConfigurationJson = JsonFile.load(resolvedRushJsonFilename);
try {
resolvedRushJsonFilename = trueCasePathSync(resolvedRushJsonFilename);
} catch (error) {
/* ignore errors from true-case-path */
}
// Check the Rush version *before* we validate the schema, since if the version is outdated
// then the schema may have changed. This should no longer be a problem after Rush 4.0 and the C2R wrapper,
// but we'll validate anyway.
const expectedRushVersion: string = rushConfigurationJson.rushVersion;
const rushJsonBaseName: string = path.basename(resolvedRushJsonFilename);
// If the version is missing or malformed, fall through and let the schema handle it.
if (expectedRushVersion && semver.valid(expectedRushVersion)) {
// Make sure the requested version isn't too old
if (semver.lt(expectedRushVersion, MINIMUM_SUPPORTED_RUSH_JSON_VERSION)) {
throw new Error(
`${rushJsonBaseName} is version ${expectedRushVersion}, which is too old for this tool. ` +
`The minimum supported version is ${MINIMUM_SUPPORTED_RUSH_JSON_VERSION}.`
);
}
// Make sure the requested version isn't too new.
//
// If the major/minor versions are the same, then we consider the file to be compatible.
// This is somewhat lax, e.g. "5.0.2-dev.3" will be assumed to be loadable by rush-lib 5.0.0.
//
// IMPORTANT: Whenever a breaking change is introduced for one of the config files, we must
// increment the minor version number for Rush.
if (
semver.major(Rush.version) !== semver.major(expectedRushVersion) ||
semver.minor(Rush.version) !== semver.minor(expectedRushVersion)
) {
// If the major/minor are different, then make sure it's an older version.
if (semver.lt(Rush.version, expectedRushVersion)) {
throw new Error(
`Unable to load ${rushJsonBaseName} because its RushVersion is` +
` ${rushConfigurationJson.rushVersion}, whereas @microsoft/rush-lib is version ${Rush.version}.` +
` Consider upgrading the library.`
);
}
}
}
RushConfiguration._jsonSchema.validateObject(rushConfigurationJson, resolvedRushJsonFilename);
return new RushConfiguration(rushConfigurationJson, resolvedRushJsonFilename);
}
public static tryLoadFromDefaultLocation(
options?: ITryFindRushJsonLocationOptions
): RushConfiguration | undefined {
const rushJsonLocation: string | undefined = RushConfiguration.tryFindRushJsonLocation(options);
if (rushJsonLocation) {
return RushConfiguration.loadFromConfigurationFile(rushJsonLocation);
}
}
public static loadFromDefaultLocation(options?: ITryFindRushJsonLocationOptions): RushConfiguration {
const rushConfiguration: RushConfiguration | undefined =
RushConfiguration.tryLoadFromDefaultLocation(options);
if (rushConfiguration) {
return rushConfiguration;
} else {
throw Utilities.getRushConfigNotFoundError();