@salesforce/plugin-templates 56.7.2 → 56.8.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.
@@ -375,134 +375,6 @@
375
375
  "trigger:apex:generate:template"
376
376
  ]
377
377
  },
378
- "template:generate:digital-experience:site": {
379
- "aliases": [],
380
- "args": {},
381
- "description": "Creates an Experience Cloud site with the specified template, name, and URL path prefix. The site includes all necessary metadata files, including DigitalExperienceConfig, DigitalExperienceBundle, Network, and CustomSite.",
382
- "examples": [
383
- "Generate an Experience Cloud site using the BuildYourOwnLWR template. The site is called \"mysite\" and has the URL path prefix \"mysite\":\n<%= config.bin %> <%= command.id %> --template BuildYourOwnLWR --name mysite --url-path-prefix mysite",
384
- "Generate an Experience Cloud site like the last example, but generate the files into the specified output directory:\n<%= config.bin %> <%= command.id %> --template BuildYourOwnLWR --name mysite --url-path-prefix mysite --output-dir force-app/main/default"
385
- ],
386
- "flags": {
387
- "json": {
388
- "description": "Format output as json.",
389
- "helpGroup": "GLOBAL",
390
- "name": "json",
391
- "allowNo": false,
392
- "type": "boolean"
393
- },
394
- "flags-dir": {
395
- "helpGroup": "GLOBAL",
396
- "name": "flags-dir",
397
- "summary": "Import flag values from a directory.",
398
- "hasDynamicHelp": false,
399
- "multiple": false,
400
- "type": "option"
401
- },
402
- "target-org": {
403
- "char": "o",
404
- "name": "target-org",
405
- "noCacheDefault": true,
406
- "summary": "Username or alias of the target org.",
407
- "hasDynamicHelp": true,
408
- "multiple": false,
409
- "type": "option"
410
- },
411
- "name": {
412
- "char": "n",
413
- "name": "name",
414
- "required": true,
415
- "summary": "Name of the Experience Cloud site to generate.",
416
- "hasDynamicHelp": false,
417
- "multiple": false,
418
- "type": "option"
419
- },
420
- "template": {
421
- "char": "t",
422
- "name": "template",
423
- "required": true,
424
- "summary": "Template to use when generating the site.",
425
- "hasDynamicHelp": false,
426
- "multiple": false,
427
- "options": [
428
- "BuildYourOwnLWR"
429
- ],
430
- "type": "option"
431
- },
432
- "url-path-prefix": {
433
- "char": "p",
434
- "name": "url-path-prefix",
435
- "summary": "URL path prefix for the site; must contain only alphanumeric characters.",
436
- "default": "",
437
- "hasDynamicHelp": false,
438
- "multiple": false,
439
- "type": "option"
440
- },
441
- "admin-email": {
442
- "char": "e",
443
- "name": "admin-email",
444
- "summary": "Email address for the site administrator. Defaults to the username of the currently authenticated user.",
445
- "hasDynamicHelp": false,
446
- "multiple": false,
447
- "type": "option"
448
- },
449
- "output-dir": {
450
- "char": "d",
451
- "description": "The location can be an absolute path or relative to the current working directory. If not specified, the command reads your sfdx-project.json file and uses the default package directory. When running outside a Salesforce DX project, defaults to the current directory.",
452
- "name": "output-dir",
453
- "summary": "Directory to generate the site files in.",
454
- "hasDynamicHelp": false,
455
- "multiple": false,
456
- "type": "option"
457
- }
458
- },
459
- "hasDynamicHelp": true,
460
- "hiddenAliases": [],
461
- "id": "template:generate:digital-experience:site",
462
- "pluginAlias": "@salesforce/plugin-templates",
463
- "pluginName": "@salesforce/plugin-templates",
464
- "pluginType": "core",
465
- "state": "preview",
466
- "strict": true,
467
- "summary": "Generate an Experience Cloud site.",
468
- "enableJsonFlag": true,
469
- "isESM": true,
470
- "relativePath": [
471
- "lib",
472
- "commands",
473
- "template",
474
- "generate",
475
- "digital-experience",
476
- "site.js"
477
- ],
478
- "aliasPermutations": [],
479
- "permutations": [
480
- "template:generate:digital-experience:site",
481
- "generate:template:digital-experience:site",
482
- "generate:digital-experience:template:site",
483
- "generate:digital-experience:site:template",
484
- "template:digital-experience:generate:site",
485
- "digital-experience:template:generate:site",
486
- "digital-experience:generate:template:site",
487
- "digital-experience:generate:site:template",
488
- "template:digital-experience:site:generate",
489
- "digital-experience:template:site:generate",
490
- "digital-experience:site:template:generate",
491
- "digital-experience:site:generate:template",
492
- "template:generate:site:digital-experience",
493
- "generate:template:site:digital-experience",
494
- "generate:site:template:digital-experience",
495
- "generate:site:digital-experience:template",
496
- "template:site:generate:digital-experience",
497
- "site:template:generate:digital-experience",
498
- "site:generate:template:digital-experience",
499
- "site:generate:digital-experience:template",
500
- "template:site:digital-experience:generate",
501
- "site:template:digital-experience:generate",
502
- "site:digital-experience:template:generate",
503
- "site:digital-experience:generate:template"
504
- ]
505
- },
506
378
  "template:generate:analytics:template": {
507
379
  "aliases": [
508
380
  "force:analytics:template:create",
@@ -656,19 +528,143 @@
656
528
  "template:analytics:generate:template"
657
529
  ]
658
530
  },
