-
Notifications
You must be signed in to change notification settings - Fork 622
/
Copy pathRushCommandLine.test.ts.snap
1530 lines (1529 loc) · 76.3 KB
/
RushCommandLine.test.ts.snap
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
// Jest Snapshot v1, https://goo.gl/fbAQLP
exports[`RushCommandLine Returns a spec 1`] = `
Object {
"actions": Array [
Object {
"actionName": "add",
"parameters": Array [
Object {
"description": "If specified, the \\"rush update\\" command will not be run after updating the package.json files.",
"environmentVariable": undefined,
"kind": "Flag",
"longName": "--skip-update",
"required": false,
"shortName": "-s",
},
Object {
"description": "The name of the package which should be added as a dependency. A SemVer version specifier can be appended after an \\"@\\" sign. WARNING: Symbol characters are usually interpreted by your shell, so it's recommended to use quotes. For example, write \\"rush add --package \\"example@^1.2.3\\"\\" instead of \\"rush add --package example@^1.2.3\\". To add multiple packages, write \\"rush add --package foo --package bar\\".",
"environmentVariable": undefined,
"kind": "StringList",
"longName": "--package",
"required": true,
"shortName": "-p",
},
Object {
"description": "If specified, the SemVer specifier added to the package.json will be an exact version (e.g. without tilde or caret).",
"environmentVariable": undefined,
"kind": "Flag",
"longName": "--exact",
"required": false,
"shortName": undefined,
},
Object {
"description": "If specified, the SemVer specifier added to the package.json will be a prepended with a \\"caret\\" specifier (\\"^\\").",
"environmentVariable": undefined,
"kind": "Flag",
"longName": "--caret",
"required": false,
"shortName": undefined,
},
Object {
"description": "If specified, the package will be added to the \\"devDependencies\\" section of the package.json",
"environmentVariable": undefined,
"kind": "Flag",
"longName": "--dev",
"required": false,
"shortName": undefined,
},
Object {
"description": "If specified, the package will be added to the \\"peerDependencies\\" section of the package.json",
"environmentVariable": undefined,
"kind": "Flag",
"longName": "--peer",
"required": false,
"shortName": undefined,
},
Object {
"description": "If specified, other packages with this dependency will have their package.json files updated to use the same version of the dependency.",
"environmentVariable": undefined,
"kind": "Flag",
"longName": "--make-consistent",
"required": false,
"shortName": "-m",
},
Object {
"description": "If specified, the dependency will be added to all projects.",
"environmentVariable": undefined,
"kind": "Flag",
"longName": "--all",
"required": false,
"shortName": undefined,
},
Object {
"description": "Run command using a variant installation configuration",
"environmentVariable": "RUSH_VARIANT",
"kind": "String",
"longName": "--variant",
"required": false,
"shortName": undefined,
},
],
},
Object {
"actionName": "change",
"parameters": Array [
Object {
"description": "Verify the change file has been generated and that it is a valid JSON file",
"environmentVariable": undefined,
"kind": "Flag",
"longName": "--verify",
"required": false,
"shortName": "-v",
},
Object {
"description": "Skips fetching the baseline branch before running \\"git diff\\" to detect changes.",
"environmentVariable": undefined,
"kind": "Flag",
"longName": "--no-fetch",
"required": false,
"shortName": undefined,
},
Object {
"description": "If this parameter is specified, compare the checked out branch with the specified branch to determine which projects were changed. If this parameter is not specified, the checked out branch is compared against the \\"main\\" branch.",
"environmentVariable": undefined,
"kind": "String",
"longName": "--target-branch",
"required": false,
"shortName": "-b",
},
Object {
"description": "If a changefile already exists, overwrite without prompting (or erroring in --bulk mode).",
"environmentVariable": undefined,
"kind": "Flag",
"longName": "--overwrite",
"required": false,
"shortName": undefined,
},
Object {
"description": "If this flag is specified generated changefiles will be commited automatically.",
"environmentVariable": undefined,
"kind": "Flag",
"longName": "--commit",
"required": false,
"shortName": "-c",
},
Object {
"description": "If this parameter is specified generated changefiles will be commited automatically with the specified commit message.",
"environmentVariable": undefined,
"kind": "String",
"longName": "--commit-message",
"required": false,
"shortName": undefined,
},
Object {
"description": "The email address to use in changefiles. If this parameter is not provided, the email address will be detected or prompted for in interactive mode.",
"environmentVariable": undefined,
"kind": "String",
"longName": "--email",
"required": false,
"shortName": undefined,
},
Object {
"description": "If this flag is specified, apply the same change message and bump type to all changed projects. The --message and the --bump-type parameters must be specified if the --bulk parameter is specified",
"environmentVariable": undefined,
"kind": "Flag",
"longName": "--bulk",
"required": false,
"shortName": undefined,
},
Object {
"description": "The message to apply to all changed projects if the --bulk flag is provided.",
"environmentVariable": undefined,
"kind": "String",
"longName": "--message",
"required": false,
"shortName": undefined,
},
Object {
"description": "The bump type to apply to all changed projects if the --bulk flag is provided.",
"environmentVariable": undefined,
"kind": "Choice",
"longName": "--bump-type",
"required": false,
"shortName": undefined,
},
],
},
Object {
"actionName": "check",
"parameters": Array [
Object {
"description": "If this flag is specified, output will be in JSON format.",
"environmentVariable": undefined,
"kind": "Flag",
"longName": "--json",
"required": false,
"shortName": undefined,
},
Object {
"description": "If this flag is specified, long lists of package names will not be truncated. This has no effect if the --json flag is also specified.",
"environmentVariable": undefined,
"kind": "Flag",
"longName": "--verbose",
"required": false,
"shortName": undefined,
},
Object {
"description": "(EXPERIMENTAL) Specifies an individual Rush subspace to check, requiring versions to be consistent only within that subspace (ignoring other subspaces). This parameter is required when the \\"subspacesEnabled\\" setting is set to true in subspaces.json.",
"environmentVariable": undefined,
"kind": "String",
"longName": "--subspace",
"required": false,
"shortName": undefined,
},
Object {
"description": "Run command using a variant installation configuration",
"environmentVariable": "RUSH_VARIANT",
"kind": "String",
"longName": "--variant",
"required": false,
"shortName": undefined,
},
],
},
Object {
"actionName": "deploy",
"parameters": Array [
Object {
"description": "Specifies the name of the main Rush project to be deployed. It must appear in the \\"deploymentProjectNames\\" setting in the deployment config file.",
"environmentVariable": undefined,
"kind": "String",
"longName": "--project",
"required": false,
"shortName": "-p",
},
Object {
"description": "By default, the deployment configuration is specified in \\"common/config/rush/deploy.json\\". You can use \\"--scenario\\" to specify an alternate name. The name must be lowercase and separated by dashes. For example, if SCENARIO_NAME is \\"web\\", then the config file would be \\"common/config/rush/deploy-web.json\\".",
"environmentVariable": undefined,
"kind": "String",
"longName": "--scenario",
"required": false,
"shortName": "-s",
},
Object {
"description": "By default, deployment will fail if the target folder is not empty. SPECIFYING THIS FLAG WILL RECURSIVELY DELETE EXISTING CONTENTS OF THE TARGET FOLDER.",
"environmentVariable": undefined,
"kind": "Flag",
"longName": "--overwrite",
"required": false,
"shortName": undefined,
},
Object {
"description": "By default, files are deployed to the \\"common/deploy\\" folder inside the Rush repo. Use this parameter to specify a different location. WARNING: USE CAUTION WHEN COMBINING WITH \\"--overwrite\\"",
"environmentVariable": "RUSH_DEPLOY_TARGET_FOLDER",
"kind": "String",
"longName": "--target-folder",
"required": false,
"shortName": "-t",
},
Object {
"description": "If specified, after the deployment has been prepared, \\"rush deploy\\" will create an archive containing the contents of the target folder. The newly created archive file will be placed according to the designated path, relative to the target folder. Supported file extensions: .zip",
"environmentVariable": undefined,
"kind": "String",
"longName": "--create-archive",
"required": false,
"shortName": undefined,
},
Object {
"description": "If specified, \\"rush deploy\\" will only create an archive containing the contents of the target folder. The target folder will not be modified other than to create the archive file.",
"environmentVariable": undefined,
"kind": "Flag",
"longName": "--create-archive-only",
"required": false,
"shortName": undefined,
},
],
},
Object {
"actionName": "init",
"parameters": Array [
Object {
"description": "By default \\"rush init\\" will not overwrite existing config files. Specify this switch to override that. This can be useful when upgrading your repo to a newer release of Rush. WARNING: USE WITH CARE!",
"environmentVariable": undefined,
"kind": "Flag",
"longName": "--overwrite-existing",
"required": false,
"shortName": undefined,
},
Object {
"description": "When copying the template config files, this uncomments fragments that are used by the \\"rush-example\\" GitHub repo, which is a sample monorepo that illustrates many Rush features. This option is primarily intended for maintaining that example.",
"environmentVariable": undefined,
"kind": "Flag",
"longName": "--rush-example-repo",
"required": false,
"shortName": undefined,
},
Object {
"description": "Include features that may not be complete features, useful for demoing specific future features or current work in progress features.",
"environmentVariable": undefined,
"kind": "Flag",
"longName": "--include-experiments",
"required": false,
"shortName": undefined,
},
],
},
Object {
"actionName": "init-autoinstaller",
"parameters": Array [
Object {
"description": "Specifies the name of the autoinstaller folder, which must conform to the naming rules for NPM packages.",
"environmentVariable": undefined,
"kind": "String",
"longName": "--name",
"required": true,
"shortName": undefined,
},
],
},
Object {
"actionName": "init-deploy",
"parameters": Array [
Object {
"description": "Specifies the name of the main Rush project to be deployed in this scenario. It will be added to the \\"deploymentProjectNames\\" setting.",
"environmentVariable": undefined,
"kind": "String",
"longName": "--project",
"required": true,
"shortName": "-p",
},
Object {
"description": "By default, the deployment configuration will be written to \\"common/config/rush/deploy.json\\". You can use \\"--scenario\\" to specify an alternate name. The name must be lowercase and separated by dashes. For example, if the name is \\"web\\", then the config file would be \\"common/config/rush/deploy-web.json\\".",
"environmentVariable": undefined,
"kind": "String",
"longName": "--scenario",
"required": false,
"shortName": "-s",
},
],
},
Object {
"actionName": "init-subspace",
"parameters": Array [
Object {
"description": "The name of the subspace that is being initialized.",
"environmentVariable": undefined,
"kind": "String",
"longName": "--name",
"required": true,
"shortName": "-n",
},
],
},
Object {
"actionName": "install",
"parameters": Array [
Object {
"description": "Perform \\"rush purge\\" before starting the installation",
"environmentVariable": undefined,
"kind": "Flag",
"longName": "--purge",
"required": false,
"shortName": "-p",
},
Object {
"description": "Overrides enforcement of the \\"gitPolicy\\" rules from rush.json (use honorably!)",
"environmentVariable": undefined,
"kind": "Flag",
"longName": "--bypass-policy",
"required": false,
"shortName": undefined,
},
Object {
"description": "If \\"--no-link\\" is specified, then project symlinks will NOT be created after the installation completes. You will need to run \\"rush link\\" manually. This flag is useful for automated builds that want to report stages individually or perform extra operations in between the two stages. This flag is not supported when using workspaces.",
"environmentVariable": undefined,
"kind": "Flag",
"longName": "--no-link",
"required": false,
"shortName": undefined,
},
Object {
"description": "If specified, limits the maximum number of concurrent network requests. This is useful when troubleshooting network failures.",
"environmentVariable": undefined,
"kind": "Integer",
"longName": "--network-concurrency",
"required": false,
"shortName": undefined,
},
Object {
"description": "Activates verbose logging for the package manager. You will probably want to pipe the output of Rush to a file when using this command.",
"environmentVariable": undefined,
"kind": "Flag",
"longName": "--debug-package-manager",
"required": false,
"shortName": undefined,
},
Object {
"description": "Overrides the default maximum number of install attempts.",
"environmentVariable": undefined,
"kind": "Integer",
"longName": "--max-install-attempts",
"required": false,
"shortName": undefined,
},
Object {
"description": "Skips execution of the \\"eventHooks\\" scripts defined in rush.json. Make sure you know what you are skipping.",
"environmentVariable": undefined,
"kind": "Flag",
"longName": "--ignore-hooks",
"required": false,
"shortName": undefined,
},
Object {
"description": "Enables installation to be performed without internet access. PNPM will instead report an error if the necessary NPM packages cannot be obtained from the local cache. For details, see the documentation for PNPM's \\"--offline\\" parameter.",
"environmentVariable": undefined,
"kind": "Flag",
"longName": "--offline",
"required": false,
"shortName": undefined,
},
Object {
"description": "Run command using a variant installation configuration",
"environmentVariable": "RUSH_VARIANT",
"kind": "String",
"longName": "--variant",
"required": false,
"shortName": undefined,
},
Object {
"description": "Normally all projects in the monorepo will be processed; adding this parameter will instead select a subset of projects. Each \\"--to\\" parameter expands this selection to include PROJECT and all its dependencies. \\".\\" can be used as shorthand for the project in the current working directory. For details, refer to the website article \\"Selecting subsets of projects\\".",
"environmentVariable": undefined,
"kind": "StringList",
"longName": "--to",
"required": false,
"shortName": "-t",
},
Object {
"description": "Normally all projects in the monorepo will be processed; adding this parameter will instead select a subset of projects. Each \\"--to-except\\" parameter expands this selection to include all dependencies of PROJECT, but not PROJECT itself. \\".\\" can be used as shorthand for the project in the current working directory. For details, refer to the website article \\"Selecting subsets of projects\\".",
"environmentVariable": undefined,
"kind": "StringList",
"longName": "--to-except",
"required": false,
"shortName": "-T",
},
Object {
"description": "Normally all projects in the monorepo will be processed; adding this parameter will instead select a subset of projects. Each \\"--from\\" parameter expands this selection to include PROJECT and all projects that depend on it, plus all dependencies of this set. \\".\\" can be used as shorthand for the project in the current working directory. For details, refer to the website article \\"Selecting subsets of projects\\".",
"environmentVariable": undefined,
"kind": "StringList",
"longName": "--from",
"required": false,
"shortName": "-f",
},
Object {
"description": "Normally all projects in the monorepo will be processed; adding this parameter will instead select a subset of projects. Each \\"--only\\" parameter expands this selection to include PROJECT; its dependencies are not added. \\".\\" can be used as shorthand for the project in the current working directory. Note that this parameter is \\"unsafe\\" as it may produce a selection that excludes some dependencies. For details, refer to the website article \\"Selecting subsets of projects\\".",
"environmentVariable": undefined,
"kind": "StringList",
"longName": "--only",
"required": false,
"shortName": "-o",
},
Object {
"description": "Normally all projects in the monorepo will be processed; adding this parameter will instead select a subset of projects. Each \\"--impacted-by\\" parameter expands this selection to include PROJECT and any projects that depend on PROJECT (and thus might be broken by changes to PROJECT). \\".\\" can be used as shorthand for the project in the current working directory. Note that this parameter is \\"unsafe\\" as it may produce a selection that excludes some dependencies. For details, refer to the website article \\"Selecting subsets of projects\\".",
"environmentVariable": undefined,
"kind": "StringList",
"longName": "--impacted-by",
"required": false,
"shortName": "-i",
},
Object {
"description": "Normally all projects in the monorepo will be processed; adding this parameter will instead select a subset of projects. Each \\"--impacted-by-except\\" parameter works the same as \\"--impacted-by\\" except that PROJECT itself is not added to the selection. \\".\\" can be used as shorthand for the project in the current working directory. Note that this parameter is \\"unsafe\\" as it may produce a selection that excludes some dependencies. For details, refer to the website article \\"Selecting subsets of projects\\".",
"environmentVariable": undefined,
"kind": "StringList",
"longName": "--impacted-by-except",
"required": false,
"shortName": "-I",
},
Object {
"description": "Normally all projects in the monorepo will be processed; adding this parameter will instead select a subset of projects. The \\"--to-version-policy\\" parameter is equivalent to specifying \\"--to\\" for each of the projects belonging to VERSION_POLICY_NAME. For details, refer to the website article \\"Selecting subsets of projects\\".",
"environmentVariable": undefined,
"kind": "StringList",
"longName": "--to-version-policy",
"required": false,
"shortName": undefined,
},
Object {
"description": "Normally all projects in the monorepo will be processed; adding this parameter will instead select a subset of projects. The \\"--from-version-policy\\" parameter is equivalent to specifying \\"--from\\" for each of the projects belonging to VERSION_POLICY_NAME. For details, refer to the website article \\"Selecting subsets of projects\\".",
"environmentVariable": undefined,
"kind": "StringList",
"longName": "--from-version-policy",
"required": false,
"shortName": undefined,
},
Object {
"description": "(EXPERIMENTAL) Specifies a Rush subspace to be installed. Requires the \\"subspacesEnabled\\" feature to be enabled in subspaces.json.",
"environmentVariable": undefined,
"kind": "String",
"longName": "--subspace",
"required": false,
"shortName": undefined,
},
Object {
"description": "Only check the validity of the shrinkwrap file without performing an install.",
"environmentVariable": undefined,
"kind": "Flag",
"longName": "--check-only",
"required": false,
"shortName": undefined,
},
Object {
"description": "Only perform dependency resolution, useful for ensuring peer dependendencies are up to date. Note that this flag is only supported when using the pnpm package manager.",
"environmentVariable": undefined,
"kind": "Flag",
"longName": "--resolution-only",
"required": false,
"shortName": undefined,
},
],
},
Object {
"actionName": "link",
"parameters": Array [
Object {
"description": "Deletes and recreates all links, even if the filesystem state seems to indicate that this is unnecessary.",
"environmentVariable": undefined,
"kind": "Flag",
"longName": "--force",
"required": false,
"shortName": "-f",
},
],
},
Object {
"actionName": "list",
"parameters": Array [
Object {
"description": "If this flag is specified, the project version will be displayed in a column along with the package name.",
"environmentVariable": undefined,
"kind": "Flag",
"longName": "--version",
"required": false,
"shortName": "-v",
},
Object {
"description": "If this flag is specified, the project path will be displayed in a column along with the package name.",
"environmentVariable": undefined,
"kind": "Flag",
"longName": "--path",
"required": false,
"shortName": "-p",
},
Object {
"description": "If this flag is specified, the project full path will be displayed in a column along with the package name.",
"environmentVariable": undefined,
"kind": "Flag",
"longName": "--full-path",
"required": false,
"shortName": undefined,
},
Object {
"description": "For the non --json view, if this flag is specified, include path (-p), version (-v) columns along with the project's applicable: versionPolicy, versionPolicyName, shouldPublish, reviewPolicy, and tags fields.",
"environmentVariable": undefined,
"kind": "Flag",
"longName": "--detailed",
"required": false,
"shortName": undefined,
},
Object {
"description": "If this flag is specified, output will be in JSON format.",
"environmentVariable": undefined,
"kind": "Flag",
"longName": "--json",
"required": false,
"shortName": undefined,
},
Object {
"description": "Normally all projects in the monorepo will be processed; adding this parameter will instead select a subset of projects. Each \\"--to\\" parameter expands this selection to include PROJECT and all its dependencies. \\".\\" can be used as shorthand for the project in the current working directory. For details, refer to the website article \\"Selecting subsets of projects\\".",
"environmentVariable": undefined,
"kind": "StringList",
"longName": "--to",
"required": false,
"shortName": "-t",
},
Object {
"description": "Normally all projects in the monorepo will be processed; adding this parameter will instead select a subset of projects. Each \\"--to-except\\" parameter expands this selection to include all dependencies of PROJECT, but not PROJECT itself. \\".\\" can be used as shorthand for the project in the current working directory. For details, refer to the website article \\"Selecting subsets of projects\\".",
"environmentVariable": undefined,
"kind": "StringList",
"longName": "--to-except",
"required": false,
"shortName": "-T",
},
Object {
"description": "Normally all projects in the monorepo will be processed; adding this parameter will instead select a subset of projects. Each \\"--from\\" parameter expands this selection to include PROJECT and all projects that depend on it, plus all dependencies of this set. \\".\\" can be used as shorthand for the project in the current working directory. For details, refer to the website article \\"Selecting subsets of projects\\".",
"environmentVariable": undefined,
"kind": "StringList",
"longName": "--from",
"required": false,
"shortName": "-f",
},
Object {
"description": "Normally all projects in the monorepo will be processed; adding this parameter will instead select a subset of projects. Each \\"--only\\" parameter expands this selection to include PROJECT; its dependencies are not added. \\".\\" can be used as shorthand for the project in the current working directory. Note that this parameter is \\"unsafe\\" as it may produce a selection that excludes some dependencies. For details, refer to the website article \\"Selecting subsets of projects\\".",
"environmentVariable": undefined,
"kind": "StringList",
"longName": "--only",
"required": false,
"shortName": "-o",
},
Object {
"description": "Normally all projects in the monorepo will be processed; adding this parameter will instead select a subset of projects. Each \\"--impacted-by\\" parameter expands this selection to include PROJECT and any projects that depend on PROJECT (and thus might be broken by changes to PROJECT). \\".\\" can be used as shorthand for the project in the current working directory. Note that this parameter is \\"unsafe\\" as it may produce a selection that excludes some dependencies. For details, refer to the website article \\"Selecting subsets of projects\\".",
"environmentVariable": undefined,
"kind": "StringList",
"longName": "--impacted-by",
"required": false,
"shortName": "-i",
},
Object {
"description": "Normally all projects in the monorepo will be processed; adding this parameter will instead select a subset of projects. Each \\"--impacted-by-except\\" parameter works the same as \\"--impacted-by\\" except that PROJECT itself is not added to the selection. \\".\\" can be used as shorthand for the project in the current working directory. Note that this parameter is \\"unsafe\\" as it may produce a selection that excludes some dependencies. For details, refer to the website article \\"Selecting subsets of projects\\".",
"environmentVariable": undefined,
"kind": "StringList",
"longName": "--impacted-by-except",
"required": false,
"shortName": "-I",
},
Object {
"description": "Normally all projects in the monorepo will be processed; adding this parameter will instead select a subset of projects. The \\"--to-version-policy\\" parameter is equivalent to specifying \\"--to\\" for each of the projects belonging to VERSION_POLICY_NAME. For details, refer to the website article \\"Selecting subsets of projects\\".",
"environmentVariable": undefined,
"kind": "StringList",
"longName": "--to-version-policy",
"required": false,
"shortName": undefined,
},
Object {
"description": "Normally all projects in the monorepo will be processed; adding this parameter will instead select a subset of projects. The \\"--from-version-policy\\" parameter is equivalent to specifying \\"--from\\" for each of the projects belonging to VERSION_POLICY_NAME. For details, refer to the website article \\"Selecting subsets of projects\\".",
"environmentVariable": undefined,
"kind": "StringList",
"longName": "--from-version-policy",
"required": false,
"shortName": undefined,
},
],
},
Object {
"actionName": "publish",
"parameters": Array [
Object {
"description": "If this flag is specified, the change requests will be applied to package.json files.",
"environmentVariable": undefined,
"kind": "Flag",
"longName": "--apply",
"required": false,
"shortName": "-a",
},
Object {
"description": "If this flag is specified, applied changes and deleted change requests will be committed and merged into the target branch.",
"environmentVariable": undefined,
"kind": "String",
"longName": "--target-branch",
"required": false,
"shortName": "-b",
},
Object {
"description": "If this flag is specified, applied changes will be published to the NPM registry.",
"environmentVariable": undefined,
"kind": "Flag",
"longName": "--publish",
"required": false,
"shortName": "-p",
},
Object {
"description": "Adds commit author and hash to the changelog.json files for each change.",
"environmentVariable": undefined,
"kind": "Flag",
"longName": "--add-commit-details",
"required": false,
"shortName": undefined,
},
Object {
"description": "Regenerates all changelog files based on the current JSON content.",
"environmentVariable": undefined,
"kind": "Flag",
"longName": "--regenerate-changelogs",
"required": false,
"shortName": undefined,
},
Object {
"description": "Publishes to a specified NPM registry. If this is specified, it will prevent the current commit will not be tagged.",
"environmentVariable": undefined,
"kind": "String",
"longName": "--registry",
"required": false,
"shortName": "-r",
},
Object {
"description": "(DEPRECATED) Specifies the authentication token to use during publishing. This parameter is deprecated because command line parameters may be readable by unrelated processes on a lab machine. Instead, a safer practice is to pass the token via an environment variable and reference it from your common/config/rush/.npmrc-publish file.",
"environmentVariable": undefined,
"kind": "String",
"longName": "--npm-auth-token",
"required": false,
"shortName": "-n",
},
Object {
"description": "The tag option to pass to npm publish. By default NPM will publish using the 'latest' tag, even if the package is older than the current latest, so in publishing workflows for older releases, providing a tag is important. When hotfix changes are made, this parameter defaults to 'hotfix'.",
"environmentVariable": undefined,
"kind": "String",
"longName": "--tag",
"required": false,
"shortName": "-t",
},
Object {
"description": "By default, when Rush invokes \\"npm publish\\" it will publish scoped packages with an access level of \\"restricted\\". Scoped packages can be published with an access level of \\"public\\" by specifying that value for this flag with the initial publication. NPM always publishes unscoped packages with an access level of \\"public\\". For more information, see the NPM documentation for the \\"--access\\" option of \\"npm publish\\".",
"environmentVariable": undefined,
"kind": "Choice",
"longName": "--set-access-level",
"required": false,
"shortName": undefined,
},
Object {
"description": "Packs projects into tarballs instead of publishing to npm repository. It can only be used when --include-all is specified. If this flag is specified, NPM registry related parameters will be ignored.",
"environmentVariable": undefined,
"kind": "Flag",
"longName": "--pack",
"required": false,
"shortName": undefined,
},
Object {
"description": "This parameter is used with --pack parameter to provide customized location for the tarballs instead of the default value. ",
"environmentVariable": undefined,
"kind": "String",
"longName": "--release-folder",
"required": false,
"shortName": undefined,
},
Object {
"description": "If this flag is specified, all packages with shouldPublish=true in rush.json or with a specified version policy will be published if their version is newer than published version.",
"environmentVariable": undefined,
"kind": "Flag",
"longName": "--include-all",
"required": false,
"shortName": undefined,
},
Object {
"description": "Version policy name. Only projects with this version policy will be published if used with --include-all.",
"environmentVariable": undefined,
"kind": "String",
"longName": "--version-policy",
"required": false,
"shortName": undefined,
},
Object {
"description": "Bump up to a prerelease version with the provided prerelease name. Cannot be used with --suffix",
"environmentVariable": undefined,
"kind": "String",
"longName": "--prerelease-name",
"required": false,
"shortName": undefined,
},
Object {
"description": "Used with --prerelease-name. Only bump packages to a prerelease version if they have changes.",
"environmentVariable": undefined,
"kind": "Flag",
"longName": "--partial-prerelease",
"required": false,
"shortName": undefined,
},
Object {
"description": "Append a suffix to all changed versions. Cannot be used with --prerelease-name.",
"environmentVariable": undefined,
"kind": "String",
"longName": "--suffix",
"required": false,
"shortName": undefined,
},
Object {
"description": "If this flag is specified with --publish, packages will be published with --force on npm",
"environmentVariable": undefined,
"kind": "Flag",
"longName": "--force",
"required": false,
"shortName": undefined,
},
Object {
"description": "If specified with --publish and --pack, git tags will be applied for packages as if a publish was being run without --pack.",
"environmentVariable": undefined,
"kind": "Flag",
"longName": "--apply-git-tags-on-pack",
"required": false,
"shortName": undefined,
},
Object {
"description": "Used in conjunction with git tagging -- apply git tags at the commit hash specified. If not provided, the current HEAD will be tagged.",
"environmentVariable": undefined,
"kind": "String",
"longName": "--commit",
"required": false,
"shortName": "-c",
},
Object {
"description": "Skips execution of all git hooks. Make sure you know what you are skipping.",
"environmentVariable": undefined,
"kind": "Flag",
"longName": "--ignore-git-hooks",
"required": false,
"shortName": undefined,
},
],
},
Object {
"actionName": "purge",
"parameters": Array [
Object {
"description": "(UNSAFE!) Also delete shared files such as the package manager instances stored in the \\".rush\\" folder in the user's home directory. This is a more aggressive fix that is NOT SAFE to run in a live environment because it will cause other concurrent Rush processes to fail.",
"environmentVariable": undefined,
"kind": "Flag",
"longName": "--unsafe",
"required": false,
"shortName": undefined,
},
],
},
Object {
"actionName": "remove",
"parameters": Array [
Object {
"description": "If specified, the \\"rush update\\" command will not be run after updating the package.json files.",
"environmentVariable": undefined,
"kind": "Flag",
"longName": "--skip-update",
"required": false,
"shortName": "-s",
},
Object {
"description": "The name of the package which should be removed. To remove multiple packages, run \\"rush remove --package foo --package bar\\".",
"environmentVariable": undefined,
"kind": "StringList",
"longName": "--package",
"required": true,
"shortName": "-p",
},
Object {
"description": "If specified, the dependency will be removed from all projects that declare it.",
"environmentVariable": undefined,
"kind": "Flag",
"longName": "--all",
"required": false,
"shortName": undefined,
},
Object {
"description": "Run command using a variant installation configuration",
"environmentVariable": "RUSH_VARIANT",
"kind": "String",
"longName": "--variant",
"required": false,
"shortName": undefined,
},
],
},
Object {
"actionName": "scan",
"parameters": Array [
Object {
"description": "If this flag is specified, output will be in JSON format.",
"environmentVariable": undefined,
"kind": "Flag",
"longName": "--json",
"required": false,
"shortName": undefined,
},
Object {
"description": "If this flag is specified, output will list all detected dependencies.",
"environmentVariable": undefined,
"kind": "Flag",
"longName": "--all",
"required": false,
"shortName": undefined,
},
],
},
Object {
"actionName": "setup",
"parameters": Array [],
},
Object {
"actionName": "unlink",
"parameters": Array [],
},
Object {
"actionName": "update",
"parameters": Array [
Object {
"description": "Perform \\"rush purge\\" before starting the installation",
"environmentVariable": undefined,
"kind": "Flag",
"longName": "--purge",
"required": false,
"shortName": "-p",
},
Object {
"description": "Overrides enforcement of the \\"gitPolicy\\" rules from rush.json (use honorably!)",
"environmentVariable": undefined,
"kind": "Flag",
"longName": "--bypass-policy",
"required": false,
"shortName": undefined,
},
Object {
"description": "If \\"--no-link\\" is specified, then project symlinks will NOT be created after the installation completes. You will need to run \\"rush link\\" manually. This flag is useful for automated builds that want to report stages individually or perform extra operations in between the two stages. This flag is not supported when using workspaces.",
"environmentVariable": undefined,
"kind": "Flag",
"longName": "--no-link",
"required": false,
"shortName": undefined,
},
Object {
"description": "If specified, limits the maximum number of concurrent network requests. This is useful when troubleshooting network failures.",
"environmentVariable": undefined,
"kind": "Integer",
"longName": "--network-concurrency",
"required": false,
"shortName": undefined,
},
Object {
"description": "Activates verbose logging for the package manager. You will probably want to pipe the output of Rush to a file when using this command.",
"environmentVariable": undefined,
"kind": "Flag",
"longName": "--debug-package-manager",
"required": false,
"shortName": undefined,
},
Object {
"description": "Overrides the default maximum number of install attempts.",
"environmentVariable": undefined,
"kind": "Integer",
"longName": "--max-install-attempts",
"required": false,
"shortName": undefined,
},
Object {
"description": "Skips execution of the \\"eventHooks\\" scripts defined in rush.json. Make sure you know what you are skipping.",
"environmentVariable": undefined,
"kind": "Flag",
"longName": "--ignore-hooks",
"required": false,
"shortName": undefined,
},
Object {
"description": "Enables installation to be performed without internet access. PNPM will instead report an error if the necessary NPM packages cannot be obtained from the local cache. For details, see the documentation for PNPM's \\"--offline\\" parameter.",
"environmentVariable": undefined,
"kind": "Flag",
"longName": "--offline",
"required": false,
"shortName": undefined,
},
Object {
"description": "Run command using a variant installation configuration",
"environmentVariable": "RUSH_VARIANT",
"kind": "String",
"longName": "--variant",
"required": false,
"shortName": undefined,
},
Object {
"description": "Normally \\"rush update\\" tries to preserve your existing installed versions and only makes the minimum updates needed to satisfy the package.json files. This conservative approach prevents your PR from getting involved with package updates that are unrelated to your work. Use \\"--full\\" when you really want to update all dependencies to the latest SemVer-compatible version. This should be done periodically by a person or robot whose role is to deal with potential upgrade regressions.",
"environmentVariable": undefined,
"kind": "Flag",
"longName": "--full",
"required": false,
"shortName": undefined,
},
Object {
"description": "If the shrinkwrap file appears to already satisfy the package.json files, then \\"rush update\\" will skip invoking the package manager at all. In certain situations this heuristic may be inaccurate. Use the \\"--recheck\\" flag to force the package manager to process the shrinkwrap file. This will also update your shrinkwrap file with Rush's fixups. (To minimize shrinkwrap churn, these fixups are normally performed only in the temporary folder.)",
"environmentVariable": undefined,
"kind": "Flag",
"longName": "--recheck",
"required": false,
"shortName": undefined,
},
],
},
Object {
"actionName": "install-autoinstaller",
"parameters": Array [
Object {
"description": "The name of the autoinstaller, which must be one of the folders under common/autoinstallers.",
"environmentVariable": undefined,
"kind": "String",
"longName": "--name",
"required": true,
"shortName": undefined,
},
],
},
Object {
"actionName": "update-autoinstaller",
"parameters": Array [
Object {
"description": "The name of the autoinstaller, which must be one of the folders under common/autoinstallers.",
"environmentVariable": undefined,
"kind": "String",
"longName": "--name",
"required": true,
"shortName": undefined,
},
],
},
Object {
"actionName": "update-cloud-credentials",
"parameters": Array [
Object {
"description": "Run the credential update operation in interactive mode, if supported by the provider.",
"environmentVariable": undefined,
"kind": "Flag",
"longName": "--interactive",
"required": false,
"shortName": "-i",
},
Object {
"description": "A static credential, to be cached.",
"environmentVariable": undefined,
"kind": "String",
"longName": "--credential",
"required": false,