@salesforce/plugin-templates 56.14.0 → 56.15.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +44 -29
- package/lib/commands/template/generate/lightning/component.d.ts +1 -1
- package/lib/commands/template/generate/lightning/component.js +22 -3
- package/lib/commands/template/generate/lightning/component.js.map +1 -1
- package/lib/commands/template/generate/project/index.d.ts +1 -1
- package/messages/lightning.md +1 -1
- package/messages/lightningCmp.md +4 -0
- package/messages/messages.md +1 -1
- package/messages/project.md +2 -2
- package/oclif.manifest.json +443 -441
- package/package.json +3 -3
package/oclif.manifest.json
CHANGED
|
@@ -1,158 +1,5 @@
|
|
|
1
1
|
{
|
|
2
2
|
"commands": {
|
|
3
|
-
"template:generate:analytics:template": {
|
|
4
|
-
"aliases": [
|
|
5
|
-
"force:analytics:template:create",
|
|
6
|
-
"analytics:generate:template"
|
|
7
|
-
],
|
|
8
|
-
"args": {},
|
|
9
|
-
"deprecateAliases": true,
|
|
10
|
-
"description": "The metadata files associated with the Analytics template must be contained in a parent directory called \"waveTemplates\" in your package directory. Either run this command from an existing directory of this name, or use the --output-dir flag to generate one or point to an existing one.",
|
|
11
|
-
"examples": [
|
|
12
|
-
"Generate the metadata files for a simple Analytics template file called myTemplate in the force-app/main/default/waveTemplates directory:\n<%= config.bin %> <%= command.id %> --name myTemplate --output-dir force-app/main/default/waveTemplates"
|
|
13
|
-
],
|
|
14
|
-
"flags": {
|
|
15
|
-
"json": {
|
|
16
|
-
"description": "Format output as json.",
|
|
17
|
-
"helpGroup": "GLOBAL",
|
|
18
|
-
"name": "json",
|
|
19
|
-
"allowNo": false,
|
|
20
|
-
"type": "boolean"
|
|
21
|
-
},
|
|
22
|
-
"flags-dir": {
|
|
23
|
-
"helpGroup": "GLOBAL",
|
|
24
|
-
"name": "flags-dir",
|
|
25
|
-
"summary": "Import flag values from a directory.",
|
|
26
|
-
"hasDynamicHelp": false,
|
|
27
|
-
"multiple": false,
|
|
28
|
-
"type": "option"
|
|
29
|
-
},
|
|
30
|
-
"output-dir": {
|
|
31
|
-
"aliases": [
|
|
32
|
-
"outputdir"
|
|
33
|
-
],
|
|
34
|
-
"char": "d",
|
|
35
|
-
"deprecateAliases": true,
|
|
36
|
-
"description": "The location can be an absolute path or relative to the current working directory. The default is the current directory.",
|
|
37
|
-
"name": "output-dir",
|
|
38
|
-
"summary": "Directory for saving the created files.",
|
|
39
|
-
"default": ".",
|
|
40
|
-
"hasDynamicHelp": false,
|
|
41
|
-
"multiple": false,
|
|
42
|
-
"type": "option"
|
|
43
|
-
},
|
|
44
|
-
"api-version": {
|
|
45
|
-
"aliases": [
|
|
46
|
-
"apiversion"
|
|
47
|
-
],
|
|
48
|
-
"deprecateAliases": true,
|
|
49
|
-
"description": "Override the api version used for api requests made by this command",
|
|
50
|
-
"name": "api-version",
|
|
51
|
-
"hasDynamicHelp": false,
|
|
52
|
-
"multiple": false,
|
|
53
|
-
"type": "option"
|
|
54
|
-
},
|
|
55
|
-
"name": {
|
|
56
|
-
"aliases": [
|
|
57
|
-
"templatename"
|
|
58
|
-
],
|
|
59
|
-
"char": "n",
|
|
60
|
-
"deprecateAliases": true,
|
|
61
|
-
"name": "name",
|
|
62
|
-
"required": true,
|
|
63
|
-
"summary": "Name of the Analytics template.",
|
|
64
|
-
"hasDynamicHelp": false,
|
|
65
|
-
"multiple": false,
|
|
66
|
-
"type": "option"
|
|
67
|
-
},
|
|
68
|
-
"loglevel": {
|
|
69
|
-
"deprecated": {
|
|
70
|
-
"message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable."
|
|
71
|
-
},
|
|
72
|
-
"hidden": true,
|
|
73
|
-
"name": "loglevel",
|
|
74
|
-
"hasDynamicHelp": false,
|
|
75
|
-
"multiple": false,
|
|
76
|
-
"type": "option"
|
|
77
|
-
}
|
|
78
|
-
},
|
|
79
|
-
"hasDynamicHelp": false,
|
|
80
|
-
"hiddenAliases": [],
|
|
81
|
-
"id": "template:generate:analytics:template",
|
|
82
|
-
"pluginAlias": "@salesforce/plugin-templates",
|
|
83
|
-
"pluginName": "@salesforce/plugin-templates",
|
|
84
|
-
"pluginType": "core",
|
|
85
|
-
"strict": true,
|
|
86
|
-
"summary": "Generate a simple Analytics template.",
|
|
87
|
-
"enableJsonFlag": true,
|
|
88
|
-
"isESM": true,
|
|
89
|
-
"relativePath": [
|
|
90
|
-
"lib",
|
|
91
|
-
"commands",
|
|
92
|
-
"template",
|
|
93
|
-
"generate",
|
|
94
|
-
"analytics",
|
|
95
|
-
"template.js"
|
|
96
|
-
],
|
|
97
|
-
"aliasPermutations": [
|
|
98
|
-
"force:analytics:template:create",
|
|
99
|
-
"analytics:force:template:create",
|
|
100
|
-
"analytics:template:force:create",
|
|
101
|
-
"analytics:template:create:force",
|
|
102
|
-
"force:template:analytics:create",
|
|
103
|
-
"template:force:analytics:create",
|
|
104
|
-
"template:analytics:force:create",
|
|
105
|
-
"template:analytics:create:force",
|
|
106
|
-
"force:template:create:analytics",
|
|
107
|
-
"template:force:create:analytics",
|
|
108
|
-
"template:create:force:analytics",
|
|
109
|
-
"template:create:analytics:force",
|
|
110
|
-
"force:analytics:create:template",
|
|
111
|
-
"analytics:force:create:template",
|
|
112
|
-
"analytics:create:force:template",
|
|
113
|
-
"analytics:create:template:force",
|
|
114
|
-
"force:create:analytics:template",
|
|
115
|
-
"create:force:analytics:template",
|
|
116
|
-
"create:analytics:force:template",
|
|
117
|
-
"create:analytics:template:force",
|
|
118
|
-
"force:create:template:analytics",
|
|
119
|
-
"create:force:template:analytics",
|
|
120
|
-
"create:template:force:analytics",
|
|
121
|
-
"create:template:analytics:force",
|
|
122
|
-
"analytics:generate:template",
|
|
123
|
-
"generate:analytics:template",
|
|
124
|
-
"generate:template:analytics",
|
|
125
|
-
"analytics:template:generate",
|
|
126
|
-
"template:analytics:generate",
|
|
127
|
-
"template:generate:analytics"
|
|
128
|
-
],
|
|
129
|
-
"permutations": [
|
|
130
|
-
"template:generate:analytics:template",
|
|
131
|
-
"generate:template:analytics:template",
|
|
132
|
-
"generate:analytics:template:template",
|
|
133
|
-
"generate:analytics:template:template",
|
|
134
|
-
"template:analytics:generate:template",
|
|
135
|
-
"analytics:template:generate:template",
|
|
136
|
-
"analytics:generate:template:template",
|
|
137
|
-
"analytics:generate:template:template",
|
|
138
|
-
"template:analytics:template:generate",
|
|
139
|
-
"analytics:template:template:generate",
|
|
140
|
-
"analytics:template:template:generate",
|
|
141
|
-
"analytics:template:generate:template",
|
|
142
|
-
"template:generate:template:analytics",
|
|
143
|
-
"generate:template:template:analytics",
|
|
144
|
-
"generate:template:template:analytics",
|
|
145
|
-
"generate:template:analytics:template",
|
|
146
|
-
"template:template:generate:analytics",
|
|
147
|
-
"template:template:generate:analytics",
|
|
148
|
-
"template:generate:template:analytics",
|
|
149
|
-
"template:generate:analytics:template",
|
|
150
|
-
"template:template:analytics:generate",
|
|
151
|
-
"template:template:analytics:generate",
|
|
152
|
-
"template:analytics:template:generate",
|
|
153
|
-
"template:analytics:generate:template"
|
|
154
|
-
]
|
|
155
|
-
},
|
|
156
3
|
"template:generate:apex:class": {
|
|
157
4
|
"aliases": [
|
|
158
5
|
"force:apex:class:create",
|
|
@@ -528,15 +375,13 @@
|
|
|
528
375
|
"trigger:apex:generate:template"
|
|
529
376
|
]
|
|
530
377
|
},
|
|
531
|
-
"template:generate:
|
|
378
|
+
"template:generate:digital-experience:site": {
|
|
532
379
|
"aliases": [],
|
|
533
380
|
"args": {},
|
|
534
|
-
"description": "
|
|
381
|
+
"description": "Creates the metadata of an Experience Cloud site with the specified template, name, and URL path prefix. The output includes all the necessary metadata files, including DigitalExperienceConfig, DigitalExperienceBundle, Network, and CustomSite.\nUnlike `sf community create`, which builds the site directly in the org, this command generates only the local metadata.",
|
|
535
382
|
"examples": [
|
|
536
|
-
"Generate
|
|
537
|
-
"Generate an
|
|
538
|
-
"Generate a HomePage FlexiPage with a custom label:\n<%= config.bin %> <%= command.id %> --name Custom_Home --template HomePage --label \"Sales Home Page\"",
|
|
539
|
-
"Generate a RecordPage with dynamic highlights and detail fields:\n<%= config.bin %> <%= command.id %> --name Property_Page --template RecordPage --sobject Rental_Property__c --primary-field Name --secondary-fields Property_Address__c,City__c --detail-fields Name,Property_Address__c,City__c,Monthly_Rent__c,Bedrooms__c"
|
|
383
|
+
"Generate an Experience Cloud site using the Build Your Own (LWR) template. The site is called \"mysite\" and has the URL path prefix \"mysite\":\n<%= config.bin %> <%= command.id %> --template-name \"Build Your Own (LWR)\" --name mysite --url-path-prefix mysite",
|
|
384
|
+
"Generate an Experience Cloud site like the last example, but generate the files into the specified output directory:\n<%= config.bin %> <%= command.id %> --template-name \"Build Your Own (LWR)\" --name mysite --url-path-prefix mysite --output-dir force-app/main/default"
|
|
540
385
|
],
|
|
541
386
|
"flags": {
|
|
542
387
|
"json": {
|
|
@@ -554,170 +399,120 @@
|
|
|
554
399
|
"multiple": false,
|
|
555
400
|
"type": "option"
|
|
556
401
|
},
|
|
402
|
+
"target-org": {
|
|
403
|
+
"char": "o",
|
|
404
|
+
"name": "target-org",
|
|
405
|
+
"noCacheDefault": true,
|
|
406
|
+
"summary": "Username or alias of the target org.",
|
|
407
|
+
"hasDynamicHelp": true,
|
|
408
|
+
"multiple": false,
|
|
409
|
+
"type": "option"
|
|
410
|
+
},
|
|
557
411
|
"name": {
|
|
558
|
-
"aliases": [
|
|
559
|
-
"flexipagename"
|
|
560
|
-
],
|
|
561
412
|
"char": "n",
|
|
562
|
-
"deprecateAliases": true,
|
|
563
|
-
"description": "The name can contain only alphanumeric characters, must start with a letter, and can't end with an underscore or contain two consecutive underscores.",
|
|
564
413
|
"name": "name",
|
|
565
414
|
"required": true,
|
|
566
|
-
"summary": "Name of the
|
|
415
|
+
"summary": "Name of the Experience Cloud site to generate.",
|
|
567
416
|
"hasDynamicHelp": false,
|
|
568
417
|
"multiple": false,
|
|
569
418
|
"type": "option"
|
|
570
419
|
},
|
|
571
|
-
"template": {
|
|
420
|
+
"template-name": {
|
|
572
421
|
"char": "t",
|
|
573
|
-
"name": "template",
|
|
422
|
+
"name": "template-name",
|
|
574
423
|
"required": true,
|
|
575
|
-
"summary": "Template
|
|
424
|
+
"summary": "Template to use when generating the site.",
|
|
576
425
|
"hasDynamicHelp": false,
|
|
577
426
|
"multiple": false,
|
|
578
427
|
"options": [
|
|
579
|
-
"
|
|
580
|
-
"AppPage",
|
|
581
|
-
"HomePage"
|
|
582
|
-
],
|
|
583
|
-
"type": "option"
|
|
584
|
-
},
|
|
585
|
-
"output-dir": {
|
|
586
|
-
"aliases": [
|
|
587
|
-
"outputdir"
|
|
588
|
-
],
|
|
589
|
-
"char": "d",
|
|
590
|
-
"deprecateAliases": true,
|
|
591
|
-
"description": "The location can be an absolute path or relative to the current working directory. The default is the current directory.",
|
|
592
|
-
"name": "output-dir",
|
|
593
|
-
"summary": "Directory for saving the created files.",
|
|
594
|
-
"default": ".",
|
|
595
|
-
"hasDynamicHelp": false,
|
|
596
|
-
"multiple": false,
|
|
597
|
-
"type": "option"
|
|
598
|
-
},
|
|
599
|
-
"api-version": {
|
|
600
|
-
"aliases": [
|
|
601
|
-
"apiversion"
|
|
602
|
-
],
|
|
603
|
-
"deprecateAliases": true,
|
|
604
|
-
"description": "Override the api version used for api requests made by this command",
|
|
605
|
-
"name": "api-version",
|
|
606
|
-
"hasDynamicHelp": false,
|
|
607
|
-
"multiple": false,
|
|
608
|
-
"type": "option"
|
|
609
|
-
},
|
|
610
|
-
"label": {
|
|
611
|
-
"aliases": [
|
|
612
|
-
"masterlabel"
|
|
428
|
+
"Build Your Own (LWR)"
|
|
613
429
|
],
|
|
614
|
-
"deprecateAliases": true,
|
|
615
|
-
"name": "label",
|
|
616
|
-
"summary": "Label of this FlexiPage; if not specified, uses the FlexiPage name as the label.",
|
|
617
|
-
"hasDynamicHelp": false,
|
|
618
|
-
"multiple": false,
|
|
619
430
|
"type": "option"
|
|
620
431
|
},
|
|
621
|
-
"
|
|
622
|
-
"
|
|
623
|
-
"
|
|
432
|
+
"url-path-prefix": {
|
|
433
|
+
"char": "p",
|
|
434
|
+
"name": "url-path-prefix",
|
|
435
|
+
"summary": "URL path prefix for the site; must contain only alphanumeric characters.",
|
|
436
|
+
"default": "",
|
|
624
437
|
"hasDynamicHelp": false,
|
|
625
438
|
"multiple": false,
|
|
626
439
|
"type": "option"
|
|
627
440
|
},
|
|
628
|
-
"
|
|
629
|
-
"
|
|
630
|
-
|
|
631
|
-
|
|
632
|
-
],
|
|
633
|
-
"char": "s",
|
|
634
|
-
"deprecateAliases": true,
|
|
635
|
-
"description": "For RecordPage FlexiPages, you must specify the associated object API name, such as 'Account', 'Opportunity', or 'Custom_Object__c'. This sets the `sobjectType` field in the FlexiPage metadata.",
|
|
636
|
-
"name": "sobject",
|
|
637
|
-
"summary": "API name of the Salesforce object; required when creating a RecordPage.",
|
|
441
|
+
"admin-email": {
|
|
442
|
+
"char": "e",
|
|
443
|
+
"name": "admin-email",
|
|
444
|
+
"summary": "Email address for the site administrator. Defaults to the username of the currently authenticated user.",
|
|
638
445
|
"hasDynamicHelp": false,
|
|
639
446
|
"multiple": false,
|
|
640
447
|
"type": "option"
|
|
641
448
|
},
|
|
642
|
-
"
|
|
643
|
-
"
|
|
644
|
-
"
|
|
645
|
-
"
|
|
646
|
-
"
|
|
647
|
-
"type": "option"
|
|
648
|
-
},
|
|
649
|
-
"secondary-fields": {
|
|
650
|
-
"name": "secondary-fields",
|
|
651
|
-
"summary": "Secondary fields shown in the dynamic highlights header. Specify multiple fields separated by commas. Maximum of 11 fields. Used only with RecordPage.",
|
|
652
|
-
"delimiter": ",",
|
|
653
|
-
"hasDynamicHelp": false,
|
|
654
|
-
"multiple": true,
|
|
655
|
-
"type": "option"
|
|
656
|
-
},
|
|
657
|
-
"detail-fields": {
|
|
658
|
-
"name": "detail-fields",
|
|
659
|
-
"summary": "Fields to display in the Details tab. Specify multiple fields separated by commas. Fields are split into two columns. Used only with RecordPage.",
|
|
660
|
-
"delimiter": ",",
|
|
661
|
-
"hasDynamicHelp": false,
|
|
662
|
-
"multiple": true,
|
|
663
|
-
"type": "option"
|
|
664
|
-
},
|
|
665
|
-
"internal": {
|
|
666
|
-
"char": "i",
|
|
667
|
-
"hidden": true,
|
|
668
|
-
"name": "internal",
|
|
669
|
-
"summary": "Generate lightning bundles without creating a -meta.xml file.",
|
|
670
|
-
"allowNo": false,
|
|
671
|
-
"type": "boolean"
|
|
672
|
-
},
|
|
673
|
-
"loglevel": {
|
|
674
|
-
"deprecated": {
|
|
675
|
-
"message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable."
|
|
676
|
-
},
|
|
677
|
-
"hidden": true,
|
|
678
|
-
"name": "loglevel",
|
|
449
|
+
"output-dir": {
|
|
450
|
+
"char": "d",
|
|
451
|
+
"description": "The location can be an absolute path or relative to the current working directory. If not specified, the command reads your sfdx-project.json file and uses the default package directory. When running outside a Salesforce DX project, defaults to the current directory.",
|
|
452
|
+
"name": "output-dir",
|
|
453
|
+
"summary": "Directory to generate the site files in.",
|
|
679
454
|
"hasDynamicHelp": false,
|
|
680
455
|
"multiple": false,
|
|
681
456
|
"type": "option"
|
|
682
457
|
}
|
|
683
458
|
},
|
|
684
|
-
"hasDynamicHelp":
|
|
459
|
+
"hasDynamicHelp": true,
|
|
685
460
|
"hiddenAliases": [],
|
|
686
|
-
"id": "template:generate:
|
|
461
|
+
"id": "template:generate:digital-experience:site",
|
|
687
462
|
"pluginAlias": "@salesforce/plugin-templates",
|
|
688
463
|
"pluginName": "@salesforce/plugin-templates",
|
|
689
464
|
"pluginType": "core",
|
|
690
|
-
"state": "
|
|
465
|
+
"state": "preview",
|
|
691
466
|
"strict": true,
|
|
692
|
-
"summary": "Generate
|
|
467
|
+
"summary": "Generate an Experience Cloud site.",
|
|
693
468
|
"enableJsonFlag": true,
|
|
694
|
-
"MAX_SECONDARY_FIELDS": 11,
|
|
695
469
|
"isESM": true,
|
|
696
470
|
"relativePath": [
|
|
697
471
|
"lib",
|
|
698
472
|
"commands",
|
|
699
473
|
"template",
|
|
700
474
|
"generate",
|
|
701
|
-
"
|
|
702
|
-
"
|
|
475
|
+
"digital-experience",
|
|
476
|
+
"site.js"
|
|
703
477
|
],
|
|
704
478
|
"aliasPermutations": [],
|
|
705
479
|
"permutations": [
|
|
706
|
-
"template:generate:
|
|
707
|
-
"generate:template:
|
|
708
|
-
"generate:
|
|
709
|
-
"
|
|
710
|
-
"
|
|
711
|
-
"
|
|
480
|
+
"template:generate:digital-experience:site",
|
|
481
|
+
"generate:template:digital-experience:site",
|
|
482
|
+
"generate:digital-experience:template:site",
|
|
483
|
+
"generate:digital-experience:site:template",
|
|
484
|
+
"template:digital-experience:generate:site",
|
|
485
|
+
"digital-experience:template:generate:site",
|
|
486
|
+
"digital-experience:generate:template:site",
|
|
487
|
+
"digital-experience:generate:site:template",
|
|
488
|
+
"template:digital-experience:site:generate",
|
|
489
|
+
"digital-experience:template:site:generate",
|
|
490
|
+
"digital-experience:site:template:generate",
|
|
491
|
+
"digital-experience:site:generate:template",
|
|
492
|
+
"template:generate:site:digital-experience",
|
|
493
|
+
"generate:template:site:digital-experience",
|
|
494
|
+
"generate:site:template:digital-experience",
|
|
495
|
+
"generate:site:digital-experience:template",
|
|
496
|
+
"template:site:generate:digital-experience",
|
|
497
|
+
"site:template:generate:digital-experience",
|
|
498
|
+
"site:generate:template:digital-experience",
|
|
499
|
+
"site:generate:digital-experience:template",
|
|
500
|
+
"template:site:digital-experience:generate",
|
|
501
|
+
"site:template:digital-experience:generate",
|
|
502
|
+
"site:digital-experience:template:generate",
|
|
503
|
+
"site:digital-experience:generate:template"
|
|
712
504
|
]
|
|
713
505
|
},
|
|
714
|
-
"template:generate:
|
|
715
|
-
"aliases": [
|
|
506
|
+
"template:generate:analytics:template": {
|
|
507
|
+
"aliases": [
|
|
508
|
+
"force:analytics:template:create",
|
|
509
|
+
"analytics:generate:template"
|
|
510
|
+
],
|
|
716
511
|
"args": {},
|
|
717
|
-
"
|
|
512
|
+
"deprecateAliases": true,
|
|
513
|
+
"description": "The metadata files associated with the Analytics template must be contained in a parent directory called \"waveTemplates\" in your package directory. Either run this command from an existing directory of this name, or use the --output-dir flag to generate one or point to an existing one.",
|
|
718
514
|
"examples": [
|
|
719
|
-
"Generate
|
|
720
|
-
"Generate an Experience Cloud site like the last example, but generate the files into the specified output directory:\n<%= config.bin %> <%= command.id %> --template-name \"Build Your Own (LWR)\" --name mysite --url-path-prefix mysite --output-dir force-app/main/default"
|
|
515
|
+
"Generate the metadata files for a simple Analytics template file called myTemplate in the force-app/main/default/waveTemplates directory:\n<%= config.bin %> <%= command.id %> --name myTemplate --output-dir force-app/main/default/waveTemplates"
|
|
721
516
|
],
|
|
722
517
|
"flags": {
|
|
723
518
|
"json": {
|
|
@@ -735,72 +530,63 @@
|
|
|
735
530
|
"multiple": false,
|
|
736
531
|
"type": "option"
|
|
737
532
|
},
|
|
738
|
-
"
|
|
739
|
-
"
|
|
740
|
-
|
|
741
|
-
|
|
742
|
-
"
|
|
743
|
-
"
|
|
744
|
-
"
|
|
745
|
-
"
|
|
746
|
-
|
|
747
|
-
|
|
748
|
-
"char": "n",
|
|
749
|
-
"name": "name",
|
|
750
|
-
"required": true,
|
|
751
|
-
"summary": "Name of the Experience Cloud site to generate.",
|
|
533
|
+
"output-dir": {
|
|
534
|
+
"aliases": [
|
|
535
|
+
"outputdir"
|
|
536
|
+
],
|
|
537
|
+
"char": "d",
|
|
538
|
+
"deprecateAliases": true,
|
|
539
|
+
"description": "The location can be an absolute path or relative to the current working directory. The default is the current directory.",
|
|
540
|
+
"name": "output-dir",
|
|
541
|
+
"summary": "Directory for saving the created files.",
|
|
542
|
+
"default": ".",
|
|
752
543
|
"hasDynamicHelp": false,
|
|
753
544
|
"multiple": false,
|
|
754
545
|
"type": "option"
|
|
755
546
|
},
|
|
756
|
-
"
|
|
757
|
-
"
|
|
758
|
-
|
|
759
|
-
"required": true,
|
|
760
|
-
"summary": "Template to use when generating the site.",
|
|
761
|
-
"hasDynamicHelp": false,
|
|
762
|
-
"multiple": false,
|
|
763
|
-
"options": [
|
|
764
|
-
"Build Your Own (LWR)"
|
|
547
|
+
"api-version": {
|
|
548
|
+
"aliases": [
|
|
549
|
+
"apiversion"
|
|
765
550
|
],
|
|
766
|
-
"
|
|
767
|
-
|
|
768
|
-
|
|
769
|
-
"char": "p",
|
|
770
|
-
"name": "url-path-prefix",
|
|
771
|
-
"summary": "URL path prefix for the site; must contain only alphanumeric characters.",
|
|
772
|
-
"default": "",
|
|
551
|
+
"deprecateAliases": true,
|
|
552
|
+
"description": "Override the api version used for api requests made by this command",
|
|
553
|
+
"name": "api-version",
|
|
773
554
|
"hasDynamicHelp": false,
|
|
774
555
|
"multiple": false,
|
|
775
556
|
"type": "option"
|
|
776
557
|
},
|
|
777
|
-
"
|
|
778
|
-
"
|
|
779
|
-
|
|
780
|
-
|
|
558
|
+
"name": {
|
|
559
|
+
"aliases": [
|
|
560
|
+
"templatename"
|
|
561
|
+
],
|
|
562
|
+
"char": "n",
|
|
563
|
+
"deprecateAliases": true,
|
|
564
|
+
"name": "name",
|
|
565
|
+
"required": true,
|
|
566
|
+
"summary": "Name of the Analytics template.",
|
|
781
567
|
"hasDynamicHelp": false,
|
|
782
568
|
"multiple": false,
|
|
783
569
|
"type": "option"
|
|
784
570
|
},
|
|
785
|
-
"
|
|
786
|
-
"
|
|
787
|
-
|
|
788
|
-
|
|
789
|
-
"
|
|
571
|
+
"loglevel": {
|
|
572
|
+
"deprecated": {
|
|
573
|
+
"message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable."
|
|
574
|
+
},
|
|
575
|
+
"hidden": true,
|
|
576
|
+
"name": "loglevel",
|
|
790
577
|
"hasDynamicHelp": false,
|
|
791
578
|
"multiple": false,
|
|
792
579
|
"type": "option"
|
|
793
580
|
}
|
|
794
581
|
},
|
|
795
|
-
"hasDynamicHelp":
|
|
582
|
+
"hasDynamicHelp": false,
|
|
796
583
|
"hiddenAliases": [],
|
|
797
|
-
"id": "template:generate:
|
|
584
|
+
"id": "template:generate:analytics:template",
|
|
798
585
|
"pluginAlias": "@salesforce/plugin-templates",
|
|
799
586
|
"pluginName": "@salesforce/plugin-templates",
|
|
800
587
|
"pluginType": "core",
|
|
801
|
-
"state": "preview",
|
|
802
588
|
"strict": true,
|
|
803
|
-
"summary": "Generate
|
|
589
|
+
"summary": "Generate a simple Analytics template.",
|
|
804
590
|
"enableJsonFlag": true,
|
|
805
591
|
"isESM": true,
|
|
806
592
|
"relativePath": [
|
|
@@ -808,51 +594,77 @@
|
|
|
808
594
|
"commands",
|
|
809
595
|
"template",
|
|
810
596
|
"generate",
|
|
811
|
-
"
|
|
812
|
-
"
|
|
597
|
+
"analytics",
|
|
598
|
+
"template.js"
|
|
599
|
+
],
|
|
600
|
+
"aliasPermutations": [
|
|
601
|
+
"force:analytics:template:create",
|
|
602
|
+
"analytics:force:template:create",
|
|
603
|
+
"analytics:template:force:create",
|
|
604
|
+
"analytics:template:create:force",
|
|
605
|
+
"force:template:analytics:create",
|
|
606
|
+
"template:force:analytics:create",
|
|
607
|
+
"template:analytics:force:create",
|
|
608
|
+
"template:analytics:create:force",
|
|
609
|
+
"force:template:create:analytics",
|
|
610
|
+
"template:force:create:analytics",
|
|
611
|
+
"template:create:force:analytics",
|
|
612
|
+
"template:create:analytics:force",
|
|
613
|
+
"force:analytics:create:template",
|
|
614
|
+
"analytics:force:create:template",
|
|
615
|
+
"analytics:create:force:template",
|
|
616
|
+
"analytics:create:template:force",
|
|
617
|
+
"force:create:analytics:template",
|
|
618
|
+
"create:force:analytics:template",
|
|
619
|
+
"create:analytics:force:template",
|
|
620
|
+
"create:analytics:template:force",
|
|
621
|
+
"force:create:template:analytics",
|
|
622
|
+
"create:force:template:analytics",
|
|
623
|
+
"create:template:force:analytics",
|
|
624
|
+
"create:template:analytics:force",
|
|
625
|
+
"analytics:generate:template",
|
|
626
|
+
"generate:analytics:template",
|
|
627
|
+
"generate:template:analytics",
|
|
628
|
+
"analytics:template:generate",
|
|
629
|
+
"template:analytics:generate",
|
|
630
|
+
"template:generate:analytics"
|
|
813
631
|
],
|
|
814
|
-
"aliasPermutations": [],
|
|
815
632
|
"permutations": [
|
|
816
|
-
"template:generate:
|
|
817
|
-
"generate:template:
|
|
818
|
-
"generate:
|
|
819
|
-
"generate:
|
|
820
|
-
"template:
|
|
821
|
-
"
|
|
822
|
-
"
|
|
823
|
-
"
|
|
824
|
-
"template:
|
|
825
|
-
"
|
|
826
|
-
"
|
|
827
|
-
"
|
|
828
|
-
"template:generate:
|
|
829
|
-
"generate:template:
|
|
830
|
-
"generate:
|
|
831
|
-
"generate:
|
|
832
|
-
"template:
|
|
833
|
-
"
|
|
834
|
-
"
|
|
835
|
-
"
|
|
836
|
-
"template:
|
|
837
|
-
"
|
|
838
|
-
"
|
|
839
|
-
"
|
|
633
|
+
"template:generate:analytics:template",
|
|
634
|
+
"generate:template:analytics:template",
|
|
635
|
+
"generate:analytics:template:template",
|
|
636
|
+
"generate:analytics:template:template",
|
|
637
|
+
"template:analytics:generate:template",
|
|
638
|
+
"analytics:template:generate:template",
|
|
639
|
+
"analytics:generate:template:template",
|
|
640
|
+
"analytics:generate:template:template",
|
|
641
|
+
"template:analytics:template:generate",
|
|
642
|
+
"analytics:template:template:generate",
|
|
643
|
+
"analytics:template:template:generate",
|
|
644
|
+
"analytics:template:generate:template",
|
|
645
|
+
"template:generate:template:analytics",
|
|
646
|
+
"generate:template:template:analytics",
|
|
647
|
+
"generate:template:template:analytics",
|
|
648
|
+
"generate:template:analytics:template",
|
|
649
|
+
"template:template:generate:analytics",
|
|
650
|
+
"template:template:generate:analytics",
|
|
651
|
+
"template:generate:template:analytics",
|
|
652
|
+
"template:generate:analytics:template",
|
|
653
|
+
"template:template:analytics:generate",
|
|
654
|
+
"template:template:analytics:generate",
|
|
655
|
+
"template:analytics:template:generate",
|
|
656
|
+
"template:analytics:generate:template"
|
|
840
657
|
]
|
|
841
658
|
},
|
|
842
|
-
"template:generate:
|
|
843
|
-
"aliases": [
|
|
844
|
-
"force:project:create",
|
|
845
|
-
"project:generate"
|
|
846
|
-
],
|
|
659
|
+
"template:generate:flexipage": {
|
|
660
|
+
"aliases": [],
|
|
847
661
|
"args": {},
|
|
848
|
-
"
|
|
849
|
-
"description": "A Salesforce DX project has a specific structure and a configuration file (sfdx-project.json) that identifies the directory as a Salesforce DX project. This command generates the necessary configuration files and directories to get you started.\n\nBy default, the generated sfdx-project.json file sets the sourceApiVersion property to the default API version currently used by Salesforce CLI. To specify a different version, set the apiVersion configuration variable. For example: \"sf config set apiVersion=57.0 --global\".",
|
|
662
|
+
"description": "FlexiPages are the metadata types associated with a Lightning page. A Lightning page represents a customizable screen made up of regions containing Lightning components.\n\nYou can use this command to generate these types of FlexiPages; specify the type with the --template flag:\n\n- AppPage: A Lightning page used as the home page for a custom app or a standalone application page.\n- HomePage: A Lightning page used to override the Home page in Lightning Experience.\n- RecordPage: A Lightning page used to override an object record page in Lightning Experience. Requires that you specify the object name with the --sobject flag.",
|
|
850
663
|
"examples": [
|
|
851
|
-
"Generate a
|
|
852
|
-
"
|
|
853
|
-
"
|
|
854
|
-
"Generate a
|
|
855
|
-
"Generate a project in which the Lightning Web Components use TypeScript rather than the default JavaScript:\n<%= config.bin %> <%= command.id %> --name mywork --lwc-language typescript"
|
|
664
|
+
"Generate a RecordPage FlexiPage for the Account object in the current directory:\n<%= config.bin %> <%= command.id %> --name Account_Record_Page --template RecordPage --sobject Account",
|
|
665
|
+
"Generate an AppPage FlexiPage in the \"force-app/main/default/flexipages\" directory:\n<%= config.bin %> <%= command.id %> --name Sales_Dashboard --template AppPage --output-dir force-app/main/default/flexipages",
|
|
666
|
+
"Generate a HomePage FlexiPage with a custom label:\n<%= config.bin %> <%= command.id %> --name Custom_Home --template HomePage --label \"Sales Home Page\"",
|
|
667
|
+
"Generate a RecordPage with dynamic highlights and detail fields:\n<%= config.bin %> <%= command.id %> --name Property_Page --template RecordPage --sobject Rental_Property__c --primary-field Name --secondary-fields Property_Address__c,City__c --detail-fields Name,Property_Address__c,City__c,Monthly_Rent__c,Bedrooms__c"
|
|
856
668
|
],
|
|
857
669
|
"flags": {
|
|
858
670
|
"json": {
|
|
@@ -872,33 +684,29 @@
|
|
|
872
684
|
},
|
|
873
685
|
"name": {
|
|
874
686
|
"aliases": [
|
|
875
|
-
"
|
|
687
|
+
"flexipagename"
|
|
876
688
|
],
|
|
877
689
|
"char": "n",
|
|
878
690
|
"deprecateAliases": true,
|
|
879
|
-
"description": "
|
|
691
|
+
"description": "The name can contain only alphanumeric characters, must start with a letter, and can't end with an underscore or contain two consecutive underscores.",
|
|
880
692
|
"name": "name",
|
|
881
693
|
"required": true,
|
|
882
|
-
"summary": "Name of the
|
|
694
|
+
"summary": "Name of the FlexiPage.",
|
|
883
695
|
"hasDynamicHelp": false,
|
|
884
696
|
"multiple": false,
|
|
885
697
|
"type": "option"
|
|
886
698
|
},
|
|
887
699
|
"template": {
|
|
888
700
|
"char": "t",
|
|
889
|
-
"description": "The template determines the sample configuration files and directories that this command generates. For example, the empty template provides these files and directory to get you started.\n\n- .forceignore\n- config/project-scratch-def.json\n- sfdx-project.json\n- package.json\n- force-app (basic source directory structure)\n\nThe standard template provides a complete force-app directory structure so you know where to put your source. It also provides additional files and scripts, especially useful when using Salesforce Extensions for VS Code. For example:\n\n- .gitignore: Use Git for version control.\n- .prettierrc and .prettierignore: Use Prettier to format your Aura components.\n- .vscode/extensions.json: When launched, Visual Studio Code, prompts you to install the recommended extensions for your project.\n- .vscode/launch.json: Configures Replay Debugger.\n- .vscode/settings.json: Additional configuration settings.\n\nThe analytics template provides similar files and the force-app/main/default/waveTemplates directory.\n\nThe reactinternalapp and reactexternalapp templates provide React-based project scaffolding for internal and external UI bundle use cases.\n\nThe agent template provides project scaffolding for building Agentforce agents and includes a sample agent called Local Info Agent.",
|
|
890
701
|
"name": "template",
|
|
891
|
-
"
|
|
892
|
-
"
|
|
702
|
+
"required": true,
|
|
703
|
+
"summary": "Template type for the FlexiPage.",
|
|
893
704
|
"hasDynamicHelp": false,
|
|
894
705
|
"multiple": false,
|
|
895
706
|
"options": [
|
|
896
|
-
"
|
|
897
|
-
"
|
|
898
|
-
"
|
|
899
|
-
"reactinternalapp",
|
|
900
|
-
"reactexternalapp",
|
|
901
|
-
"agent"
|
|
707
|
+
"RecordPage",
|
|
708
|
+
"AppPage",
|
|
709
|
+
"HomePage"
|
|
902
710
|
],
|
|
903
711
|
"type": "option"
|
|
904
712
|
},
|
|
@@ -916,64 +724,80 @@
|
|
|
916
724
|
"multiple": false,
|
|
917
725
|
"type": "option"
|
|
918
726
|
},
|
|
919
|
-
"
|
|
920
|
-
"
|
|
921
|
-
|
|
922
|
-
|
|
923
|
-
"
|
|
727
|
+
"api-version": {
|
|
728
|
+
"aliases": [
|
|
729
|
+
"apiversion"
|
|
730
|
+
],
|
|
731
|
+
"deprecateAliases": true,
|
|
732
|
+
"description": "Override the api version used for api requests made by this command",
|
|
733
|
+
"name": "api-version",
|
|
924
734
|
"hasDynamicHelp": false,
|
|
925
735
|
"multiple": false,
|
|
926
736
|
"type": "option"
|
|
927
737
|
},
|
|
928
|
-
"
|
|
738
|
+
"label": {
|
|
929
739
|
"aliases": [
|
|
930
|
-
"
|
|
740
|
+
"masterlabel"
|
|
931
741
|
],
|
|
932
|
-
"char": "p",
|
|
933
742
|
"deprecateAliases": true,
|
|
934
|
-
"
|
|
935
|
-
"
|
|
936
|
-
"summary": "Default package directory name.",
|
|
937
|
-
"default": "force-app",
|
|
743
|
+
"name": "label",
|
|
744
|
+
"summary": "Label of this FlexiPage; if not specified, uses the FlexiPage name as the label.",
|
|
938
745
|
"hasDynamicHelp": false,
|
|
939
746
|
"multiple": false,
|
|
940
747
|
"type": "option"
|
|
941
748
|
},
|
|
942
|
-
"
|
|
943
|
-
"
|
|
944
|
-
"
|
|
945
|
-
"
|
|
946
|
-
"
|
|
947
|
-
"
|
|
948
|
-
"type": "boolean"
|
|
749
|
+
"description": {
|
|
750
|
+
"name": "description",
|
|
751
|
+
"summary": "Description for the FlexiPage, which provides context about its purpose.",
|
|
752
|
+
"hasDynamicHelp": false,
|
|
753
|
+
"multiple": false,
|
|
754
|
+
"type": "option"
|
|
949
755
|
},
|
|
950
|
-
"
|
|
756
|
+
"sobject": {
|
|
951
757
|
"aliases": [
|
|
952
|
-
"
|
|
758
|
+
"entity-name",
|
|
759
|
+
"entity"
|
|
953
760
|
],
|
|
954
|
-
"char": "
|
|
761
|
+
"char": "s",
|
|
955
762
|
"deprecateAliases": true,
|
|
956
|
-
"description": "
|
|
957
|
-
"
|
|
958
|
-
"
|
|
959
|
-
"
|
|
960
|
-
"
|
|
763
|
+
"description": "For RecordPage FlexiPages, you must specify the associated object API name, such as 'Account', 'Opportunity', or 'Custom_Object__c'. This sets the `sobjectType` field in the FlexiPage metadata.",
|
|
764
|
+
"name": "sobject",
|
|
765
|
+
"summary": "API name of the Salesforce object; required when creating a RecordPage.",
|
|
766
|
+
"hasDynamicHelp": false,
|
|
767
|
+
"multiple": false,
|
|
768
|
+
"type": "option"
|
|
769
|
+
},
|
|
770
|
+
"primary-field": {
|
|
771
|
+
"name": "primary-field",
|
|
772
|
+
"summary": "Primary field for the dynamic highlights header; typically 'Name'. Used only with RecordPage.",
|
|
773
|
+
"hasDynamicHelp": false,
|
|
774
|
+
"multiple": false,
|
|
775
|
+
"type": "option"
|
|
776
|
+
},
|
|
777
|
+
"secondary-fields": {
|
|
778
|
+
"name": "secondary-fields",
|
|
779
|
+
"summary": "Secondary fields shown in the dynamic highlights header. Specify multiple fields separated by commas. Maximum of 11 fields. Used only with RecordPage.",
|
|
780
|
+
"delimiter": ",",
|
|
961
781
|
"hasDynamicHelp": false,
|
|
962
|
-
"multiple":
|
|
782
|
+
"multiple": true,
|
|
963
783
|
"type": "option"
|
|
964
784
|
},
|
|
965
|
-
"
|
|
966
|
-
"
|
|
967
|
-
"
|
|
968
|
-
"
|
|
785
|
+
"detail-fields": {
|
|
786
|
+
"name": "detail-fields",
|
|
787
|
+
"summary": "Fields to display in the Details tab. Specify multiple fields separated by commas. Fields are split into two columns. Used only with RecordPage.",
|
|
788
|
+
"delimiter": ",",
|
|
969
789
|
"hasDynamicHelp": false,
|
|
970
|
-
"multiple":
|
|
971
|
-
"options": [
|
|
972
|
-
"javascript",
|
|
973
|
-
"typescript"
|
|
974
|
-
],
|
|
790
|
+
"multiple": true,
|
|
975
791
|
"type": "option"
|
|
976
792
|
},
|
|
793
|
+
"internal": {
|
|
794
|
+
"char": "i",
|
|
795
|
+
"hidden": true,
|
|
796
|
+
"name": "internal",
|
|
797
|
+
"summary": "Generate lightning bundles without creating a -meta.xml file.",
|
|
798
|
+
"allowNo": false,
|
|
799
|
+
"type": "boolean"
|
|
800
|
+
},
|
|
977
801
|
"loglevel": {
|
|
978
802
|
"deprecated": {
|
|
979
803
|
"message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable."
|
|
@@ -983,51 +807,36 @@
|
|
|
983
807
|
"hasDynamicHelp": false,
|
|
984
808
|
"multiple": false,
|
|
985
809
|
"type": "option"
|
|
986
|
-
},
|
|
987
|
-
"api-version": {
|
|
988
|
-
"description": "Override the api version used for api requests made by this command",
|
|
989
|
-
"name": "api-version",
|
|
990
|
-
"summary": "Will set this version as sourceApiVersion in the sfdx-project.json file",
|
|
991
|
-
"hasDynamicHelp": false,
|
|
992
|
-
"multiple": false,
|
|
993
|
-
"type": "option"
|
|
994
810
|
}
|
|
995
811
|
},
|
|
996
812
|
"hasDynamicHelp": false,
|
|
997
813
|
"hiddenAliases": [],
|
|
998
|
-
"id": "template:generate:
|
|
814
|
+
"id": "template:generate:flexipage",
|
|
999
815
|
"pluginAlias": "@salesforce/plugin-templates",
|
|
1000
816
|
"pluginName": "@salesforce/plugin-templates",
|
|
1001
817
|
"pluginType": "core",
|
|
818
|
+
"state": "beta",
|
|
1002
819
|
"strict": true,
|
|
1003
|
-
"summary": "Generate a
|
|
820
|
+
"summary": "Generate a FlexiPage, also known as a Lightning page.",
|
|
1004
821
|
"enableJsonFlag": true,
|
|
822
|
+
"MAX_SECONDARY_FIELDS": 11,
|
|
1005
823
|
"isESM": true,
|
|
1006
824
|
"relativePath": [
|
|
1007
825
|
"lib",
|
|
1008
826
|
"commands",
|
|
1009
827
|
"template",
|
|
1010
828
|
"generate",
|
|
1011
|
-
"
|
|
829
|
+
"flexipage",
|
|
1012
830
|
"index.js"
|
|
1013
831
|
],
|
|
1014
|
-
"aliasPermutations": [
|
|
1015
|
-
"force:project:create",
|
|
1016
|
-
"project:force:create",
|
|
1017
|
-
"project:create:force",
|
|
1018
|
-
"force:create:project",
|
|
1019
|
-
"create:force:project",
|
|
1020
|
-
"create:project:force",
|
|
1021
|
-
"project:generate",
|
|
1022
|
-
"generate:project"
|
|
1023
|
-
],
|
|
832
|
+
"aliasPermutations": [],
|
|
1024
833
|
"permutations": [
|
|
1025
|
-
"template:generate:
|
|
1026
|
-
"generate:template:
|
|
1027
|
-
"generate:
|
|
1028
|
-
"template:
|
|
1029
|
-
"
|
|
1030
|
-
"
|
|
834
|
+
"template:generate:flexipage",
|
|
835
|
+
"generate:template:flexipage",
|
|
836
|
+
"generate:flexipage:template",
|
|
837
|
+
"template:flexipage:generate",
|
|
838
|
+
"flexipage:template:generate",
|
|
839
|
+
"flexipage:generate:template"
|
|
1031
840
|
]
|
|
1032
841
|
},
|
|
1033
842
|
"template:generate:lightning:app": {
|
|
@@ -1074,7 +883,7 @@
|
|
|
1074
883
|
},
|
|
1075
884
|
"template": {
|
|
1076
885
|
"char": "t",
|
|
1077
|
-
"description": "Supplied parameter values or default values are filled into a copy of the template.",
|
|
886
|
+
"description": "Supplied parameter values or default values are filled into a copy of the template. For Lightning Web Components, if this flag isn't specified, the CLI command automatically selects the template based on the \"defaultLwcLanguage\" field in the DX project's \"sfdx-project.json\" file.",
|
|
1078
887
|
"name": "template",
|
|
1079
888
|
"summary": "Template to use for file creation.",
|
|
1080
889
|
"default": "DefaultLightningApp",
|
|
@@ -1218,7 +1027,8 @@
|
|
|
1218
1027
|
"Generate the metadata files for an Aura component bundle in the current directory:\n<%= config.bin %> <%= command.id %> --name mycomponent",
|
|
1219
1028
|
"Generate a Lightning web component bundle in the current directory:\n<%= config.bin %> <%= command.id %> --name mycomponent --type lwc",
|
|
1220
1029
|
"Generate an Aura component bundle in the \"force-app/main/default/aura\" directory:\n<%= config.bin %> <%= command.id %> --name mycomponent --output-dir force-app/main/default/aura",
|
|
1221
|
-
"Generate a Lightning web component bundle in the \"force-app/main/default/lwc\" directory:\n<%= config.bin %> <%= command.id %> --name mycomponent --type lwc --output-dir force-app/main/default/lwc"
|
|
1030
|
+
"Generate a Lightning web component bundle in the \"force-app/main/default/lwc\" directory:\n<%= config.bin %> <%= command.id %> --name mycomponent --type lwc --output-dir force-app/main/default/lwc",
|
|
1031
|
+
"Generate a TypeScript Lightning Web Component:\n<%= config.bin %> <%= command.id %> --name mycomponent --type lwc --template typescript"
|
|
1222
1032
|
],
|
|
1223
1033
|
"flags": {
|
|
1224
1034
|
"json": {
|
|
@@ -1252,7 +1062,7 @@
|
|
|
1252
1062
|
},
|
|
1253
1063
|
"template": {
|
|
1254
1064
|
"char": "t",
|
|
1255
|
-
"description": "Supplied parameter values or default values are filled into a copy of the template.",
|
|
1065
|
+
"description": "Supplied parameter values or default values are filled into a copy of the template. For Lightning Web Components, if this flag isn't specified, the CLI command automatically selects the template based on the \"defaultLwcLanguage\" field in the DX project's \"sfdx-project.json\" file.",
|
|
1256
1066
|
"name": "template",
|
|
1257
1067
|
"summary": "Template to use for file creation.",
|
|
1258
1068
|
"default": "default",
|
|
@@ -1261,7 +1071,8 @@
|
|
|
1261
1071
|
"options": [
|
|
1262
1072
|
"default",
|
|
1263
1073
|
"analyticsDashboard",
|
|
1264
|
-
"analyticsDashboardWithStep"
|
|
1074
|
+
"analyticsDashboardWithStep",
|
|
1075
|
+
"typescript"
|
|
1265
1076
|
],
|
|
1266
1077
|
"type": "option"
|
|
1267
1078
|
},
|
|
@@ -1442,7 +1253,7 @@
|
|
|
1442
1253
|
},
|
|
1443
1254
|
"template": {
|
|
1444
1255
|
"char": "t",
|
|
1445
|
-
"description": "Supplied parameter values or default values are filled into a copy of the template.",
|
|
1256
|
+
"description": "Supplied parameter values or default values are filled into a copy of the template. For Lightning Web Components, if this flag isn't specified, the CLI command automatically selects the template based on the \"defaultLwcLanguage\" field in the DX project's \"sfdx-project.json\" file.",
|
|
1446
1257
|
"name": "template",
|
|
1447
1258
|
"summary": "Template to use for file creation.",
|
|
1448
1259
|
"default": "DefaultLightningEvt",
|
|
@@ -1618,7 +1429,7 @@
|
|
|
1618
1429
|
},
|
|
1619
1430
|
"template": {
|
|
1620
1431
|
"char": "t",
|
|
1621
|
-
"description": "Supplied parameter values or default values are filled into a copy of the template.",
|
|
1432
|
+
"description": "Supplied parameter values or default values are filled into a copy of the template. For Lightning Web Components, if this flag isn't specified, the CLI command automatically selects the template based on the \"defaultLwcLanguage\" field in the DX project's \"sfdx-project.json\" file.",
|
|
1622
1433
|
"name": "template",
|
|
1623
1434
|
"summary": "Template to use for file creation.",
|
|
1624
1435
|
"default": "DefaultLightningIntf",
|
|
@@ -1794,7 +1605,7 @@
|
|
|
1794
1605
|
},
|
|
1795
1606
|
"template": {
|
|
1796
1607
|
"char": "t",
|
|
1797
|
-
"description": "Supplied parameter values or default values are filled into a copy of the template.",
|
|
1608
|
+
"description": "Supplied parameter values or default values are filled into a copy of the template. For Lightning Web Components, if this flag isn't specified, the CLI command automatically selects the template based on the \"defaultLwcLanguage\" field in the DX project's \"sfdx-project.json\" file.",
|
|
1798
1609
|
"name": "template",
|
|
1799
1610
|
"summary": "Template to use for file creation.",
|
|
1800
1611
|
"default": "DefaultLightningTest",
|
|
@@ -1926,6 +1737,197 @@
|
|
|
1926
1737
|
"test:lightning:generate:template"
|
|
1927
1738
|
]
|
|
1928
1739
|
},
|
|
1740
|
+
"template:generate:project": {
|
|
1741
|
+
"aliases": [
|
|
1742
|
+
"force:project:create",
|
|
1743
|
+
"project:generate"
|
|
1744
|
+
],
|
|
1745
|
+
"args": {},
|
|
1746
|
+
"deprecateAliases": true,
|
|
1747
|
+
"description": "A Salesforce DX project has a specific structure and a configuration file (sfdx-project.json) that identifies the directory as a Salesforce DX project. This command generates the necessary configuration files and directories to get you started.\n\nBy default, the generated sfdx-project.json file sets the sourceApiVersion property to the default API version currently used by Salesforce CLI. To specify a different version, set the apiVersion configuration variable. For example: \"sf config set apiVersion=57.0 --global\".",
|
|
1748
|
+
"examples": [
|
|
1749
|
+
"Generate a project called \"mywork\":\n<%= config.bin %> <%= command.id %> --name mywork",
|
|
1750
|
+
"Similar to previous example, but generate the files in a directory called \"myapp\":\n<%= config.bin %> <%= command.id %> --name mywork --default-package-dir myapp",
|
|
1751
|
+
"Similar to prevoius example, but also generate a default package.xml manifest file:\n<%= config.bin %> <%= command.id %> --name mywork --default-package-dir myapp --manifest",
|
|
1752
|
+
"Generate a project with the minimum files and directories:\n<%= config.bin %> <%= command.id %> --name mywork --template empty",
|
|
1753
|
+
"Generate a project in which the Lightning Web Components use TypeScript rather than the default JavaScript:\n<%= config.bin %> <%= command.id %> --name mywork --lwc-language typescript"
|
|
1754
|
+
],
|
|
1755
|
+
"flags": {
|
|
1756
|
+
"json": {
|
|
1757
|
+
"description": "Format output as json.",
|
|
1758
|
+
"helpGroup": "GLOBAL",
|
|
1759
|
+
"name": "json",
|
|
1760
|
+
"allowNo": false,
|
|
1761
|
+
"type": "boolean"
|
|
1762
|
+
},
|
|
1763
|
+
"flags-dir": {
|
|
1764
|
+
"helpGroup": "GLOBAL",
|
|
1765
|
+
"name": "flags-dir",
|
|
1766
|
+
"summary": "Import flag values from a directory.",
|
|
1767
|
+
"hasDynamicHelp": false,
|
|
1768
|
+
"multiple": false,
|
|
1769
|
+
"type": "option"
|
|
1770
|
+
},
|
|
1771
|
+
"name": {
|
|
1772
|
+
"aliases": [
|
|
1773
|
+
"projectname"
|
|
1774
|
+
],
|
|
1775
|
+
"char": "n",
|
|
1776
|
+
"deprecateAliases": true,
|
|
1777
|
+
"description": "Generates a project directory with this name; any valid directory name is accepted. Also sets the \"name\" property in the sfdx-project.json file to this name.",
|
|
1778
|
+
"name": "name",
|
|
1779
|
+
"required": true,
|
|
1780
|
+
"summary": "Name of the generated project.",
|
|
1781
|
+
"hasDynamicHelp": false,
|
|
1782
|
+
"multiple": false,
|
|
1783
|
+
"type": "option"
|
|
1784
|
+
},
|
|
1785
|
+
"template": {
|
|
1786
|
+
"char": "t",
|
|
1787
|
+
"description": "The template determines the sample configuration files and directories that this command generates. For example, the empty template provides these files and directory to get you started.\n\n- .forceignore\n- config/project-scratch-def.json\n- sfdx-project.json\n- package.json\n- force-app (basic source directory structure)\n\nThe standard template provides a complete force-app directory structure so you know where to put your source. It also provides additional files and scripts, especially useful when using Salesforce Extensions for VS Code. For example:\n\n- .gitignore: Use Git for version control.\n- .prettierrc and .prettierignore: Use Prettier to format your Aura components.\n- .vscode/extensions.json: When launched, Visual Studio Code, prompts you to install the recommended extensions for your project.\n- .vscode/launch.json: Configures Replay Debugger.\n- .vscode/settings.json: Additional configuration settings.\n\nThe analytics template provides similar files and the force-app/main/default/waveTemplates directory.\n\nThe reactinternalapp and reactexternalapp templates provide React-based project scaffolding for internal and external UI bundle use cases.\n\nThe agent template provides project scaffolding for building Agentforce agents and includes a sample agent called Local Info Agent.",
|
|
1788
|
+
"name": "template",
|
|
1789
|
+
"summary": "Template to use for project creation.",
|
|
1790
|
+
"default": "standard",
|
|
1791
|
+
"hasDynamicHelp": false,
|
|
1792
|
+
"multiple": false,
|
|
1793
|
+
"options": [
|
|
1794
|
+
"standard",
|
|
1795
|
+
"empty",
|
|
1796
|
+
"analytics",
|
|
1797
|
+
"reactinternalapp",
|
|
1798
|
+
"reactexternalapp",
|
|
1799
|
+
"agent"
|
|
1800
|
+
],
|
|
1801
|
+
"type": "option"
|
|
1802
|
+
},
|
|
1803
|
+
"output-dir": {
|
|
1804
|
+
"aliases": [
|
|
1805
|
+
"outputdir"
|
|
1806
|
+
],
|
|
1807
|
+
"char": "d",
|
|
1808
|
+
"deprecateAliases": true,
|
|
1809
|
+
"description": "The location can be an absolute path or relative to the current working directory. The default is the current directory.",
|
|
1810
|
+
"name": "output-dir",
|
|
1811
|
+
"summary": "Directory for saving the created files.",
|
|
1812
|
+
"default": ".",
|
|
1813
|
+
"hasDynamicHelp": false,
|
|
1814
|
+
"multiple": false,
|
|
1815
|
+
"type": "option"
|
|
1816
|
+
},
|
|
1817
|
+
"namespace": {
|
|
1818
|
+
"char": "s",
|
|
1819
|
+
"name": "namespace",
|
|
1820
|
+
"summary": "Namespace associated with this project and any connected scratch orgs.",
|
|
1821
|
+
"default": "",
|
|
1822
|
+
"hasDynamicHelp": false,
|
|
1823
|
+
"multiple": false,
|
|
1824
|
+
"type": "option"
|
|
1825
|
+
},
|
|
1826
|
+
"default-package-dir": {
|
|
1827
|
+
"aliases": [
|
|
1828
|
+
"defaultpackagedir"
|
|
1829
|
+
],
|
|
1830
|
+
"char": "p",
|
|
1831
|
+
"deprecateAliases": true,
|
|
1832
|
+
"description": "Metadata items such as classes and Lightning bundles are placed inside this folder.",
|
|
1833
|
+
"name": "default-package-dir",
|
|
1834
|
+
"summary": "Default package directory name.",
|
|
1835
|
+
"default": "force-app",
|
|
1836
|
+
"hasDynamicHelp": false,
|
|
1837
|
+
"multiple": false,
|
|
1838
|
+
"type": "option"
|
|
1839
|
+
},
|
|
1840
|
+
"manifest": {
|
|
1841
|
+
"char": "x",
|
|
1842
|
+
"description": "Generates a default manifest (package.xml) for fetching Apex, Visualforce, Lightning components, and static resources.",
|
|
1843
|
+
"name": "manifest",
|
|
1844
|
+
"summary": "Generate a manifest (package.xml) for change-set based development.",
|
|
1845
|
+
"allowNo": false,
|
|
1846
|
+
"type": "boolean"
|
|
1847
|
+
},
|
|
1848
|
+
"login-url": {
|
|
1849
|
+
"aliases": [
|
|
1850
|
+
"loginurl"
|
|
1851
|
+
],
|
|
1852
|
+
"char": "l",
|
|
1853
|
+
"deprecateAliases": true,
|
|
1854
|
+
"description": "Normally defaults to https://login.salesforce.com.",
|
|
1855
|
+
"hidden": true,
|
|
1856
|
+
"name": "login-url",
|
|
1857
|
+
"summary": "Salesforce instance login URL.",
|
|
1858
|
+
"default": "https://login.salesforce.com",
|
|
1859
|
+
"hasDynamicHelp": false,
|
|
1860
|
+
"multiple": false,
|
|
1861
|
+
"type": "option"
|
|
1862
|
+
},
|
|
1863
|
+
"lwc-language": {
|
|
1864
|
+
"description": "When set to `'typescript'`, generates TypeScript configuration files (tsconfig.json, package.json with TypeScript dependencies, and TypeScript-aware ESLint config). When you deploy the TypeScript-based Lightning Web Components, the TypeScript files are first compiled locally for validation and then the `.ts` files are deployed to your org for server-side type stripping.",
|
|
1865
|
+
"name": "lwc-language",
|
|
1866
|
+
"summary": "Language of the Lightning Web Components. If not specified, \"javascript\" is used.",
|
|
1867
|
+
"hasDynamicHelp": false,
|
|
1868
|
+
"multiple": false,
|
|
1869
|
+
"options": [
|
|
1870
|
+
"javascript",
|
|
1871
|
+
"typescript"
|
|
1872
|
+
],
|
|
1873
|
+
"type": "option"
|
|
1874
|
+
},
|
|
1875
|
+
"loglevel": {
|
|
1876
|
+
"deprecated": {
|
|
1877
|
+
"message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable."
|
|
1878
|
+
},
|
|
1879
|
+
"hidden": true,
|
|
1880
|
+
"name": "loglevel",
|
|
1881
|
+
"hasDynamicHelp": false,
|
|
1882
|
+
"multiple": false,
|
|
1883
|
+
"type": "option"
|
|
1884
|
+
},
|
|
1885
|
+
"api-version": {
|
|
1886
|
+
"description": "Override the api version used for api requests made by this command",
|
|
1887
|
+
"name": "api-version",
|
|
1888
|
+
"summary": "Will set this version as sourceApiVersion in the sfdx-project.json file",
|
|
1889
|
+
"hasDynamicHelp": false,
|
|
1890
|
+
"multiple": false,
|
|
1891
|
+
"type": "option"
|
|
1892
|
+
}
|
|
1893
|
+
},
|
|
1894
|
+
"hasDynamicHelp": false,
|
|
1895
|
+
"hiddenAliases": [],
|
|
1896
|
+
"id": "template:generate:project",
|
|
1897
|
+
"pluginAlias": "@salesforce/plugin-templates",
|
|
1898
|
+
"pluginName": "@salesforce/plugin-templates",
|
|
1899
|
+
"pluginType": "core",
|
|
1900
|
+
"strict": true,
|
|
1901
|
+
"summary": "Generate a Salesforce DX project.",
|
|
1902
|
+
"enableJsonFlag": true,
|
|
1903
|
+
"isESM": true,
|
|
1904
|
+
"relativePath": [
|
|
1905
|
+
"lib",
|
|
1906
|
+
"commands",
|
|
1907
|
+
"template",
|
|
1908
|
+
"generate",
|
|
1909
|
+
"project",
|
|
1910
|
+
"index.js"
|
|
1911
|
+
],
|
|
1912
|
+
"aliasPermutations": [
|
|
1913
|
+
"force:project:create",
|
|
1914
|
+
"project:force:create",
|
|
1915
|
+
"project:create:force",
|
|
1916
|
+
"force:create:project",
|
|
1917
|
+
"create:force:project",
|
|
1918
|
+
"create:project:force",
|
|
1919
|
+
"project:generate",
|
|
1920
|
+
"generate:project"
|
|
1921
|
+
],
|
|
1922
|
+
"permutations": [
|
|
1923
|
+
"template:generate:project",
|
|
1924
|
+
"generate:template:project",
|
|
1925
|
+
"generate:project:template",
|
|
1926
|
+
"template:project:generate",
|
|
1927
|
+
"project:template:generate",
|
|
1928
|
+
"project:generate:template"
|
|
1929
|
+
]
|
|
1930
|
+
},
|
|
1929
1931
|
"template:generate:static-resource": {
|
|
1930
1932
|
"aliases": [
|
|
1931
1933
|
"force:staticresource:create",
|
|
@@ -2514,5 +2516,5 @@
|
|
|
2514
2516
|
]
|
|
2515
2517
|
}
|
|
2516
2518
|
},
|
|
2517
|
-
"version": "56.
|
|
2519
|
+
"version": "56.15.1"
|
|
2518
2520
|
}
|