@salesforce/plugin-templates 56.6.0 → 56.7.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.
Files changed (47) hide show
  1. package/README.md +258 -247
  2. package/lib/commands/{analytics/generate → template/generate/analytics}/template.js +3 -3
  3. package/lib/commands/template/generate/analytics/template.js.map +1 -0
  4. package/lib/commands/{lightning/generate → template/generate/lightning}/app.js +3 -3
  5. package/lib/commands/template/generate/lightning/app.js.map +1 -0
  6. package/lib/commands/{lightning/generate → template/generate/lightning}/component.js +3 -3
  7. package/lib/commands/template/generate/lightning/component.js.map +1 -0
  8. package/lib/commands/{lightning/generate → template/generate/lightning}/event.js +3 -3
  9. package/lib/commands/template/generate/lightning/event.js.map +1 -0
  10. package/lib/commands/{lightning/generate → template/generate/lightning}/interface.js +3 -3
  11. package/lib/commands/template/generate/lightning/interface.js.map +1 -0
  12. package/lib/commands/{lightning/generate → template/generate/lightning}/test.js +3 -3
  13. package/lib/commands/template/generate/lightning/test.js.map +1 -0
  14. package/lib/commands/{project/generate.js → template/generate/project/index.js} +4 -4
  15. package/lib/commands/template/generate/project/index.js.map +1 -0
  16. package/lib/commands/{static-resource/generate.js → template/generate/static-resource/index.js} +4 -4
  17. package/lib/commands/template/generate/static-resource/index.js.map +1 -0
  18. package/lib/commands/{visualforce/generate → template/generate/visualforce}/component.js +3 -3
  19. package/lib/commands/template/generate/visualforce/component.js.map +1 -0
  20. package/lib/commands/{visualforce/generate → template/generate/visualforce}/page.js +3 -3
  21. package/lib/commands/template/generate/visualforce/page.js.map +1 -0
  22. package/lib/commands/{webapp/generate.d.ts → template/generate/webapp/index.d.ts} +2 -0
  23. package/lib/commands/{webapp/generate.js → template/generate/webapp/index.js} +4 -2
  24. package/lib/commands/template/generate/webapp/index.js.map +1 -0
  25. package/oclif.manifest.json +873 -635
  26. package/package.json +22 -36
  27. package/lib/commands/analytics/generate/template.js.map +0 -1
  28. package/lib/commands/lightning/generate/app.js.map +0 -1
  29. package/lib/commands/lightning/generate/component.js.map +0 -1
  30. package/lib/commands/lightning/generate/event.js.map +0 -1
  31. package/lib/commands/lightning/generate/interface.js.map +0 -1
  32. package/lib/commands/lightning/generate/test.js.map +0 -1
  33. package/lib/commands/project/generate.js.map +0 -1
  34. package/lib/commands/static-resource/generate.js.map +0 -1
  35. package/lib/commands/visualforce/generate/component.js.map +0 -1
  36. package/lib/commands/visualforce/generate/page.js.map +0 -1
  37. package/lib/commands/webapp/generate.js.map +0 -1
  38. /package/lib/commands/{analytics/generate → template/generate/analytics}/template.d.ts +0 -0
  39. /package/lib/commands/{lightning/generate → template/generate/lightning}/app.d.ts +0 -0
  40. /package/lib/commands/{lightning/generate → template/generate/lightning}/component.d.ts +0 -0
  41. /package/lib/commands/{lightning/generate → template/generate/lightning}/event.d.ts +0 -0
  42. /package/lib/commands/{lightning/generate → template/generate/lightning}/interface.d.ts +0 -0
  43. /package/lib/commands/{lightning/generate → template/generate/lightning}/test.d.ts +0 -0
  44. /package/lib/commands/{project/generate.d.ts → template/generate/project/index.d.ts} +0 -0
  45. /package/lib/commands/{static-resource/generate.d.ts → template/generate/static-resource/index.d.ts} +0 -0
  46. /package/lib/commands/{visualforce/generate → template/generate/visualforce}/component.d.ts +0 -0
  47. /package/lib/commands/{visualforce/generate → template/generate/visualforce}/page.d.ts +0 -0
package/README.md CHANGED
@@ -118,27 +118,28 @@ Congrats, you are debugging!
118
118
 
119
119
  <!-- commands -->
120
120
 