659
- "template:generate:project": {
660
- "aliases": [
661
- "force:project:create",
662
- "project:generate"
531
+ "template:generate:digital-experience:site": {
532
+ "aliases": [],
533
+ "args": {},
534
+ "description": "Creates an Experience Cloud site with the specified template, name, and URL path prefix. The site includes all necessary metadata files, including DigitalExperienceConfig, DigitalExperienceBundle, Network, and CustomSite.",
535
+ "examples": [
536
+ "Generate an Experience Cloud site using the BuildYourOwnLWR template. The site is called \"mysite\" and has the URL path prefix \"mysite\":\n<%= config.bin %> <%= command.id %> --template BuildYourOwnLWR --name mysite --url-path-prefix mysite",
537
+ "Generate an Experience Cloud site like the last example, but generate the files into the specified output directory:\n<%= config.bin %> <%= command.id %> --template BuildYourOwnLWR --name mysite --url-path-prefix mysite --output-dir force-app/main/default"
663
538
  ],
539
+ "flags": {
540
+ "json": {
541
+ "description": "Format output as json.",
542
+ "helpGroup": "GLOBAL",
543
+ "name": "json",
544
+ "allowNo": false,
545
+ "type": "boolean"
546
+ },
547
+ "flags-dir": {
548
+ "helpGroup": "GLOBAL",
549
+ "name": "flags-dir",
550
+ "summary": "Import flag values from a directory.",
551
+ "hasDynamicHelp": false,
552
+ "multiple": false,
553
+ "type": "option"
554
+ },
555
+ "target-org": {
556
+ "char": "o",
557
+ "name": "target-org",
558
+ "noCacheDefault": true,
559
+ "summary": "Username or alias of the target org.",
560
+ "hasDynamicHelp": true,
561
+ "multiple": false,
562
+ "type": "option"
563
+ },
564
+ "name": {
565
+ "char": "n",
566
+ "name": "name",
567
+ "required": true,
568
+ "summary": "Name of the Experience Cloud site to generate.",
569
+ "hasDynamicHelp": false,
570
+ "multiple": false,
571
+ "type": "option"
572
+ },
573
+ "template": {
574
+ "char": "t",
575
+ "name": "template",
576
+ "required": true,
577
+ "summary": "Template to use when generating the site.",
578
+ "hasDynamicHelp": false,
579
+ "multiple": false,
580
+ "options": [
581
+ "BuildYourOwnLWR"
582
+ ],
583
+ "type": "option"
584
+ },
585
+ "url-path-prefix": {
586
+ "char": "p",
587
+ "name": "url-path-prefix",
588
+ "summary": "URL path prefix for the site; must contain only alphanumeric characters.",
589
+ "default": "",
590
+ "hasDynamicHelp": false,
591
+ "multiple": false,
592
+ "type": "option"
593
+ },
594
+ "admin-email": {
595
+ "char": "e",
596
+ "name": "admin-email",
597
+ "summary": "Email address for the site administrator. Defaults to the username of the currently authenticated user.",
598
+ "hasDynamicHelp": false,
599
+ "multiple": false,
600
+ "type": "option"
601
+ },
602
+ "output-dir": {
603
+ "char": "d",
604
+ "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.",
605
+ "name": "output-dir",
606
+ "summary": "Directory to generate the site files in.",
607
+ "hasDynamicHelp": false,
608
+ "multiple": false,
609
+ "type": "option"
610
+ }
611
+ },
612
+ "hasDynamicHelp": true,
613
+ "hiddenAliases": [],
614
+ "id": "template:generate:digital-experience:site",
615
+ "pluginAlias": "@salesforce/plugin-templates",
616
+ "pluginName": "@salesforce/plugin-templates",
617
+ "pluginType": "core",
618
+ "state": "preview",
619
+ "strict": true,
620
+ "summary": "Generate an Experience Cloud site.",
621
+ "enableJsonFlag": true,
622
+ "isESM": true,
623
+ "relativePath": [
624
+ "lib",
625
+ "commands",
626
+ "template",
627
+ "generate",
628
+ "digital-experience",
629
+ "site.js"
630
+ ],
631
+ "aliasPermutations": [],
632
+ "permutations": [
633
+ "template:generate:digital-experience:site",
634
+ "generate:template:digital-experience:site",
635
+ "generate:digital-experience:template:site",
636
+ "generate:digital-experience:site:template",
637
+ "template:digital-experience:generate:site",
638
+ "digital-experience:template:generate:site",
639
+ "digital-experience:generate:template:site",
640
+ "digital-experience:generate:site:template",
641
+ "template:digital-experience:site:generate",
642
+ "digital-experience:template:site:generate",
643
+ "digital-experience:site:template:generate",
644
+ "digital-experience:site:generate:template",
645
+ "template:generate:site:digital-experience",
646
+ "generate:template:site:digital-experience",
647
+ "generate:site:template:digital-experience",
648
+ "generate:site:digital-experience:template",
649
+ "template:site:generate:digital-experience",
650
+ "site:template:generate:digital-experience",
651
+ "site:generate:template:digital-experience",
652
+ "site:generate:digital-experience:template",
653
+ "template:site:digital-experience:generate",
654
+ "site:template:digital-experience:generate",
655
+ "site:digital-experience:template:generate",
656
+ "site:digital-experience:generate:template"
657
+ ]
658
+ },
659
+ "template:generate:flexipage": {
660
+ "aliases": [],
664
661
  "args": {},
665
- "deprecateAliases": true,
666
- "description": "A Salesforce DX project has a specific structure and a configuration file (sfdx-project.json) that identifies the directory as a Salesforce DX project. This command generates the necessary configuration files and directories to get you started.\n\nBy default, the generated sfdx-project.json file sets the sourceApiVersion property to the default API version currently used by Salesforce CLI. To specify a different version, set the apiVersion configuration variable. For example: \"sf config set apiVersion=57.0 --global\".",
662
+ "description": "FlexiPages are the metadata types associated with a Lightning page. A Lightning page represents a customizable screen made up of regions containing Lightning components.\n\nYou can use this command to generate these types of FlexiPages; specify the type with the --template flag:\n\n- AppPage: A Lightning page used as the home page for a custom app or a standalone application page.\n- HomePage: A Lightning page used to override the Home page in Lightning Experience.\n- RecordPage: A Lightning page used to override an object record page in Lightning Experience. Requires that you specify the object name with the --sobject flag.",
667
663
  "examples": [
668
- "Generate a project called \"mywork\":\n<%= config.bin %> <%= command.id %> --name mywork",
669
- "Similar to previous example, but generate the files in a directory called \"myapp\":\n<%= config.bin %> <%= command.id %> --name mywork --default-package-dir myapp",
670
- "Similar to prevoius example, but also generate a default package.xml manifest file:\n<%= config.bin %> <%= command.id %> --name mywork --default-package-dir myapp --manifest",
671
- "Generate a project with the minimum files and directories:\n<%= config.bin %> <%= command.id %> --name mywork --template empty"
664
+ "Generate a RecordPage FlexiPage for the Account object in the current directory:\n<%= config.bin %> <%= command.id %> --name Account_Record_Page --template RecordPage --sobject Account",
665
+ "Generate an AppPage FlexiPage in the \"force-app/main/default/flexipages\" directory:\n<%= config.bin %> <%= command.id %> --name Sales_Dashboard --template AppPage --output-dir force-app/main/default/flexipages",
666
+ "Generate a HomePage FlexiPage with a custom label:\n<%= config.bin %> <%= command.id %> --name Custom_Home --template HomePage --label \"Sales Home Page\"",
667
+ "Generate a RecordPage with dynamic highlights and detail fields:\n<%= config.bin %> <%= command.id %> --name Property_Page --template RecordPage --sobject Rental_Property__c --primary-field Name --secondary-fields Property_Address__c,City__c --detail-fields Name,Property_Address__c,City__c,Monthly_Rent__c,Bedrooms__c"
672
668
  ],
673
669
  "flags": {
674
670
  "json": {
@@ -688,30 +684,29 @@
688
684
  },
689
685
  "name": {
690
686
  "aliases": [
691
- "projectname"
687
+ "flexipagename"
692
688
  ],
693
689
  "char": "n",
694
690
  "deprecateAliases": true,
695
- "description": "Generates a project directory with this name; any valid directory name is accepted. Also sets the \"name\" property in the sfdx-project.json file to this name.",
691
+ "description": "The name can contain only alphanumeric characters, must start with a letter, and can't end with an underscore or contain two consecutive underscores.",
696
692
  "name": "name",
697
693
  "required": true,
698
- "summary": "Name of the generated project.",
694
+ "summary": "Name of the FlexiPage.",
699
695
  "hasDynamicHelp": false,
700
696
  "multiple": false,
701
697
  "type": "option"
702
698
  },
703
699
  "template": {
704
700
  "char": "t",
705
- "description": "The template determines the sample configuration files and directories that this command generates. For example, the empty template provides these files and directory to get you started.\n\n- .forceignore\n- config/project-scratch-def.json\n- sfdx-project.json\n- package.json\n- force-app (basic source directory structure)\n\nThe standard template provides a complete force-app directory structure so you know where to put your source. It also provides additional files and scripts, especially useful when using Salesforce Extensions for VS Code. For example:\n\n- .gitignore: Use Git for version control.\n- .prettierrc and .prettierignore: Use Prettier to format your Aura components.\n- .vscode/extensions.json: When launched, Visual Studio Code, prompts you to install the recommended extensions for your project.\n- .vscode/launch.json: Configures Replay Debugger.\n- .vscode/settings.json: Additional configuration settings.\n\nThe analytics template provides similar files and the force-app/main/default/waveTemplates directory.",
706
701
  "name": "template",
707
- "summary": "Template to use for project creation.",
708
- "default": "standard",
702
+ "required": true,
703
+ "summary": "Template type for the FlexiPage.",
709
704
  "hasDynamicHelp": false,
710
705
  "multiple": false,
711
706
  "options": [
712
- "standard",
713
- "empty",
714
- "analytics"
707
+ "RecordPage",
708
+ "AppPage",
709
+ "HomePage"
715
710
  ],
716
711
  "type": "option"
717
712
  },
@@ -729,52 +724,80 @@
729
724
  "multiple": false,
730
725
  "type": "option"
731
726
  },
732
- "namespace": {
733
- "char": "s",
734
- "name": "namespace",
735
- "summary": "Namespace associated with this project and any connected scratch orgs.",
736
- "default": "",
727
+ "api-version": {
728
+ "aliases": [
729
+ "apiversion"
730
+ ],
731
+ "deprecateAliases": true,
732
+ "description": "Override the api version used for api requests made by this command",
733
+ "name": "api-version",
737
734
  "hasDynamicHelp": false,
738
735
  "multiple": false,
739
736
  "type": "option"
740
737
  },
741
- "default-package-dir": {
738
+ "label": {
742
739
  "aliases": [
743
- "defaultpackagedir"
740
+ "masterlabel"
744
741
  ],
745
- "char": "p",
746
742
  "deprecateAliases": true,
747
- "description": "Metadata items such as classes and Lightning bundles are placed inside this folder.",
748
- "name": "default-package-dir",
749
- "summary": "Default package directory name.",
750
- "default": "force-app",
743
+ "name": "label",
744
+ "summary": "Label of this FlexiPage; if not specified, uses the FlexiPage name as the label.",
751
745
  "hasDynamicHelp": false,
752
746
  "multiple": false,
753
747
  "type": "option"
754
748
  },
755
- "manifest": {
756
- "char": "x",
757
- "description": "Generates a default manifest (package.xml) for fetching Apex, Visualforce, Lightning components, and static resources.",
758
- "name": "manifest",
759
- "summary": "Generate a manifest (package.xml) for change-set based development.",
760
- "allowNo": false,
761
- "type": "boolean"
749
+ "description": {
750
+ "name": "description",
751
+ "summary": "Description for the FlexiPage, which provides context about its purpose.",
752
+ "hasDynamicHelp": false,
753
+ "multiple": false,
754
+ "type": "option"
762
755
  },
763
- "login-url": {
756
+ "sobject": {
764
757
  "aliases": [
765
- "loginurl"
758
+ "entity-name",
759
+ "entity"
766
760
  ],
767
- "char": "l",
761
+ "char": "s",
768
762
  "deprecateAliases": true,
769
- "description": "Normally defaults to https://login.salesforce.com.",
770
- "hidden": true,
771
- "name": "login-url",
772
- "summary": "Salesforce instance login URL.",
773
- "default": "https://login.salesforce.com",
763
+ "description": "For RecordPage FlexiPages, you must specify the associated object API name, such as 'Account', 'Opportunity', or 'Custom_Object__c'. This sets the `sobjectType` field in the FlexiPage metadata.",
764
+ "name": "sobject",
765
+ "summary": "API name of the Salesforce object; required when creating a RecordPage.",
766
+ "hasDynamicHelp": false,
767
+ "multiple": false,
768
+ "type": "option"
769
+ },
770
+ "primary-field": {
771
+ "name": "primary-field",
772
+ "summary": "Primary field for the dynamic highlights header; typically 'Name'. Used only with RecordPage.",
774
773
  "hasDynamicHelp": false,
775
774
  "multiple": false,
776
775
  "type": "option"
777
776
  },
777
+ "secondary-fields": {
778
+ "name": "secondary-fields",
779
+ "summary": "Secondary fields shown in the dynamic highlights header. Specify multiple fields separated by commas. Maximum of 11 fields. Used only with RecordPage.",
780
+ "delimiter": ",",
781
+ "hasDynamicHelp": false,
782
+ "multiple": true,
783
+ "type": "option"
784
+ },
785
+ "detail-fields": {
786
+ "name": "detail-fields",
787
+ "summary": "Fields to display in the Details tab. Specify multiple fields separated by commas. Fields are split into two columns. Used only with RecordPage.",
788
+ "delimiter": ",",
789
+ "hasDynamicHelp": false,
790
+ "multiple": true,
791
+ "type": "option"
792
+ },
793
+ "internal": {
794
+ "char": "i",
795
+ "hidden": true,
796
+ "name": "internal",
797
+ "summary": "Generate lightning bundles without creating a -meta.xml file.",
798
+ "allowNo": false,
799
+ "type": "boolean"
800
+ },
778
801
  "loglevel": {
779
802
  "deprecated": {
780
803
  "message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable."
@@ -784,51 +807,36 @@
784
807
  "hasDynamicHelp": false,
785
808
  "multiple": false,
786
809
  "type": "option"
787
- },
788
- "api-version": {
789
- "description": "Override the api version used for api requests made by this command",
790
- "name": "api-version",
791
- "summary": "Will set this version as sourceApiVersion in the sfdx-project.json file",
792
- "hasDynamicHelp": false,
793
- "multiple": false,
794
- "type": "option"
795
810
  }
796
811
  },
797
812
  "hasDynamicHelp": false,
798
813
  "hiddenAliases": [],
799
- "id": "template:generate:project",
814
+ "id": "template:generate:flexipage",
800
815
  "pluginAlias": "@salesforce/plugin-templates",
801
816
  "pluginName": "@salesforce/plugin-templates",
802
817
  "pluginType": "core",
818
+ "state": "beta",
803
819
  "strict": true,
804
- "summary": "Generate a Salesforce DX project.",
820
+ "summary": "Generate a FlexiPage, also known as a Lightning page.",
805
821
  "enableJsonFlag": true,
822
+ "MAX_SECONDARY_FIELDS": 11,
806
823
  "isESM": true,
807
824
  "relativePath": [
808
825
  "lib",
809
826
  "commands",
810
827
  "template",
811
828
  "generate",
812
- "project",
829
+ "flexipage",
813
830
  "index.js"
814
831
  ],
815
- "aliasPermutations": [
816
- "force:project:create",
817
- "project:force:create",
818
- "project:create:force",
819
- "force:create:project",
820
- "create:force:project",
821
- "create:project:force",
822
- "project:generate",
823
- "generate:project"
824
- ],
832
+ "aliasPermutations": [],
825
833
  "permutations": [
826
- "template:generate:project",
827
- "generate:template:project",
828
- "generate:project:template",
829
- "template:project:generate",
830
- "project:template:generate",
831
- "project:generate:template"
834
+ "template:generate:flexipage",
835
+ "generate:template:flexipage",
836
+ "generate:flexipage:template",
837
+ "template:flexipage:generate",
838
+ "flexipage:template:generate",
839
+ "flexipage:generate:template"
832
840
  ]
833
841
  },
834
842
  "template:generate:lightning:app": {
@@ -1701,30 +1709,205 @@
1701
1709
  "test:generate:lightning"
1702
1710
  ],
1703
1711
  "permutations": [
1704
- "template:generate:lightning:test",
1705
- "generate:template:lightning:test",
1706
- "generate:lightning:template:test",
1707
- "generate:lightning:test:template",
1708
- "template:lightning:generate:test",
1709
- "lightning:template:generate:test",
1710
- "lightning:generate:template:test",
1711
- "lightning:generate:test:template",
1712
- "template:lightning:test:generate",
1713
- "lightning:template:test:generate",
1714
- "lightning:test:template:generate",
1715
- "lightning:test:generate:template",
1716
- "template:generate:test:lightning",
1717
- "generate:template:test:lightning",
1718
- "generate:test:template:lightning",
1719
- "generate:test:lightning:template",
1720
- "template:test:generate:lightning",
1721
- "test:template:generate:lightning",
1722
- "test:generate:template:lightning",
1723
- "test:generate:lightning:template",
1724
- "template:test:lightning:generate",
1725
- "test:template:lightning:generate",
1726
- "test:lightning:template:generate",
1727
- "test:lightning:generate:template"
1712
+ "template:generate:lightning:test",
1713
+ "generate:template:lightning:test",
1714
+ "generate:lightning:template:test",
1715
+ "generate:lightning:test:template",
1716
+ "template:lightning:generate:test",
1717
+ "lightning:template:generate:test",
1718
+ "lightning:generate:template:test",
1719
+ "lightning:generate:test:template",
1720
+ "template:lightning:test:generate",
1721
+ "lightning:template:test:generate",
1722
+ "lightning:test:template:generate",
1723
+ "lightning:test:generate:template",
1724
+ "template:generate:test:lightning",
1725
+ "generate:template:test:lightning",
1726
+ "generate:test:template:lightning",
1727
+ "generate:test:lightning:template",
1728
+ "template:test:generate:lightning",
1729
+ "test:template:generate:lightning",
1730
+ "test:generate:template:lightning",
1731
+ "test:generate:lightning:template",
1732
+ "template:test:lightning:generate",
1733
+ "test:template:lightning:generate",
1734
+ "test:lightning:template:generate",
1735
+ "test:lightning:generate:template"
1736
+ ]
1737
+ },
1738
+ "template:generate:project": {
1739
+ "aliases": [
1740
+ "force:project:create",
1741
+ "project:generate"
1742
+ ],
1743
+ "args": {},
1744
+ "deprecateAliases": true,
1745
+ "description": "A Salesforce DX project has a specific structure and a configuration file (sfdx-project.json) that identifies the directory as a Salesforce DX project. This command generates the necessary configuration files and directories to get you started.\n\nBy default, the generated sfdx-project.json file sets the sourceApiVersion property to the default API version currently used by Salesforce CLI. To specify a different version, set the apiVersion configuration variable. For example: \"sf config set apiVersion=57.0 --global\".",
1746
+ "examples": [
1747
+ "Generate a project called \"mywork\":\n<%= config.bin %> <%= command.id %> --name mywork",
1748
+ "Similar to previous example, but generate the files in a directory called \"myapp\":\n<%= config.bin %> <%= command.id %> --name mywork --default-package-dir myapp",
1749
+ "Similar to prevoius example, but also generate a default package.xml manifest file:\n<%= config.bin %> <%= command.id %> --name mywork --default-package-dir myapp --manifest",
1750
+ "Generate a project with the minimum files and directories:\n<%= config.bin %> <%= command.id %> --name mywork --template empty"
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
+ "name": {
1769
+ "aliases": [
1770
+ "projectname"
1771
+ ],
1772
+ "char": "n",
1773
+ "deprecateAliases": true,
1774
+ "description": "Generates a project directory with this name; any valid directory name is accepted. Also sets the \"name\" property in the sfdx-project.json file to this name.",
1775
+ "name": "name",
1776
+ "required": true,
1777
+ "summary": "Name of the generated project.",
1778
+ "hasDynamicHelp": false,
1779
+ "multiple": false,
1780
+ "type": "option"
1781
+ },
1782
+ "template": {
1783
+ "char": "t",
1784
+ "description": "The template determines the sample configuration files and directories that this command generates. For example, the empty template provides these files and directory to get you started.\n\n- .forceignore\n- config/project-scratch-def.json\n- sfdx-project.json\n- package.json\n- force-app (basic source directory structure)\n\nThe standard template provides a complete force-app directory structure so you know where to put your source. It also provides additional files and scripts, especially useful when using Salesforce Extensions for VS Code. For example:\n\n- .gitignore: Use Git for version control.\n- .prettierrc and .prettierignore: Use Prettier to format your Aura components.\n- .vscode/extensions.json: When launched, Visual Studio Code, prompts you to install the recommended extensions for your project.\n- .vscode/launch.json: Configures Replay Debugger.\n- .vscode/settings.json: Additional configuration settings.\n\nThe analytics template provides similar files and the force-app/main/default/waveTemplates directory.",
1785
+ "name": "template",
1786
+ "summary": "Template to use for project creation.",
1787
+ "default": "standard",
1788
+ "hasDynamicHelp": false,
1789
+ "multiple": false,
1790
+ "options": [
1791
+ "standard",
1792
+ "empty",
1793
+ "analytics"
1794
+ ],
1795
+ "type": "option"
1796
+ },
1797
+ "output-dir": {
1798
+ "aliases": [
1799
+ "outputdir"
1800
+ ],
1801
+ "char": "d",
1802
+ "deprecateAliases": true,
1803
+ "description": "The location can be an absolute path or relative to the current working directory. The default is the current directory.",
1804
+ "name": "output-dir",
1805
+ "summary": "Directory for saving the created files.",
1806
+ "default": ".",
1807
+ "hasDynamicHelp": false,
1808
+ "multiple": false,
1809
+ "type": "option"
1810
+ },
1811
+ "namespace": {
1812
+ "char": "s",
1813
+ "name": "namespace",
1814
+ "summary": "Namespace associated with this project and any connected scratch orgs.",
1815
+ "default": "",
1816
+ "hasDynamicHelp": false,
1817
+ "multiple": false,
1818
+ "type": "option"
1819
+ },
1820
+ "default-package-dir": {
1821
+ "aliases": [
1822
+ "defaultpackagedir"
1823
+ ],
1824
+ "char": "p",
1825
+ "deprecateAliases": true,
1826
+ "description": "Metadata items such as classes and Lightning bundles are placed inside this folder.",
1827
+ "name": "default-package-dir",
1828
+ "summary": "Default package directory name.",
1829
+ "default": "force-app",
1830
+ "hasDynamicHelp": false,
1831
+ "multiple": false,
1832
+ "type": "option"
1833
+ },
1834
+ "manifest": {
1835
+ "char": "x",
1836
+ "description": "Generates a default manifest (package.xml) for fetching Apex, Visualforce, Lightning components, and static resources.",
1837
+ "name": "manifest",
1838
+ "summary": "Generate a manifest (package.xml) for change-set based development.",
1839
+ "allowNo": false,
1840
+ "type": "boolean"
1841
+ },
1842
+ "login-url": {
1843
+ "aliases": [
1844
+ "loginurl"
1845
+ ],
1846
+ "char": "l",
1847
+ "deprecateAliases": true,
1848
+ "description": "Normally defaults to https://login.salesforce.com.",
1849
+ "hidden": true,
1850
+ "name": "login-url",
1851
+ "summary": "Salesforce instance login URL.",
1852
+ "default": "https://login.salesforce.com",
1853
+ "hasDynamicHelp": false,
1854
+ "multiple": false,
1855
+ "type": "option"
1856
+ },
1857
+ "loglevel": {
1858
+ "deprecated": {
1859
+ "message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable."
1860
+ },
1861
+ "hidden": true,
1862
+ "name": "loglevel",
1863
+ "hasDynamicHelp": false,
1864
+ "multiple": false,
1865
+ "type": "option"
1866
+ },
1867
+ "api-version": {
1868
+ "description": "Override the api version used for api requests made by this command",
1869
+ "name": "api-version",
1870
+ "summary": "Will set this version as sourceApiVersion in the sfdx-project.json file",
1871
+ "hasDynamicHelp": false,
1872
+ "multiple": false,
1873
+ "type": "option"
1874
+ }
1875
+ },
1876
+ "hasDynamicHelp": false,
1877
+ "hiddenAliases": [],
1878
+ "id": "template:generate:project",
1879
+ "pluginAlias": "@salesforce/plugin-templates",
1880
+ "pluginName": "@salesforce/plugin-templates",
1881
+ "pluginType": "core",
1882
+ "strict": true,
1883
+ "summary": "Generate a Salesforce DX project.",
1884
+ "enableJsonFlag": true,
1885
+ "isESM": true,
1886
+ "relativePath": [
1887
+ "lib",
1888
+ "commands",
1889
+ "template",
1890
+ "generate",
1891
+ "project",
1892
+ "index.js"
1893
+ ],
1894
+ "aliasPermutations": [
1895
+ "force:project:create",
1896
+ "project:force:create",
1897
+ "project:create:force",
1898
+ "force:create:project",
1899
+ "create:force:project",
1900
+ "create:project:force",
1901
+ "project:generate",
1902
+ "generate:project"
1903
+ ],
1904
+ "permutations": [
1905
+ "template:generate:project",
1906
+ "generate:template:project",
1907
+ "generate:project:template",
1908
+ "template:project:generate",
1909
+ "project:template:generate",
1910
+ "project:generate:template"
1728
1911
  ]
1729
1912
  },
1730
1913
  "template:generate:static-resource": {
@@ -1856,116 +2039,6 @@
1856
2039
  "static-resource:generate:template"
1857
2040
  ]
1858
2041
  },
1859
- "template:generate:webapp": {
1860
- "aliases": [
1861
- "webapp:generate"
1862
- ],
1863
- "args": {},
1864
- "deprecateAliases": true,
1865
- "description": "Generates a web application in the specified directory or the current working directory. The web application files are created in a folder with the designated name. Web application files must be contained in a parent directory called \"webapplications\" 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.",
1866
- "examples": [
1867
- "Generate a web application called MyWebApp in the current directory:\n<%= config.bin %> <%= command.id %> --name MyWebApp",
1868
- "Generate a React-based web application:\n<%= config.bin %> <%= command.id %> --name MyReactApp --template reactbasic",
1869
- "Generate the web application in the \"force-app/main/default/webapplications\" directory:\n<%= config.bin %> <%= command.id %> --name MyWebApp --output-dir force-app/main/default/webapplications"
1870
- ],
1871
- "flags": {
1872
- "json": {
1873
- "description": "Format output as json.",
1874
- "helpGroup": "GLOBAL",
1875
- "name": "json",
1876
- "allowNo": false,
1877
- "type": "boolean"
1878
- },
1879
- "flags-dir": {
1880
- "helpGroup": "GLOBAL",
1881
- "name": "flags-dir",
1882
- "summary": "Import flag values from a directory.",
1883
- "hasDynamicHelp": false,
1884
- "multiple": false,
1885
- "type": "option"
1886
- },
1887
- "name": {
1888
- "char": "n",
1889
- "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.",
1890
- "name": "name",
1891
- "required": true,
1892
- "summary": "Name of the generated web application.",
1893
- "hasDynamicHelp": false,
1894
- "multiple": false,
1895
- "type": "option"
1896
- },
1897
- "template": {
1898
- "char": "t",
1899
- "description": "Supplied parameter values or default values are filled into a copy of the template.",
1900
- "name": "template",
1901
- "summary": "Template to use for file creation.",
1902
- "default": "default",
1903
- "hasDynamicHelp": false,
1904
- "multiple": false,
1905
- "options": [
1906
- "default",
1907
- "reactbasic"
1908
- ],
1909
- "type": "option"
1910
- },
1911
- "label": {
1912
- "char": "l",
1913
- "description": "If not specified, the label is derived from the name.",
1914
- "name": "label",
1915
- "summary": "Master label for the web application.",
1916
- "hasDynamicHelp": false,
1917
- "multiple": false,
1918
- "type": "option"
1919
- },
1920
- "output-dir": {
1921
- "char": "d",
1922
- "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 and defaults to the webapplications directory within your default package directory. When running outside a Salesforce DX project, defaults to the current directory.",
1923
- "name": "output-dir",
1924
- "summary": "Directory for saving the created files.",
1925
- "hasDynamicHelp": false,
1926
- "multiple": false,
1927
- "type": "option"
1928
- },
1929
- "api-version": {
1930
- "description": "Override the api version used for api requests made by this command",
1931
- "name": "api-version",
1932
- "hasDynamicHelp": false,
1933
- "multiple": false,
1934
- "type": "option"
1935
- }
1936
- },
1937
- "hasDynamicHelp": false,
1938
- "hidden": true,
1939
- "hiddenAliases": [],
1940
- "id": "template:generate:webapp",
1941
- "pluginAlias": "@salesforce/plugin-templates",
1942
- "pluginName": "@salesforce/plugin-templates",
1943
- "pluginType": "core",
1944
- "strict": true,
1945
- "summary": "Generate a web application.",
1946
- "enableJsonFlag": true,
1947
- "isESM": true,
1948
- "relativePath": [
1949
- "lib",
1950
- "commands",
1951
- "template",
1952
- "generate",
1953
- "webapp",
1954
- "index.js"
1955
- ],
1956
- "aliasPermutations": [
1957
- "webapp:generate",
1958
- "generate:webapp"
1959
- ],
1960
- "permutations": [
1961
- "template:generate:webapp",
1962
- "generate:template:webapp",
1963
- "generate:webapp:template",
1964
- "template:webapp:generate",
1965
- "webapp:template:generate",
1966
- "webapp:generate:template"
1967
- ]
1968
- },
1969
2042
  "template:generate:visualforce:component": {
1970
2043
  "aliases": [
1971
2044
  "force:visualforce:component:create",
@@ -2320,7 +2393,117 @@
2320
2393
  "page:visualforce:template:generate",
2321
2394
  "page:visualforce:generate:template"
2322
2395
  ]
2396
+ },
2397
+ "template:generate:webapp": {
2398
+ "aliases": [
2399
+ "webapp:generate"
2400
+ ],
2401
+ "args": {},
2402
+ "deprecateAliases": true,
2403
+ "description": "Generates a web application in the specified directory or the current working directory. The web application files are created in a folder with the designated name. Web application files must be contained in a parent directory called \"webapplications\" 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.",
2404
+ "examples": [
2405
+ "Generate a web application called MyWebApp in the current directory:\n<%= config.bin %> <%= command.id %> --name MyWebApp",
2406
+ "Generate a React-based web application:\n<%= config.bin %> <%= command.id %> --name MyReactApp --template reactbasic",
2407
+ "Generate the web application in the \"force-app/main/default/webapplications\" directory:\n<%= config.bin %> <%= command.id %> --name MyWebApp --output-dir force-app/main/default/webapplications"
2408
+ ],
2409
+ "flags": {
2410
+ "json": {
2411
+ "description": "Format output as json.",
2412
+ "helpGroup": "GLOBAL",
2413
+ "name": "json",
2414
+ "allowNo": false,
2415
+ "type": "boolean"
2416
+ },
2417
+ "flags-dir": {
2418
+ "helpGroup": "GLOBAL",
2419
+ "name": "flags-dir",
2420
+ "summary": "Import flag values from a directory.",
2421
+ "hasDynamicHelp": false,
2422
+ "multiple": false,
2423
+ "type": "option"
2424
+ },
2425
+ "name": {
2426
+ "char": "n",
2427
+ "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.",
2428
+ "name": "name",
2429
+ "required": true,
2430
+ "summary": "Name of the generated web application.",
2431
+ "hasDynamicHelp": false,
2432
+ "multiple": false,
2433
+ "type": "option"
2434
+ },
2435
+ "template": {
2436
+ "char": "t",
2437
+ "description": "Supplied parameter values or default values are filled into a copy of the template.",
2438
+ "name": "template",
2439
+ "summary": "Template to use for file creation.",
2440
+ "default": "default",
2441
+ "hasDynamicHelp": false,
2442
+ "multiple": false,
2443
+ "options": [
2444
+ "default",
2445
+ "reactbasic"
2446
+ ],
2447
+ "type": "option"
2448
+ },
2449
+ "label": {
2450
+ "char": "l",
2451
+ "description": "If not specified, the label is derived from the name.",
2452
+ "name": "label",
2453
+ "summary": "Master label for the web application.",
2454
+ "hasDynamicHelp": false,
2455
+ "multiple": false,
2456
+ "type": "option"
2457
+ },
2458
+ "output-dir": {
2459
+ "char": "d",
2460
+ "description": "The location can be an absolute path or relative to the current working directory. \n\n**Important:** The generator automatically ensures the output directory ends with \"webapplications\". If your specified path doesn't end with \"webapplications\", it's automatically appended. The web application is created at \"<output-dir>/<webappname>\".\n\n**Examples:**\n- \"--output-dir force-app/main/default\" → Creates a web application at \"force-app/main/default/webapplications/MyWebApp/\"\n- \"--output-dir force-app/main/default/webapplications\" → Creates a web application at \"force-app/main/default/webapplications/MyWebApp/\" (no change)\n\nIf not specified, the command reads your sfdx-project.json and defaults to \"webapplications\" directory within your default package directory. When running outside a Salesforce DX project, defaults to the current directory.",
2461
+ "name": "output-dir",
2462
+ "summary": "Directory for saving the created files.",
2463
+ "hasDynamicHelp": false,
2464
+ "multiple": false,
2465
+ "type": "option"
2466
+ },
2467
+ "api-version": {
2468
+ "description": "Override the api version used for api requests made by this command",
2469
+ "name": "api-version",
2470
+ "hasDynamicHelp": false,
2471
+ "multiple": false,
2472
+ "type": "option"
2473
+ }
2474
+ },
2475
+ "hasDynamicHelp": false,
2476
+ "hidden": true,
2477
+ "hiddenAliases": [],
2478
+ "id": "template:generate:webapp",
2479
+ "pluginAlias": "@salesforce/plugin-templates",
2480
+ "pluginName": "@salesforce/plugin-templates",
2481
+ "pluginType": "core",
2482
+ "strict": true,
2483
+ "summary": "Generate a web application.",
2484
+ "enableJsonFlag": true,
2485
+ "isESM": true,
2486
+ "relativePath": [
2487
+ "lib",
2488
+ "commands",
2489
+ "template",
2490
+ "generate",
2491
+ "webapp",
2492
+ "index.js"
2493
+ ],
2494
+ "aliasPermutations": [
2495
+ "webapp:generate",
2496
+ "generate:webapp"
2497
+ ],
2498
+ "permutations": [
2499
+ "template:generate:webapp",
2500
+ "generate:template:webapp",
2501
+ "generate:webapp:template",
2502
+ "template:webapp:generate",
2503
+ "webapp:template:generate",
2504
+ "webapp:generate:template"
2505
+ ]
2323
2506
  }
2324
2507
  },
2325
- "version": "56.7.2"
2508
+ "version": "56.8.1"
2326
2509
  }