Repository navigation
Expand file tree
/
Copy pathmap.json
More file actions
1942 lines (1940 loc) · 68 KB
/
Copy pathmap.json
File metadata and controls
1942 lines (1940 loc) · 68 KB
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
10BC8
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
{
"$schema": "./../scripts/documentation/map-schema.json",
"title": "Documentation map reference",
"description": "This is used to create documentation routing and hierarchy on the nx.dev website.",
"content": [
{
"name": "Nx docs",
"id": "nx-documentation",
"description": "Nx documentation for you to discover!",
"itemList": [
{
"name": "Getting Started",
"id": "getting-started",
"description": "Get started with basic information, concepts and tutorials.",
"itemList": [
{
"name": "Intro to Nx",
"id": "intro",
"file": "shared/getting-started/intro"
},
{
"name": "Package-Based Repo Tutorial",
"id": "package-based-repo-tutorial",
"file": "shared/npm-tutorial/package-based"
},
{
"name": "Integrated Repo Tutorial",
"id": "integrated-repo-tutorial",
"file": "shared/npm-tutorial/integrated"
},
{
"name": "React Standalone Tutorial",
"id": "react-standalone-tutorial",
"file": "shared/react-standalone-tutorial/1-code-generation"
},
{
"name": "Angular Standalone Tutorial",
"id": "angular-standalone-tutorial",
"file": "shared/angular-standalone-tutorial/1-code-generation"
},
{
"name": "Node Tutorial",
"id": "node-tutorial",
"file": "shared/node-tutorial/1-code-generation"
}
]
},
{
"name": "Core Tutorial",
"id": "core-tutorial",
"description": "Learn to use Nx with this core tutorial where you will learn about all its main feature with a real project.",
"itemList": [
{
"name": "1 - Create Blog",
"id": "01-create-blog",
"file": "shared/core-tutorial/01-create-blog"
},
{
"name": "2 - Create CLI",
"id": "02-create-cli",
"file": "shared/core-tutorial/02-create-cli"
},
{
"name": "3 - Share Assets",
"id": "03-share-assets",
"file": "shared/core-tutorial/03-share-assets"
},
{
"name": "4 - Build Affected Projects",
"id": "04-build-affected-projects",
"file": "shared/core-tutorial/04-build-affected-projects"
},
{
"name": "5 - Automatically Detect Dependencies",
"id": "05-auto-detect-dependencies",
"file": "shared/core-tutorial/05-auto-detect-dependencies"
},
{
"name": "6 - Summary",
"id": "06-summary",
"file": "shared/core-tutorial/06-summary"
}
]
},
{
"name": "React Monorepo Tutorial",
"id": "react-tutorial",
"description": "In this tutorial you'll create a frontend-focused workspace with Nx.",
"itemList": [
{
"name": "1 - Code Generation",
"id": "1-code-generation",
"file": "shared/react-tutorial/1-code-generation"
},
{
"name": "2 - Project Graph",
"id": "2-project-graph",
"file": "shared/react-tutorial/2-project-graph"
},
{
"name": "3 - Task Running",
"id": "3-task-running",
"file": "shared/react-tutorial/3-task-running"
},
{
"name": "4 - Workspace Optimization",
"id": "4-workspace-optimization",
"file": "shared/react-tutorial/4-workspace-optimization"
},
{
"name": "5 - Summary",
"id": "5-summary",
"file": "shared/react-tutorial/5-summary"
}
]
},
{
"name": "React Standalone Tutorial",
"id": "react-standalone-tutorial",
"description": "In this tutorial you'll create a frontend-focused workspace with Nx.",
"itemList": [
{
"name": "1 - Code Generation",
"id": "1-code-generation",
"file": "shared/react-standalone-tutorial/1-code-generation"
},
{
"name": "2 - Project Graph",
"id": "2-project-graph",
"file": "shared/react-standalone-tutorial/2-project-graph"
},
{
"name": "3 - Task Running",
"id": "3-task-running",
"file": "shared/react-standalone-tutorial/3-task-running"
},
{
"name": "4 - Task Pipelines",
"id": "4-task-pipelines",
"file": "shared/react-standalone-tutorial/4-task-pipelines"
},
{
"name": "5 - Summary",
"id": "5-summary",
"file": "shared/react-standalone-tutorial/5-summary"
}
]
},
{
"name": "Angular Monorepo Tutorial",
"id": "angular-tutorial",
"description": "Learn to use Nx with this Angular tutorial where you will learn about all its main feature with a real project.",
"itemList": [
{
"name": "1 - Code Generation",
"id": "1-code-generation",
"file": "shared/angular-tutorial/1-code-generation"
},
{
"name": "2 - Project Graph",
"id": "2-project-graph",
"file": "shared/angular-tutorial/2-project-graph"
},
{
"name": "3 - Task Running",
"id": "3-task-running",
"file": "shared/angular-tutorial/3-task-running"
},
{
"name": "4 - Workspace Optimization",
"id": "4-workspace-optimization",
"file": "shared/angular-tutorial/4-workspace-optimization"
},
{
"name": "5 - Summary",
"id": "5-summary",
"file": "shared/angular-tutorial/5-summary"
}
]
},
{
"name": "Angular Standalone Tutorial",
"id": "angular-standalone-tutorial",
"description": "Learn to use Nx with this Angular tutorial where you will learn about all its main feature with a real project.",
"itemList": [
{
"name": "1 - Code Generation",
"id": "1-code-generation",
"file": "shared/angular-standalone-tutorial/1-code-generation"
},
{
"name": "2 - Project Graph",
"id": "2-project-graph",
"file": "shared/angular-standalone-tutorial/2-project-graph"
},
{
"name": "3 - Task Running",
"id": "3-task-running",
"file": "shared/angular-standalone-tutorial/3-task-running"
},
{
"name": "4 - Task Pipelines",
"id": "4-task-pipelines&q
8
uot;,
"file": "shared/angular-standalone-tutorial/4-task-pipelines"
},
{
"name": "5 - Summary",
"id": "5-summary",
"file": "shared/angular-standalone-tutorial/5-summary"
}
]
},
{
"name": "Node Tutorial",
"id": "node-tutorial",
"description": "Learn to use Nx with this Node tutorial where you will learn about all its main feature with a real project.",
"itemList": [
{
"name": "1 - Code Generation",
"id": "1-code-generation",
"file": "shared/node-tutorial/1-code-generation"
},
{
"name": "2 - Project Graph",
"id": "2-project-graph",
"file": "shared/node-tutorial/2-project-graph"
},
{
"name": "3 - Task Running",
"id": "3-task-running",
"file": "shared/node-tutorial/3-task-running"
},
{
"name": "4 - Workspace Optimization",
"id": "4-workspace-optimization",
"file": "shared/node-tutorial/4-workspace-optimization"
},
{
"name": "5 - Summary",
"id": "5-summary",
"file": "shared/node-tutorial/5-summary"
}
]
},
{
"name": "Core Features",
"id": "core-features",
"description": "Learn the core features of Nx with in depth guides.",
"itemList": [
{
"name": "Run Tasks",
"tags": ["run-tasks"],
"id": "run-tasks",
"file": "shared/core-features/run-tasks"
},
{
"name": "Cache Task Results",
"id": "cache-task-results",
"tags": ["cache-task-results"],
"file": "shared/core-features/cache-task-results"
},
{
"name": "Share Your Cache",
"id": "share-your-cache",
"tags": ["share-your-cache"],
"file": "shared/core-features/share-your-cache"
},
{
"name": "Explore the Graph",
"id": "explore-graph",
"tags": ["explore-graph"],
"file": "shared/core-features/explore-graph"
},
{
"name": "Distribute Task Execution",
"id": "distribute-task-execution",
"tags": ["distribute-task-execution"],
"file": "shared/core-features/distribute-task-execution"
},
{
"name": "Integrate with Editors",
"id": "integrate-with-editors",
"tags": ["integrate-with-editors"],
"file": "shared/core-features/integrate-with-editors"
},
{
"name": "Automate Updating Dependencies",
"id": "automate-updating-dependencies",
"tags": ["automate-updating-dependencies"],
"file": "shared/core-features/automate-updating-dependencies"
},
{
"name": "Enforce Project Boundaries",
"id": "enforce-project-boundaries",
"tags": ["enforce-project-boundaries"],
"file": "shared/core-features/enforce-project-boundaries"
}
]
},
{
"name": "Plugin Features",
"id": "plugin-features",
"description": "Learn what is a plugin, the different type of plugins and how to create one.",
"itemList": [
{
"name": "Use Task Executors",
"id": "use-task-executors",
"tags": ["use-task-executors"],
"file": "shared/plugin-features/use-task-executors"
},
{
"name": "Use Code Generators",
"id": "use-code-generators",
"tags": ["use-code-generators"],
"file": "shared/plugin-features/use-code-generators"
},
{
"name": "Create Your Own Plugin",
"id": "create-your-own-plugin",
"tags": ["create-your-own-plugin"],
"file": "shared/plugin-features/create-your-own-plugin"
}
]
},
{
"name": "Concepts",
"id": "concepts",
"description": "Learn about all the different concepts Nx uses to manage your tasks and enhance your productivity.",
"itemList": [
{
"name": "Integrated Repos vs. Package-Based Repos vs. Standalone Apps",
"tags": ["intro"],
"id": "integrated-vs-package-based",
"file": "shared/concepts/integrated-vs-package-based"
},
{
"name": "Mental Model",
"tags": ["intro"],
"id": "mental-model",
"file": "shared/mental-model"
},
{
"name": "How Caching Works",
"tags": ["cache-task-results"],
"id": "how-caching-works",
"file": "shared/concepts/how-caching-works"
},
{
"name": "Improve Worst Case CI Times",
"tags": ["distribute-task-execution"],
"id": "dte",
"file": "shared/concepts/improve-worst-case-ci-times"
},
{
"name": "Task Pipeline Configuration",
"tags": ["run-tasks", "cache-task-results", "use-task-executors"],
"id": "task-pipeline-configuration",
"file": "shared/concepts/task-pipeline-configuration"
},
{
"name": "Affected",
"tags": ["run-tasks"],
"id": "affected",
"file": "shared/using-nx/affected"
},
{
"name": "More Concept Guides »",
"id": "more-concept-guides",
"file": "shared/concepts/more-concepts"
}
]
},
{
"name": "More Concepts",
"id": "more-concepts",
"description": "Get deeper into how Nx works and its different aspects.",
"itemList": [
{
"name": "Customizing Inputs",
"id": "customizing-inputs",
"tags": ["cache-task-results"],
"file": "shared/concepts/customizing-inputs"
},
{
"name": "Incremental Builds",
"id": "incremental-builds",
"tags": ["use-task-executors"],
"file": "shared/incremental-builds"
},
{
"name": "Illustrated Distributed Task Execution",
"tags": ["distribute-task-execution"],
"id": "illustrated-dte",
"file": "shared/concepts/illustrated-dte-guide"
},
{
"name": "Nx and Turborepo",
"id": "turbo-and-nx",
"file": "shared/guides/turbo-and-nx"
},
{
"name": "Monorepos",
"id": "why-monorepos",
"file": "shared/guides/why-monorepos"
},
{
"name": "Dependency Management",
"id": "dependency-management",
"file": "shared/concepts/dependency-management"
},
{
"name": "Code Sharing",
"id": "code-sharing",
"file": "shared/concepts/code-sharing"
},
{
"name": "Using Nx at Enterprises",
"id": "monorepo-nx-enterprise",
"tags": ["enforce-project-boundaries", "use-code-generators"],
"file": "shared/monorepo-nx-enterprise"
},
{
"name": "Nx Daemon",
"id": "nx-daemon",
"file": "shared/daemon"
},
{
"name": "Nx and the Angular CLI",
"id": "nx-and-angular",
"file": "shared/guides/nx-and-angular-cli"
},
{
"name": "Folder Structure",
"id": "folder-structure",
"file": "shared/guides/integrated-repo-folder-structure"
},
{
"name": "Nx Devkit and Angular Devkit",
"id": "nx-devkit-angular-devkit",
"tags": ["create-your-own-plugin"],
"file": "shared/guides/nx-devkit-angular-devkit"
},
{
"name": "Micro Frontend Architecture",
"id": "micro-frontend-architecture",
"file": "shared/guides/module-federation/micro-frontend-architecture"
},
{
"name": "Applications and Libraries",
"id": "applications-and-libraries",
"tags": ["enforce-project-boundaries"],
"file": "shared/workspace/applications-and-libraries"
},
{
"name": "Creating Libraries",
10BC8
"id": "creating-libraries",
"tags": ["enforce-project-boundaries"],
"file": "shared/workspace/creating-libraries"
},
{
"name": "Library Types",
"id": "library-types",
"tags": ["enforce-project-boundaries"],
"file": "shared/workspace/library-types"
},
{
"name": "Grouping Libraries",
"id": "grouping-libraries",
"tags": ["enforce-project-boundaries"],
"file": "shared/workspace/grouping-libraries"
},
{
"name": "Buildable and Publishable Libraries",
"id": "buildable-and-publishable-libraries",
"file": "shared/workspace/buildable-and-publishable-libraries"
},
{
"name": "How the Project Graph is Built",
"id": "how-project-graph-is-built",
"tags": ["explore-graph"],
"file": "shared/concepts/how-project-graph-is-built"
},
{
"name": "Encapsulated Nx and the Nx Wrapper",
"id": "encapsulated-nx-and-the-wrapper",
"file": "shared/guides/encapsulated-nx-and-the-wrapper"
}
]
},
{
"name": "Recipes",
"id": "recipes",
"description": "Learn quickly how to do things with Nx.",
"itemList": [
{
"name": "CI Setup",
"id": "ci-setup",
"path": "/recipes/ci/ci-setup"
},
{
"name": "Adopting Nx",
"id": "adopting-nx",
"path": "/recipes/adopting-nx"
},
{
"name": "All Recipes »",
"id": "all",
"path": "/recipes"
}
]
},
{
"name": "Reference",
"id": "reference",
"description": "Understand how to use Nx functionalities, what arguments and options are available for each component.",
"itemList": [
{
"name": "Commands",
"id": "commands",
"file": "shared/reference/commands"
},
{
"name": "nx.json",
"id": "nx-json",
"file": "shared/reference/nx-json"
},
{
"name": "Project Configuration",
"id": "project-configuration",
"tags": ["use-task-executors"],
"file": "shared/reference/project-configuration"
},
{
"name": ".nxignore",
"id": "nxignore",
"tags": ["enforce-project-boundaries"],
"file": "shared/reference/nxignore"
},
{
"name": "Environment Variables",
"id": "environment-variables",
"tags": ["environment-variables"],
"file": "shared/reference/environment-variables"
},
{
"name": "Packages",
"id": "packages",
"file": "",
"path": "/packages",
"isExternal": true
},
{
"name": "Nx Devkit",
"id": "packages-devkit",
"tags": ["create-your-own-plugin"],
"file": "",
"path": "/packages/devkit/documents/nrwl_devkit",
"isExternal": true
},
{
"name": "Glossary",
"id": "glossary",
"tags": [],
"file": "shared/reference/glossary"
}
]
},
{
"name": "Deprecated",
"id": "deprecated",
"description": "Functionality that has been superseded in the current version of Nx. Listed here for those running older versions.",
"itemList": [
{
"name": "workspace.json",
"id": "workspace-json",
"file": "shared/deprecated/workspace-json"
},
{
"name": "Workspace Generators",
"id": "workspace-generators",
"file": "shared/deprecated/workspace-generators"
},
{
"name": "Workspace Executors",
"id": "workspace-executors",
"file": "shared/deprecated/workspace-executors"
},
{
"name": "defaultCollection",
"id": "default-collection",
"file": "shared/deprecated/default-collection"
},
{
"name": "runtimeCacheInputs",
"id": "runtime-cache-inputs",
"file": "shared/deprecated/runtime-cache-inputs"
},
{
"name": "globalImplicitDependencies",
"id": "global-implicit-dependencies",
"file": "shared/deprecated/global-implicit-dependencies"
}
]
},
{
"name": "See Also",
"id": "see-also",
"description": "Links to other pieces of documentation",
"itemList": [
{
"name": "Nx Cloud Documentation",
"id": "nx-cloud-documentation",
"file": "",
"tags": ["cache-task-results", "distribute-task-execution"],
"path": "/nx-cloud/intro/what-is-nx-cloud",
"isExternal": true
},
{
"name": "Nx Cloud Main Site",
"id": "nx-cloud-main-site",
"file": "",
"tags": ["cache-task-results", "distribute-task-execution"],
"path": "https://nx.app",
"isExternal": true
},
{
"name": "--skip-nx-cache flag",
"id": "skip-nx-cache-flag",
"file": "",
"tags": ["cache-task-results"],
"path": "/packages/nx/documents/affected#skip-nx-cache",
"isExternal": true
},
{
"name": "tasks-runner-options property",
"id": "tasks-runner-options-property",
"file": "",
"tags": ["cache-task-results"],
"path": "/reference/nx-json#tasks-runner-options",
"isExternal": true
},
{
"name": "nx.json reference: inputs and namedInputs",
"id": "nxjson-inputs",
"file": "",
"tags": ["cache-task-results"],
"path": "/reference/nx-json#inputs-&-namedinputs",
"isExternal": true
},
{
"name": "Project Configuration reference: inputs and namedInputs",
"id": "project-config-inputs",
"file": "",
"tags": ["cache-task-results"],
"path": "/reference/project-configuration#inputs-&-namedinputs",
"isExternal": true
},
{
"name": "nx.json workspaceLayout property",
"id": "nxjson-workspaceLayout",
"file": "",
"tags": ["enforce-project-boundaries"],
"path": "/reference/nx-json#workspace-layout",
"isExternal": true
},
{
"name": "nx.json generator defaults",
"id": "nxjson-generator-defaults",
"file": "",
"tags": ["use-code-generators"],
"path": "/reference/nx-json#generators",
"isExternal": true
}
]
}
]
},
{
"name": "Nx Recipes",
"id": "nx-recipes",
"description": "Learn quickly how to do things with Nx.",
"itemList": [
{
"name": "Getting Started",
"id": "getting-started",
"description": "Basic information to get you started.",
"itemList": [
{
"name": "Set up a new workspace",
"id": "set-up-a-new-workspace",
"description": "How to setup quickly a new Nx workspace.",
"file": "shared/recipes/set-up-a-new-workspace"
}
]
},
{
"name": "Nx Console",
"id": "nx-console",
"description": "Checkout all the recipes related to Nx Console.",
"itemList": [
{
"name": "Nx Console Generate Command",
"id": "console-generate-command",
"tags": ["integrate-with-editors"],
"file": "shared/recipes/console-generate-command"
},
{
"name": "Nx Console Run Command",
"id": "console-run-command",
"tags": ["integrate-with-editors"],
"file": "shared/recipes/console-run-command"
},
{
"name": "Nx Console Add Dependency Command",
"id": "console-add-dependency-command",
"tags": ["integrate-with-editors"],
"file": "shared/recipes/console-add-dependency-command"
},
{
"name": "Nx Console Project Pane",
"id": "console-project-pane",
"tags": ["integrate-with-editors"],
"file": "shared/recipes/console-project-pane"
},
{
"name": "Nx Console Keyboard Shortcuts",
"id": "console-shortcuts",
"tags": ["integrate-with-editors"],
"file": "shared/recipes/console-shortcuts"
}
]
},
{
"name": "CI",
"id": "ci",
"description": "All recipes about how to use Nx to make your CI faster.",
"itemList": [
{
"name": "CI Setup",
"id": "ci-setup",
"tags": ["distribute-task-execution"],
"file": "shared/ci-overview"
},
{
"name": "Prepare applications for deployment via CI",
"id": "ci-deployment",
"tags": ["docker", "deploy"],
"file": "shared/recipes/ci-deployment"
},
{
"name": "Setting up Azure Pipelines",
"id": "monorepo-ci-azure",
"file": "shared/monorepo-ci-azure"
},
{
"name": "Setting up CircleCI",
"id": "monorepo-ci-circle-ci",
"file": "shared/monorepo-ci-circle-ci"
},
{
"name": "Setting up GitHub Actions",
"id": "monorepo-ci-github-actions",
"file": "shared/monorepo-ci-github-actions"
},
{
"name": "Setting up Jenkins",
"id": "monorepo-ci-jenkins",
"file": "shared/monorepo-ci-jenkins"
},
{
"name": "Setting up GitLab",
"id": "monorepo-ci-gitlab",
"file": "shared/monorepo-ci-gitlab"
},
{
"name": "Setting up Bitbucket",
"id": "monorepo-ci-bitbucket-pipelines",
"file": "shared/monorepo-ci-bitbucket-pipelines"
}
]
},
{
"name": "Adopting Nx",
"id": "adopting-nx",
"description": "Adopting Nx incrementally, on existing project or from scratch.",
"itemList": [
{
"name": "NPM/Yarn/PNPM workspaces",
"id": "adding-to-monorepo",
"file": "shared/migration/adding-to-monorepo"
},
{
"name": "Add to any Project",
"id": "adding-to-existing-project",
"file": "shared/migration/adding-to-existing-project"
},
{
"name": "From CRA",
"id": "migration-cra",
"file": "shared/migration/migration-cra"
},
{
"name": "From Angular CLI",
"id": "migration-angular",
"file": "shared/migration/migration-angular"
},
{
"name": "Nx and Lerna",
"id": "lerna-and-nx",
"file": "shared/migration/lerna-and-nx"
},
{
"name": "From AngularJS",
"id": "migration-angularjs",
"file": "shared/migration/migration-angularjs"
},
{
"name": "Preserving Git Histories",
"id": "preserving-git-histories",
"file": "shared/migration/preserving-git-histories"
},
{
"name": "Manual migration",
"id": "manual",
"file": "shared/migration/manual"
}
]
},
{
"name": "Executors",
"id": "executors",
"description": "Use, extend and compose executors.",
"itemList": [
{
"name": "Use Executor Configurations",
"id": "use-executor-configurations",
"tags": ["use-task-executors"],
"file": "shared/recipes/use-executor-configurations"
},
{
"name": "Running Custom Commands",
"id": "run-commands-executor",
"tags": ["use-task-executors"],
"file": "shared/running-custom-commands"
},
{
"name": "Local Executors",
"id": "creating-custom-executors",
"tags": ["use-task-executors", "create-your-own-plugin"],
"file": "shared/recipes/plugins/local-executors"
},
{
"name": "Compose Executors",
"id": "compose-executors",
"tags": ["use-task-executors"],
"file": "shared/recipes/plugins/compose-executors"
}
]
},
{
"name": "Generators",
"id": "generators",
"description": "Use, extend and compose generators.",
"itemList": [
{
"name": "Local Generators",
"id": "local-generators",
"tags": ["use-code-generators", "create-your-own-plugin"],
"file": "shared/recipes/generators/local-generators"
},
{
"name": "Composing Generators",
"id": "composing-generators",
"tags": ["use-code-generators"],
"file": "shared/recipes/generators/composing-generators"
},
{
"name": "Generator Options",
"id": "generator-options",
"tags": ["use-code-generators"],
"file": "shared/recipes/generators/generator-options"
},
{
"name": "Creating Files",
"id": "creating-files",
"tags": ["use-code-generators"],
"file": "shared/recipes/generators/creating-files"
},
{
"name": "Modifying Files",
"id": "modifying-files",
"tags": ["use-code-generators"],
"file": "shared/recipes/generators/modifying-files"
}
]
},
{
"name": "Advanced Plugins",
"id": "advanced-plugins",
"description": "Learn more about creating your own plugin, extending Nx.",
"itemList": [
{
"name": "Share Your Plugin",
"id": "share-your-plugin",
"tags": ["create-your-own-plugin"],
"file": "shared/recipes/plugins/share-your-plugin"
},
{
"name": "Create a Preset",
"id": "create-preset",
"tags": ["create-your-own-plugin"],
"file": "shared/recipes/plugins/create-preset"
},
{
"name": "Migration Generators",
"id": "migration-generators",
"tags": ["create-your-own-plugin"],
"file": "shared/recipes/plugins/migration-generators"
},
{
"name": "Project Graph Plugins",
"id": "project-graph-plugins",
"tags": ["create-your-own-plugin", "explore-graph"],
"file": "shared/recipes/plugins/project-graph-plugins"
},
{
"name": "Project Inference Plugins",
"id": "project-inference-plugins",
"tags": ["create-your-own-plugin"],
"file": "shared/recipes/plugins/project-inference-plugins"
}
]
},
{
"name": "Environment Variables",
"id": "environment-variables",
"description": "Using environment variables in an Nx workspace.",
"itemList": [
{
"name": "Define Environment Variables",
"id": "define-environment-variables",
"tags": ["environment-variables"],
"file": "shared/guides/define-environment-variables"
},
{
"name": "Use Environment Variables in React",
"id": "use-environment-variables-in-react",
"tags": ["environment-variables"],
"file": "shared/guides/use-environment-variables-in-react"
},
{
"name": "Use Environment Variables in Angular",
"id": "use-environment-variables-in-angular",
"tags": ["environment-variables"],
"file": "shared/guides/use-environment-variables-in-angular"
}
]
},
{
"name": "Module Federation and Micro Frontends",
"id": "module-federation",
"description": "How to work with and setup Module Federation with Nx.",
"itemList": [
{
"name": "Faster Builds with Module Federation",
"id": "faster-builds",
"tags": [
"use-task-executors",
"module-federation",
"angular",
"react"
],
"file": "shared/guides/module-federation/faster-builds"
},
{
"name": "Setup Module Federation with SSR for Angular and React",
"id": "module-federation-with-ssr",
"tags": [
"use-task-executors",
"module-federation",
"angular",
"react"
],
"file": "shared/recipes/module-federation-with-ssr"
},
{
"name": "Advanced Micro Frontends with Angular using Dynamic Federation",
"id": "dynamic-module-federation-with-angular",
"tags": ["use-task-executors", "module-federation", "angular"],
"file": "shared/guides/module-federation/dynamic-mfe-angular"
},
{
"name": "Nx Micro-Frontend Example",
"id": "nx-examples",
"file": "shared/examples/nx-examples"
}
]
},
{
"name": "Storybook",