@salesforce/plugin-templates 56.17.7 → 56.18.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 +15 -15
- package/lib/commands/template/generate/lightning/embedding.d.ts +20 -0
- package/lib/commands/template/generate/lightning/embedding.js +75 -0
- package/lib/commands/template/generate/lightning/embedding.js.map +1 -0
- package/messages/lightningEmbedding.md +55 -0
- package/oclif.manifest.json +618 -450
- package/package.json +4 -4
package/oclif.manifest.json
CHANGED
|
@@ -1,5 +1,158 @@
|
|
|
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
|
+
},
|
|
3
156
|
"template:generate:apex:class": {
|
|
4
157
|
"aliases": [
|
|
5
158
|
"force:apex:class:create",
|
|
@@ -375,159 +528,6 @@
|
|
|
375
528
|
"trigger:apex:generate:template"
|
|
376
529
|
]
|
|
377
530
|
},
|
|
378
|
-
"template:generate:analytics:template": {
|
|
379
|
-
"aliases": [
|
|
380
|
-
"force:analytics:template:create",
|
|
381
|
-
"analytics:generate:template"
|
|
382
|
-
],
|
|
383
|
-
"args": {},
|
|
384
|
-
"deprecateAliases": true,
|
|
385
|
-
"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.",
|
|
386
|
-
"examples": [
|
|
387
|
-
"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"
|
|
388
|
-
],
|
|
389
|
-
"flags": {
|
|
390
|
-
"json": {
|
|
391
|
-
"description": "Format output as json.",
|
|
392
|
-
"helpGroup": "GLOBAL",
|
|
393
|
-
"name": "json",
|
|
394
|
-
"allowNo": false,
|
|
395
|
-
"type": "boolean"
|
|
396
|
-
},
|
|
397
|
-
"flags-dir": {
|
|
398
|
-
"helpGroup": "GLOBAL",
|
|
399
|
-
"name": "flags-dir",
|
|
400
|
-
"summary": "Import flag values from a directory.",
|
|
401
|
-
"hasDynamicHelp": false,
|
|
402
|
-
"multiple": false,
|
|
403
|
-
"type": "option"
|
|
404
|
-
},
|
|
405
|
-
"output-dir": {
|
|
406
|
-
"aliases": [
|
|
407
|
-
"outputdir"
|
|
408
|
-
],
|
|
409
|
-
"char": "d",
|
|
410
|
-
"deprecateAliases": true,
|
|
411
|
-
"description": "The location can be an absolute path or relative to the current working directory. The default is the current directory.",
|
|
412
|
-
"name": "output-dir",
|
|
413
|
-
"summary": "Directory for saving the created files.",
|
|
414
|
-
"default": ".",
|
|
415
|
-
"hasDynamicHelp": false,
|
|
416
|
-
"multiple": false,
|
|
417
|
-
"type": "option"
|
|
418
|
-
},
|
|
419
|
-
"api-version": {
|
|
420
|
-
"aliases": [
|
|
421
|
-
"apiversion"
|
|
422
|
-
],
|
|
423
|
-
"deprecateAliases": true,
|
|
424
|
-
"description": "Override the api version used for api requests made by this command",
|
|
425
|
-
"name": "api-version",
|
|
426
|
-
"hasDynamicHelp": false,
|
|
427
|
-
"multiple": false,
|
|
428
|
-
"type": "option"
|
|
429
|
-
},
|
|
430
|
-
"name": {
|
|
431
|
-
"aliases": [
|
|
432
|
-
"templatename"
|
|
433
|
-
],
|
|
434
|
-
"char": "n",
|
|
435
|
-
"deprecateAliases": true,
|
|
436
|
-
"name": "name",
|
|
437
|
-
"required": true,
|
|
438
|
-
"summary": "Name of the Analytics template.",
|
|
439
|
-
"hasDynamicHelp": false,
|
|
440
|
-
"multiple": false,
|
|
441
|
-
"type": "option"
|
|
442
|
-
},
|
|
443
|
-
"loglevel": {
|
|
444
|
-
"deprecated": {
|
|
445
|
-
"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."
|
|
446
|
-
},
|
|
447
|
-
"hidden": true,
|
|
448
|
-
"name": "loglevel",
|
|
449
|
-
"hasDynamicHelp": false,
|
|
450
|
-
"multiple": false,
|
|
451
|
-
"type": "option"
|
|
452
|
-
}
|
|
453
|
-
},
|
|
454
|
-
"hasDynamicHelp": false,
|
|
455
|
-
"hiddenAliases": [],
|
|
456
|
-
"id": "template:generate:analytics:template",
|
|
457
|
-
"pluginAlias": "@salesforce/plugin-templates",
|
|
458
|
-
"pluginName": "@salesforce/plugin-templates",
|
|
459
|
-
"pluginType": "core",
|
|
460
|
-
"strict": true,
|
|
461
|
-
"summary": "Generate a simple Analytics template.",
|
|
462
|
-
"enableJsonFlag": true,
|
|
463
|
-
"isESM": true,
|
|
464
|
-
"relativePath": [
|
|
465
|
-
"lib",
|
|
466
|
-
"commands",
|
|
467
|
-
"template",
|
|
468
|
-
"generate",
|
|
469
|
-
"analytics",
|
|
470
|
-
"template.js"
|
|
471
|
-
],
|
|
472
|
-
"aliasPermutations": [
|
|
473
|
-
"force:analytics:template:create",
|
|
474
|
-
"analytics:force:template:create",
|
|
475
|
-
"analytics:template:force:create",
|
|
476
|
-
"analytics:template:create:force",
|
|
477
|
-
"force:template:analytics:create",
|
|
478
|
-
"template:force:analytics:create",
|
|
479
|
-
"template:analytics:force:create",
|
|
480
|
-
"template:analytics:create:force",
|
|
481
|
-
"force:template:create:analytics",
|
|
482
|
-
"template:force:create:analytics",
|
|
483
|
-
"template:create:force:analytics",
|
|
484
|
-
"template:create:analytics:force",
|
|
485
|
-
"force:analytics:create:template",
|
|
486
|
-
"analytics:force:create:template",
|
|
487
|
-
"analytics:create:force:template",
|
|
488
|
-
"analytics:create:template:force",
|
|
489
|
-
"force:create:analytics:template",
|
|
490
|
-
"create:force:analytics:template",
|
|
491
|
-
"create:analytics:force:template",
|
|
492
|
-
"create:analytics:template:force",
|
|
493
|
-
"force:create:template:analytics",
|
|
494
|
-
"create:force:template:analytics",
|
|
495
|
-
"create:template:force:analytics",
|
|
496
|
-
"create:template:analytics:force",
|
|
497
|
-
"analytics:generate:template",
|
|
498
|
-
"generate:analytics:template",
|
|
499
|
-
"generate:template:analytics",
|
|
500
|
-
"analytics:template:generate",
|
|
501
|
-
"template:analytics:generate",
|
|
502
|
-
"template:generate:analytics"
|
|
503
|
-
],
|
|
504
|
-
"permutations": [
|
|
505
|
-
"template:generate:analytics:template",
|
|
506
|
-
"generate:template:analytics:template",
|
|
507
|
-
"generate:analytics:template:template",
|
|
508
|
-
"generate:analytics:template:template",
|
|
509
|
-
"template:analytics:generate:template",
|
|
510
|
-
"analytics:template:generate:template",
|
|
511
|
-
"analytics:generate:template:template",
|
|
512
|
-
"analytics:generate:template:template",
|
|
513
|
-
"template:analytics:template:generate",
|
|
514
|
-
"analytics:template:template:generate",
|
|
515
|
-
"analytics:template:template:generate",
|
|
516
|
-
"analytics:template:generate:template",
|
|
517
|
-
"template:generate:template:analytics",
|
|
518
|
-
"generate:template:template:analytics",
|
|
519
|
-
"generate:template:template:analytics",
|
|
520
|
-
"generate:template:analytics:template",
|
|
521
|
-
"template:template:generate:analytics",
|
|
522
|
-
"template:template:generate:analytics",
|
|
523
|
-
"template:generate:template:analytics",
|
|
524
|
-
"template:generate:analytics:template",
|
|
525
|
-
"template:template:analytics:generate",
|
|
526
|
-
"template:template:analytics:generate",
|
|
527
|
-
"template:analytics:template:generate",
|
|
528
|
-
"template:analytics:generate:template"
|
|
529
|
-
]
|
|
530
|
-
},
|
|
531
531
|
"template:generate:digital-experience:site": {
|
|
532
532
|
"aliases": [],
|
|
533
533
|
"args": {},
|
|
@@ -663,196 +663,8 @@
|
|
|
663
663
|
"examples": [
|
|
664
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
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"
|
|
668
|
-
],
|
|
669
|
-
"flags": {
|
|
670
|
-
"json": {
|
|
671
|
-
"description": "Format output as json.",
|
|
672
|
-
"helpGroup": "GLOBAL",
|
|
673
|
-
"name": "json",
|
|
674
|
-
"allowNo": false,
|
|
675
|
-
"type": "boolean"
|
|
676
|
-
},
|
|
677
|
-
"flags-dir": {
|
|
678
|
-
"helpGroup": "GLOBAL",
|
|
679
|
-
"name": "flags-dir",
|
|
680
|
-
"summary": "Import flag values from a directory.",
|
|
681
|
-
"hasDynamicHelp": false,
|
|
682
|
-
"multiple": false,
|
|
683
|
-
"type": "option"
|
|
684
|
-
},
|
|
685
|
-
"name": {
|
|
686
|
-
"aliases": [
|
|
687
|
-
"flexipagename"
|
|
688
|
-
],
|
|
689
|
-
"char": "n",
|
|
690
|
-
"deprecateAliases": true,
|
|
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.",
|
|
692
|
-
"name": "name",
|
|
693
|
-
"required": true,
|
|
694
|
-
"summary": "Name of the FlexiPage.",
|
|
695
|
-
"hasDynamicHelp": false,
|
|
696
|
-
"multiple": false,
|
|
697
|
-
"type": "option"
|
|
698
|
-
},
|
|
699
|
-
"template": {
|
|
700
|
-
"char": "t",
|
|
701
|
-
"name": "template",
|
|
702
|
-
"required": true,
|
|
703
|
-
"summary": "Template type for the FlexiPage.",
|
|
704
|
-
"hasDynamicHelp": false,
|
|
705
|
-
"multiple": false,
|
|
706
|
-
"options": [
|
|
707
|
-
"RecordPage",
|
|
708
|
-
"AppPage",
|
|
709
|
-
"HomePage"
|
|
710
|
-
],
|
|
711
|
-
"type": "option"
|
|
712
|
-
},
|
|
713
|
-
"output-dir": {
|
|
714
|
-
"aliases": [
|
|
715
|
-
"outputdir"
|
|
716
|
-
],
|
|
717
|
-
"char": "d",
|
|
718
|
-
"deprecateAliases": true,
|
|
719
|
-
"description": "The location can be an absolute path or relative to the current working directory. The default is the current directory.",
|
|
720
|
-
"name": "output-dir",
|
|
721
|
-
"summary": "Directory for saving the created files.",
|
|
722
|
-
"default": ".",
|
|
723
|
-
"hasDynamicHelp": false,
|
|
724
|
-
"multiple": false,
|
|
725
|
-
"type": "option"
|
|
726
|
-
},
|
|
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",
|
|
734
|
-
"hasDynamicHelp": false,
|
|
735
|
-
"multiple": false,
|
|
736
|
-
"type": "option"
|
|
737
|
-
},
|
|
738
|
-
"label": {
|
|
739
|
-
"aliases": [
|
|
740
|
-
"masterlabel"
|
|
741
|
-
],
|
|
742
|
-
"deprecateAliases": true,
|
|
743
|
-
"name": "label",
|
|
744
|
-
"summary": "Label of this FlexiPage; if not specified, uses the FlexiPage name as the label.",
|
|
745
|
-
"hasDynamicHelp": false,
|
|
746
|
-
"multiple": false,
|
|
747
|
-
"type": "option"
|
|
748
|
-
},
|
|
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"
|
|
755
|
-
},
|
|
756
|
-
"sobject": {
|
|
757
|
-
"aliases": [
|
|
758
|
-
"entity-name",
|
|
759
|
-
"entity"
|
|
760
|
-
],
|
|
761
|
-
"char": "s",
|
|
762
|
-
"deprecateAliases": true,
|
|
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": ",",
|
|
781
|
-
"hasDynamicHelp": false,
|
|
782
|
-
"multiple": true,
|
|
783
|
-
"type": "option"
|
|
784
|
-
},
|
|
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": ",",
|
|
789
|
-
"hasDynamicHelp": false,
|
|
790
|
-
"multiple": true,
|
|
791
|
-
"type": "option"
|
|
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
|
-
},
|
|
801
|
-
"loglevel": {
|
|
802
|
-
"deprecated": {
|
|
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."
|
|
804
|
-
},
|
|
805
|
-
"hidden": true,
|
|
806
|
-
"name": "loglevel",
|
|
807
|
-
"hasDynamicHelp": false,
|
|
808
|
-
"multiple": false,
|
|
809
|
-
"type": "option"
|
|
810
|
-
}
|
|
811
|
-
},
|
|
812
|
-
"hasDynamicHelp": false,
|
|
813
|
-
"hiddenAliases": [],
|
|
814
|
-
"id": "template:generate:flexipage",
|
|
815
|
-
"pluginAlias": "@salesforce/plugin-templates",
|
|
816
|
-
"pluginName": "@salesforce/plugin-templates",
|
|
817
|
-
"pluginType": "core",
|
|
818
|
-
"state": "beta",
|
|
819
|
-
"strict": true,
|
|
820
|
-
"summary": "Generate a FlexiPage, also known as a Lightning page.",
|
|
821
|
-
"enableJsonFlag": true,
|
|
822
|
-
"MAX_SECONDARY_FIELDS": 11,
|
|
823
|
-
"isESM": true,
|
|
824
|
-
"relativePath": [
|
|
825
|
-
"lib",
|
|
826
|
-
"commands",
|
|
827
|
-
"template",
|
|
828
|
-
"generate",
|
|
829
|
-
"flexipage",
|
|
830
|
-
"index.js"
|
|
831
|
-
],
|
|
832
|
-
"aliasPermutations": [],
|
|
833
|
-
"permutations": [
|
|
834
|
-
"template:generate:flexipage",
|
|
835
|
-
"generate:template:flexipage",
|
|
836
|
-
"generate:flexipage:template",
|
|
837
|
-
"template:flexipage:generate",
|
|
838
|
-
"flexipage:template:generate",
|
|
839
|
-
"flexipage:generate:template"
|
|
840
|
-
]
|
|
841
|
-
},
|
|
842
|
-
"template:generate:project": {
|
|
843
|
-
"aliases": [
|
|
844
|
-
"force:project:create",
|
|
845
|
-
"project:generate"
|
|
846
|
-
],
|
|
847
|
-
"args": {},
|
|
848
|
-
"deprecateAliases": true,
|
|
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\".",
|
|
850
|
-
"examples": [
|
|
851
|
-
"Generate a project called \"mywork\":\n<%= config.bin %> <%= command.id %> --name mywork",
|
|
852
|
-
"Similar to previous example, but generate the files in a directory called \"myapp\":\n<%= config.bin %> <%= command.id %> --name mywork --default-package-dir myapp",
|
|
853
|
-
"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",
|
|
854
|
-
"Generate a project with the minimum files and directories:\n<%= config.bin %> <%= command.id %> --name mywork --template empty",
|
|
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"
|
|
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
|
-
"summary": "Salesforce instance login URL.",
|
|
960
|
-
"default": "https://login.salesforce.com",
|
|
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.",
|
|
961
766
|
"hasDynamicHelp": false,
|
|
962
767
|
"multiple": false,
|
|
963
768
|
"type": "option"
|
|
964
769
|
},
|
|
965
|
-
"
|
|
966
|
-
"
|
|
967
|
-
"
|
|
968
|
-
"summary": "Language of the Lightning Web Components. If not specified, \"javascript\" is used.",
|
|
770
|
+
"primary-field": {
|
|
771
|
+
"name": "primary-field",
|
|
772
|
+
"summary": "Primary field for the dynamic highlights header; typically 'Name'. Used only with RecordPage.",
|
|
969
773
|
"hasDynamicHelp": false,
|
|
970
774
|
"multiple": false,
|
|
971
|
-
"options": [
|
|
972
|
-
"javascript",
|
|
973
|
-
"typescript"
|
|
974
|
-
],
|
|
975
775
|
"type": "option"
|
|
976
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": ",",
|
|
781
|
+
"hasDynamicHelp": false,
|
|
782
|
+
"multiple": true,
|
|
783
|
+
"type": "option"
|
|
784
|
+
},
|
|
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": ",",
|
|
789
|
+
"hasDynamicHelp": false,
|
|
790
|
+
"multiple": true,
|
|
791
|
+
"type": "option"
|
|
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": {
|
|
@@ -1400,6 +1209,174 @@
|
|
|
1400
1209
|
"component:lightning:generate:template"
|
|
1401
1210
|
]
|
|
1402
1211
|
},
|
|
1212
|
+
"template:generate:lightning:embedding": {
|
|
1213
|
+
"aliases": [],
|
|
1214
|
+
"args": {},
|
|
1215
|
+
"description": "The generated LWC bundle consumes the first-party <lightning-embedding> component, which is pre-wired with the three required attributes: the widget URL (src), iframe sandbox tokens, and an accessible iframe title (shell-title).\n\nThe generated LWC bundle contains four files (.html, .js, .js-meta.xml, .css) in a directory named with the camelCased component name. The bundle must live under a parent folder named \"lwc\".",
|
|
1216
|
+
"examples": [
|
|
1217
|
+
"Generate an embedding wrapper LWC in the current directory:\n<%= config.bin %> <%= command.id %> --name MyEmbeddingWrapper --src https://app.example.com --sandbox allow-forms --shell-title \"Expense Report Widget\"",
|
|
1218
|
+
"Generate an embedding wrapper LWC in the \"force-app/main/default/lwc\" directory with multiple sandbox tokens:\n<%= config.bin %> <%= command.id %> --name MyEmbeddingWrapper --src https://app.example.com --sandbox allow-forms --sandbox allow-scripts --shell-title \"Expense Report Widget\" --output-dir force-app/main/default/lwc"
|
|
1219
|
+
],
|
|
1220
|
+
"flags": {
|
|
1221
|
+
"json": {
|
|
1222
|
+
"description": "Format output as json.",
|
|
1223
|
+
"helpGroup": "GLOBAL",
|
|
1224
|
+
"name": "json",
|
|
1225
|
+
"allowNo": false,
|
|
1226
|
+
"type": "boolean"
|
|
1227
|
+
},
|
|
1228
|
+
"flags-dir": {
|
|
1229
|
+
"helpGroup": "GLOBAL",
|
|
1230
|
+
"name": "flags-dir",
|
|
1231
|
+
"summary": "Import flag values from a directory.",
|
|
1232
|
+
"hasDynamicHelp": false,
|
|
1233
|
+
"multiple": false,
|
|
1234
|
+
"type": "option"
|
|
1235
|
+
},
|
|
1236
|
+
"name": {
|
|
1237
|
+
"char": "n",
|
|
1238
|
+
"description": "The component name is also used (camelCased) as the LWC folder name and file stem. Must contain only alphanumeric characters and start with a letter.",
|
|
1239
|
+
"name": "name",
|
|
1240
|
+
"required": true,
|
|
1241
|
+
"summary": "Name of the generated component; must be in PascalCase format.",
|
|
1242
|
+
"hasDynamicHelp": false,
|
|
1243
|
+
"multiple": false,
|
|
1244
|
+
"type": "option"
|
|
1245
|
+
},
|
|
1246
|
+
"src": {
|
|
1247
|
+
"char": "s",
|
|
1248
|
+
"description": "The URL is bound to the <lightning-embedding> \"src\" attribute as a reactive property in the generated LWC. Must use HTTPS; plain HTTP is allowed only for localhost or 127.0.0.1 (for local development).",
|
|
1249
|
+
"name": "src",
|
|
1250
|
+
"required": true,
|
|
1251
|
+
"summary": "Absolute HTTPS URL that the iframe will load.",
|
|
1252
|
+
"hasDynamicHelp": false,
|
|
1253
|
+
"multiple": false,
|
|
1254
|
+
"type": "option"
|
|
1255
|
+
},
|
|
1256
|
+
"sandbox": {
|
|
1257
|
+
"description": "Each token is written into the space-separated \"sandbox\" attribute on <lightning-embedding>. Only W3C-defined sandbox tokens are accepted.",
|
|
1258
|
+
"name": "sandbox",
|
|
1259
|
+
"required": true,
|
|
1260
|
+
"summary": "Iframe sandbox token. Specify this flag multiple times to set more than one token.",
|
|
1261
|
+
"hasDynamicHelp": false,
|
|
1262
|
+
"multiple": true,
|
|
1263
|
+
"options": [
|
|
1264
|
+
"allow-forms",
|
|
1265
|
+
"allow-modals",
|
|
1266
|
+
"allow-orientation-lock",
|
|
1267
|
+
"allow-pointer-lock",
|
|
1268
|
+
"allow-popups",
|
|
1269
|
+
"allow-popups-to-escape-sandbox",
|
|
1270
|
+
"allow-presentation",
|
|
1271
|
+
"allow-same-origin",
|
|
1272
|
+
"allow-scripts",
|
|
1273
|
+
"allow-storage-access-by-user-activation",
|
|
1274
|
+
"allow-top-navigation",
|
|
1275
|
+
"allow-top-navigation-by-user-activation"
|
|
1276
|
+
],
|
|
1277
|
+
"type": "option"
|
|
1278
|
+
},
|
|
1279
|
+
"shell-title": {
|
|
1280
|
+
"description": "Written to the \"shell-title\" attribute on <lightning-embedding> and used as the iframe's accessible name (announced by screen readers).",
|
|
1281
|
+
"name": "shell-title",
|
|
1282
|
+
"required": true,
|
|
1283
|
+
"summary": "Accessible title for the embedded iframe.",
|
|
1284
|
+
"hasDynamicHelp": false,
|
|
1285
|
+
"multiple": false,
|
|
1286
|
+
"type": "option"
|
|
1287
|
+
},
|
|
1288
|
+
"output-dir": {
|
|
1289
|
+
"aliases": [
|
|
1290
|
+
"outputdir"
|
|
1291
|
+
],
|
|
1292
|
+
"char": "d",
|
|
1293
|
+
"deprecateAliases": true,
|
|
1294
|
+
"description": "The location can be an absolute path or relative to the current working directory. The default is the current directory.",
|
|
1295
|
+
"name": "output-dir",
|
|
1296
|
+
"summary": "Directory for saving the created files.",
|
|
1297
|
+
"default": ".",
|
|
1298
|
+
"hasDynamicHelp": false,
|
|
1299
|
+
"multiple": false,
|
|
1300
|
+
"type": "option"
|
|
1301
|
+
},
|
|
1302
|
+
"api-version": {
|
|
1303
|
+
"aliases": [
|
|
1304
|
+
"apiversion"
|
|
1305
|
+
],
|
|
1306
|
+
"deprecateAliases": true,
|
|
1307
|
+
"description": "Override the api version used for api requests made by this command",
|
|
1308
|
+
"name": "api-version",
|
|
1309
|
+
"hasDynamicHelp": false,
|
|
1310
|
+
"multiple": false,
|
|
1311
|
+
"type": "option"
|
|
1312
|
+
},
|
|
1313
|
+
"internal": {
|
|
1314
|
+
"char": "i",
|
|
1315
|
+
"hidden": true,
|
|
1316
|
+
"name": "internal",
|
|
1317
|
+
"summary": "Generate lightning bundles without creating a -meta.xml file.",
|
|
1318
|
+
"allowNo": false,
|
|
1319
|
+
"type": "boolean"
|
|
1320
|
+
},
|
|
1321
|
+
"loglevel": {
|
|
1322
|
+
"deprecated": {
|
|
1323
|
+
"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."
|
|
1324
|
+
},
|
|
1325
|
+
"hidden": true,
|
|
1326
|
+
"name": "loglevel",
|
|
1327
|
+
"hasDynamicHelp": false,
|
|
1328
|
+
"multiple": false,
|
|
1329
|
+
"type": "option"
|
|
1330
|
+
}
|
|
1331
|
+
},
|
|
1332
|
+
"hasDynamicHelp": false,
|
|
1333
|
+
"hidden": true,
|
|
1334
|
+
"hiddenAliases": [],
|
|
1335
|
+
"id": "template:generate:lightning:embedding",
|
|
1336
|
+
"pluginAlias": "@salesforce/plugin-templates",
|
|
1337
|
+
"pluginName": "@salesforce/plugin-templates",
|
|
1338
|
+
"pluginType": "core",
|
|
1339
|
+
"state": "beta",
|
|
1340
|
+
"strict": true,
|
|
1341
|
+
"summary": "Generate a Lightning Web Component (LWC) bundle that wraps the lightning-embedding base component.",
|
|
1342
|
+
"enableJsonFlag": true,
|
|
1343
|
+
"isESM": true,
|
|
1344
|
+
"relativePath": [
|
|
1345
|
+
"lib",
|
|
1346
|
+
"commands",
|
|
1347
|
+
"template",
|
|
1348
|
+
"generate",
|
|
1349
|
+
"lightning",
|
|
1350
|
+
"embedding.js"
|
|
1351
|
+
],
|
|
1352
|
+
"aliasPermutations": [],
|
|
1353
|
+
"permutations": [
|
|
1354
|
+
"template:generate:lightning:embedding",
|
|
1355
|
+
"generate:template:lightning:embedding",
|
|
1356
|
+
"generate:lightning:template:embedding",
|
|
1357
|
+
"generate:lightning:embedding:template",
|
|
1358
|
+
"template:lightning:generate:embedding",
|
|
1359
|
+
"lightning:template:generate:embedding",
|
|
1360
|
+
"lightning:generate:template:embedding",
|
|
1361
|
+
"lightning:generate:embedding:template",
|
|
1362
|
+
"template:lightning:embedding:generate",
|
|
1363
|
+
"lightning:template:embedding:generate",
|
|
1364
|
+
"lightning:embedding:template:generate",
|
|
1365
|
+
"lightning:embedding:generate:template",
|
|
1366
|
+
"template:generate:embedding:lightning",
|
|
1367
|
+
"generate:template:embedding:lightning",
|
|
1368
|
+
"generate:embedding:template:lightning",
|
|
1369
|
+
"generate:embedding:lightning:template",
|
|
1370
|
+
"template:embedding:generate:lightning",
|
|
1371
|
+
"embedding:template:generate:lightning",
|
|
1372
|
+
"embedding:generate:template:lightning",
|
|
1373
|
+
"embedding:generate:lightning:template",
|
|
1374
|
+
"template:embedding:lightning:generate",
|
|
1375
|
+
"embedding:template:lightning:generate",
|
|
1376
|
+
"embedding:lightning:template:generate",
|
|
1377
|
+
"embedding:lightning:generate:template"
|
|
1378
|
+
]
|
|
1379
|
+
},
|
|
1403
1380
|
"template:generate:lightning:event": {
|
|
1404
1381
|
"aliases": [
|
|
1405
1382
|
"force:lightning:event:create",
|
|
@@ -1928,14 +1905,20 @@
|
|
|
1928
1905
|
"test:lightning:generate:template"
|
|
1929
1906
|
]
|
|
1930
1907
|
},
|
|
1931
|
-
"template:generate:
|
|
1932
|
-
"aliases": [
|
|
1908
|
+
"template:generate:project": {
|
|
1909
|
+
"aliases": [
|
|
1910
|
+
"force:project:create",
|
|
1911
|
+
"project:generate"
|
|
1912
|
+
],
|
|
1933
1913
|
"args": {},
|
|
1934
|
-
"
|
|
1914
|
+
"deprecateAliases": true,
|
|
1915
|
+
"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\".",
|
|
1935
1916
|
"examples": [
|
|
1936
|
-
"Generate a
|
|
1937
|
-
"
|
|
1938
|
-
"
|
|
1917
|
+
"Generate a project called \"mywork\":\n<%= config.bin %> <%= command.id %> --name mywork",
|
|
1918
|
+
"Similar to previous example, but generate the files in a directory called \"myapp\":\n<%= config.bin %> <%= command.id %> --name mywork --default-package-dir myapp",
|
|
1919
|
+
"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",
|
|
1920
|
+
"Generate a project with the minimum files and directories:\n<%= config.bin %> <%= command.id %> --name mywork --template empty",
|
|
1921
|
+
"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"
|
|
1939
1922
|
],
|
|
1940
1923
|
"flags": {
|
|
1941
1924
|
"json": {
|
|
@@ -1954,43 +1937,115 @@
|
|
|
1954
1937
|
"type": "option"
|
|
1955
1938
|
},
|
|
1956
1939
|
"name": {
|
|
1940
|
+
"aliases": [
|
|
1941
|
+
"projectname"
|
|
1942
|
+
],
|
|
1957
1943
|
"char": "n",
|
|
1958
|
-
"
|
|
1944
|
+
"deprecateAliases": true,
|
|
1945
|
+
"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.",
|
|
1959
1946
|
"name": "name",
|
|
1960
1947
|
"required": true,
|
|
1961
|
-
"summary": "
|
|
1948
|
+
"summary": "Name of the generated project.",
|
|
1962
1949
|
"hasDynamicHelp": false,
|
|
1963
1950
|
"multiple": false,
|
|
1964
1951
|
"type": "option"
|
|
1965
1952
|
},
|
|
1966
1953
|
"template": {
|
|
1967
1954
|
"char": "t",
|
|
1968
|
-
"description": "
|
|
1955
|
+
"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.",
|
|
1969
1956
|
"name": "template",
|
|
1970
|
-
"summary": "Template to use
|
|
1971
|
-
"default": "
|
|
1957
|
+
"summary": "Template to use for project creation.",
|
|
1958
|
+
"default": "standard",
|
|
1972
1959
|
"hasDynamicHelp": false,
|
|
1973
1960
|
"multiple": false,
|
|
1974
1961
|
"options": [
|
|
1975
|
-
"
|
|
1976
|
-
"
|
|
1962
|
+
"standard",
|
|
1963
|
+
"empty",
|
|
1964
|
+
"analytics",
|
|
1965
|
+
"reactinternalapp",
|
|
1966
|
+
"reactexternalapp",
|
|
1967
|
+
"agent"
|
|
1977
1968
|
],
|
|
1978
1969
|
"type": "option"
|
|
1979
1970
|
},
|
|
1980
|
-
"
|
|
1971
|
+
"output-dir": {
|
|
1972
|
+
"aliases": [
|
|
1973
|
+
"outputdir"
|
|
1974
|
+
],
|
|
1975
|
+
"char": "d",
|
|
1976
|
+
"deprecateAliases": true,
|
|
1977
|
+
"description": "The location can be an absolute path or relative to the current working directory. The default is the current directory.",
|
|
1978
|
+
"name": "output-dir",
|
|
1979
|
+
"summary": "Directory for saving the created files.",
|
|
1980
|
+
"default": ".",
|
|
1981
|
+
"hasDynamicHelp": false,
|
|
1982
|
+
"multiple": false,
|
|
1983
|
+
"type": "option"
|
|
1984
|
+
},
|
|
1985
|
+
"namespace": {
|
|
1986
|
+
"char": "s",
|
|
1987
|
+
"name": "namespace",
|
|
1988
|
+
"summary": "Namespace associated with this project and any connected scratch orgs.",
|
|
1989
|
+
"default": "",
|
|
1990
|
+
"hasDynamicHelp": false,
|
|
1991
|
+
"multiple": false,
|
|
1992
|
+
"type": "option"
|
|
1993
|
+
},
|
|
1994
|
+
"default-package-dir": {
|
|
1995
|
+
"aliases": [
|
|
1996
|
+
"defaultpackagedir"
|
|
1997
|
+
],
|
|
1998
|
+
"char": "p",
|
|
1999
|
+
"deprecateAliases": true,
|
|
2000
|
+
"description": "Metadata items such as classes and Lightning bundles are placed inside this folder.",
|
|
2001
|
+
"name": "default-package-dir",
|
|
2002
|
+
"summary": "Default package directory name.",
|
|
2003
|
+
"default": "force-app",
|
|
2004
|
+
"hasDynamicHelp": false,
|
|
2005
|
+
"multiple": false,
|
|
2006
|
+
"type": "option"
|
|
2007
|
+
},
|
|
2008
|
+
"manifest": {
|
|
2009
|
+
"char": "x",
|
|
2010
|
+
"description": "Generates a default manifest (package.xml) for fetching Apex, Visualforce, Lightning components, and static resources.",
|
|
2011
|
+
"name": "manifest",
|
|
2012
|
+
"summary": "Generate a manifest (package.xml) for change-set based development.",
|
|
2013
|
+
"allowNo": false,
|
|
2014
|
+
"type": "boolean"
|
|
2015
|
+
},
|
|
2016
|
+
"login-url": {
|
|
2017
|
+
"aliases": [
|
|
2018
|
+
"loginurl"
|
|
2019
|
+
],
|
|
1981
2020
|
"char": "l",
|
|
1982
|
-
"
|
|
1983
|
-
"
|
|
1984
|
-
"
|
|
2021
|
+
"deprecateAliases": true,
|
|
2022
|
+
"description": "Normally defaults to https://login.salesforce.com.",
|
|
2023
|
+
"hidden": true,
|
|
2024
|
+
"name": "login-url",
|
|
2025
|
+
"summary": "Salesforce instance login URL.",
|
|
2026
|
+
"default": "https://login.salesforce.com",
|
|
1985
2027
|
"hasDynamicHelp": false,
|
|
1986
2028
|
"multiple": false,
|
|
1987
2029
|
"type": "option"
|
|
1988
2030
|
},
|
|
1989
|
-
"
|
|
1990
|
-
"
|
|
1991
|
-
"
|
|
1992
|
-
"
|
|
1993
|
-
"
|
|
2031
|
+
"lwc-language": {
|
|
2032
|
+
"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.",
|
|
2033
|
+
"name": "lwc-language",
|
|
2034
|
+
"summary": "Language of the Lightning Web Components. If not specified, \"javascript\" is used.",
|
|
2035
|
+
"hasDynamicHelp": false,
|
|
2036
|
+
"multiple": false,
|
|
2037
|
+
"options": [
|
|
2038
|
+
"javascript",
|
|
2039
|
+
"typescript"
|
|
2040
|
+
],
|
|
2041
|
+
"type": "option"
|
|
2042
|
+
},
|
|
2043
|
+
"loglevel": {
|
|
2044
|
+
"deprecated": {
|
|
2045
|
+
"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."
|
|
2046
|
+
},
|
|
2047
|
+
"hidden": true,
|
|
2048
|
+
"name": "loglevel",
|
|
1994
2049
|
"hasDynamicHelp": false,
|
|
1995
2050
|
"multiple": false,
|
|
1996
2051
|
"type": "option"
|
|
@@ -1998,6 +2053,7 @@
|
|
|
1998
2053
|
"api-version": {
|
|
1999
2054
|
"description": "Override the api version used for api requests made by this command",
|
|
2000
2055
|
"name": "api-version",
|
|
2056
|
+
"summary": "Will set this version as sourceApiVersion in the sfdx-project.json file",
|
|
2001
2057
|
"hasDynamicHelp": false,
|
|
2002
2058
|
"multiple": false,
|
|
2003
2059
|
"type": "option"
|
|
@@ -2005,12 +2061,12 @@
|
|
|
2005
2061
|
},
|
|
2006
2062
|
"hasDynamicHelp": false,
|
|
2007
2063
|
"hiddenAliases": [],
|
|
2008
|
-
"id": "template:generate:
|
|
2064
|
+
"id": "template:generate:project",
|
|
2009
2065
|
"pluginAlias": "@salesforce/plugin-templates",
|
|
2010
2066
|
"pluginName": "@salesforce/plugin-templates",
|
|
2011
2067
|
"pluginType": "core",
|
|
2012
2068
|
"strict": true,
|
|
2013
|
-
"summary": "Generate a
|
|
2069
|
+
"summary": "Generate a Salesforce DX project.",
|
|
2014
2070
|
"enableJsonFlag": true,
|
|
2015
2071
|
"isESM": true,
|
|
2016
2072
|
"relativePath": [
|
|
@@ -2018,17 +2074,26 @@
|
|
|
2018
2074
|
"commands",
|
|
2019
2075
|
"template",
|
|
2020
2076
|
"generate",
|
|
2021
|
-
"
|
|
2077
|
+
"project",
|
|
2022
2078
|
"index.js"
|
|
2023
2079
|
],
|
|
2024
|
-
"aliasPermutations": [
|
|
2080
|
+
"aliasPermutations": [
|
|
2081
|
+
"force:project:create",
|
|
2082
|
+
"project:force:create",
|
|
2083
|
+
"project:create:force",
|
|
2084
|
+
"force:create:project",
|
|
2085
|
+
"create:force:project",
|
|
2086
|
+
"create:project:force",
|
|
2087
|
+
"project:generate",
|
|
2088
|
+
"generate:project"
|
|
2089
|
+
],
|
|
2025
2090
|
"permutations": [
|
|
2026
|
-
"template:generate:
|
|
2027
|
-
"generate:template:
|
|
2028
|
-
"generate:
|
|
2029
|
-
"template:
|
|
2030
|
-
"
|
|
2031
|
-
"
|
|
2091
|
+
"template:generate:project",
|
|
2092
|
+
"generate:template:project",
|
|
2093
|
+
"generate:project:template",
|
|
2094
|
+
"template:project:generate",
|
|
2095
|
+
"project:template:generate",
|
|
2096
|
+
"project:generate:template"
|
|
2032
2097
|
]
|
|
2033
2098
|
},
|
|
2034
2099
|
"template:generate:static-resource": {
|
|
@@ -2160,6 +2225,109 @@
|
|
|
2160
2225
|
"static-resource:generate:template"
|
|
2161
2226
|
]
|
|
2162
2227
|
},
|
|
2228
|
+
"template:generate:ui-bundle": {
|
|
2229
|
+
"aliases": [],
|
|
2230
|
+
"args": {},
|
|
2231
|
+
"description": "Salesforce provides native UI frameworks, such as Lighting Web Components (LWC), to build applications that run on the Salesforce Platform. But you can also use non-native JavaScript- or TypeScript-based UI frameworks, such as React, to build a UI experience for the Salesforce Platform and that you can launch from the App Launcher.\n\nThese non-native UI experiences are defined by the \"UIBundle\" metadata type in your DX project. Use this command to generate the required DX project structure and files. For example, when you run this command and specify the name MyUiBundle, then the files are generated into a \"uiBundles/MyUiBundle\" directory. Use the --output-dir flag to specify a different directory.\n\nUse the --template flag for generating the files to get started with a speciic UI framework, such as React. Check out the README.md file in the generated \"uiBundles/<bundlename>\" directory for more information about the template.",
|
|
2232
|
+
"examples": [
|
|
2233
|
+
"Generate a UI bundle called MyUiBundle in the current directory:\n<%= config.bin %> <%= command.id %> --name MyUiBundle",
|
|
2234
|
+
"Generate a React-based UI bundle:\n<%= config.bin %> <%= command.id %> --name MyReactApp --template reactbasic",
|
|
2235
|
+
"Generate the React-based UI bundle in the \"force-app/main/default/uiBundles\" directory:\n<%= config.bin %> <%= command.id %> --name MyUiBundle --template reactbasic --output-dir force-app/main/default/uiBundles"
|
|
2236
|
+
],
|
|
2237
|
+
"flags": {
|
|
2238
|
+
"json": {
|
|
2239
|
+
"description": "Format output as json.",
|
|
2240
|
+
"helpGroup": "GLOBAL",
|
|
2241
|
+
"name": "json",
|
|
2242
|
+
"allowNo": false,
|
|
2243
|
+
"type": "boolean"
|
|
2244
|
+
},
|
|
2245
|
+
"flags-dir": {
|
|
2246
|
+
"helpGroup": "GLOBAL",
|
|
2247
|
+
"name": "flags-dir",
|
|
2248
|
+
"summary": "Import flag values from a directory.",
|
|
2249
|
+
"hasDynamicHelp": false,
|
|
2250
|
+
"multiple": false,
|
|
2251
|
+
"type": "option"
|
|
2252
|
+
},
|
|
2253
|
+
"name": {
|
|
2254
|
+
"char": "n",
|
|
2255
|
+
"description": "This name can contain only underscores and alphanumeric characters, and must be unique in your org. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores.",
|
|
2256
|
+
"name": "name",
|
|
2257
|
+
"required": true,
|
|
2258
|
+
"summary": "API name of the generated UI bundle.",
|
|
2259
|
+
"hasDynamicHelp": false,
|
|
2260
|
+
"multiple": false,
|
|
2261
|
+
"type": "option"
|
|
2262
|
+
},
|
|
2263
|
+
"template": {
|
|
2264
|
+
"char": "t",
|
|
2265
|
+
"description": "Supplied parameter values or default values are filled into a copy of the template.",
|
|
2266
|
+
"name": "template",
|
|
2267
|
+
"summary": "Template to use when creating the files for a specific UI framework.",
|
|
2268
|
+
"default": "default",
|
|
2269
|
+
"hasDynamicHelp": false,
|
|
2270
|
+
"multiple": false,
|
|
2271
|
+
"options": [
|
|
2272
|
+
"default",
|
|
2273
|
+
"reactbasic"
|
|
2274
|
+
],
|
|
2275
|
+
"type": "option"
|
|
2276
|
+
},
|
|
2277
|
+
"label": {
|
|
2278
|
+
"char": "l",
|
|
2279
|
+
"description": "If not specified, the label is derived from the name.",
|
|
2280
|
+
"name": "label",
|
|
2281
|
+
"summary": "Master label for the UI bundle.",
|
|
2282
|
+
"hasDynamicHelp": false,
|
|
2283
|
+
"multiple": false,
|
|
2284
|
+
"type": "option"
|
|
2285
|
+
},
|
|
2286
|
+
"output-dir": {
|
|
2287
|
+
"char": "d",
|
|
2288
|
+
"description": "The location can be an absolute path or relative to the current working directory.\n\nIf not specified, the command reads your sfdx-project.json and defaults to \"uiBundles\" directory within your default package directory. When running outside a Salesforce DX project, defaults to the current directory.\n\n**Important:** This command automatically ensures the output directory ends with \"uiBundles\". If your specified path doesn't end with \"uiBundles\", it's automatically appended. The UI bundle is created at \"<output-dir>/<name>\".\n\n**Examples:**\n\n- \"--output-dir force-app/main/default\" → Creates a UI bundle at \"force-app/main/default/uiBundles/MyUiBundle/\"\n- \"--output-dir force-app/main/default/uiBundles\" → Creates a UI bundle at \"force-app/main/default/uiBundles/MyUiBundle/\" (no change)",
|
|
2289
|
+
"name": "output-dir",
|
|
2290
|
+
"summary": "Directory into which the files are created.",
|
|
2291
|
+
"hasDynamicHelp": false,
|
|
2292
|
+
"multiple": false,
|
|
2293
|
+
"type": "option"
|
|
2294
|
+
},
|
|
2295
|
+
"api-version": {
|
|
2296
|
+
"description": "Override the api version used for api requests made by this command",
|
|
2297
|
+
"name": "api-version",
|
|
2298
|
+
"hasDynamicHelp": false,
|
|
2299
|
+
"multiple": false,
|
|
2300
|
+
"type": "option"
|
|
2301
|
+
}
|
|
2302
|
+
},
|
|
2303
|
+
"hasDynamicHelp": false,
|
|
2304
|
+
"hiddenAliases": [],
|
|
2305
|
+
"id": "template:generate:ui-bundle",
|
|
2306
|
+
"pluginAlias": "@salesforce/plugin-templates",
|
|
2307
|
+
"pluginName": "@salesforce/plugin-templates",
|
|
2308
|
+
"pluginType": "core",
|
|
2309
|
+
"strict": true,
|
|
2310
|
+
"summary": "Generate a UI bundle, which contains the code and metadata to build a UI experience that uses non-native Salesforce frameworks, such as React.",
|
|
2311
|
+
"enableJsonFlag": true,
|
|
2312
|
+
"isESM": true,
|
|
2313
|
+
"relativePath": [
|
|
2314
|
+
"lib",
|
|
2315
|
+
"commands",
|
|
2316
|
+
"template",
|
|
2317
|
+
"generate",
|
|
2318
|
+
"ui-bundle",
|
|
2319
|
+
"index.js"
|
|
2320
|
+
],
|
|
2321
|
+
"aliasPermutations": [],
|
|
2322
|
+
"permutations": [
|
|
2323
|
+
"template:generate:ui-bundle",
|
|
2324
|
+
"generate:template:ui-bundle",
|
|
2325
|
+
"generate:ui-bundle:template",
|
|
2326
|
+
"template:ui-bundle:generate",
|
|
2327
|
+
"ui-bundle:template:generate",
|
|
2328
|
+
"ui-bundle:generate:template"
|
|
2329
|
+
]
|
|
2330
|
+
},
|
|
2163
2331
|
"template:generate:visualforce:component": {
|
|
2164
2332
|
"aliases": [
|
|
2165
2333
|
"force:visualforce:component:create",
|
|
@@ -2516,5 +2684,5 @@
|
|
|
2516
2684
|
]
|
|
2517
2685
|
}
|
|
2518
2686
|
},
|
|
2519
|
-
"version": "56.
|
|
2687
|
+
"version": "56.18.1"
|
|
2520
2688
|
}
|