121
- - [`sf analytics generate template`](#sf-analytics-generate-template)
122
- - [`sf lightning generate app`](#sf-lightning-generate-app)
123
- - [`sf lightning generate component`](#sf-lightning-generate-component)
124
- - [`sf lightning generate event`](#sf-lightning-generate-event)
125
- - [`sf lightning generate interface`](#sf-lightning-generate-interface)
126
- - [`sf lightning generate test`](#sf-lightning-generate-test)
127
- - [`sf project generate`](#sf-project-generate)
128
- - [`sf static-resource generate`](#sf-static-resource-generate)
121
+ - [`sf template generate analytics template`](#sf-template-generate-analytics-template)
129
122
  - [`sf template generate apex class`](#sf-template-generate-apex-class)
130
123
  - [`sf template generate apex trigger`](#sf-template-generate-apex-trigger)
131
124
  - [`sf template generate digital-experience site`](#sf-template-generate-digital-experience-site)
132
- - [`sf visualforce generate component`](#sf-visualforce-generate-component)
133
- - [`sf visualforce generate page`](#sf-visualforce-generate-page)
134
-
135
- ## `sf analytics generate template`
125
+ - [`sf template generate lightning app`](#sf-template-generate-lightning-app)
126
+ - [`sf template generate lightning component`](#sf-template-generate-lightning-component)
127
+ - [`sf template generate lightning event`](#sf-template-generate-lightning-event)
128
+ - [`sf template generate lightning interface`](#sf-template-generate-lightning-interface)
129
+ - [`sf template generate lightning test`](#sf-template-generate-lightning-test)
130
+ - [`sf template generate project`](#sf-template-generate-project)
131
+ - [`sf template generate static-resource`](#sf-template-generate-static-resource)
132
+ - [`sf template generate visualforce component`](#sf-template-generate-visualforce-component)
133
+ - [`sf template generate visualforce page`](#sf-template-generate-visualforce-page)
134
+
135
+ ## `sf template generate analytics template`
136
136
 
137
137
  Generate a simple Analytics template.
138
138
 
139
139
  ```
140
140
  USAGE
141
- $ sf analytics generate template -n <value> [--json] [--flags-dir <value>] [-d <value>] [--api-version <value>]
141
+ $ sf template generate analytics template -n <value> [--json] [--flags-dir <value>] [-d <value>] [--api-version
142
+ <value>]
142
143
 
143
144
  FLAGS
144
145
  -d, --output-dir=<value> [default: .] Directory for saving the created files.
@@ -158,29 +159,210 @@ DESCRIPTION
158
159
 
159
160
  ALIASES
160
161
  $ sf force analytics template create
162
+ $ sf analytics generate template
161
163
 
162
164
  EXAMPLES
163
165
  Generate the metadata files for a simple Analytics template file called myTemplate in the
164
166
  force-app/main/default/waveTemplates directory:
165
167
 
166
- $ sf analytics generate template --name myTemplate --output-dir force-app/main/default/waveTemplates
168
+ $ sf template generate analytics template --name myTemplate --output-dir force-app/main/default/waveTemplates
169
+
170
+ FLAG DESCRIPTIONS
171
+ -d, --output-dir=<value> Directory for saving the created files.
172
+
173
+ The location can be an absolute path or relative to the current working directory. The default is the current
174
+ directory.
175
+ ```
176
+
177
+ _See code: [src/commands/template/generate/analytics/template.ts](https://github.com/salesforcecli/plugin-templates/blob/56.7.1/src/commands/template/generate/analytics/template.ts)_
178
+
179
+ ## `sf template generate apex class`
180
+
181
+ Generate an Apex class.
182
+
183
+ ```
184
+ USAGE
185
+ $ sf template generate apex class -n <value> [--json] [--flags-dir <value>] [-t
186
+ ApexException|ApexUnitTest|BasicUnitTest|DefaultApexClass|InboundEmailService] [-d <value>] [--api-version <value>]
187
+
188
+ FLAGS
189
+ -d, --output-dir=<value> [default: .] Directory for saving the created files.
190
+ -n, --name=<value> (required) Name of the generated Apex class.
191
+ -t, --template=<option> [default: DefaultApexClass] Template to use for file creation.
192
+ <options: ApexException|ApexUnitTest|BasicUnitTest|DefaultApexClass|InboundEmailService>
193
+ --api-version=<value> Override the api version used for api requests made by this command
194
+
195
+ GLOBAL FLAGS
196
+ --flags-dir=<value> Import flag values from a directory.
197
+ --json Format output as json.
198
+
199
+ DESCRIPTION
200
+ Generate an Apex class.
201
+
202
+ Generates the Apex *.cls file and associated metadata file. These files must be contained in a parent directory called
203
+ "classes" in your package directory. Either run this command from an existing directory of this name, or use the
204
+ --output-dir flag to generate one or point to an existing one.
205
+
206
+ ALIASES
207
+ $ sf force apex class create
208
+ $ sf apex generate class
209
+
210
+ EXAMPLES
211
+ Generate two metadata files associated with the MyClass Apex class (MyClass.cls and MyClass.cls-meta.xml) in the
212
+ current directory:
213
+
214
+ $ sf template generate apex class --name MyClass
215
+
216
+ Similar to previous example, but generates the files in the "force-app/main/default/classes" directory:
217
+
218
+ $ sf template generate apex class --name MyClass --output-dir force-app/main/default/classes
167
219
 
168
220
  FLAG DESCRIPTIONS
169
221
  -d, --output-dir=<value> Directory for saving the created files.
170
222
 
171
223
  The location can be an absolute path or relative to the current working directory. The default is the current
172
224
  directory.
225
+
226
+ -n, --name=<value> Name of the generated Apex class.
227
+
228
+ The name can be up to 40 characters and must start with a letter.
229
+
230
+ -t, --template=ApexException|ApexUnitTest|BasicUnitTest|DefaultApexClass|InboundEmailService
231
+
232
+ Template to use for file creation.
233
+
234
+ Supplied parameter values or default values are filled into a copy of the template.
235
+ ```
236
+
237
+ _See code: [src/commands/template/generate/apex/class.ts](https://github.com/salesforcecli/plugin-templates/blob/56.7.1/src/commands/template/generate/apex/class.ts)_
238
+
239
+ ## `sf template generate apex trigger`
240
+
241
+ Generate an Apex trigger.
242
+
243
+ ```
244
+ USAGE
245
+ $ sf template generate apex trigger -n <value> [--json] [--flags-dir <value>] [-t ApexTrigger] [-d <value>] [--api-version
246
+ <value>] [-s <value>] [-e before insert|before update|before delete|after insert|after update|after delete|after
247
+ undelete...]
248
+
249
+ FLAGS
250
+ -d, --output-dir=<value> [default: .] Directory for saving the created files.
251
+ -e, --event=<option>... [default: before insert] Events that fire the trigger.
252
+ <options: before insert|before update|before delete|after insert|after update|after
253
+ delete|after undelete>
254
+ -n, --name=<value> (required) Name of the generated Apex trigger
255
+ -s, --sobject=<value> [default: SOBJECT] Salesforce object to generate a trigger on.
256
+ -t, --template=<option> [default: ApexTrigger] Template to use for file creation.
257
+ <options: ApexTrigger>
258
+ --api-version=<value> Override the api version used for api requests made by this command
259
+
260
+ GLOBAL FLAGS
261
+ --flags-dir=<value> Import flag values from a directory.
262
+ --json Format output as json.
263
+
264
+ DESCRIPTION
265
+ Generate an Apex trigger.
266
+
267
+ Generates the Apex trigger *.trigger file and associated metadata file. These files must be contained in a parent
268
+ directory called "triggers" in your package directory. Either run this command from an existing directory of this
269
+ name, or use the --output-dir flag to generate one or point to an existing one.
270
+
271
+ If you don't specify the --sobject flag, the .trigger file contains the generic placeholder SOBJECT; replace it with
272
+ the Salesforce object you want to generate a trigger for. If you don't specify --event, "before insert" is used.
273
+
274
+ ALIASES
275
+ $ sf force apex trigger create
276
+ $ sf apex generate trigger
277
+
278
+ EXAMPLES
279
+ Generate two files associated with the MyTrigger Apex trigger (MyTrigger.trigger and MyTrigger.trigger-meta.xml) in
280
+ the current directory:
281
+
282
+ $ sf template generate apex trigger --name MyTrigger
283
+
284
+ Similar to the previous example, but generate the files in the "force-app/main/default/triggers" directory:
285
+
286
+ $ sf template generate apex trigger --name MyTrigger --output-dir force-app/main/default/triggers
287
+
288
+ Generate files for a trigger that fires on the Account object before and after an insert:
289
+
290
+ $ sf template generate apex trigger --name MyTrigger --sobject Account --event "before insert,after insert"
291
+
292
+ FLAG DESCRIPTIONS
293
+ -d, --output-dir=<value> Directory for saving the created files.
294
+
295
+ The location can be an absolute path or relative to the current working directory. The default is the current
296
+ directory.
297
+
298
+ -n, --name=<value> Name of the generated Apex trigger
299
+
300
+ The name can be up to 40 characters and must start with a letter.
301
+
302
+ -t, --template=ApexTrigger Template to use for file creation.
303
+
304
+ Supplied parameter values or default values are filled into a copy of the template.
305
+ ```
306
+
307
+ _See code: [src/commands/template/generate/apex/trigger.ts](https://github.com/salesforcecli/plugin-templates/blob/56.7.1/src/commands/template/generate/apex/trigger.ts)_
308
+
309
+ ## `sf template generate digital-experience site`
310
+
311
+ Generate an Experience Cloud site.
312
+
313
+ ```
314
+ USAGE
315
+ $ sf template generate digital-experience site -n <value> -t BuildYourOwnLWR [--json] [--flags-dir <value>] [-o <value>] [-p <value>] [-e
316
+ <value>] [-d <value>]
317
+
318
+ FLAGS
319
+ -d, --output-dir=<value> Directory to generate the site files in.
320
+ -e, --admin-email=<value> Email address for the site administrator. Defaults to the username of the currently
321
+ authenticated user.
322
+ -n, --name=<value> (required) Name of the Experience Cloud site to generate.
323
+ -o, --target-org=<value> Username or alias of the target org.
324
+ -p, --url-path-prefix=<value> URL path prefix for the site; must contain only alphanumeric characters.
325
+ -t, --template=<option> (required) Template to use when generating the site.
326
+ <options: BuildYourOwnLWR>
327
+
328
+ GLOBAL FLAGS
329
+ --flags-dir=<value> Import flag values from a directory.
330
+ --json Format output as json.
331
+
332
+ DESCRIPTION
333
+ Generate an Experience Cloud site.
334
+
335
+ Creates an Experience Cloud site with the specified template, name, and URL path prefix. The site includes all
336
+ necessary metadata files, including DigitalExperienceConfig, DigitalExperienceBundle, Network, and CustomSite.
337
+
338
+ EXAMPLES
339
+ Generate an Experience Cloud site using the BuildYourOwnLWR template. The site is called "mysite" and has the URL
340
+ path prefix "mysite":
341
+
342
+ $ sf template generate digital-experience site --template BuildYourOwnLWR --name mysite --url-path-prefix mysite
343
+
344
+ Generate an Experience Cloud site like the last example, but generate the files into the specified output directory:
345
+
346
+ $ sf template generate digital-experience site --template BuildYourOwnLWR --name mysite --url-path-prefix mysite \
347
+ --output-dir force-app/main/default
348
+
349
+ FLAG DESCRIPTIONS
350
+ -d, --output-dir=<value> Directory to generate the site files in.
351
+
352
+ The location can be an absolute path or relative to the current working directory. If not specified, the command
353
+ reads your sfdx-project.json file and uses the default package directory. When running outside a Salesforce DX
354
+ project, defaults to the current directory.
173
355
  ```
174
356
 
175
- _See code: [src/commands/analytics/generate/template.ts](https://github.com/salesforcecli/plugin-templates/blob/56.6.0/src/commands/analytics/generate/template.ts)_
357
+ _See code: [src/commands/template/generate/digital-experience/site.ts](https://github.com/salesforcecli/plugin-templates/blob/56.7.1/src/commands/template/generate/digital-experience/site.ts)_
176
358
 
177
- ## `sf lightning generate app`
359
+ ## `sf template generate lightning app`
178
360
 
179
361
  Generate a Lightning App.
180
362
 
181
363
  ```
182
364
  USAGE
183
- $ sf lightning generate app -n <value> [--json] [--flags-dir <value>] [-t DefaultLightningApp] [-d <value>] [--api-version
365
+ $ sf template generate lightning app -n <value> [--json] [--flags-dir <value>] [-t DefaultLightningApp] [-d <value>] [--api-version
184
366
  <value>]
185
367
 
186
368
  FLAGS
@@ -202,15 +384,16 @@ DESCRIPTION
202
384
 
203
385
  ALIASES
204
386
  $ sf force lightning app create
387
+ $ sf lightning generate app
205
388
 
206
389
  EXAMPLES
207
390
  Generate the metadata files for a Lightning app bundle called "myapp" in the current directory:
208
391
 
209
- $ sf lightning generate app --name myapp
392
+ $ sf template generate lightning app --name myapp
210
393
 
211
394
  Similar to the previous example, but generate the files in the "force-app/main/default/aura" directory:
212
395
 
213
- $ sf lightning generate app --name myapp --output-dir force-app/main/default/aura
396
+ $ sf template generate lightning app --name myapp --output-dir force-app/main/default/aura
214
397
 
215
398
  FLAG DESCRIPTIONS
216
399
  -d, --output-dir=<value> Directory for saving the created files.
@@ -227,15 +410,15 @@ FLAG DESCRIPTIONS
227
410
  Supplied parameter values or default values are filled into a copy of the template.
228
411
  ```
229
412
 
230
- _See code: [src/commands/lightning/generate/app.ts](https://github.com/salesforcecli/plugin-templates/blob/56.6.0/src/commands/lightning/generate/app.ts)_
413
+ _See code: [src/commands/template/generate/lightning/app.ts](https://github.com/salesforcecli/plugin-templates/blob/56.7.1/src/commands/template/generate/lightning/app.ts)_
231
414
 
232
- ## `sf lightning generate component`
415
+ ## `sf template generate lightning component`
233
416
 
234
417
  Generate a bundle for an Aura component or a Lightning web component.
235
418
 
236
419
  ```
237
420
  USAGE
238
- $ sf lightning generate component -n <value> [--json] [--flags-dir <value>] [-t
421
+ $ sf template generate lightning component -n <value> [--json] [--flags-dir <value>] [-t
239
422
  default|analyticsDashboard|analyticsDashboardWithStep] [-d <value>] [--api-version <value>] [--type aura|lwc]
240
423
 
241
424
  FLAGS
@@ -263,23 +446,24 @@ DESCRIPTION
263
446
 
264
447
  ALIASES
265
448
  $ sf force lightning component create
449
+ $ sf lightning generate component
266
450
 
267
451
  EXAMPLES
268
452
  Generate the metadata files for an Aura component bundle in the current directory:
269
453
 
270
- $ sf lightning generate component --name mycomponent
454
+ $ sf template generate lightning component --name mycomponent
271
455
 
272
456
  Generate a Lightning web component bundle in the current directory:
273
457
 
274
- $ sf lightning generate component --name mycomponent --type lwc
458
+ $ sf template generate lightning component --name mycomponent --type lwc
275
459
 
276
460
  Generate an Aura component bundle in the "force-app/main/default/aura" directory:
277
461
 
278
- $ sf lightning generate component --name mycomponent --output-dir force-app/main/default/aura
462
+ $ sf template generate lightning component --name mycomponent --output-dir force-app/main/default/aura
279
463
 
280
464
  Generate a Lightning web component bundle in the "force-app/main/default/lwc" directory:
281
465
 
282
- $ sf lightning generate component --name mycomponent --type lwc --output-dir force-app/main/default/lwc
466
+ $ sf template generate lightning component --name mycomponent --type lwc --output-dir force-app/main/default/lwc
283
467
 
284
468
  FLAG DESCRIPTIONS
285
469
  -d, --output-dir=<value> Directory for saving the created files.
@@ -296,15 +480,15 @@ FLAG DESCRIPTIONS
296
480
  Supplied parameter values or default values are filled into a copy of the template.
297
481
  ```
298
482
 
299
- _See code: [src/commands/lightning/generate/component.ts](https://github.com/salesforcecli/plugin-templates/blob/56.6.0/src/commands/lightning/generate/component.ts)_
483
+ _See code: [src/commands/template/generate/lightning/component.ts](https://github.com/salesforcecli/plugin-templates/blob/56.7.1/src/commands/template/generate/lightning/component.ts)_
300
484
 
301
- ## `sf lightning generate event`
485
+ ## `sf template generate lightning event`
302
486
 
303
487
  Generate a Lightning Event.
304
488
 
305
489
  ```
306
490
  USAGE
307
- $ sf lightning generate event -n <value> [--json] [--flags-dir <value>] [-t DefaultLightningEvt] [-d <value>] [--api-version
491
+ $ sf template generate lightning event -n <value> [--json] [--flags-dir <value>] [-t DefaultLightningEvt] [-d <value>] [--api-version
308
492
  <value>]
309
493
 
310
494
  FLAGS
@@ -326,15 +510,16 @@ DESCRIPTION
326
510
 
327
511
  ALIASES
328
512
  $ sf force lightning event create
513
+ $ sf lightning generate event
329
514
 
330
515
  EXAMPLES
331
516
  Generate the metadata files for a Lightning event bundle called "myevent" in the current directory:
332
517
 
333
- $ sf lightning generate event --name myevent
518
+ $ sf template generate lightning event --name myevent
334
519
 
335
520
  Similar to previous example, but generate the files in the "force-app/main/default/aura" directory:
336
521
 
337
- $ sf lightning generate event --name myevent --output-dir force-app/main/default/aura
522
+ $ sf template generate lightning event --name myevent --output-dir force-app/main/default/aura
338
523
 
339
524
  FLAG DESCRIPTIONS
340
525
  -d, --output-dir=<value> Directory for saving the created files.
@@ -351,15 +536,15 @@ FLAG DESCRIPTIONS
351
536
  Supplied parameter values or default values are filled into a copy of the template.
352
537
  ```
353
538
 
354
- _See code: [src/commands/lightning/generate/event.ts](https://github.com/salesforcecli/plugin-templates/blob/56.6.0/src/commands/lightning/generate/event.ts)_
539
+ _See code: [src/commands/template/generate/lightning/event.ts](https://github.com/salesforcecli/plugin-templates/blob/56.7.1/src/commands/template/generate/lightning/event.ts)_
355
540
 
356
- ## `sf lightning generate interface`
541
+ ## `sf template generate lightning interface`
357
542
 
358
543
  Generate a Lightning Interface.
359
544
 
360
545
  ```
361
546
  USAGE
362
- $ sf lightning generate interface -n <value> [--json] [--flags-dir <value>] [-t DefaultLightningIntf] [-d <value>]
547
+ $ sf template generate lightning interface -n <value> [--json] [--flags-dir <value>] [-t DefaultLightningIntf] [-d <value>]
363
548
  [--api-version <value>]
364
549
 
365
550
  FLAGS
@@ -381,15 +566,16 @@ DESCRIPTION
381
566
 
382
567
  ALIASES
383
568
  $ sf force lightning interface create
569
+ $ sf lightning generate interface
384
570
 
385
571
  EXAMPLES
386
572
  Generate the metadata files for a Lightning interface bundle called "myinterface" in the current directory:
387
573
 
388
- $ sf lightning generate interface --name myinterface
574
+ $ sf template generate lightning interface --name myinterface
389
575
 
390
576
  Similar to the previous example but generate the files in the "force-app/main/default/aura" directory:
391
577
 
392
- $ sf lightning generate interface --name myinterface --output-dir force-app/main/default/aura
578
+ $ sf template generate lightning interface --name myinterface --output-dir force-app/main/default/aura
393
579
 
394
580
  FLAG DESCRIPTIONS
395
581
  -d, --output-dir=<value> Directory for saving the created files.
@@ -406,15 +592,15 @@ FLAG DESCRIPTIONS
406
592
  Supplied parameter values or default values are filled into a copy of the template.
407
593
  ```
408
594
 
409
- _See code: [src/commands/lightning/generate/interface.ts](https://github.com/salesforcecli/plugin-templates/blob/56.6.0/src/commands/lightning/generate/interface.ts)_
595
+ _See code: [src/commands/template/generate/lightning/interface.ts](https://github.com/salesforcecli/plugin-templates/blob/56.7.1/src/commands/template/generate/lightning/interface.ts)_
410
596
 
411
- ## `sf lightning generate test`
597
+ ## `sf template generate lightning test`
412
598
 
413
599
  Generate a Lightning test.
414
600
 
415
601
  ```
416
602
  USAGE
417
- $ sf lightning generate test -n <value> [--json] [--flags-dir <value>] [-t DefaultLightningTest] [-d <value>]
603
+ $ sf template generate lightning test -n <value> [--json] [--flags-dir <value>] [-t DefaultLightningTest] [-d <value>]
418
604
  [--api-version <value>]
419
605
 
420
606
  FLAGS
@@ -436,15 +622,16 @@ DESCRIPTION
436
622
 
437
623
  ALIASES
438
624
  $ sf force lightning test create
625
+ $ sf lightning generate test
439
626
 
440
627
  EXAMPLES
441
628
  Generate the metadata files for the Lightning test called MyLightningTest in the current directory:
442
629
 
443
- $ sf lightning generate test --name MyLightningTest
630
+ $ sf template generate lightning test --name MyLightningTest
444
631
 
445
632
  Similar to the previous example but generate the files in the "force-app/main/default/lightningTests" directory:
446
633
 
447
- $ sf lightning generate test --name MyLightningTest --output-dir force-app/main/default/lightningTests
634
+ $ sf template generate lightning test --name MyLightningTest --output-dir force-app/main/default/lightningTests
448
635
 
449
636
  FLAG DESCRIPTIONS
450
637
  -d, --output-dir=<value> Directory for saving the created files.
@@ -461,15 +648,15 @@ FLAG DESCRIPTIONS
461
648
  Supplied parameter values or default values are filled into a copy of the template.
462
649
  ```
463
650
 
464
- _See code: [src/commands/lightning/generate/test.ts](https://github.com/salesforcecli/plugin-templates/blob/56.6.0/src/commands/lightning/generate/test.ts)_
651
+ _See code: [src/commands/template/generate/lightning/test.ts](https://github.com/salesforcecli/plugin-templates/blob/56.7.1/src/commands/template/generate/lightning/test.ts)_
465
652
 
466
- ## `sf project generate`
653
+ ## `sf template generate project`
467
654
 
468
655
  Generate a Salesforce DX project.
469
656
 
470
657
  ```
471
658
  USAGE
472
- $ sf project generate -n <value> [--json] [--flags-dir <value>] [-t standard|empty|analytics] [-d <value>] [-s
659
+ $ sf template generate project -n <value> [--json] [--flags-dir <value>] [-t standard|empty|analytics] [-d <value>] [-s
473
660
  <value>] [-p <value>] [-x] [--api-version <value>]
474
661
 
475
662
  FLAGS
@@ -499,23 +686,24 @@ DESCRIPTION
499
686
 
500
687
  ALIASES
501
688
  $ sf force project create
689
+ $ sf project generate
502
690
 
503
691
  EXAMPLES
504
692
  Generate a project called "mywork":
505
693
 
506
- $ sf project generate --name mywork
694
+ $ sf template generate project --name mywork
507
695
 
508
696
  Similar to previous example, but generate the files in a directory called "myapp":
509
697
 
510
- $ sf project generate --name mywork --default-package-dir myapp
698
+ $ sf template generate project --name mywork --default-package-dir myapp
511
699
 
512
700
  Similar to prevoius example, but also generate a default package.xml manifest file:
513
701
 
514
- $ sf project generate --name mywork --default-package-dir myapp --manifest
702
+ $ sf template generate project --name mywork --default-package-dir myapp --manifest
515
703
 
516
704
  Generate a project with the minimum files and directories:
517
705
 
518
- $ sf project generate --name mywork --template empty
706
+ $ sf template generate project --name mywork --template empty
519
707
 
520
708
  FLAG DESCRIPTIONS
521
709
  -d, --output-dir=<value> Directory for saving the created files.
@@ -566,16 +754,16 @@ FLAG DESCRIPTIONS
566
754
  Override the api version used for api requests made by this command
567
755
  ```
568
756
 
569
- _See code: [src/commands/project/generate.ts](https://github.com/salesforcecli/plugin-templates/blob/56.6.0/src/commands/project/generate.ts)_
757
+ _See code: [src/commands/template/generate/project/index.ts](https://github.com/salesforcecli/plugin-templates/blob/56.7.1/src/commands/template/generate/project/index.ts)_
570
758
 
571
- ## `sf static-resource generate`
759
+ ## `sf template generate static-resource`
572
760
 
573
761
  Generate a static resource.
574
762
 
575
763
  ```
576
764
  USAGE
577
- $ sf static-resource generate -n <value> [--json] [--flags-dir <value>] [--type <value>] [-d <value>] [--api-version
578
- <value>]
765
+ $ sf template generate static-resource -n <value> [--json] [--flags-dir <value>] [--type <value>] [-d <value>]
766
+ [--api-version <value>]
579
767
 
580
768
  FLAGS
581
769
  -d, --output-dir=<value> [default: .] Directory for saving the created files.
@@ -597,19 +785,20 @@ DESCRIPTION
597
785
 
598
786
  ALIASES
599
787
  $ sf force staticresource create
788
+ $ sf static-resource generate
600
789
 
601
790
  EXAMPLES
602
791
  Generate the metadata file for a static resource called MyResource in the current directory:
603
792
 
604
- $ sf static-resource generate --name MyResource
793
+ $ sf template generate static-resource --name MyResource
605
794
 
606
795
  Similar to previous example, but specifies a MIME type of application/json:
607
796
 
608
- $ sf static-resource generate --name MyResource --type application/json
797
+ $ sf template generate static-resource --name MyResource --type application/json
609
798
 
610
799
  Generate the resource file in the "force-app/main/default/staticresources" directory:
611
800
 
612
- $ sf static-resource generate --name MyResource --output-dir force-app/main/default/staticresources
801
+ $ sf template generate static-resource --name MyResource --output-dir force-app/main/default/staticresources
613
802
 
614
803
  FLAG DESCRIPTIONS
615
804
  -d, --output-dir=<value> Directory for saving the created files.
@@ -628,195 +817,15 @@ FLAG DESCRIPTIONS
628
817
  etc.
629
818
  ```
630
819
 
631
- _See code: [src/commands/static-resource/generate.ts](https://github.com/salesforcecli/plugin-templates/blob/56.6.0/src/commands/static-resource/generate.ts)_
632
-
633
- ## `sf template generate apex class`
634
-
635
- Generate an Apex class.
636
-
637
- ```
638
- USAGE
639
- $ sf template generate apex class -n <value> [--json] [--flags-dir <value>] [-t
640
- ApexException|ApexUnitTest|BasicUnitTest|DefaultApexClass|InboundEmailService] [-d <value>] [--api-version <value>]
641
-
642
- FLAGS
643
- -d, --output-dir=<value> [default: .] Directory for saving the created files.
644
- -n, --name=<value> (required) Name of the generated Apex class.
645
- -t, --template=<option> [default: DefaultApexClass] Template to use for file creation.
646
- <options: ApexException|ApexUnitTest|BasicUnitTest|DefaultApexClass|InboundEmailService>
647
- --api-version=<value> Override the api version used for api requests made by this command
648
-
649
- GLOBAL FLAGS
650
- --flags-dir=<value> Import flag values from a directory.
651
- --json Format output as json.
652
-
653
- DESCRIPTION
654
- Generate an Apex class.
655
-
656
- Generates the Apex *.cls file and associated metadata file. These files must be contained in a parent directory called
657
- "classes" in your package directory. Either run this command from an existing directory of this name, or use the
658
- --output-dir flag to generate one or point to an existing one.
659
-
660
- ALIASES
661
- $ sf force apex class create
662
- $ sf apex generate class
663
-
664
- EXAMPLES
665
- Generate two metadata files associated with the MyClass Apex class (MyClass.cls and MyClass.cls-meta.xml) in the
666
- current directory:
667
-
668
- $ sf template generate apex class --name MyClass
669
-
670
- Similar to previous example, but generates the files in the "force-app/main/default/classes" directory:
671
-
672
- $ sf template generate apex class --name MyClass --output-dir force-app/main/default/classes
673
-
674
- FLAG DESCRIPTIONS
675
- -d, --output-dir=<value> Directory for saving the created files.
676
-
677
- The location can be an absolute path or relative to the current working directory. The default is the current
678
- directory.
679
-
680
- -n, --name=<value> Name of the generated Apex class.
681
-
682
- The name can be up to 40 characters and must start with a letter.
683
-
684
- -t, --template=ApexException|ApexUnitTest|BasicUnitTest|DefaultApexClass|InboundEmailService
685
-
686
- Template to use for file creation.
687
-
688
- Supplied parameter values or default values are filled into a copy of the template.
689
- ```
690
-
691
- _See code: [src/commands/template/generate/apex/class.ts](https://github.com/salesforcecli/plugin-templates/blob/56.6.0/src/commands/template/generate/apex/class.ts)_
820
+ _See code: [src/commands/template/generate/static-resource/index.ts](https://github.com/salesforcecli/plugin-templates/blob/56.7.1/src/commands/template/generate/static-resource/index.ts)_
692
821
 
693
- ## `sf template generate apex trigger`
694
-
695
- Generate an Apex trigger.
696
-
697
- ```
698
- USAGE
699
- $ sf template generate apex trigger -n <value> [--json] [--flags-dir <value>] [-t ApexTrigger] [-d <value>] [--api-version
700
- <value>] [-s <value>] [-e before insert|before update|before delete|after insert|after update|after delete|after
701
- undelete...]
702
-
703
- FLAGS
704
- -d, --output-dir=<value> [default: .] Directory for saving the created files.
705
- -e, --event=<option>... [default: before insert] Events that fire the trigger.
706
- <options: before insert|before update|before delete|after insert|after update|after
707
- delete|after undelete>
708
- -n, --name=<value> (required) Name of the generated Apex trigger
709
- -s, --sobject=<value> [default: SOBJECT] Salesforce object to generate a trigger on.
710
- -t, --template=<option> [default: ApexTrigger] Template to use for file creation.
711
- <options: ApexTrigger>
712
- --api-version=<value> Override the api version used for api requests made by this command
713
-
714
- GLOBAL FLAGS
715
- --flags-dir=<value> Import flag values from a directory.
716
- --json Format output as json.
717
-
718
- DESCRIPTION
719
- Generate an Apex trigger.
720
-
721
- Generates the Apex trigger *.trigger file and associated metadata file. These files must be contained in a parent
722
- directory called "triggers" in your package directory. Either run this command from an existing directory of this
723
- name, or use the --output-dir flag to generate one or point to an existing one.
724
-
725
- If you don't specify the --sobject flag, the .trigger file contains the generic placeholder SOBJECT; replace it with
726
- the Salesforce object you want to generate a trigger for. If you don't specify --event, "before insert" is used.
727
-
728
- ALIASES
729
- $ sf force apex trigger create
730
- $ sf apex generate trigger
731
-
732
- EXAMPLES
733
- Generate two files associated with the MyTrigger Apex trigger (MyTrigger.trigger and MyTrigger.trigger-meta.xml) in
734
- the current directory:
735
-
736
- $ sf template generate apex trigger --name MyTrigger
737
-
738
- Similar to the previous example, but generate the files in the "force-app/main/default/triggers" directory:
739
-
740
- $ sf template generate apex trigger --name MyTrigger --output-dir force-app/main/default/triggers
741
-
742
- Generate files for a trigger that fires on the Account object before and after an insert:
743
-
744
- $ sf template generate apex trigger --name MyTrigger --sobject Account --event "before insert,after insert"
745
-
746
- FLAG DESCRIPTIONS
747
- -d, --output-dir=<value> Directory for saving the created files.
748
-
749
- The location can be an absolute path or relative to the current working directory. The default is the current
750
- directory.
751
-
752
- -n, --name=<value> Name of the generated Apex trigger
753
-
754
- The name can be up to 40 characters and must start with a letter.
755
-
756
- -t, --template=ApexTrigger Template to use for file creation.
757
-
758
- Supplied parameter values or default values are filled into a copy of the template.
759
- ```
760
-
761
- _See code: [src/commands/template/generate/apex/trigger.ts](https://github.com/salesforcecli/plugin-templates/blob/56.6.0/src/commands/template/generate/apex/trigger.ts)_
762
-
763
- ## `sf template generate digital-experience site`
764
-
765
- Generate an Experience Cloud site.
766
-
767
- ```
768
- USAGE
769
- $ sf template generate digital-experience site -n <value> -t BuildYourOwnLWR [--json] [--flags-dir <value>] [-o <value>] [-p <value>] [-e
770
- <value>] [-d <value>]
771
-
772
- FLAGS
773
- -d, --output-dir=<value> Directory to generate the site files in.
774
- -e, --admin-email=<value> Email address for the site administrator. Defaults to the username of the currently
775
- authenticated user.
776
- -n, --name=<value> (required) Name of the Experience Cloud site to generate.
777
- -o, --target-org=<value> Username or alias of the target org.
778
- -p, --url-path-prefix=<value> URL path prefix for the site; must contain only alphanumeric characters.
779
- -t, --template=<option> (required) Template to use when generating the site.
780
- <options: BuildYourOwnLWR>
781
-
782
- GLOBAL FLAGS
783
- --flags-dir=<value> Import flag values from a directory.
784
- --json Format output as json.
785
-
786
- DESCRIPTION
787
- Generate an Experience Cloud site.
788
-
789
- Creates an Experience Cloud site with the specified template, name, and URL path prefix. The site includes all
790
- necessary metadata files, including DigitalExperienceConfig, DigitalExperienceBundle, Network, and CustomSite.
791
-
792
- EXAMPLES
793
- Generate an Experience Cloud site using the BuildYourOwnLWR template. The site is called "mysite" and has the URL
794
- path prefix "mysite":
795
-
796
- $ sf template generate digital-experience site --template BuildYourOwnLWR --name mysite --url-path-prefix mysite
797
-
798
- Generate an Experience Cloud site like the last example, but generate the files into the specified output directory:
799
-
800
- $ sf template generate digital-experience site --template BuildYourOwnLWR --name mysite --url-path-prefix mysite \
801
- --output-dir force-app/main/default
802
-
803
- FLAG DESCRIPTIONS
804
- -d, --output-dir=<value> Directory to generate the site files in.
805
-
806
- The location can be an absolute path or relative to the current working directory. If not specified, the command
807
- reads your sfdx-project.json file and uses the default package directory. When running outside a Salesforce DX
808
- project, defaults to the current directory.
809
- ```
810
-
811
- _See code: [src/commands/template/generate/digital-experience/site.ts](https://github.com/salesforcecli/plugin-templates/blob/56.6.0/src/commands/template/generate/digital-experience/site.ts)_
812
-
813
- ## `sf visualforce generate component`
822
+ ## `sf template generate visualforce component`
814
823
 
815
824
  Generate a Visualforce Component.
816
825
 
817
826
  ```
818
827
  USAGE
819
- $ sf visualforce generate component -n <value> -l <value> [--json] [--flags-dir <value>] [-t DefaultVFComponent] [-d <value>]
828
+ $ sf template generate visualforce component -n <value> -l <value> [--json] [--flags-dir <value>] [-t DefaultVFComponent] [-d <value>]
820
829
  [--api-version <value>]
821
830
 
822
831
  FLAGS
@@ -839,15 +848,16 @@ DESCRIPTION
839
848
 
840
849
  ALIASES
841
850
  $ sf force visualforce component create
851
+ $ sf visualforce generate component
842
852
 
843
853
  EXAMPLES
844
854
  Generate the metadata files for a Visualforce component in the current directory:
845
855
 
846
- $ sf visualforce generate component --name mycomponent --label mylabel
856
+ $ sf template generate visualforce component --name mycomponent --label mylabel
847
857
 
848
858
  Similar to previous example, but generate the files in the directory "force-app/main/default/components":
849
859
 
850
- $ sf visualforce generate component --name mycomponent --label mylabel --output-dir components
860
+ $ sf template generate visualforce component --name mycomponent --label mylabel --output-dir components
851
861
 
852
862
  FLAG DESCRIPTIONS
853
863
  -d, --output-dir=<value> Directory for saving the created files.
@@ -864,16 +874,16 @@ FLAG DESCRIPTIONS
864
874
  Supplied parameter values or default values are filled into a copy of the template.
865
875
  ```
866
876
 
867
- _See code: [src/commands/visualforce/generate/component.ts](https://github.com/salesforcecli/plugin-templates/blob/56.6.0/src/commands/visualforce/generate/component.ts)_
877
+ _See code: [src/commands/template/generate/visualforce/component.ts](https://github.com/salesforcecli/plugin-templates/blob/56.7.1/src/commands/template/generate/visualforce/component.ts)_
868
878
 
869
- ## `sf visualforce generate page`
879
+ ## `sf template generate visualforce page`
870
880
 
871
881
  Generate a Visualforce Page.
872
882
 
873
883
  ```
874
884
  USAGE
875
- $ sf visualforce generate page -n <value> -l <value> [--json] [--flags-dir <value>] [-d <value>] [--api-version
876
- <value>]
885
+ $ sf template generate visualforce page -n <value> -l <value> [--json] [--flags-dir <value>] [-d <value>]
886
+ [--api-version <value>]
877
887
 
878
888
  FLAGS
879
889
  -d, --output-dir=<value> [default: .] Directory for saving the created files.
@@ -893,15 +903,16 @@ DESCRIPTION
893
903
 
894
904
  ALIASES
895
905
  $ sf force visualforce page create
906
+ $ sf visualforce generate page
896
907
 
897
908
  EXAMPLES
898
909
  Generate the metadata files for a Visualforce page in the current directory:
899
910
 
900
- $ sf visualforce generate page --name mypage --label mylabel
911
+ $ sf template generate visualforce page --name mypage --label mylabel
901
912
 
902
913
  Similar to previous example, but generate the files in the directory "force-app/main/default/pages":
903
914
 
904
- $ sf visualforce generate page --name mypage --label mylabel --output-dir pages
915
+ $ sf template generate visualforce page --name mypage --label mylabel --output-dir pages
905
916
 
906
917
  FLAG DESCRIPTIONS
907
918
  -d, --output-dir=<value> Directory for saving the created files.
@@ -914,6 +925,6 @@ FLAG DESCRIPTIONS
914
925
  The name can be up to 40 characters and must start with a letter.
915
926
  ```
916
927
 
917
- _See code: [src/commands/visualforce/generate/page.ts](https://github.com/salesforcecli/plugin-templates/blob/56.6.0/src/commands/visualforce/generate/page.ts)_
928
+ _See code: [src/commands/template/generate/visualforce/page.ts](https://github.com/salesforcecli/plugin-templates/blob/56.7.1/src/commands/template/generate/visualforce/page.ts)_
918
929
 
919
930
  <!-- commandsstop -->