-
Notifications
You must be signed in to change notification settings - Fork 20
/
sfdx-project.schema.json
960 lines (960 loc) · 29.3 KB
/
sfdx-project.schema.json
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
{
"$id": "http://schemas.salesforce.com/sfdx-project.json",
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"definitions": {
"MetadataRegistry": {
"additionalProperties": false,
"properties": {
"childTypes": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"strictDirectoryNames": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"suffixes": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"types": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"aliasFor": {
"type": "string"
},
"children": {
"additionalProperties": false,
"properties": {
"directories": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"suffixes": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"types": {
"$ref": "#/definitions/alias-147831185-257-1138-147831185-0-1202"
}
},
"required": [
"types",
"suffixes"
],
"type": "object"
},
"directoryName": {
"type": "string"
},
"folderContentType": {
"type": "string"
},
"folderType": {
"type": "string"
},
"id": {
"type": "string"
},
"ignoreParsedFullName": {
"type": "boolean"
},
"isAddressable": {
"type": "boolean"
},
"name": {
"type": "string"
},
"strategies": {
"additionalProperties": false,
"properties": {
"adapter": {
"enum": [
"mixedContent",
"matchingContentFile",
"decomposed",
"bundle",
"default"
],
"type": "string"
},
"decomposition": {
"enum": [
"topLevel",
"folderPerType"
],
"type": "string"
},
"transformer": {
"enum": [
"decomposed",
"staticResource",
"standard"
],
"type": "string"
}
},
"required": [
"adapter"
],
"type": "object"
},
"strictDirectoryName": {
"type": "boolean"
},
"suffix": {
"type": "string"
},
"supportsPartialDelete": {
"type": "boolean"
},
"supportsWildcardAndName": {
"type": "boolean"
},
"unaddressableWithoutParent": {
"type": "boolean"
},
"uniqueIdElement": {
"type": "string"
},
"xmlElementName": {
"type": "string"
}
},
"required": [
"id",
"name",
"directoryName"
],
"type": "object"
},
"type": "object"
}
},
"required": [
"types",
"suffixes",
"strictDirectoryNames",
"childTypes"
],
"type": "object"
},
"PackageDir": {
"anyOf": [
{
"additionalProperties": false,
"description": "type required just for projects, regardless of 1gp/2gp package use",
"properties": {
"default": {
"default": true,
"description": "If you have specified more than one path, include this parameter for the default path to indicate which is the default package directory.",
"title": "default",
"type": "boolean"
},
"path": {
"description": "If you don’t specify a path, the Salesforce CLI uses a placeholder when you create a package.",
"title": "Path",
"type": "string"
}
},
"required": [
"path"
],
"type": "object"
},
{
"$ref": "#/definitions/PackagePackageDir"
}
]
},
"PackageDirDependency": {
"additionalProperties": {},
"description": "from packaging library. Where does this go? export type PackageDescriptorJson = Partial<NamedPackageDir> & Partial<{ - id: string; - features: string[]; - orgPreferences: string[]; - snapshot: string; apexTestAccess: { permissionSets: string[] | string; permissionSetLicenses: string[] | string }; - permissionSetNames: string[]; - permissionSetLicenseDeveloperNames: string[]; - branch: string; subscriberPackageVersionId: string; packageId: string; versionName: string; language?: string; }>;",
"properties": {
"branch": {
"type": "string"
},
"package": {
"type": "string"
},
"versionNumber": {
"type": "string"
}
},
"required": [
"package"
],
"type": "object"
},
"PackagePackageDir": {
"additionalProperties": false,
"description": "has the \"full\" info used for packaging.",
"properties": {
"ancestorId": {
"description": "The ancestor that’s the immediate parent of the version that you’re creating. The package version ID to supply starts with '05i'.",
"title": "Ancestor ID",
"type": "string"
},
"ancestorVersion": {
"description": "The ancestor that’s the immediate parent of the version that you’re creating. The ancestor version uses the format major.minor.patch.build.",
"title": "Ancestor Version",
"type": "string"
},
"apexTestAccess": {
"additionalProperties": false,
"description": "Additional access that should be granted to the user when running package Apex tests",
"properties": {
"permissionSetLicenses": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "string"
}
],
"description": "The list of permission sets licenses to enable while running Apex tests",
"title": "Permission Set Licenses"
},
"permissionSets": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "string"
}
],
"description": "The list of permission sets to enable while running Apex tests",
"title": "Permission Sets"
}
},
"required": [
"permissionSets",
"permissionSetLicenses"
],
"type": "object"
},
"default": {
"default": true,
"description": "If you have specified more than one path, include this parameter for the default path to indicate which is the default package directory.",
"title": "default",
"type": "boolean"
},
"definitionFile": {
"description": "Reference an external .json file to specify the features and org preferences required for the metadata of your package, such as the scratch org definition.",
"title": "Definition File",
"type": "string"
},
"dependencies": {
"description": "To specify dependencies for 2GP within the same Dev Hub, use either the package version alias or a combination of the package name and the version number.",
"items": {
"$ref": "#/definitions/PackageDirDependency"
},
"type": "array"
},
"functions": {
"deprecated": true,
"items": {
"type": "string"
},
"type": "array"
},
"includeProfileUserLicenses": {
"default": false,
"description": "Whether to include <userLicense> elements in profile metadata. Defaults to false.",
"title": "Include Profile User Licenses",
"type": "boolean"
},
"package": {
"description": "The package name you specified when creating the package.",
"title": "Package Identifier",
"type": "string"
},
"packageMetadataAccess": {
"additionalProperties": false,
"description": "Additional access that should be granted to the user while deploying package metadata, available in Salesforce API version 61.0 and above",
"properties": {
"permissionSetLicenses": {
"anyOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
],
"description": "The list of permission set licenses to enable while deploying package metadata",
"title": "Permission Set Licenses"
},
"permissionSets": {
"anyOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
],
"description": "The list of permission sets to enable while deploying package metadata",
"title": "Permission Sets"
}
},
"required": [
"permissionSets",
"permissionSetLicenses"
],
"title": "Package Metadata Access",
"type": "object"
},
"path": {
"description": "If you don’t specify a path, the Salesforce CLI uses a placeholder when you create a package.",
"title": "Path",
"type": "string"
},
"postInstallScript": {
"description": "The post install script.",
"title": "Post Install Script",
"type": "string"
},
"postInstallUrl": {
"description": "The post install url.",
"title": "Post Install Url",
"type": "string"
},
"releaseNotesUrl": {
"description": "The release notes url.",
"title": "Release Notes Url",
"type": "string"
},
"scopeProfiles": {
"default": false,
"description": "Determines whether to include profile settings from only the directory being packaged (true), or whether to include profile settings from all package directories (false). If not specified, the default is false.",
"title": "Scope Profiles",
"type": "boolean"
},
"seedMetadata": {
"additionalProperties": false,
"description": "Metadata not meant to be packaged, but deployed before deploying packaged metadata",
"properties": {
"path": {
"description": "The path name of the package directory containing the seed metadata",
"title": "Path",
"type": "string"
}
},
"required": [
"path"
],
"title": "Seed Metadata",
"type": "object"
},
"uninstallScript": {
"description": "The uninstall script.",
"title": "Uninstall Script",
"type": "string"
},
"unpackagedMetadata": {
"additionalProperties": false,
"description": "Metadata not meant to be packaged, but deployed when testing packaged metadata",
"properties": {
"path": {
"description": "The path name of the package directory containing the unpackaged metadata",
"title": "Path",
"type": "string"
}
},
"required": [
"path"
],
"title": "Unpackaged Metadata",
"type": "object"
},
"versionDescription": {
"description": "Human readable version information, format not specified.",
"title": "Version Description",
"type": "string"
},
"versionName": {
"description": "If not specified, the CLI uses versionNumber as the version name.",
"title": "Version Name",
"type": "string"
},
"versionNumber": {
"description": "Version numbers are formatted as major.minor.patch.build. For example, 1.2.1.8.",
"title": "Version Number",
"type": "string"
}
},
"required": [
"package",
"path",
"versionNumber"
],
"type": "object"
},
"RegistryPresets": {
"items": {
"type": "string"
},
"type": "array"
},
"Replacements": {
"anyOf": [
{
"additionalProperties": false,
"properties": {
"filename": {
"type": "string"
},
"replaceWhenEnv": {
"items": {
"additionalProperties": false,
"properties": {
"env": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"env",
"value"
],
"type": "object"
},
"type": "array"
},
"replaceWithFile": {
"type": "string"
},
"stringToReplace": {
"type": "string"
}
},
"required": [
"filename",
"replaceWithFile",
"stringToReplace"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"allowUnsetEnvVariable": {
"type": "boolean"
},
"filename": {
"type": "string"
},
"replaceWhenEnv": {
"items": {
"additionalProperties": false,
"properties": {
"env": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"env",
"value"
],
"type": "object"
},
"type": "array"
},
"replaceWithEnv": {
"type": "string"
},
"stringToReplace": {
"type": "string"
}
},
"required": [
"filename",
"replaceWithEnv",
"stringToReplace"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"filename": {
"type": "string"
},
"regexToReplace": {
"type": "string"
},
"replaceWhenEnv": {
"items": {
"additionalProperties": false,
"properties": {
"env": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"env",
"value"
],
"type": "object"
},
"type": "array"
},
"replaceWithFile": {
"type": "string"
}
},
"required": [
"filename",
"regexToReplace",
"replaceWithFile"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"allowUnsetEnvVariable": {
"type": "boolean"
},
"filename": {
"type": "string"
},
"regexToReplace": {
"type": "string"
},
"replaceWhenEnv": {
"items": {
"additionalProperties": false,
"properties": {
"env": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"env",
"value"
],
"type": "object"
},
"type": "array"
},
"replaceWithEnv": {
"type": "string"
}
},
"required": [
"filename",
"regexToReplace",
"replaceWithEnv"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"glob": {
"type": "string"
},
"replaceWhenEnv": {
"items": {
"additionalProperties": false,
"properties": {
"env": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"env",
"value"
],
"type": "object"
},
"type": "array"
},
"replaceWithFile": {
"type": "string"
},
"stringToReplace": {
"type": "string"
}
},
"required": [
"glob",
"replaceWithFile",
"stringToReplace"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"allowUnsetEnvVariable": {
"type": "boolean"
},
"glob": {
"type": "string"
},
"replaceWhenEnv": {
"items": {
"additionalProperties": false,
"properties": {
"env": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"env",
"value"
],
"type": "object"
},
"type": "array"
},
"replaceWithEnv": {
"type": "string"
},
"stringToReplace": {
"type": "string"
}
},
"required": [
"glob",
"replaceWithEnv",
"stringToReplace"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"glob": {
"type": "string"
},
"regexToReplace": {
"type": "string"
},
"replaceWhenEnv": {
"items": {
"additionalProperties": false,
"properties": {
"env": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"env",
"value"
],
"type": "object"
},
"type": "array"
},
"replaceWithFile": {
"type": "string"
}
},
"required": [
"glob",
"regexToReplace",
"replaceWithFile"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"allowUnsetEnvVariable": {
"type": "boolean"
},
"glob": {
"type": "string"
},
"regexToReplace": {
"type": "string"
},
"replaceWhenEnv": {
"items": {
"additionalProperties": false,
"properties": {
"env": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"env",
"value"
],
"type": "object"
},
"type": "array"
},
"replaceWithEnv": {
"type": "string"
}
},
"required": [
"glob",
"regexToReplace",
"replaceWithEnv"
],
"type": "object"
}
]
},
"alias-147831185-257-1138-147831185-0-1202": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"aliasFor": {
"type": "string"
},
"children": {
"additionalProperties": false,
"properties": {
"directories": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"suffixes": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"types": {
"$ref": "#/definitions/alias-147831185-257-1138-147831185-0-1202"
}
},
"required": [
"types",
"suffixes"
],
"type": "object"
},
"directoryName": {
"type": "string"
},
"folderContentType": {
"type": "string"
},
"folderType": {
"type": "string"
},
"id": {
"type": "string"
},
"ignoreParsedFullName": {
"type": "boolean"
},
"isAddressable": {
"type": "boolean"
},
"name": {
"type": "string"
},
"strategies": {
"additionalProperties": false,
"properties": {
"adapter": {
"enum": [
"mixedContent",
"matchingContentFile",
"decomposed",
"bundle",
"default"
],
"type": "string"
},
"decomposition": {
"enum": [
"topLevel",
"folderPerType"
],
"type": "string"
},
"transformer": {
"enum": [
"decomposed",
"staticResource",
"standard"
],
"type": "string"
}
},
"required": [
"adapter"
],
"type": "object"
},
"strictDirectoryName": {
"type": "boolean"
},
"suffix": {
"type": "string"
},
"supportsPartialDelete": {
"type": "boolean"
},
"supportsWildcardAndName": {
"type": "boolean"
},
"unaddressableWithoutParent": {
"type": "boolean"
},
"uniqueIdElement": {
"type": "string"
},
"xmlElementName": {
"type": "string"
}
},
"required": [
"id",
"name",
"directoryName"
],
"type": "object"
},
"type": "object"
}
},
"description": "The properties and shape of the SFDX project",
"properties": {
"name": {
"description": "The name of your Salesforce project.",
"title": "name",
"type": "string"
},
"namespace": {
"description": "A namespace is an alphanumeric identifier that distinguishes your package and its contents from other packages in your customer’s org. For steps on how to register a namespace and link it to your Dev Hub org, see Create and Register Your Namespace for Second-Generation Managed Packages on developer.salesforce.com. If you’re creating an unlocked package, you can create it without a namespace.",
"title": "Namespace",
"type": "string"
},
"oauthLocalPort": {
"default": 1717,
"description": "By default, the OAuth port is 1717. However, change this port if this port is already in use, and you plan to create a connected app in your Dev Hub org to support JWT-based authorization.",
"type": "number"
},
"packageAliases": {
"additionalProperties": {
"type": "string"
},
"description": "The Salesforce CLI updates this file with the aliases when you create a package or package version. You can also manually update this section for existing packages or package versions. You can use the alias instead of the cryptic package ID when running CLI force:package commands.",
"title": "Aliases for packaging ids",
"type": "object"
},
"packageDirectories": {
"$comment": "The properties ancestorId & ancestorVersion cannot be included together, but this schema optimizes for VS Code code completion rather than pure validation.",
"description": "Package directories indicate which directories to target when syncing source to and from the scratch org. These directories can contain source from your managed package, unmanaged package, or unpackaged source, for example, ant tool or change set.",
"items": {
"$ref": "#/definitions/PackageDir"
},
"minItems": 1,
"title": "Package Directories",
"type": "array"
},
"plugins": {
"additionalProperties": {},
"description": "Salesforce CLI plugin configurations used with this project.",
"title": "CLI Plugins custom settings",
"type": "object"
},
"pushPackageDirectoriesSequentially": {
"deprecated": "only works with deprecated commands. See https://github.com/forcedotcom/cli/discussions/2402",
"type": "boolean"
},
"registryCustomizations": {
"$ref": "#/definitions/MetadataRegistry"
},
"registryPresets": {
"$ref": "#/definitions/RegistryPresets",
"deprecated": "use `sourceBehaviorOptions`\nfilenames from https://github.com/forcedotcom/source-deploy-retrieve/tree/main/src/registry/presets",
"title": "Custom predefined presets for decomposing metadata types"
},
"replacements": {
"description": "The Salesforce CLI will conditionally replace portions of your metadata during a deployment\"",
"items": {
"$ref": "#/definitions/Replacements"
},
"title": "Replacements for metadata that are executed during deployments\"",
"type": "array"
},
"sfdcLoginUrl": {
"description": "The login URL that the force:auth commands use. If not specified, the default is login.salesforce.com. Override the default value if you want users to authorize to a specific Salesforce instance. For example, if you want to authorize into a sandbox org, set this parameter to test.salesforce.com.",
"title": "SFDC Login URL",
"type": "string"
},
"signupTargetLoginUrl": {
"description": "The url that is used when creating new scratch orgs. This is typically only used for testing prerelease environments.",
"type": "string"
},
"sourceApiVersion": {
"default": "48.0",
"description": "The API version that the source is compatible with. By default it matches the API version.",
"title": "Source API Version",
"type": "string"
},
"sourceBehaviorOptions": {
"$ref": "#/definitions/RegistryPresets",
"description": "filenames from https://github.com/forcedotcom/source-deploy-retrieve/tree/main/src/registry/presets",
"title": "Custom predefined presets for decomposing metadata types"
}
},
"required": [
"packageDirectories"
],
"title": "Salesforce DX Project File",
"type": "object"
}