@salesforce/plugin-templates 57.4.13 → 57.5.0
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 +100 -16
- package/lib/commands/template/generate/lightning-out/index.d.ts +0 -2
- package/lib/commands/template/generate/lightning-out/index.js +12 -9
- package/lib/commands/template/generate/lightning-out/index.js.map +1 -1
- package/messages/lightningOut.md +22 -10
- package/oclif.manifest.json +492 -492
- package/package.json +6 -6
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 `SF_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",
|
|
@@ -377,16 +530,13 @@
|
|
|
377
530
|
"trigger:apex:generate:template"
|
|
378
531
|
]
|
|
379
532
|
},
|
|
380
|
-
"template:generate:
|
|
381
|
-
"aliases": [
|
|
382
|
-
"force:analytics:template:create",
|
|
383
|
-
"analytics:generate:template"
|
|
384
|
-
],
|
|
533
|
+
"template:generate:digital-experience:site": {
|
|
534
|
+
"aliases": [],
|
|
385
535
|
"args": {},
|
|
386
|
-
"
|
|
387
|
-
"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.",
|
|
536
|
+
"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.",
|
|
388
537
|
"examples": [
|
|
389
|
-
"Generate
|
|
538
|
+
"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",
|
|
539
|
+
"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"
|
|
390
540
|
],
|
|
391
541
|
"flags": {
|
|
392
542
|
"json": {
|
|
@@ -404,63 +554,72 @@
|
|
|
404
554
|
"multiple": false,
|
|
405
555
|
"type": "option"
|
|
406
556
|
},
|
|
407
|
-
"
|
|
408
|
-
"
|
|
409
|
-
|
|
410
|
-
|
|
411
|
-
"
|
|
412
|
-
"
|
|
413
|
-
"
|
|
414
|
-
"
|
|
415
|
-
|
|
416
|
-
|
|
557
|
+
"target-org": {
|
|
558
|
+
"char": "o",
|
|
559
|
+
"name": "target-org",
|
|
560
|
+
"noCacheDefault": true,
|
|
561
|
+
"summary": "Username or alias of the target org.",
|
|
562
|
+
"hasDynamicHelp": true,
|
|
563
|
+
"multiple": false,
|
|
564
|
+
"type": "option"
|
|
565
|
+
},
|
|
566
|
+
"name": {
|
|
567
|
+
"char": "n",
|
|
568
|
+
"name": "name",
|
|
569
|
+
"required": true,
|
|
570
|
+
"summary": "Name of the Experience Cloud site to generate.",
|
|
417
571
|
"hasDynamicHelp": false,
|
|
418
572
|
"multiple": false,
|
|
419
573
|
"type": "option"
|
|
420
574
|
},
|
|
421
|
-
"
|
|
422
|
-
"
|
|
423
|
-
|
|
575
|
+
"template-name": {
|
|
576
|
+
"char": "t",
|
|
577
|
+
"name": "template-name",
|
|
578
|
+
"required": true,
|
|
579
|
+
"summary": "Template to use when generating the site.",
|
|
580
|
+
"hasDynamicHelp": false,
|
|
581
|
+
"multiple": false,
|
|
582
|
+
"options": [
|
|
583
|
+
"Build Your Own (LWR)"
|
|
424
584
|
],
|
|
425
|
-
"
|
|
426
|
-
|
|
427
|
-
|
|
585
|
+
"type": "option"
|
|
586
|
+
},
|
|
587
|
+
"url-path-prefix": {
|
|
588
|
+
"char": "p",
|
|
589
|
+
"name": "url-path-prefix",
|
|
590
|
+
"summary": "URL path prefix for the site; must contain only alphanumeric characters.",
|
|
591
|
+
"default": "",
|
|
428
592
|
"hasDynamicHelp": false,
|
|
429
593
|
"multiple": false,
|
|
430
594
|
"type": "option"
|
|
431
595
|
},
|
|
432
|
-
"
|
|
433
|
-
"
|
|
434
|
-
|
|
435
|
-
|
|
436
|
-
"char": "n",
|
|
437
|
-
"deprecateAliases": true,
|
|
438
|
-
"name": "name",
|
|
439
|
-
"required": true,
|
|
440
|
-
"summary": "Name of the Analytics template.",
|
|
596
|
+
"admin-email": {
|
|
597
|
+
"char": "e",
|
|
598
|
+
"name": "admin-email",
|
|
599
|
+
"summary": "Email address for the site administrator. Defaults to the username of the currently authenticated user.",
|
|
441
600
|
"hasDynamicHelp": false,
|
|
442
601
|
"multiple": false,
|
|
443
602
|
"type": "option"
|
|
444
603
|
},
|
|
445
|
-
"
|
|
446
|
-
"
|
|
447
|
-
|
|
448
|
-
|
|
449
|
-
"
|
|
450
|
-
"name": "loglevel",
|
|
604
|
+
"output-dir": {
|
|
605
|
+
"char": "d",
|
|
606
|
+
"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.",
|
|
607
|
+
"name": "output-dir",
|
|
608
|
+
"summary": "Directory to generate the site files in.",
|
|
451
609
|
"hasDynamicHelp": false,
|
|
452
610
|
"multiple": false,
|
|
453
611
|
"type": "option"
|
|
454
612
|
}
|
|
455
613
|
},
|
|
456
|
-
"hasDynamicHelp":
|
|
614
|
+
"hasDynamicHelp": true,
|
|
457
615
|
"hiddenAliases": [],
|
|
458
|
-
"id": "template:generate:
|
|
616
|
+
"id": "template:generate:digital-experience:site",
|
|
459
617
|
"pluginAlias": "@salesforce/plugin-templates",
|
|
460
618
|
"pluginName": "@salesforce/plugin-templates",
|
|
461
619
|
"pluginType": "core",
|
|
620
|
+
"state": "preview",
|
|
462
621
|
"strict": true,
|
|
463
|
-
"summary": "Generate
|
|
622
|
+
"summary": "Generate an Experience Cloud site.",
|
|
464
623
|
"enableJsonFlag": true,
|
|
465
624
|
"isESM": true,
|
|
466
625
|
"relativePath": [
|
|
@@ -468,167 +627,8 @@
|
|
|
468
627
|
"commands",
|
|
469
628
|
"template",
|
|
470
629
|
"generate",
|
|
471
|
-
"
|
|
472
|
-
"
|
|
473
|
-
],
|
|
474
|
-
"aliasPermutations": [
|
|
475
|
-
"force:analytics:template:create",
|
|
476
|
-
"analytics:force:template:create",
|
|
477
|
-
"analytics:template:force:create",
|
|
478
|
-
"analytics:template:create:force",
|
|
479
|
-
"force:template:analytics:create",
|
|
480
|
-
"template:force:analytics:create",
|
|
481
|
-
"template:analytics:force:create",
|
|
482
|
-
"template:analytics:create:force",
|
|
483
|
-
"force:template:create:analytics",
|
|
484
|
-
"template:force:create:analytics",
|
|
485
|
-
"template:create:force:analytics",
|
|
486
|
-
"template:create:analytics:force",
|
|
487
|
-
"force:analytics:create:template",
|
|
488
|
-
"analytics:force:create:template",
|
|
489
|
-
"analytics:create:force:template",
|
|
490
|
-
"analytics:create:template:force",
|
|
491
|
-
"force:create:analytics:template",
|
|
492
|
-
"create:force:analytics:template",
|
|
493
|
-
"create:analytics:force:template",
|
|
494
|
-
"create:analytics:template:force",
|
|
495
|
-
"force:create:template:analytics",
|
|
496
|
-
"create:force:template:analytics",
|
|
497
|
-
"create:template:force:analytics",
|
|
498
|
-
"create:template:analytics:force",
|
|
499
|
-
"analytics:generate:template",
|
|
500
|
-
"generate:analytics:template",
|
|
501
|
-
"generate:template:analytics",
|
|
502
|
-
"analytics:template:generate",
|
|
503
|
-
"template:analytics:generate",
|
|
504
|
-
"template:generate:analytics"
|
|
505
|
-
],
|
|
506
|
-
"permutations": [
|
|
507
|
-
"template:generate:analytics:template",
|
|
508
|
-
"generate:template:analytics:template",
|
|
509
|
-
"generate:analytics:template:template",
|
|
510
|
-
"generate:analytics:template:template",
|
|
511
|
-
"template:analytics:generate:template",
|
|
512
|
-
"analytics:template:generate:template",
|
|
513
|
-
"analytics:generate:template:template",
|
|
514
|
-
"analytics:generate:template:template",
|
|
515
|
-
"template:analytics:template:generate",
|
|
516
|
-
"analytics:template:template:generate",
|
|
517
|
-
"analytics:template:template:generate",
|
|
518
|
-
"analytics:template:generate:template",
|
|
519
|
-
"template:generate:template:analytics",
|
|
520
|
-
"generate:template:template:analytics",
|
|
521
|
-
"generate:template:template:analytics",
|
|
522
|
-
"generate:template:analytics:template",
|
|
523
|
-
"template:template:generate:analytics",
|
|
524
|
-
"template:template:generate:analytics",
|
|
525
|
-
"template:generate:template:analytics",
|
|
526
|
-
"template:generate:analytics:template",
|
|
527
|
-
"template:template:analytics:generate",
|
|
528
|
-
"template:template:analytics:generate",
|
|
529
|
-
"template:analytics:template:generate",
|
|
530
|
-
"template:analytics:generate:template"
|
|
531
|
-
]
|
|
532
|
-
},
|
|
533
|
-
"template:generate:digital-experience:site": {
|
|
534
|
-
"aliases": [],
|
|
535
|
-
"args": {},
|
|
536
|
-
"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.",
|
|
537
|
-
"examples": [
|
|
538
|
-
"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",
|
|
539
|
-
"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
|
-
],
|
|
541
|
-
"flags": {
|
|
542
|
-
"json": {
|
|
543
|
-
"description": "Format output as json.",
|
|
544
|
-
"helpGroup": "GLOBAL",
|
|
545
|
-
"name": "json",
|
|
546
|
-
"allowNo": false,
|
|
547
|
-
"type": "boolean"
|
|
548
|
-
},
|
|
549
|
-
"flags-dir": {
|
|
550
|
-
"helpGroup": "GLOBAL",
|
|
551
|
-
"name": "flags-dir",
|
|
552
|
-
"summary": "Import flag values from a directory.",
|
|
553
|
-
"hasDynamicHelp": false,
|
|
554
|
-
"multiple": false,
|
|
555
|
-
"type": "option"
|
|
556
|
-
},
|
|
557
|
-
"target-org": {
|
|
558
|
-
"char": "o",
|
|
559
|
-
"name": "target-org",
|
|
560
|
-
"noCacheDefault": true,
|
|
561
|
-
"summary": "Username or alias of the target org.",
|
|
562
|
-
"hasDynamicHelp": true,
|
|
563
|
-
"multiple": false,
|
|
564
|
-
"type": "option"
|
|
565
|
-
},
|
|
566
|
-
"name": {
|
|
567
|
-
"char": "n",
|
|
568
|
-
"name": "name",
|
|
569
|
-
"required": true,
|
|
570
|
-
"summary": "Name of the Experience Cloud site to generate.",
|
|
571
|
-
"hasDynamicHelp": false,
|
|
572
|
-
"multiple": false,
|
|
573
|
-
"type": "option"
|
|
574
|
-
},
|
|
575
|
-
"template-name": {
|
|
576
|
-
"char": "t",
|
|
577
|
-
"name": "template-name",
|
|
578
|
-
"required": true,
|
|
579
|
-
"summary": "Template to use when generating the site.",
|
|
580
|
-
"hasDynamicHelp": false,
|
|
581
|
-
"multiple": false,
|
|
582
|
-
"options": [
|
|
583
|
-
"Build Your Own (LWR)"
|
|
584
|
-
],
|
|
585
|
-
"type": "option"
|
|
586
|
-
},
|
|
587
|
-
"url-path-prefix": {
|
|
588
|
-
"char": "p",
|
|
589
|
-
"name": "url-path-prefix",
|
|
590
|
-
"summary": "URL path prefix for the site; must contain only alphanumeric characters.",
|
|
591
|
-
"default": "",
|
|
592
|
-
"hasDynamicHelp": false,
|
|
593
|
-
"multiple": false,
|
|
594
|
-
"type": "option"
|
|
595
|
-
},
|
|
596
|
-
"admin-email": {
|
|
597
|
-
"char": "e",
|
|
598
|
-
"name": "admin-email",
|
|
599
|
-
"summary": "Email address for the site administrator. Defaults to the username of the currently authenticated user.",
|
|
600
|
-
"hasDynamicHelp": false,
|
|
601
|
-
"multiple": false,
|
|
602
|
-
"type": "option"
|
|
603
|
-
},
|
|
604
|
-
"output-dir": {
|
|
605
|
-
"char": "d",
|
|
606
|
-
"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.",
|
|
607
|
-
"name": "output-dir",
|
|
608
|
-
"summary": "Directory to generate the site files in.",
|
|
609
|
-
"hasDynamicHelp": false,
|
|
610
|
-
"multiple": false,
|
|
611
|
-
"type": "option"
|
|
612
|
-
}
|
|
613
|
-
},
|
|
614
|
-
"hasDynamicHelp": true,
|
|
615
|
-
"hiddenAliases": [],
|
|
616
|
-
"id": "template:generate:digital-experience:site",
|
|
617
|
-
"pluginAlias": "@salesforce/plugin-templates",
|
|
618
|
-
"pluginName": "@salesforce/plugin-templates",
|
|
619
|
-
"pluginType": "core",
|
|
620
|
-
"state": "preview",
|
|
621
|
-
"strict": true,
|
|
622
|
-
"summary": "Generate an Experience Cloud site.",
|
|
623
|
-
"enableJsonFlag": true,
|
|
624
|
-
"isESM": true,
|
|
625
|
-
"relativePath": [
|
|
626
|
-
"lib",
|
|
627
|
-
"commands",
|
|
628
|
-
"template",
|
|
629
|
-
"generate",
|
|
630
|
-
"digital-experience",
|
|
631
|
-
"site.js"
|
|
630
|
+
"digital-experience",
|
|
631
|
+
"site.js"
|
|
632
632
|
],
|
|
633
633
|
"aliasPermutations": [],
|
|
634
634
|
"permutations": [
|
|
@@ -841,6 +841,149 @@
|
|
|
841
841
|
"flexipage:generate:template"
|
|
842
842
|
]
|
|
843
843
|
},
|
|
844
|
+
"template:generate:lightning-out": {
|
|
845
|
+
"aliases": [],
|
|
846
|
+
"args": {},
|
|
847
|
+
"description": "Lightning Out 2.0 lets you embed custom Lightning web components (LWCs) into your external, non-Salesforce apps.\n\nThis command gets you started by generating the seven metadata artifact types that a Lightning Out 2.0 app requires into your Salesforce DX project: LightningOutApp, MyDomain and Security settings, one CorsWhitelistOrigin per host domain, and the three External Client Application OAuth components (ExternalClientApplication, ExtlClntAppGlobalOauthSettings, ExtlClntAppOauthSettings). The command only generates files. It doesn't deploy any metadata to an org.\n\nInputs can come from a --definition-file JSON, individual flags, or both. Flag values take precedence over the file on a per-key basis. The command validates the types of definition-file fields; the underlying generator performs the remaining structural validation, such as required fields and formats.",
|
|
848
|
+
"examples": [
|
|
849
|
+
"Generate a Lightning Out 2.0 app using individual flags to specify the values:\n<%= config.bin %> <%= command.id %> --app-name MyLoApp --runtime LWR_CORE --host-domains https://example.com --eca-name MyLoAppEca --eca-contact-email dev@example.com --eca-callback-url https://example.com/cb",
|
|
850
|
+
"Generate an app using the values in a JSON definition file called lo-def.json:\n<%= config.bin %> <%= command.id %> --definition-file lo-def.json",
|
|
851
|
+
"Generate the app into a specific directory:\n<%= config.bin %> <%= command.id %> --definition-file lo-def.json --output-dir force-app/main/default",
|
|
852
|
+
"Generate a CLWR app for an Experience Cloud site using a definition file:\n<%= config.bin %> <%= command.id %> --runtime CLWR --definition-file lo-def.json",
|
|
853
|
+
"Generate the app using most of the values from a definition file, but the --host-domains value overrides its equivalent in the file:\n<%= config.bin %> <%= command.id %> --definition-file lo-def.json --host-domains https://staging.example.com"
|
|
854
|
+
],
|
|
855
|
+
"flags": {
|
|
856
|
+
"json": {
|
|
857
|
+
"description": "Format output as json.",
|
|
858
|
+
"helpGroup": "GLOBAL",
|
|
859
|
+
"name": "json",
|
|
860
|
+
"allowNo": false,
|
|
861
|
+
"type": "boolean"
|
|
862
|
+
},
|
|
863
|
+
"flags-dir": {
|
|
864
|
+
"helpGroup": "GLOBAL",
|
|
865
|
+
"name": "flags-dir",
|
|
866
|
+
"summary": "Import flag values from a directory.",
|
|
867
|
+
"hasDynamicHelp": false,
|
|
868
|
+
"multiple": false,
|
|
869
|
+
"type": "option"
|
|
870
|
+
},
|
|
871
|
+
"app-name": {
|
|
872
|
+
"name": "app-name",
|
|
873
|
+
"required": false,
|
|
874
|
+
"summary": "Developer name of the new Lightning Out 2.0 app.",
|
|
875
|
+
"hasDynamicHelp": false,
|
|
876
|
+
"multiple": false,
|
|
877
|
+
"type": "option"
|
|
878
|
+
},
|
|
879
|
+
"eca-name": {
|
|
880
|
+
"name": "eca-name",
|
|
881
|
+
"required": false,
|
|
882
|
+
"summary": "Developer name of the External Client Application associated with the app.",
|
|
883
|
+
"hasDynamicHelp": false,
|
|
884
|
+
"multiple": false,
|
|
885
|
+
"type": "option"
|
|
886
|
+
},
|
|
887
|
+
"runtime": {
|
|
888
|
+
"description": "LWR_CORE serves the app from your Salesforce org to authenticated users. CLWR serves it from an Experience Cloud site to guest and authenticated users. After you deploy a CLWR app, link it to your site in Setup.",
|
|
889
|
+
"name": "runtime",
|
|
890
|
+
"summary": "Runtime that serves the app.",
|
|
891
|
+
"hasDynamicHelp": false,
|
|
892
|
+
"multiple": false,
|
|
893
|
+
"options": [
|
|
894
|
+
"LWR_CORE",
|
|
895
|
+
"CLWR"
|
|
896
|
+
],
|
|
897
|
+
"type": "option"
|
|
898
|
+
},
|
|
899
|
+
"host-domains": {
|
|
900
|
+
"name": "host-domains",
|
|
901
|
+
"summary": "HTTP or HTTPS origin of an external host page that embeds the app. Repeat the flag to specify more than one. Replaces, rather than merges with, any hostDomains in the --definition-file. For CLWR apps, host domains are used only for CORS, which authenticated users need. Set up framing for the site in Experience Builder.",
|
|
902
|
+
"hasDynamicHelp": false,
|
|
903
|
+
"multiple": true,
|
|
904
|
+
"type": "option"
|
|
905
|
+
},
|
|
906
|
+
"components": {
|
|
907
|
+
"name": "components",
|
|
908
|
+
"summary": "Name of a Lightning web component exposed by the app. Repeat the flag to specify more than one. Replaces, rather than merges with, any components in the --definition-file.",
|
|
909
|
+
"hasDynamicHelp": false,
|
|
910
|
+
"multiple": true,
|
|
911
|
+
"type": "option"
|
|
912
|
+
},
|
|
913
|
+
"eca-contact-email": {
|
|
914
|
+
"name": "eca-contact-email",
|
|
915
|
+
"summary": "Contact email for the External Client Application.",
|
|
916
|
+
"hasDynamicHelp": false,
|
|
917
|
+
"multiple": false,
|
|
918
|
+
"type": "option"
|
|
919
|
+
},
|
|
920
|
+
"eca-callback-url": {
|
|
921
|
+
"name": "eca-callback-url",
|
|
922
|
+
"summary": "OAuth callback URL for the External Client Application.",
|
|
923
|
+
"hasDynamicHelp": false,
|
|
924
|
+
"multiple": false,
|
|
925
|
+
"type": "option"
|
|
926
|
+
},
|
|
927
|
+
"definition-file": {
|
|
928
|
+
"name": "definition-file",
|
|
929
|
+
"summary": "Path to a JSON file describing the Lightning Out 2.0 app. Individual flags, when supplied, override the corresponding value in this file.",
|
|
930
|
+
"hasDynamicHelp": false,
|
|
931
|
+
"multiple": false,
|
|
932
|
+
"type": "option"
|
|
933
|
+
},
|
|
934
|
+
"output-dir": {
|
|
935
|
+
"aliases": [
|
|
936
|
+
"outputdir"
|
|
937
|
+
],
|
|
938
|
+
"char": "d",
|
|
939
|
+
"deprecateAliases": true,
|
|
940
|
+
"description": "The location can be an absolute path or relative to the current working directory. The default is the current directory.",
|
|
941
|
+
"name": "output-dir",
|
|
942
|
+
"summary": "Directory for saving the created files.",
|
|
943
|
+
"default": ".",
|
|
944
|
+
"hasDynamicHelp": false,
|
|
945
|
+
"multiple": false,
|
|
946
|
+
"type": "option"
|
|
947
|
+
},
|
|
948
|
+
"loglevel": {
|
|
949
|
+
"deprecated": {
|
|
950
|
+
"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 `SF_LOG_LEVEL` environment variable."
|
|
951
|
+
},
|
|
952
|
+
"hidden": true,
|
|
953
|
+
"name": "loglevel",
|
|
954
|
+
"hasDynamicHelp": false,
|
|
955
|
+
"multiple": false,
|
|
956
|
+
"type": "option"
|
|
957
|
+
}
|
|
958
|
+
},
|
|
959
|
+
"hasDynamicHelp": false,
|
|
960
|
+
"hiddenAliases": [],
|
|
961
|
+
"id": "template:generate:lightning-out",
|
|
962
|
+
"pluginAlias": "@salesforce/plugin-templates",
|
|
963
|
+
"pluginName": "@salesforce/plugin-templates",
|
|
964
|
+
"pluginType": "core",
|
|
965
|
+
"strict": true,
|
|
966
|
+
"summary": "Generate the required metadata to scaffold a Lightning Out 2.0 app.",
|
|
967
|
+
"enableJsonFlag": true,
|
|
968
|
+
"isESM": true,
|
|
969
|
+
"relativePath": [
|
|
970
|
+
"lib",
|
|
971
|
+
"commands",
|
|
972
|
+
"template",
|
|
973
|
+
"generate",
|
|
974
|
+
"lightning-out",
|
|
975
|
+
"index.js"
|
|
976
|
+
],
|
|
977
|
+
"aliasPermutations": [],
|
|
978
|
+
"permutations": [
|
|
979
|
+
"template:generate:lightning-out",
|
|
980
|
+
"generate:template:lightning-out",
|
|
981
|
+
"generate:lightning-out:template",
|
|
982
|
+
"template:lightning-out:generate",
|
|
983
|
+
"lightning-out:template:generate",
|
|
984
|
+
"lightning-out:generate:template"
|
|
985
|
+
]
|
|
986
|
+
},
|
|
844
987
|
"template:generate:lightning:app": {
|
|
845
988
|
"aliases": [
|
|
846
989
|
"force:lightning:app:create",
|
|
@@ -1694,192 +1837,49 @@
|
|
|
1694
1837
|
"test:create:force:lightning",
|
|
1695
1838
|
"test:create:lightning:force",
|
|
1696
1839
|
"force:lightning:create:test",
|
|
1697
|
-
"lightning:force:create:test",
|
|
1698
|
-
"lightning:create:force:test",
|
|
1699
|
-
"lightning:create:test:force",
|
|
1700
|
-
"force:create:lightning:test",
|
|
1701
|
-
"create:force:lightning:test",
|
|
1702
|
-
"create:lightning:force:test",
|
|
1703
|
-
"create:lightning:test:force",
|
|
1704
|
-
"force:create:test:lightning",
|
|
1705
|
-
"create:force:test:lightning",
|
|
1706
|
-
"create:test:force:lightning",
|
|
1707
|
-
"create:test:lightning:force",
|
|
1708
|
-
"lightning:generate:test",
|
|
1709
|
-
"generate:lightning:test",
|
|
1710
|
-
"generate:test:lightning",
|
|
1711
|
-
"lightning:test:generate",
|
|
1712
|
-
"test:lightning:generate",
|
|
1713
|
-
"test:generate:lightning"
|
|
1714
|
-
],
|
|
1715
|
-
"permutations": [
|
|
1716
|
-
"template:generate:lightning:test",
|
|
1717
|
-
"generate:template:lightning:test",
|
|
1718
|
-
"generate:lightning:template:test",
|
|
1719
|
-
"generate:lightning:test:template",
|
|
1720
|
-
"template:lightning:generate:test",
|
|
1721
|
-
"lightning:template:generate:test",
|
|
1722
|
-
"lightning:generate:template:test",
|
|
1723
|
-
"lightning:generate:test:template",
|
|
1724
|
-
"template:lightning:test:generate",
|
|
1725
|
-
"lightning:template:test:generate",
|
|
1726
|
-
"lightning:test:template:generate",
|
|
1727
|
-
"lightning:test:generate:template",
|
|
1728
|
-
"template:generate:test:lightning",
|
|
1729
|
-
"generate:template:test:lightning",
|
|
1730
|
-
"generate:test:template:lightning",
|
|
1731
|
-
"generate:test:lightning:template",
|
|
1732
|
-
"template:test:generate:lightning",
|
|
1733
|
-
"test:template:generate:lightning",
|
|
1734
|
-
"test:generate:template:lightning",
|
|
1735
|
-
"test:generate:lightning:template",
|
|
1736
|
-
"template:test:lightning:generate",
|
|
1737
|
-
"test:template:lightning:generate",
|
|
1738
|
-
"test:lightning:template:generate",
|
|
1739
|
-
"test:lightning:generate:template"
|
|
1740
|
-
]
|
|
1741
|
-
},
|
|
1742
|
-
"template:generate:lightning-out": {
|
|
1743
|
-
"aliases": [],
|
|
1744
|
-
"args": {},
|
|
1745
|
-
"description": "Lightning Out 2.0 lets you embed custom Lightning web components (LWCs) into your external, non-Salesforce apps.\n\nThis command gets you started by generating the seven metadata artifact types that a Lightning Out 2.0 app requires into your Salesforce DX project: LightningOutApp, MyDomain and Security settings, one CorsWhitelistOrigin per host domain, and the three External Client Application OAuth components (ExternalClientApplication, ExtlClntAppGlobalOauthSettings, ExtlClntAppOauthSettings). The command is generate-only; it doesn't deploy any metadata to an org.\n\nInputs may come from a --definition-file JSON, individual flags, or both. Flag values take precedence over the file on a per-key basis. The command validates the types of definition-file fields; the underlying generator performs the remaining structural validation, such as required fields and formats.",
|
|
1746
|
-
"examples": [
|
|
1747
|
-
"Generate a Lightning Out 2.0 app using individual flags to specify the values:\n<%= config.bin %> <%= command.id %> --app-name MyLoApp --runtime LWR_CORE --host-domains https://example.com --eca-name MyLoAppEca --eca-contact-email dev@example.com --eca-callback-url https://example.com/cb",
|
|
1748
|
-
"Generate an app using the values in a JSON definition file called lo-def.json:\n<%= config.bin %> <%= command.id %> --definition-file lo-def.json",
|
|
1749
|
-
"Generate the app into a specific directory:\n<%= config.bin %> <%= command.id %> --definition-file lo-def.json --output-dir force-app/main/default",
|
|
1750
|
-
"Generate the app using most of the values from a definition file, but the --host-domains value overrides its equivalent in the file:\n<%= config.bin %> <%= command.id %> --definition-file lo-def.json --host-domains https://staging.example.com"
|
|
1751
|
-
],
|
|
1752
|
-
"flags": {
|
|
1753
|
-
"json": {
|
|
1754
|
-
"description": "Format output as json.",
|
|
1755
|
-
"helpGroup": "GLOBAL",
|
|
1756
|
-
"name": "json",
|
|
1757
|
-
"allowNo": false,
|
|
1758
|
-
"type": "boolean"
|
|
1759
|
-
},
|
|
1760
|
-
"flags-dir": {
|
|
1761
|
-
"helpGroup": "GLOBAL",
|
|
1762
|
-
"name": "flags-dir",
|
|
1763
|
-
"summary": "Import flag values from a directory.",
|
|
1764
|
-
"hasDynamicHelp": false,
|
|
1765
|
-
"multiple": false,
|
|
1766
|
-
"type": "option"
|
|
1767
|
-
},
|
|
1768
|
-
"app-name": {
|
|
1769
|
-
"name": "app-name",
|
|
1770
|
-
"required": false,
|
|
1771
|
-
"summary": "Developer name of the new Lightning Out 2.0 app.",
|
|
1772
|
-
"hasDynamicHelp": false,
|
|
1773
|
-
"multiple": false,
|
|
1774
|
-
"type": "option"
|
|
1775
|
-
},
|
|
1776
|
-
"eca-name": {
|
|
1777
|
-
"name": "eca-name",
|
|
1778
|
-
"required": false,
|
|
1779
|
-
"summary": "Developer name of the External Client Application associated with the app.",
|
|
1780
|
-
"hasDynamicHelp": false,
|
|
1781
|
-
"multiple": false,
|
|
1782
|
-
"type": "option"
|
|
1783
|
-
},
|
|
1784
|
-
"runtime": {
|
|
1785
|
-
"name": "runtime",
|
|
1786
|
-
"summary": "Runtime the app targets. LWR_CORE serves from your Salesforce org for authenticated users; CLWR serves from an Experience Cloud site (guest access, extra site-deployment step).",
|
|
1787
|
-
"hasDynamicHelp": false,
|
|
1788
|
-
"multiple": false,
|
|
1789
|
-
"options": [
|
|
1790
|
-
"LWR_CORE",
|
|
1791
|
-
"CLWR"
|
|
1792
|
-
],
|
|
1793
|
-
"type": "option"
|
|
1794
|
-
},
|
|
1795
|
-
"host-domains": {
|
|
1796
|
-
"name": "host-domains",
|
|
1797
|
-
"summary": "HTTP or HTTPS origin of an external host page that embeds the app. Repeat the flag to specify more than one. Replaces, rather than merges with, any hostDomains in the --definition-file.",
|
|
1798
|
-
"hasDynamicHelp": false,
|
|
1799
|
-
"multiple": true,
|
|
1800
|
-
"type": "option"
|
|
1801
|
-
},
|
|
1802
|
-
"components": {
|
|
1803
|
-
"name": "components",
|
|
1804
|
-
"summary": "Name of a Lightning web component exposed by the app. Repeat the flag to specify more than one. Replaces, rather than merges with, any components in the --definition-file.",
|
|
1805
|
-
"hasDynamicHelp": false,
|
|
1806
|
-
"multiple": true,
|
|
1807
|
-
"type": "option"
|
|
1808
|
-
},
|
|
1809
|
-
"eca-contact-email": {
|
|
1810
|
-
"name": "eca-contact-email",
|
|
1811
|
-
"summary": "Contact email for the External Client Application.",
|
|
1812
|
-
"hasDynamicHelp": false,
|
|
1813
|
-
"multiple": false,
|
|
1814
|
-
"type": "option"
|
|
1815
|
-
},
|
|
1816
|
-
"eca-callback-url": {
|
|
1817
|
-
"name": "eca-callback-url",
|
|
1818
|
-
"summary": "OAuth callback URL for the External Client Application.",
|
|
1819
|
-
"hasDynamicHelp": false,
|
|
1820
|
-
"multiple": false,
|
|
1821
|
-
"type": "option"
|
|
1822
|
-
},
|
|
1823
|
-
"definition-file": {
|
|
1824
|
-
"name": "definition-file",
|
|
1825
|
-
"summary": "Path to a JSON file describing the Lightning Out 2.0 app. Individual flags, when supplied, override the corresponding value in this file.",
|
|
1826
|
-
"hasDynamicHelp": false,
|
|
1827
|
-
"multiple": false,
|
|
1828
|
-
"type": "option"
|
|
1829
|
-
},
|
|
1830
|
-
"output-dir": {
|
|
1831
|
-
"aliases": [
|
|
1832
|
-
"outputdir"
|
|
1833
|
-
],
|
|
1834
|
-
"char": "d",
|
|
1835
|
-
"deprecateAliases": true,
|
|
1836
|
-
"description": "The location can be an absolute path or relative to the current working directory. The default is the current directory.",
|
|
1837
|
-
"name": "output-dir",
|
|
1838
|
-
"summary": "Directory for saving the created files.",
|
|
1839
|
-
"default": ".",
|
|
1840
|
-
"hasDynamicHelp": false,
|
|
1841
|
-
"multiple": false,
|
|
1842
|
-
"type": "option"
|
|
1843
|
-
},
|
|
1844
|
-
"loglevel": {
|
|
1845
|
-
"deprecated": {
|
|
1846
|
-
"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 `SF_LOG_LEVEL` environment variable."
|
|
1847
|
-
},
|
|
1848
|
-
"hidden": true,
|
|
1849
|
-
"name": "loglevel",
|
|
1850
|
-
"hasDynamicHelp": false,
|
|
1851
|
-
"multiple": false,
|
|
1852
|
-
"type": "option"
|
|
1853
|
-
}
|
|
1854
|
-
},
|
|
1855
|
-
"hasDynamicHelp": false,
|
|
1856
|
-
"hidden": true,
|
|
1857
|
-
"hiddenAliases": [],
|
|
1858
|
-
"id": "template:generate:lightning-out",
|
|
1859
|
-
"pluginAlias": "@salesforce/plugin-templates",
|
|
1860
|
-
"pluginName": "@salesforce/plugin-templates",
|
|
1861
|
-
"pluginType": "core",
|
|
1862
|
-
"state": "beta",
|
|
1863
|
-
"strict": true,
|
|
1864
|
-
"summary": "Generate the required metadata to scaffold a Lightning Out 2.0 app.",
|
|
1865
|
-
"enableJsonFlag": true,
|
|
1866
|
-
"isESM": true,
|
|
1867
|
-
"relativePath": [
|
|
1868
|
-
"lib",
|
|
1869
|
-
"commands",
|
|
1870
|
-
"template",
|
|
1871
|
-
"generate",
|
|
1872
|
-
"lightning-out",
|
|
1873
|
-
"index.js"
|
|
1840
|
+
"lightning:force:create:test",
|
|
1841
|
+
"lightning:create:force:test",
|
|
1842
|
+
"lightning:create:test:force",
|
|
1843
|
+
"force:create:lightning:test",
|
|
1844
|
+
"create:force:lightning:test",
|
|
1845
|
+
"create:lightning:force:test",
|
|
1846
|
+
"create:lightning:test:force",
|
|
1847
|
+
"force:create:test:lightning",
|
|
1848
|
+
"create:force:test:lightning",
|
|
1849
|
+
"create:test:force:lightning",
|
|
1850
|
+
"create:test:lightning:force",
|
|
1851
|
+
"lightning:generate:test",
|
|
1852
|
+
"generate:lightning:test",
|
|
1853
|
+
"generate:test:lightning",
|
|
1854
|
+
"lightning:test:generate",
|
|
1855
|
+
"test:lightning:generate",
|
|
1856
|
+
"test:generate:lightning"
|
|
1874
1857
|
],
|
|
1875
|
-
"aliasPermutations": [],
|
|
1876
1858
|
"permutations": [
|
|
1877
|
-
"template:generate:lightning
|
|
1878
|
-
"generate:template:lightning
|
|
1879
|
-
"generate:lightning
|
|
1880
|
-
"
|
|
1881
|
-
"lightning
|
|
1882
|
-
"lightning
|
|
1859
|
+
"template:generate:lightning:test",
|
|
1860
|
+
"generate:template:lightning:test",
|
|
1861
|
+
"generate:lightning:template:test",
|
|
1862
|
+
"generate:lightning:test:template",
|
|
1863
|
+
"template:lightning:generate:test",
|
|
1864
|
+
"lightning:template:generate:test",
|
|
1865
|
+
"lightning:generate:template:test",
|
|
1866
|
+
"lightning:generate:test:template",
|
|
1867
|
+
"template:lightning:test:generate",
|
|
1868
|
+
"lightning:template:test:generate",
|
|
1869
|
+
"lightning:test:template:generate",
|
|
1870
|
+
"lightning:test:generate:template",
|
|
1871
|
+
"template:generate:test:lightning",
|
|
1872
|
+
"generate:template:test:lightning",
|
|
1873
|
+
"generate:test:template:lightning",
|
|
1874
|
+
"generate:test:lightning:template",
|
|
1875
|
+
"template:test:generate:lightning",
|
|
1876
|
+
"test:template:generate:lightning",
|
|
1877
|
+
"test:generate:template:lightning",
|
|
1878
|
+
"test:generate:lightning:template",
|
|
1879
|
+
"template:test:lightning:generate",
|
|
1880
|
+
"test:template:lightning:generate",
|
|
1881
|
+
"test:lightning:template:generate",
|
|
1882
|
+
"test:lightning:generate:template"
|
|
1883
1883
|
]
|
|
1884
1884
|
},
|
|
1885
1885
|
"template:generate:project": {
|
|
@@ -2075,18 +2075,16 @@
|
|
|
2075
2075
|
"project:generate:template"
|
|
2076
2076
|
]
|
|
2077
2077
|
},
|
|
2078
|
-
"template:generate:
|
|
2079
|
-
"aliases": [
|
|
2080
|
-
"force:staticresource:create",
|
|
2081
|
-
"static-resource:generate"
|
|
2082
|
-
],
|
|
2078
|
+
"template:generate:ui-bundle": {
|
|
2079
|
+
"aliases": [],
|
|
2083
2080
|
"args": {},
|
|
2084
|
-
"
|
|
2085
|
-
"description": "Generates the metadata resource file in the specified directory or the current working directory. Static resource files must be contained in a parent directory called \"staticresources\" in your package directory. Either run this command from an existing directory of this name, or use the --output-dir flag to create one or point to an existing one.",
|
|
2081
|
+
"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 specific UI framework, such as React or Angular. Check out the README.md file in the generated \"uiBundles/<bundlename>\" directory for more information about the template.",
|
|
2086
2082
|
"examples": [
|
|
2087
|
-
"Generate
|
|
2088
|
-
"
|
|
2089
|
-
"Generate
|
|
2083
|
+
"Generate a UI bundle called MyUiBundle in the current directory:\n<%= config.bin %> <%= command.id %> --name MyUiBundle",
|
|
2084
|
+
"Generate a React-based UI bundle:\n<%= config.bin %> <%= command.id %> --name MyReactApp --template reactbasic",
|
|
2085
|
+
"Generate an Angular-based UI bundle:\n<%= config.bin %> <%= command.id %> --name MyAngularApp --template angularbasic",
|
|
2086
|
+
"Generate a Vue-based UI bundle:\n<%= config.bin %> <%= command.id %> --name MyVueApp --template vuebasic",
|
|
2087
|
+
"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"
|
|
2090
2088
|
],
|
|
2091
2089
|
"flags": {
|
|
2092
2090
|
"json": {
|
|
@@ -2105,76 +2103,65 @@
|
|
|
2105
2103
|
"type": "option"
|
|
2106
2104
|
},
|
|
2107
2105
|
"name": {
|
|
2108
|
-
"aliases": [
|
|
2109
|
-
"resourcename"
|
|
2110
|
-
],
|
|
2111
2106
|
"char": "n",
|
|
2112
|
-
"deprecateAliases": true,
|
|
2113
2107
|
"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.",
|
|
2114
2108
|
"name": "name",
|
|
2115
2109
|
"required": true,
|
|
2116
|
-
"summary": "
|
|
2110
|
+
"summary": "API name of the generated UI bundle.",
|
|
2117
2111
|
"hasDynamicHelp": false,
|
|
2118
2112
|
"multiple": false,
|
|
2119
2113
|
"type": "option"
|
|
2120
2114
|
},
|
|
2121
|
-
"
|
|
2122
|
-
"
|
|
2123
|
-
|
|
2115
|
+
"template": {
|
|
2116
|
+
"char": "t",
|
|
2117
|
+
"description": "Supplied parameter values or default values are filled into a copy of the template.",
|
|
2118
|
+
"name": "template",
|
|
2119
|
+
"summary": "Template to use when creating the files for a specific UI framework.",
|
|
2120
|
+
"default": "default",
|
|
2121
|
+
"hasDynamicHelp": false,
|
|
2122
|
+
"multiple": false,
|
|
2123
|
+
"options": [
|
|
2124
|
+
"default",
|
|
2125
|
+
"reactbasic",
|
|
2126
|
+
"angularbasic",
|
|
2127
|
+
"vuebasic"
|
|
2124
2128
|
],
|
|
2125
|
-
"
|
|
2126
|
-
|
|
2127
|
-
|
|
2128
|
-
"
|
|
2129
|
-
"
|
|
2129
|
+
"type": "option"
|
|
2130
|
+
},
|
|
2131
|
+
"label": {
|
|
2132
|
+
"char": "l",
|
|
2133
|
+
"description": "If not specified, the label is derived from the name.",
|
|
2134
|
+
"name": "label",
|
|
2135
|
+
"summary": "Master label for the UI bundle.",
|
|
2130
2136
|
"hasDynamicHelp": false,
|
|
2131
2137
|
"multiple": false,
|
|
2132
2138
|
"type": "option"
|
|
2133
2139
|
},
|
|
2134
2140
|
"output-dir": {
|
|
2135
|
-
"aliases": [
|
|
2136
|
-
"outputdir"
|
|
2137
|
-
],
|
|
2138
2141
|
"char": "d",
|
|
2139
|
-
"
|
|
2140
|
-
"description": "The location can be an absolute path or relative to the current working directory. The default is the current directory.",
|
|
2142
|
+
"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)",
|
|
2141
2143
|
"name": "output-dir",
|
|
2142
|
-
"summary": "Directory
|
|
2143
|
-
"default": ".",
|
|
2144
|
+
"summary": "Directory into which the files are created.",
|
|
2144
2145
|
"hasDynamicHelp": false,
|
|
2145
2146
|
"multiple": false,
|
|
2146
2147
|
"type": "option"
|
|
2147
2148
|
},
|
|
2148
2149
|
"api-version": {
|
|
2149
|
-
"aliases": [
|
|
2150
|
-
"apiversion"
|
|
2151
|
-
],
|
|
2152
|
-
"deprecateAliases": true,
|
|
2153
2150
|
"description": "Override the api version used for api requests made by this command",
|
|
2154
2151
|
"name": "api-version",
|
|
2155
2152
|
"hasDynamicHelp": false,
|
|
2156
2153
|
"multiple": false,
|
|
2157
2154
|
"type": "option"
|
|
2158
|
-
},
|
|
2159
|
-
"loglevel": {
|
|
2160
|
-
"deprecated": {
|
|
2161
|
-
"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 `SF_LOG_LEVEL` environment variable."
|
|
2162
|
-
},
|
|
2163
|
-
"hidden": true,
|
|
2164
|
-
"name": "loglevel",
|
|
2165
|
-
"hasDynamicHelp": false,
|
|
2166
|
-
"multiple": false,
|
|
2167
|
-
"type": "option"
|
|
2168
2155
|
}
|
|
2169
2156
|
},
|
|
2170
2157
|
"hasDynamicHelp": false,
|
|
2171
2158
|
"hiddenAliases": [],
|
|
2172
|
-
"id": "template:generate:
|
|
2159
|
+
"id": "template:generate:ui-bundle",
|
|
2173
2160
|
"pluginAlias": "@salesforce/plugin-templates",
|
|
2174
2161
|
"pluginName": "@salesforce/plugin-templates",
|
|
2175
2162
|
"pluginType": "core",
|
|
2176
2163
|
"strict": true,
|
|
2177
|
-
"summary": "Generate a
|
|
2164
|
+
"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 or Angular.",
|
|
2178
2165
|
"enableJsonFlag": true,
|
|
2179
2166
|
"isESM": true,
|
|
2180
2167
|
"relativePath": [
|
|
@@ -2182,38 +2169,31 @@
|
|
|
2182
2169
|
"commands",
|
|
2183
2170
|
"template",
|
|
2184
2171
|
"generate",
|
|
2185
|
-
"
|
|
2172
|
+
"ui-bundle",
|
|
2186
2173
|
"index.js"
|
|
2187
2174
|
],
|
|
2188
|
-
"aliasPermutations": [
|
|
2189
|
-
"force:staticresource:create",
|
|
2190
|
-
"staticresource:force:create",
|
|
2191
|
-
"staticresource:create:force",
|
|
2192
|
-
"force:create:staticresource",
|
|
2193
|
-
"create:force:staticresource",
|
|
2194
|
-
"create:staticresource:force",
|
|
2195
|
-
"static-resource:generate",
|
|
2196
|
-
"generate:static-resource"
|
|
2197
|
-
],
|
|
2175
|
+
"aliasPermutations": [],
|
|
2198
2176
|
"permutations": [
|
|
2199
|
-
"template:generate:
|
|
2200
|
-
"generate:template:
|
|
2201
|
-
"generate:
|
|
2202
|
-
"template:
|
|
2203
|
-
"
|
|
2204
|
-
"
|
|
2177
|
+
"template:generate:ui-bundle",
|
|
2178
|
+
"generate:template:ui-bundle",
|
|
2179
|
+
"generate:ui-bundle:template",
|
|
2180
|
+
"template:ui-bundle:generate",
|
|
2181
|
+
"ui-bundle:template:generate",
|
|
2182
|
+
"ui-bundle:generate:template"
|
|
2205
2183
|
]
|
|
2206
2184
|
},
|
|
2207
|
-
"template:generate:
|
|
2208
|
-
"aliases": [
|
|
2185
|
+
"template:generate:static-resource": {
|
|
2186
|
+
"aliases": [
|
|
2187
|
+
"force:staticresource:create",
|
|
2188
|
+
"static-resource:generate"
|
|
2189
|
+
],
|
|
2209
2190
|
"args": {},
|
|
2210
|
-
"
|
|
2191
|
+
"deprecateAliases": true,
|
|
2192
|
+
"description": "Generates the metadata resource file in the specified directory or the current working directory. Static resource files must be contained in a parent directory called \"staticresources\" in your package directory. Either run this command from an existing directory of this name, or use the --output-dir flag to create one or point to an existing one.",
|
|
2211
2193
|
"examples": [
|
|
2212
|
-
"Generate a
|
|
2213
|
-
"
|
|
2214
|
-
"Generate
|
|
2215
|
-
"Generate a Vue-based UI bundle:\n<%= config.bin %> <%= command.id %> --name MyVueApp --template vuebasic",
|
|
2216
|
-
"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"
|
|
2194
|
+
"Generate the metadata file for a static resource called MyResource in the current directory:\n<%= config.bin %> <%= command.id %> --name MyResource",
|
|
2195
|
+
"Similar to previous example, but specifies a MIME type of application/json:\n<%= config.bin %> <%= command.id %> --name MyResource --type application/json",
|
|
2196
|
+
"Generate the resource file in the \"force-app/main/default/staticresources\" directory:\n<%= config.bin %> <%= command.id %> --name MyResource --output-dir force-app/main/default/staticresources"
|
|
2217
2197
|
],
|
|
2218
2198
|
"flags": {
|
|
2219
2199
|
"json": {
|
|
@@ -2232,65 +2212,76 @@
|
|
|
2232
2212
|
"type": "option"
|
|
2233
2213
|
},
|
|
2234
2214
|
"name": {
|
|
2215
|
+
"aliases": [
|
|
2216
|
+
"resourcename"
|
|
2217
|
+
],
|
|
2235
2218
|
"char": "n",
|
|
2219
|
+
"deprecateAliases": true,
|
|
2236
2220
|
"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.",
|
|
2237
2221
|
"name": "name",
|
|
2238
2222
|
"required": true,
|
|
2239
|
-
"summary": "
|
|
2223
|
+
"summary": "Name of the generated static resource.",
|
|
2240
2224
|
"hasDynamicHelp": false,
|
|
2241
2225
|
"multiple": false,
|
|
2242
2226
|
"type": "option"
|
|
2243
2227
|
},
|
|
2244
|
-
"
|
|
2245
|
-
"
|
|
2246
|
-
|
|
2247
|
-
"name": "template",
|
|
2248
|
-
"summary": "Template to use when creating the files for a specific UI framework.",
|
|
2249
|
-
"default": "default",
|
|
2250
|
-
"hasDynamicHelp": false,
|
|
2251
|
-
"multiple": false,
|
|
2252
|
-
"options": [
|
|
2253
|
-
"default",
|
|
2254
|
-
"reactbasic",
|
|
2255
|
-
"angularbasic",
|
|
2256
|
-
"vuebasic"
|
|
2228
|
+
"type": {
|
|
2229
|
+
"aliases": [
|
|
2230
|
+
"contenttype"
|
|
2257
2231
|
],
|
|
2258
|
-
"
|
|
2259
|
-
|
|
2260
|
-
|
|
2261
|
-
"
|
|
2262
|
-
"
|
|
2263
|
-
"name": "label",
|
|
2264
|
-
"summary": "Master label for the UI bundle.",
|
|
2232
|
+
"deprecateAliases": true,
|
|
2233
|
+
"description": "Must be a valid MIME type such as application/json, application/javascript, application/zip, text/plain, text/css, etc.",
|
|
2234
|
+
"name": "type",
|
|
2235
|
+
"summary": "Content type (mime type) of the generated static resource.",
|
|
2236
|
+
"default": "application/zip",
|
|
2265
2237
|
"hasDynamicHelp": false,
|
|
2266
2238
|
"multiple": false,
|
|
2267
2239
|
"type": "option"
|
|
2268
2240
|
},
|
|
2269
2241
|
"output-dir": {
|
|
2242
|
+
"aliases": [
|
|
2243
|
+
"outputdir"
|
|
2244
|
+
],
|
|
2270
2245
|
"char": "d",
|
|
2271
|
-
"
|
|
2246
|
+
"deprecateAliases": true,
|
|
2247
|
+
"description": "The location can be an absolute path or relative to the current working directory. The default is the current directory.",
|
|
2272
2248
|
"name": "output-dir",
|
|
2273
|
-
"summary": "Directory
|
|
2249
|
+
"summary": "Directory for saving the created files.",
|
|
2250
|
+
"default": ".",
|
|
2274
2251
|
"hasDynamicHelp": false,
|
|
2275
2252
|
"multiple": false,
|
|
2276
2253
|
"type": "option"
|
|
2277
2254
|
},
|
|
2278
2255
|
"api-version": {
|
|
2256
|
+
"aliases": [
|
|
2257
|
+
"apiversion"
|
|
2258
|
+
],
|
|
2259
|
+
"deprecateAliases": true,
|
|
2279
2260
|
"description": "Override the api version used for api requests made by this command",
|
|
2280
2261
|
"name": "api-version",
|
|
2281
2262
|
"hasDynamicHelp": false,
|
|
2282
2263
|
"multiple": false,
|
|
2283
2264
|
"type": "option"
|
|
2265
|
+
},
|
|
2266
|
+
"loglevel": {
|
|
2267
|
+
"deprecated": {
|
|
2268
|
+
"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 `SF_LOG_LEVEL` environment variable."
|
|
2269
|
+
},
|
|
2270
|
+
"hidden": true,
|
|
2271
|
+
"name": "loglevel",
|
|
2272
|
+
"hasDynamicHelp": false,
|
|
2273
|
+
"multiple": false,
|
|
2274
|
+
"type": "option"
|
|
2284
2275
|
}
|
|
2285
2276
|
},
|
|
2286
2277
|
"hasDynamicHelp": false,
|
|
2287
2278
|
"hiddenAliases": [],
|
|
2288
|
-
"id": "template:generate:
|
|
2279
|
+
"id": "template:generate:static-resource",
|
|
2289
2280
|
"pluginAlias": "@salesforce/plugin-templates",
|
|
2290
2281
|
"pluginName": "@salesforce/plugin-templates",
|
|
2291
2282
|
"pluginType": "core",
|
|
2292
2283
|
"strict": true,
|
|
2293
|
-
"summary": "Generate a
|
|
2284
|
+
"summary": "Generate a static resource.",
|
|
2294
2285
|
"enableJsonFlag": true,
|
|
2295
2286
|
"isESM": true,
|
|
2296
2287
|
"relativePath": [
|
|
@@ -2298,17 +2289,26 @@
|
|
|
2298
2289
|
"commands",
|
|
2299
2290
|
"template",
|
|
2300
2291
|
"generate",
|
|
2301
|
-
"
|
|
2292
|
+
"static-resource",
|
|
2302
2293
|
"index.js"
|
|
2303
2294
|
],
|
|
2304
|
-
"aliasPermutations": [
|
|
2295
|
+
"aliasPermutations": [
|
|
2296
|
+
"force:staticresource:create",
|
|
2297
|
+
"staticresource:force:create",
|
|
2298
|
+
"staticresource:create:force",
|
|
2299
|
+
"force:create:staticresource",
|
|
2300
|
+
"create:force:staticresource",
|
|
2301
|
+
"create:staticresource:force",
|
|
2302
|
+
"static-resource:generate",
|
|
2303
|
+
"generate:static-resource"
|
|
2304
|
+
],
|
|
2305
2305
|
"permutations": [
|
|
2306
|
-
"template:generate:
|
|
2307
|
-
"generate:template:
|
|
2308
|
-
"generate:
|
|
2309
|
-
"template:
|
|
2310
|
-
"
|
|
2311
|
-
"
|
|
2306
|
+
"template:generate:static-resource",
|
|
2307
|
+
"generate:template:static-resource",
|
|
2308
|
+
"generate:static-resource:template",
|
|
2309
|
+
"template:static-resource:generate",
|
|
2310
|
+
"static-resource:template:generate",
|
|
2311
|
+
"static-resource:generate:template"
|
|
2312
2312
|
]
|
|
2313
2313
|
},
|
|
2314
2314
|
"template:generate:ui-embedding": {
|
|
@@ -2815,5 +2815,5 @@
|
|
|
2815
2815
|
]
|
|
2816
2816
|
}
|
|
2817
2817
|
},
|
|
2818
|
-
"version": "57.
|
|
2818
|
+
"version": "57.5.0"
|
|
2819
2819
|
}
|