@salesforce/plugin-templates 57.1.2 → 57.3.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 +95 -15
- package/lib/commands/template/generate/ui-embedding/index.d.ts +1 -3
- package/lib/commands/template/generate/ui-embedding/index.js +4 -6
- package/lib/commands/template/generate/ui-embedding/index.js.map +1 -1
- package/messages/uiEmbedding.md +5 -5
- package/oclif.manifest.json +997 -999
- package/package.json +4 -4
package/oclif.manifest.json
CHANGED
|
@@ -658,20 +658,15 @@
|
|
|
658
658
|
"site:digital-experience:generate:template"
|
|
659
659
|
]
|
|
660
660
|
},
|
|
661
|
-
"template:generate:
|
|
662
|
-
"aliases": [
|
|
663
|
-
"force:project:create",
|
|
664
|
-
"project:generate"
|
|
665
|
-
],
|
|
661
|
+
"template:generate:flexipage": {
|
|
662
|
+
"aliases": [],
|
|
666
663
|
"args": {},
|
|
667
|
-
"
|
|
668
|
-
"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\".",
|
|
664
|
+
"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.",
|
|
669
665
|
"examples": [
|
|
670
|
-
"Generate a
|
|
671
|
-
"
|
|
672
|
-
"
|
|
673
|
-
"Generate a
|
|
674
|
-
"Generate a project in which the Lightning Web Components use TypeScript rather than the default JavaScript:\n<%= config.bin %> <%= command.id %> --name mywork --lwc-language typescript"
|
|
666
|
+
"Generate a RecordPage FlexiPage for the Account object in the current directory:\n<%= config.bin %> <%= command.id %> --name Account_Record_Page --template RecordPage --sobject Account",
|
|
667
|
+
"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",
|
|
668
|
+
"Generate a HomePage FlexiPage with a custom label:\n<%= config.bin %> <%= command.id %> --name Custom_Home --template HomePage --label \"Sales Home Page\"",
|
|
669
|
+
"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"
|
|
675
670
|
],
|
|
676
671
|
"flags": {
|
|
677
672
|
"json": {
|
|
@@ -691,35 +686,29 @@
|
|
|
691
686
|
},
|
|
692
687
|
"name": {
|
|
693
688
|
"aliases": [
|
|
694
|
-
"
|
|
689
|
+
"flexipagename"
|
|
695
690
|
],
|
|
696
691
|
"char": "n",
|
|
697
692
|
"deprecateAliases": true,
|
|
698
|
-
"description": "
|
|
693
|
+
"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.",
|
|
699
694
|
"name": "name",
|
|
700
695
|
"required": true,
|
|
701
|
-
"summary": "Name of the
|
|
696
|
+
"summary": "Name of the FlexiPage.",
|
|
702
697
|
"hasDynamicHelp": false,
|
|
703
698
|
"multiple": false,
|
|
704
699
|
"type": "option"
|
|
705
700
|
},
|
|
706
701
|
"template": {
|
|
707
702
|
"char": "t",
|
|
708
|
-
"description": "The template determines the sample configuration files and directories that this command generates. For example, the empty template provides these files and directory to get you started.\n\n- .forceignore\n- config/project-scratch-def.json\n- sfdx-project.json\n- package.json\n- force-app (basic source directory structure)\n\nThe standard template provides a complete force-app directory structure so you know where to put your source. It also provides additional files and scripts, especially useful when using Salesforce Extensions for VS Code. For example:\n\n- .gitignore: Use Git for version control.\n- .prettierrc and .prettierignore: Use Prettier to format your Aura components.\n- .vscode/extensions.json: When launched, Visual Studio Code, prompts you to install the recommended extensions for your project.\n- .vscode/launch.json: Configures Replay Debugger.\n- .vscode/settings.json: Additional configuration settings.\n\nThe analytics template provides similar files and the force-app/main/default/waveTemplates directory.\n\nThe reactinternalapp and reactexternalapp templates provide React-based project scaffolding for internal and external UI bundle use cases.\n\nThe angularinternalapp and angularexternalapp templates provide Angular-based project scaffolding for internal and external UI bundle use cases.\n\nThe agent template provides project scaffolding for building Agentforce agents and includes a sample agent called Local Info Agent.",
|
|
709
703
|
"name": "template",
|
|
710
|
-
"
|
|
711
|
-
"
|
|
704
|
+
"required": true,
|
|
705
|
+
"summary": "Template type for the FlexiPage.",
|
|
712
706
|
"hasDynamicHelp": false,
|
|
713
707
|
"multiple": false,
|
|
714
708
|
"options": [
|
|
715
|
-
"
|
|
716
|
-
"
|
|
717
|
-
"
|
|
718
|
-
"reactinternalapp",
|
|
719
|
-
"reactexternalapp",
|
|
720
|
-
"angularinternalapp",
|
|
721
|
-
"angularexternalapp",
|
|
722
|
-
"agent"
|
|
709
|
+
"RecordPage",
|
|
710
|
+
"AppPage",
|
|
711
|
+
"HomePage"
|
|
723
712
|
],
|
|
724
713
|
"type": "option"
|
|
725
714
|
},
|
|
@@ -737,64 +726,80 @@
|
|
|
737
726
|
"multiple": false,
|
|
738
727
|
"type": "option"
|
|
739
728
|
},
|
|
740
|
-
"
|
|
741
|
-
"
|
|
742
|
-
|
|
743
|
-
|
|
744
|
-
"
|
|
729
|
+
"api-version": {
|
|
730
|
+
"aliases": [
|
|
731
|
+
"apiversion"
|
|
732
|
+
],
|
|
733
|
+
"deprecateAliases": true,
|
|
734
|
+
"description": "Override the api version used for api requests made by this command",
|
|
735
|
+
"name": "api-version",
|
|
745
736
|
"hasDynamicHelp": false,
|
|
746
737
|
"multiple": false,
|
|
747
738
|
"type": "option"
|
|
748
739
|
},
|
|
749
|
-
"
|
|
740
|
+
"label": {
|
|
750
741
|
"aliases": [
|
|
751
|
-
"
|
|
742
|
+
"masterlabel"
|
|
752
743
|
],
|
|
753
|
-
"char": "p",
|
|
754
744
|
"deprecateAliases": true,
|
|
755
|
-
"
|
|
756
|
-
"
|
|
757
|
-
"summary": "Default package directory name.",
|
|
758
|
-
"default": "force-app",
|
|
745
|
+
"name": "label",
|
|
746
|
+
"summary": "Label of this FlexiPage; if not specified, uses the FlexiPage name as the label.",
|
|
759
747
|
"hasDynamicHelp": false,
|
|
760
748
|
"multiple": false,
|
|
761
749
|
"type": "option"
|
|
762
750
|
},
|
|
763
|
-
"
|
|
764
|
-
"
|
|
765
|
-
"
|
|
766
|
-
"
|
|
767
|
-
"
|
|
768
|
-
"
|
|
769
|
-
"type": "boolean"
|
|
751
|
+
"description": {
|
|
752
|
+
"name": "description",
|
|
753
|
+
"summary": "Description for the FlexiPage, which provides context about its purpose.",
|
|
754
|
+
"hasDynamicHelp": false,
|
|
755
|
+
"multiple": false,
|
|
756
|
+
"type": "option"
|
|
770
757
|
},
|
|
771
|
-
"
|
|
758
|
+
"sobject": {
|
|
772
759
|
"aliases": [
|
|
773
|
-
"
|
|
760
|
+
"entity-name",
|
|
761
|
+
"entity"
|
|
774
762
|
],
|
|
775
|
-
"char": "
|
|
763
|
+
"char": "s",
|
|
776
764
|
"deprecateAliases": true,
|
|
777
|
-
"description": "
|
|
778
|
-
"
|
|
779
|
-
"
|
|
780
|
-
"summary": "Salesforce instance login URL.",
|
|
781
|
-
"default": "https://login.salesforce.com",
|
|
765
|
+
"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.",
|
|
766
|
+
"name": "sobject",
|
|
767
|
+
"summary": "API name of the Salesforce object; required when creating a RecordPage.",
|
|
782
768
|
"hasDynamicHelp": false,
|
|
783
769
|
"multiple": false,
|
|
784
770
|
"type": "option"
|
|
785
771
|
},
|
|
786
|
-
"
|
|
787
|
-
"
|
|
788
|
-
"
|
|
789
|
-
"summary": "Language of the Lightning Web Components. If not specified, \"javascript\" is used.",
|
|
772
|
+
"primary-field": {
|
|
773
|
+
"name": "primary-field",
|
|
774
|
+
"summary": "Primary field for the dynamic highlights header; typically 'Name'. Used only with RecordPage.",
|
|
790
775
|
"hasDynamicHelp": false,
|
|
791
776
|
"multiple": false,
|
|
792
|
-
"options": [
|
|
793
|
-
"javascript",
|
|
794
|
-
"typescript"
|
|
795
|
-
],
|
|
796
777
|
"type": "option"
|
|
797
778
|
},
|
|
779
|
+
"secondary-fields": {
|
|
780
|
+
"name": "secondary-fields",
|
|
781
|
+
"summary": "Secondary fields shown in the dynamic highlights header. Specify multiple fields separated by commas. Maximum of 11 fields. Used only with RecordPage.",
|
|
782
|
+
"delimiter": ",",
|
|
783
|
+
"hasDynamicHelp": false,
|
|
784
|
+
"multiple": true,
|
|
785
|
+
"type": "option"
|
|
786
|
+
},
|
|
787
|
+
"detail-fields": {
|
|
788
|
+
"name": "detail-fields",
|
|
789
|
+
"summary": "Fields to display in the Details tab. Specify multiple fields separated by commas. Fields are split into two columns. Used only with RecordPage.",
|
|
790
|
+
"delimiter": ",",
|
|
791
|
+
"hasDynamicHelp": false,
|
|
792
|
+
"multiple": true,
|
|
793
|
+
"type": "option"
|
|
794
|
+
},
|
|
795
|
+
"internal": {
|
|
796
|
+
"char": "i",
|
|
797
|
+
"hidden": true,
|
|
798
|
+
"name": "internal",
|
|
799
|
+
"summary": "Generate lightning bundles without creating a -meta.xml file.",
|
|
800
|
+
"allowNo": false,
|
|
801
|
+
"type": "boolean"
|
|
802
|
+
},
|
|
798
803
|
"loglevel": {
|
|
799
804
|
"deprecated": {
|
|
800
805
|
"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."
|
|
@@ -804,65 +809,49 @@
|
|
|
804
809
|
"hasDynamicHelp": false,
|
|
805
810
|
"multiple": false,
|
|
806
811
|
"type": "option"
|
|
807
|
-
},
|
|
808
|
-
"api-version": {
|
|
809
|
-
"description": "Override the api version used for api requests made by this command",
|
|
810
|
-
"name": "api-version",
|
|
811
|
-
"summary": "Will set this version as sourceApiVersion in the sfdx-project.json file",
|
|
812
|
-
"hasDynamicHelp": false,
|
|
813
|
-
"multiple": false,
|
|
814
|
-
"type": "option"
|
|
815
812
|
}
|
|
816
813
|
},
|
|
817
814
|
"hasDynamicHelp": false,
|
|
818
815
|
"hiddenAliases": [],
|
|
819
|
-
"id": "template:generate:
|
|
816
|
+
"id": "template:generate:flexipage",
|
|
820
817
|
"pluginAlias": "@salesforce/plugin-templates",
|
|
821
818
|
"pluginName": "@salesforce/plugin-templates",
|
|
822
819
|
"pluginType": "core",
|
|
820
|
+
"state": "beta",
|
|
823
821
|
"strict": true,
|
|
824
|
-
"summary": "Generate a
|
|
822
|
+
"summary": "Generate a FlexiPage, also known as a Lightning page.",
|
|
825
823
|
"enableJsonFlag": true,
|
|
824
|
+
"MAX_SECONDARY_FIELDS": 11,
|
|
826
825
|
"isESM": true,
|
|
827
826
|
"relativePath": [
|
|
828
827
|
"lib",
|
|
829
828
|
"commands",
|
|
830
829
|
"template",
|
|
831
830
|
"generate",
|
|
832
|
-
"
|
|
831
|
+
"flexipage",
|
|
833
832
|
"index.js"
|
|
834
833
|
],
|
|
835
|
-
"aliasPermutations": [
|
|
836
|
-
"force:project:create",
|
|
837
|
-
"project:force:create",
|
|
838
|
-
"project:create:force",
|
|
839
|
-
"force:create:project",
|
|
840
|
-
"create:force:project",
|
|
841
|
-
"create:project:force",
|
|
842
|
-
"project:generate",
|
|
843
|
-
"generate:project"
|
|
844
|
-
],
|
|
834
|
+
"aliasPermutations": [],
|
|
845
835
|
"permutations": [
|
|
846
|
-
"template:generate:
|
|
847
|
-
"generate:template:
|
|
848
|
-
"generate:
|
|
849
|
-
"template:
|
|
850
|
-
"
|
|
851
|
-
"
|
|
836
|
+
"template:generate:flexipage",
|
|
837
|
+
"generate:template:flexipage",
|
|
838
|
+
"generate:flexipage:template",
|
|
839
|
+
"template:flexipage:generate",
|
|
840
|
+
"flexipage:template:generate",
|
|
841
|
+
"flexipage:generate:template"
|
|
852
842
|
]
|
|
853
843
|
},
|
|
854
|
-
"template:generate:
|
|
844
|
+
"template:generate:lightning:app": {
|
|
855
845
|
"aliases": [
|
|
856
|
-
"force:
|
|
857
|
-
"
|
|
846
|
+
"force:lightning:app:create",
|
|
847
|
+
"lightning:generate:app"
|
|
858
848
|
],
|
|
859
849
|
"args": {},
|
|
860
850
|
"deprecateAliases": true,
|
|
861
|
-
"description": "Generates
|
|
851
|
+
"description": "Generates a Lightning App bundle in the specified directory or the current working directory. The bundle consists of multiple files in a folder with the designated name.",
|
|
862
852
|
"examples": [
|
|
863
|
-
"Generate the metadata
|
|
864
|
-
"Similar to previous example, but
|
|
865
|
-
"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"
|
|
853
|
+
"Generate the metadata files for a Lightning app bundle called \"myapp\" in the current directory:\n<%= config.bin %> <%= command.id %> --name myapp",
|
|
854
|
+
"Similar to the previous example, but generate the files in the \"force-app/main/default/aura\" directory:\n<%= config.bin %> <%= command.id %> --name myapp --output-dir force-app/main/default/aura"
|
|
866
855
|
],
|
|
867
856
|
"flags": {
|
|
868
857
|
"json": {
|
|
@@ -882,29 +871,29 @@
|
|
|
882
871
|
},
|
|
883
872
|
"name": {
|
|
884
873
|
"aliases": [
|
|
885
|
-
"
|
|
874
|
+
"appname"
|
|
886
875
|
],
|
|
887
876
|
"char": "n",
|
|
888
877
|
"deprecateAliases": true,
|
|
889
|
-
"description": "
|
|
878
|
+
"description": "The name can be up to 40 characters and must start with a letter.",
|
|
890
879
|
"name": "name",
|
|
891
880
|
"required": true,
|
|
892
|
-
"summary": "Name of the generated
|
|
881
|
+
"summary": "Name of the generated Lightning App.",
|
|
893
882
|
"hasDynamicHelp": false,
|
|
894
883
|
"multiple": false,
|
|
895
884
|
"type": "option"
|
|
896
885
|
},
|
|
897
|
-
"
|
|
898
|
-
"
|
|
899
|
-
|
|
900
|
-
|
|
901
|
-
"
|
|
902
|
-
"
|
|
903
|
-
"name": "type",
|
|
904
|
-
"summary": "Content type (mime type) of the generated static resource.",
|
|
905
|
-
"default": "application/zip",
|
|
886
|
+
"template": {
|
|
887
|
+
"char": "t",
|
|
888
|
+
"description": "Supplied parameter values or default values are filled into a copy of the template. For Lightning Web Components, if this flag isn't specified, the CLI command automatically selects the template based on the \"defaultLwcLanguage\" field in the DX project's \"sfdx-project.json\" file.",
|
|
889
|
+
"name": "template",
|
|
890
|
+
"summary": "Template to use for file creation.",
|
|
891
|
+
"default": "DefaultLightningApp",
|
|
906
892
|
"hasDynamicHelp": false,
|
|
907
893
|
"multiple": false,
|
|
894
|
+
"options": [
|
|
895
|
+
"DefaultLightningApp"
|
|
896
|
+
],
|
|
908
897
|
"type": "option"
|
|
909
898
|
},
|
|
910
899
|
"output-dir": {
|
|
@@ -932,6 +921,14 @@
|
|
|
932
921
|
"multiple": false,
|
|
933
922
|
"type": "option"
|
|
934
923
|
},
|
|
924
|
+
"internal": {
|
|
925
|
+
"char": "i",
|
|
926
|
+
"hidden": true,
|
|
927
|
+
"name": "internal",
|
|
928
|
+
"summary": "Generate lightning bundles without creating a -meta.xml file.",
|
|
929
|
+
"allowNo": false,
|
|
930
|
+
"type": "boolean"
|
|
931
|
+
},
|
|
935
932
|
"loglevel": {
|
|
936
933
|
"deprecated": {
|
|
937
934
|
"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."
|
|
@@ -945,12 +942,12 @@
|
|
|
945
942
|
},
|
|
946
943
|
"hasDynamicHelp": false,
|
|
947
944
|
"hiddenAliases": [],
|
|
948
|
-
"id": "template:generate:
|
|
945
|
+
"id": "template:generate:lightning:app",
|
|
949
946
|
"pluginAlias": "@salesforce/plugin-templates",
|
|
950
947
|
"pluginName": "@salesforce/plugin-templates",
|
|
951
948
|
"pluginType": "core",
|
|
952
949
|
"strict": true,
|
|
953
|
-
"summary": "Generate a
|
|
950
|
+
"summary": "Generate a Lightning App.",
|
|
954
951
|
"enableJsonFlag": true,
|
|
955
952
|
"isESM": true,
|
|
956
953
|
"relativePath": [
|
|
@@ -958,47 +955,92 @@
|
|
|
958
955
|
"commands",
|
|
959
956
|
"template",
|
|
960
957
|
"generate",
|
|
961
|
-
"
|
|
962
|
-
"
|
|
958
|
+
"lightning",
|
|
959
|
+
"app.js"
|
|
963
960
|
],
|
|
964
961
|
"aliasPermutations": [
|
|
965
|
-
"force:
|
|
966
|
-
"
|
|
967
|
-
"
|
|
968
|
-
"
|
|
969
|
-
"
|
|
970
|
-
"
|
|
971
|
-
"
|
|
972
|
-
"
|
|
973
|
-
|
|
974
|
-
|
|
975
|
-
"
|
|
976
|
-
"
|
|
977
|
-
"
|
|
978
|
-
"
|
|
979
|
-
"
|
|
980
|
-
"
|
|
981
|
-
|
|
982
|
-
|
|
983
|
-
|
|
984
|
-
|
|
985
|
-
|
|
986
|
-
|
|
987
|
-
|
|
988
|
-
"
|
|
989
|
-
"
|
|
990
|
-
"
|
|
991
|
-
"
|
|
992
|
-
|
|
993
|
-
|
|
994
|
-
"
|
|
995
|
-
|
|
996
|
-
|
|
997
|
-
|
|
998
|
-
|
|
999
|
-
|
|
1000
|
-
|
|
1001
|
-
"
|
|
962
|
+
"force:lightning:app:create",
|
|
963
|
+
"lightning:force:app:create",
|
|
964
|
+
"lightning:app:force:create",
|
|
965
|
+
"lightning:app:create:force",
|
|
966
|
+
"force:app:lightning:create",
|
|
967
|
+
"app:force:lightning:create",
|
|
968
|
+
"app:lightning:force:create",
|
|
969
|
+
"app:lightning:create:force",
|
|
970
|
+
"force:app:create:lightning",
|
|
971
|
+
"app:force:create:lightning",
|
|
972
|
+
"app:create:force:lightning",
|
|
973
|
+
"app:create:lightning:force",
|
|
974
|
+
"force:lightning:create:app",
|
|
975
|
+
"lightning:force:create:app",
|
|
976
|
+
"lightning:create:force:app",
|
|
977
|
+
"lightning:create:app:force",
|
|
978
|
+
"force:create:lightning:app",
|
|
979
|
+
"create:force:lightning:app",
|
|
980
|
+
"create:lightning:force:app",
|
|
981
|
+
"create:lightning:app:force",
|
|
982
|
+
"force:create:app:lightning",
|
|
983
|
+
"create:force:app:lightning",
|
|
984
|
+
"create:app:force:lightning",
|
|
985
|
+
"create:app:lightning:force",
|
|
986
|
+
"lightning:generate:app",
|
|
987
|
+
"generate:lightning:app",
|
|
988
|
+
"generate:app:lightning",
|
|
989
|
+
"lightning:app:generate",
|
|
990
|
+
"app:lightning:generate",
|
|
991
|
+
"app:generate:lightning"
|
|
992
|
+
],
|
|
993
|
+
"permutations": [
|
|
994
|
+
"template:generate:lightning:app",
|
|
995
|
+
"generate:template:lightning:app",
|
|
996
|
+
"generate:lightning:template:app",
|
|
997
|
+
"generate:lightning:app:template",
|
|
998
|
+
"template:lightning:generate:app",
|
|
999
|
+
"lightning:template:generate:app",
|
|
1000
|
+
"lightning:generate:template:app",
|
|
1001
|
+
"lightning:generate:app:template",
|
|
1002
|
+
"template:lightning:app:generate",
|
|
1003
|
+
"lightning:template:app:generate",
|
|
1004
|
+
"lightning:app:template:generate",
|
|
1005
|
+
"lightning:app:generate:template",
|
|
1006
|
+
"template:generate:app:lightning",
|
|
1007
|
+
"generate:template:app:lightning",
|
|
1008
|
+
"generate:app:template:lightning",
|
|
1009
|
+
"generate:app:lightning:template",
|
|
1010
|
+
"template:app:generate:lightning",
|
|
1011
|
+
"app:template:generate:lightning",
|
|
1012
|
+
"app:generate:template:lightning",
|
|
1013
|
+
"app:generate:lightning:template",
|
|
1014
|
+
"template:app:lightning:generate",
|
|
1015
|
+
"app:template:lightning:generate",
|
|
1016
|
+
"app:lightning:template:generate",
|
|
1017
|
+
"app:lightning:generate:template"
|
|
1018
|
+
]
|
|
1019
|
+
},
|
|
1020
|
+
"template:generate:lightning:component": {
|
|
1021
|
+
"aliases": [
|
|
1022
|
+
"force:lightning:component:create",
|
|
1023
|
+
"lightning:generate:component"
|
|
1024
|
+
],
|
|
1025
|
+
"args": {},
|
|
1026
|
+
"deprecateAliases": true,
|
|
1027
|
+
"description": "Generates the bundle in the specified directory or the current working directory. The bundle consists of multiple files in a directory with the designated name. Lightning web components are contained in the directory with name \"lwc\", Aura components in \"aura\".\n\nTo generate a Lightning web component, pass \"--type lwc\" to the command. If you don’t specify --type, Salesforce CLI generates an Aura component by default.",
|
|
1028
|
+
"examples": [
|
|
1029
|
+
"Generate the metadata files for an Aura component bundle in the current directory:\n<%= config.bin %> <%= command.id %> --name mycomponent",
|
|
1030
|
+
"Generate a Lightning web component bundle in the current directory:\n<%= config.bin %> <%= command.id %> --name mycomponent --type lwc",
|
|
1031
|
+
"Generate an Aura component bundle in the \"force-app/main/default/aura\" directory:\n<%= config.bin %> <%= command.id %> --name mycomponent --output-dir force-app/main/default/aura",
|
|
1032
|
+
"Generate a Lightning web component bundle in the \"force-app/main/default/lwc\" directory:\n<%= config.bin %> <%= command.id %> --name mycomponent --type lwc --output-dir force-app/main/default/lwc",
|
|
1033
|
+
"Generate a TypeScript Lightning Web Component:\n<%= config.bin %> <%= command.id %> --name mycomponent --type lwc --template typescript"
|
|
1034
|
+
],
|
|
1035
|
+
"flags": {
|
|
1036
|
+
"json": {
|
|
1037
|
+
"description": "Format output as json.",
|
|
1038
|
+
"helpGroup": "GLOBAL",
|
|
1039
|
+
"name": "json",
|
|
1040
|
+
"allowNo": false,
|
|
1041
|
+
"type": "boolean"
|
|
1042
|
+
},
|
|
1043
|
+
"flags-dir": {
|
|
1002
1044
|
"helpGroup": "GLOBAL",
|
|
1003
1045
|
"name": "flags-dir",
|
|
1004
1046
|
"summary": "Import flag values from a directory.",
|
|
@@ -1007,64 +1049,99 @@
|
|
|
1007
1049
|
"type": "option"
|
|
1008
1050
|
},
|
|
1009
1051
|
"name": {
|
|
1052
|
+
"aliases": [
|
|
1053
|
+
"componentname"
|
|
1054
|
+
],
|
|
1010
1055
|
"char": "n",
|
|
1011
|
-
"
|
|
1056
|
+
"deprecateAliases": true,
|
|
1057
|
+
"description": "The name can be up to 40 characters and must start with a letter.",
|
|
1012
1058
|
"name": "name",
|
|
1013
1059
|
"required": true,
|
|
1014
|
-
"summary": "
|
|
1060
|
+
"summary": "Name of the generated Lightning Component.",
|
|
1015
1061
|
"hasDynamicHelp": false,
|
|
1016
1062
|
"multiple": false,
|
|
1017
1063
|
"type": "option"
|
|
1018
1064
|
},
|
|
1019
1065
|
"template": {
|
|
1020
1066
|
"char": "t",
|
|
1021
|
-
"description": "Supplied parameter values or default values are filled into a copy of the template.",
|
|
1067
|
+
"description": "Supplied parameter values or default values are filled into a copy of the template. For Lightning Web Components, if this flag isn't specified, the CLI command automatically selects the template based on the \"defaultLwcLanguage\" field in the DX project's \"sfdx-project.json\" file.",
|
|
1022
1068
|
"name": "template",
|
|
1023
|
-
"summary": "Template to use
|
|
1069
|
+
"summary": "Template to use for file creation.",
|
|
1024
1070
|
"default": "default",
|
|
1025
1071
|
"hasDynamicHelp": false,
|
|
1026
1072
|
"multiple": false,
|
|
1027
1073
|
"options": [
|
|
1028
1074
|
"default",
|
|
1029
|
-
"
|
|
1030
|
-
"
|
|
1075
|
+
"analyticsDashboard",
|
|
1076
|
+
"analyticsDashboardWithStep",
|
|
1077
|
+
"typescript"
|
|
1031
1078
|
],
|
|
1032
1079
|
"type": "option"
|
|
1033
1080
|
},
|
|
1034
|
-
"label": {
|
|
1035
|
-
"char": "l",
|
|
1036
|
-
"description": "If not specified, the label is derived from the name.",
|
|
1037
|
-
"name": "label",
|
|
1038
|
-
"summary": "Master label for the UI bundle.",
|
|
1039
|
-
"hasDynamicHelp": false,
|
|
1040
|
-
"multiple": false,
|
|
1041
|
-
"type": "option"
|
|
1042
|
-
},
|
|
1043
1081
|
"output-dir": {
|
|
1082
|
+
"aliases": [
|
|
1083
|
+
"outputdir"
|
|
1084
|
+
],
|
|
1044
1085
|
"char": "d",
|
|
1045
|
-
"
|
|
1086
|
+
"deprecateAliases": true,
|
|
1087
|
+
"description": "The location can be an absolute path or relative to the current working directory. The default is the current directory.",
|
|
1046
1088
|
"name": "output-dir",
|
|
1047
|
-
"summary": "Directory
|
|
1089
|
+
"summary": "Directory for saving the created files.",
|
|
1090
|
+
"default": ".",
|
|
1048
1091
|
"hasDynamicHelp": false,
|
|
1049
1092
|
"multiple": false,
|
|
1050
1093
|
"type": "option"
|
|
1051
1094
|
},
|
|
1052
1095
|
"api-version": {
|
|
1096
|
+
"aliases": [
|
|
1097
|
+
"apiversion"
|
|
1098
|
+
],
|
|
1099
|
+
"deprecateAliases": true,
|
|
1053
1100
|
"description": "Override the api version used for api requests made by this command",
|
|
1054
1101
|
"name": "api-version",
|
|
1055
1102
|
"hasDynamicHelp": false,
|
|
1056
1103
|
"multiple": false,
|
|
1057
1104
|
"type": "option"
|
|
1105
|
+
},
|
|
1106
|
+
"type": {
|
|
1107
|
+
"name": "type",
|
|
1108
|
+
"summary": "Type of the component bundle.",
|
|
1109
|
+
"default": "aura",
|
|
1110
|
+
"hasDynamicHelp": false,
|
|
1111
|
+
"multiple": false,
|
|
1112
|
+
"options": [
|
|
1113
|
+
"aura",
|
|
1114
|
+
"lwc"
|
|
1115
|
+
],
|
|
1116
|
+
"type": "option"
|
|
1117
|
+
},
|
|
1118
|
+
"internal": {
|
|
1119
|
+
"char": "i",
|
|
1120
|
+
"hidden": true,
|
|
1121
|
+
"name": "internal",
|
|
1122
|
+
"summary": "Generate lightning bundles without creating a -meta.xml file.",
|
|
1123
|
+
"allowNo": false,
|
|
1124
|
+
"type": "boolean"
|
|
1125
|
+
},
|
|
1126
|
+
"loglevel": {
|
|
1127
|
+
"deprecated": {
|
|
1128
|
+
"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."
|
|
1129
|
+
},
|
|
1130
|
+
"hidden": true,
|
|
1131
|
+
"name": "loglevel",
|
|
1132
|
+
"hasDynamicHelp": false,
|
|
1133
|
+
"multiple": false,
|
|
1134
|
+
"type": "option"
|
|
1058
1135
|
}
|
|
1059
1136
|
},
|
|
1060
1137
|
"hasDynamicHelp": false,
|
|
1061
1138
|
"hiddenAliases": [],
|
|
1062
|
-
"id": "template:generate:
|
|
1139
|
+
"id": "template:generate:lightning:component",
|
|
1063
1140
|
"pluginAlias": "@salesforce/plugin-templates",
|
|
1064
1141
|
"pluginName": "@salesforce/plugin-templates",
|
|
1065
1142
|
"pluginType": "core",
|
|
1066
1143
|
"strict": true,
|
|
1067
|
-
"summary": "Generate a
|
|
1144
|
+
"summary": "Generate a bundle for an Aura component or a Lightning web component.",
|
|
1068
1145
|
"enableJsonFlag": true,
|
|
1069
1146
|
"isESM": true,
|
|
1070
1147
|
"relativePath": [
|
|
@@ -1072,28 +1149,79 @@
|
|
|
1072
1149
|
"commands",
|
|
1073
1150
|
"template",
|
|
1074
1151
|
"generate",
|
|
1075
|
-
"
|
|
1076
|
-
"
|
|
1152
|
+
"lightning",
|
|
1153
|
+
"component.js"
|
|
1154
|
+
],
|
|
1155
|
+
"aliasPermutations": [
|
|
1156
|
+
"force:lightning:component:create",
|
|
1157
|
+
"lightning:force:component:create",
|
|
1158
|
+
"lightning:component:force:create",
|
|
1159
|
+
"lightning:component:create:force",
|
|
1160
|
+
"force:component:lightning:create",
|
|
1161
|
+
"component:force:lightning:create",
|
|
1162
|
+
"component:lightning:force:create",
|
|
1163
|
+
"component:lightning:create:force",
|
|
1164
|
+
"force:component:create:lightning",
|
|
1165
|
+
"component:force:create:lightning",
|
|
1166
|
+
"component:create:force:lightning",
|
|
1167
|
+
"component:create:lightning:force",
|
|
1168
|
+
"force:lightning:create:component",
|
|
1169
|
+
"lightning:force:create:component",
|
|
1170
|
+
"lightning:create:force:component",
|
|
1171
|
+
"lightning:create:component:force",
|
|
1172
|
+
"force:create:lightning:component",
|
|
1173
|
+
"create:force:lightning:component",
|
|
1174
|
+
"create:lightning:force:component",
|
|
1175
|
+
"create:lightning:component:force",
|
|
1176
|
+
"force:create:component:lightning",
|
|
1177
|
+
"create:force:component:lightning",
|
|
1178
|
+
"create:component:force:lightning",
|
|
1179
|
+
"create:component:lightning:force",
|
|
1180
|
+
"lightning:generate:component",
|
|
1181
|
+
"generate:lightning:component",
|
|
1182
|
+
"generate:component:lightning",
|
|
1183
|
+
"lightning:component:generate",
|
|
1184
|
+
"component:lightning:generate",
|
|
1185
|
+
"component:generate:lightning"
|
|
1077
1186
|
],
|
|
1078
|
-
"aliasPermutations": [],
|
|
1079
1187
|
"permutations": [
|
|
1080
|
-
"template:generate:
|
|
1081
|
-
"generate:template:
|
|
1082
|
-
"generate:
|
|
1083
|
-
"
|
|
1084
|
-
"
|
|
1085
|
-
"
|
|
1188
|
+
"template:generate:lightning:component",
|
|
1189
|
+
"generate:template:lightning:component",
|
|
1190
|
+
"generate:lightning:template:component",
|
|
1191
|
+
"generate:lightning:component:template",
|
|
1192
|
+
"template:lightning:generate:component",
|
|
1193
|
+
"lightning:template:generate:component",
|
|
1194
|
+
"lightning:generate:template:component",
|
|
1195
|
+
"lightning:generate:component:template",
|
|
1196
|
+
"template:lightning:component:generate",
|
|
1197
|
+
"lightning:template:component:generate",
|
|
1198
|
+
"lightning:component:template:generate",
|
|
1199
|
+
"lightning:component:generate:template",
|
|
1200
|
+
"template:generate:component:lightning",
|
|
1201
|
+
"generate:template:component:lightning",
|
|
1202
|
+
"generate:component:template:lightning",
|
|
1203
|
+
"generate:component:lightning:template",
|
|
1204
|
+
"template:component:generate:lightning",
|
|
1205
|
+
"component:template:generate:lightning",
|
|
1206
|
+
"component:generate:template:lightning",
|
|
1207
|
+
"component:generate:lightning:template",
|
|
1208
|
+
"template:component:lightning:generate",
|
|
1209
|
+
"component:template:lightning:generate",
|
|
1210
|
+
"component:lightning:template:generate",
|
|
1211
|
+
"component:lightning:generate:template"
|
|
1086
1212
|
]
|
|
1087
1213
|
},
|
|
1088
|
-
"template:generate:
|
|
1089
|
-
"aliases": [
|
|
1214
|
+
"template:generate:lightning:event": {
|
|
1215
|
+
"aliases": [
|
|
1216
|
+
"force:lightning:event:create",
|
|
1217
|
+
"lightning:generate:event"
|
|
1218
|
+
],
|
|
1090
1219
|
"args": {},
|
|
1091
|
-
"
|
|
1220
|
+
"deprecateAliases": true,
|
|
1221
|
+
"description": "Generates a Lightning Event bundle in the specified directory or the current working directory. The bundle consists of multiple files in a folder with the designated name.",
|
|
1092
1222
|
"examples": [
|
|
1093
|
-
"Generate
|
|
1094
|
-
"
|
|
1095
|
-
"Generate a HomePage FlexiPage with a custom label:\n<%= config.bin %> <%= command.id %> --name Custom_Home --template HomePage --label \"Sales Home Page\"",
|
|
1096
|
-
"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"
|
|
1223
|
+
"Generate the metadata files for a Lightning event bundle called \"myevent\" in the current directory:\n<%= config.bin %> <%= command.id %> --name myevent",
|
|
1224
|
+
"Similar to previous example, but generate the files in the \"force-app/main/default/aura\" directory:\n<%= config.bin %> <%= command.id %> --name myevent --output-dir force-app/main/default/aura"
|
|
1097
1225
|
],
|
|
1098
1226
|
"flags": {
|
|
1099
1227
|
"json": {
|
|
@@ -1113,29 +1241,28 @@
|
|
|
1113
1241
|
},
|
|
1114
1242
|
"name": {
|
|
1115
1243
|
"aliases": [
|
|
1116
|
-
"
|
|
1244
|
+
"eventname"
|
|
1117
1245
|
],
|
|
1118
1246
|
"char": "n",
|
|
1119
1247
|
"deprecateAliases": true,
|
|
1120
|
-
"description": "The name can
|
|
1248
|
+
"description": "The name can be up to 40 characters and must start with a letter.",
|
|
1121
1249
|
"name": "name",
|
|
1122
1250
|
"required": true,
|
|
1123
|
-
"summary": "Name of the
|
|
1251
|
+
"summary": "Name of the generated Lightning Event.",
|
|
1124
1252
|
"hasDynamicHelp": false,
|
|
1125
1253
|
"multiple": false,
|
|
1126
1254
|
"type": "option"
|
|
1127
1255
|
},
|
|
1128
1256
|
"template": {
|
|
1129
1257
|
"char": "t",
|
|
1258
|
+
"description": "Supplied parameter values or default values are filled into a copy of the template. For Lightning Web Components, if this flag isn't specified, the CLI command automatically selects the template based on the \"defaultLwcLanguage\" field in the DX project's \"sfdx-project.json\" file.",
|
|
1130
1259
|
"name": "template",
|
|
1131
|
-
"
|
|
1132
|
-
"
|
|
1260
|
+
"summary": "Template to use for file creation.",
|
|
1261
|
+
"default": "DefaultLightningEvt",
|
|
1133
1262
|
"hasDynamicHelp": false,
|
|
1134
1263
|
"multiple": false,
|
|
1135
1264
|
"options": [
|
|
1136
|
-
"
|
|
1137
|
-
"AppPage",
|
|
1138
|
-
"HomePage"
|
|
1265
|
+
"DefaultLightningEvt"
|
|
1139
1266
|
],
|
|
1140
1267
|
"type": "option"
|
|
1141
1268
|
},
|
|
@@ -1164,61 +1291,6 @@
|
|
|
1164
1291
|
"multiple": false,
|
|
1165
1292
|
"type": "option"
|
|
1166
1293
|
},
|
|
1167
|
-
"label": {
|
|
1168
|
-
"aliases": [
|
|
1169
|
-
"masterlabel"
|
|
1170
|
-
],
|
|
1171
|
-
"deprecateAliases": true,
|
|
1172
|
-
"name": "label",
|
|
1173
|
-
"summary": "Label of this FlexiPage; if not specified, uses the FlexiPage name as the label.",
|
|
1174
|
-
"hasDynamicHelp": false,
|
|
1175
|
-
"multiple": false,
|
|
1176
|
-
"type": "option"
|
|
1177
|
-
},
|
|
1178
|
-
"description": {
|
|
1179
|
-
"name": "description",
|
|
1180
|
-
"summary": "Description for the FlexiPage, which provides context about its purpose.",
|
|
1181
|
-
"hasDynamicHelp": false,
|
|
1182
|
-
"multiple": false,
|
|
1183
|
-
"type": "option"
|
|
1184
|
-
},
|
|
1185
|
-
"sobject": {
|
|
1186
|
-
"aliases": [
|
|
1187
|
-
"entity-name",
|
|
1188
|
-
"entity"
|
|
1189
|
-
],
|
|
1190
|
-
"char": "s",
|
|
1191
|
-
"deprecateAliases": true,
|
|
1192
|
-
"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.",
|
|
1193
|
-
"name": "sobject",
|
|
1194
|
-
"summary": "API name of the Salesforce object; required when creating a RecordPage.",
|
|
1195
|
-
"hasDynamicHelp": false,
|
|
1196
|
-
"multiple": false,
|
|
1197
|
-
"type": "option"
|
|
1198
|
-
},
|
|
1199
|
-
"primary-field": {
|
|
1200
|
-
"name": "primary-field",
|
|
1201
|
-
"summary": "Primary field for the dynamic highlights header; typically 'Name'. Used only with RecordPage.",
|
|
1202
|
-
"hasDynamicHelp": false,
|
|
1203
|
-
"multiple": false,
|
|
1204
|
-
"type": "option"
|
|
1205
|
-
},
|
|
1206
|
-
"secondary-fields": {
|
|
1207
|
-
"name": "secondary-fields",
|
|
1208
|
-
"summary": "Secondary fields shown in the dynamic highlights header. Specify multiple fields separated by commas. Maximum of 11 fields. Used only with RecordPage.",
|
|
1209
|
-
"delimiter": ",",
|
|
1210
|
-
"hasDynamicHelp": false,
|
|
1211
|
-
"multiple": true,
|
|
1212
|
-
"type": "option"
|
|
1213
|
-
},
|
|
1214
|
-
"detail-fields": {
|
|
1215
|
-
"name": "detail-fields",
|
|
1216
|
-
"summary": "Fields to display in the Details tab. Specify multiple fields separated by commas. Fields are split into two columns. Used only with RecordPage.",
|
|
1217
|
-
"delimiter": ",",
|
|
1218
|
-
"hasDynamicHelp": false,
|
|
1219
|
-
"multiple": true,
|
|
1220
|
-
"type": "option"
|
|
1221
|
-
},
|
|
1222
1294
|
"internal": {
|
|
1223
1295
|
"char": "i",
|
|
1224
1296
|
"hidden": true,
|
|
@@ -1240,41 +1312,92 @@
|
|
|
1240
1312
|
},
|
|
1241
1313
|
"hasDynamicHelp": false,
|
|
1242
1314
|
"hiddenAliases": [],
|
|
1243
|
-
"id": "template:generate:
|
|
1315
|
+
"id": "template:generate:lightning:event",
|
|
1244
1316
|
"pluginAlias": "@salesforce/plugin-templates",
|
|
1245
1317
|
"pluginName": "@salesforce/plugin-templates",
|
|
1246
1318
|
"pluginType": "core",
|
|
1247
|
-
"state": "beta",
|
|
1248
1319
|
"strict": true,
|
|
1249
|
-
"summary": "Generate a
|
|
1320
|
+
"summary": "Generate a Lightning Event.",
|
|
1250
1321
|
"enableJsonFlag": true,
|
|
1251
|
-
"MAX_SECONDARY_FIELDS": 11,
|
|
1252
1322
|
"isESM": true,
|
|
1253
1323
|
"relativePath": [
|
|
1254
1324
|
"lib",
|
|
1255
1325
|
"commands",
|
|
1256
1326
|
"template",
|
|
1257
1327
|
"generate",
|
|
1258
|
-
"
|
|
1259
|
-
"
|
|
1328
|
+
"lightning",
|
|
1329
|
+
"event.js"
|
|
1330
|
+
],
|
|
1331
|
+
"aliasPermutations": [
|
|
1332
|
+
"force:lightning:event:create",
|
|
1333
|
+
"lightning:force:event:create",
|
|
1334
|
+
"lightning:event:force:create",
|
|
1335
|
+
"lightning:event:create:force",
|
|
1336
|
+
"force:event:lightning:create",
|
|
1337
|
+
"event:force:lightning:create",
|
|
1338
|
+
"event:lightning:force:create",
|
|
1339
|
+
"event:lightning:create:force",
|
|
1340
|
+
"force:event:create:lightning",
|
|
1341
|
+
"event:force:create:lightning",
|
|
1342
|
+
"event:create:force:lightning",
|
|
1343
|
+
"event:create:lightning:force",
|
|
1344
|
+
"force:lightning:create:event",
|
|
1345
|
+
"lightning:force:create:event",
|
|
1346
|
+
"lightning:create:force:event",
|
|
1347
|
+
"lightning:create:event:force",
|
|
1348
|
+
"force:create:lightning:event",
|
|
1349
|
+
"create:force:lightning:event",
|
|
1350
|
+
"create:lightning:force:event",
|
|
1351
|
+
"create:lightning:event:force",
|
|
1352
|
+
"force:create:event:lightning",
|
|
1353
|
+
"create:force:event:lightning",
|
|
1354
|
+
"create:event:force:lightning",
|
|
1355
|
+
"create:event:lightning:force",
|
|
1356
|
+
"lightning:generate:event",
|
|
1357
|
+
"generate:lightning:event",
|
|
1358
|
+
"generate:event:lightning",
|
|
1359
|
+
"lightning:event:generate",
|
|
1360
|
+
"event:lightning:generate",
|
|
1361
|
+
"event:generate:lightning"
|
|
1260
1362
|
],
|
|
1261
|
-
"aliasPermutations": [],
|
|
1262
1363
|
"permutations": [
|
|
1263
|
-
"template:generate:
|
|
1264
|
-
"generate:template:
|
|
1265
|
-
"generate:
|
|
1266
|
-
"
|
|
1267
|
-
"
|
|
1268
|
-
"
|
|
1364
|
+
"template:generate:lightning:event",
|
|
1365
|
+
"generate:template:lightning:event",
|
|
1366
|
+
"generate:lightning:template:event",
|
|
1367
|
+
"generate:lightning:event:template",
|
|
1368
|
+
"template:lightning:generate:event",
|
|
1369
|
+
"lightning:template:generate:event",
|
|
1370
|
+
"lightning:generate:template:event",
|
|
1371
|
+
"lightning:generate:event:template",
|
|
1372
|
+
"template:lightning:event:generate",
|
|
1373
|
+
"lightning:template:event:generate",
|
|
1374
|
+
"lightning:event:template:generate",
|
|
1375
|
+
"lightning:event:generate:template",
|
|
1376
|
+
"template:generate:event:lightning",
|
|
1377
|
+
"generate:template:event:lightning",
|
|
1378
|
+
"generate:event:template:lightning",
|
|
1379
|
+
"generate:event:lightning:template",
|
|
1380
|
+
"template:event:generate:lightning",
|
|
1381
|
+
"event:template:generate:lightning",
|
|
1382
|
+
"event:generate:template:lightning",
|
|
1383
|
+
"event:generate:lightning:template",
|
|
1384
|
+
"template:event:lightning:generate",
|
|
1385
|
+
"event:template:lightning:generate",
|
|
1386
|
+
"event:lightning:template:generate",
|
|
1387
|
+
"event:lightning:generate:template"
|
|
1269
1388
|
]
|
|
1270
1389
|
},
|
|
1271
|
-
"template:generate:
|
|
1272
|
-
"aliases": [
|
|
1390
|
+
"template:generate:lightning:interface": {
|
|
1391
|
+
"aliases": [
|
|
1392
|
+
"force:lightning:interface:create",
|
|
1393
|
+
"lightning:generate:interface"
|
|
1394
|
+
],
|
|
1273
1395
|
"args": {},
|
|
1274
|
-
"
|
|
1396
|
+
"deprecateAliases": true,
|
|
1397
|
+
"description": "Generates a Lightning Interface bundle in the specified directory or the current working directory. The bundle consists of multiple files in a folder with the designated name.",
|
|
1275
1398
|
"examples": [
|
|
1276
|
-
"Generate
|
|
1277
|
-
"
|
|
1399
|
+
"Generate the metadata files for a Lightning interface bundle called \"myinterface\" in the current directory:\n<%= config.bin %> <%= command.id %> --name myinterface",
|
|
1400
|
+
"Similar to the previous example but generate the files in the \"force-app/main/default/aura\" directory:\n<%= config.bin %> <%= command.id %> --name myinterface --output-dir force-app/main/default/aura"
|
|
1278
1401
|
],
|
|
1279
1402
|
"flags": {
|
|
1280
1403
|
"json": {
|
|
@@ -1293,57 +1416,32 @@
|
|
|
1293
1416
|
"type": "option"
|
|
1294
1417
|
},
|
|
1295
1418
|
"name": {
|
|
1419
|
+
"aliases": [
|
|
1420
|
+
"interfacename"
|
|
1421
|
+
],
|
|
1296
1422
|
"char": "n",
|
|
1297
|
-
"
|
|
1423
|
+
"deprecateAliases": true,
|
|
1424
|
+
"description": "The name can be up to 40 characters and must start with a letter.",
|
|
1298
1425
|
"name": "name",
|
|
1299
1426
|
"required": true,
|
|
1300
|
-
"summary": "Name of the generated
|
|
1427
|
+
"summary": "Name of the generated Lightning Interface.",
|
|
1301
1428
|
"hasDynamicHelp": false,
|
|
1302
1429
|
"multiple": false,
|
|
1303
1430
|
"type": "option"
|
|
1304
1431
|
},
|
|
1305
|
-
"
|
|
1306
|
-
"char": "
|
|
1307
|
-
"description": "
|
|
1308
|
-
"name": "
|
|
1309
|
-
"
|
|
1310
|
-
"
|
|
1432
|
+
"template": {
|
|
1433
|
+
"char": "t",
|
|
1434
|
+
"description": "Supplied parameter values or default values are filled into a copy of the template. For Lightning Web Components, if this flag isn't specified, the CLI command automatically selects the template based on the \"defaultLwcLanguage\" field in the DX project's \"sfdx-project.json\" file.",
|
|
1435
|
+
"name": "template",
|
|
1436
|
+
"summary": "Template to use for file creation.",
|
|
1437
|
+
"default": "DefaultLightningIntf",
|
|
1311
1438
|
"hasDynamicHelp": false,
|
|
1312
1439
|
"multiple": false,
|
|
1313
|
-
"type": "option"
|
|
1314
|
-
},
|
|
1315
|
-
"sandbox": {
|
|
1316
|
-
"description": "Each token is written into the space-separated \"sandbox\" attribute on <lightning-ui-embedding>. Only W3C-defined sandbox tokens are accepted.",
|
|
1317
|
-
"name": "sandbox",
|
|
1318
|
-
"required": true,
|
|
1319
|
-
"summary": "Iframe sandbox token. Specify this flag multiple times to set more than one token.",
|
|
1320
|
-
"hasDynamicHelp": false,
|
|
1321
|
-
"multiple": true,
|
|
1322
1440
|
"options": [
|
|
1323
|
-
"
|
|
1324
|
-
"allow-modals",
|
|
1325
|
-
"allow-orientation-lock",
|
|
1326
|
-
"allow-pointer-lock",
|
|
1327
|
-
"allow-popups",
|
|
1328
|
-
"allow-popups-to-escape-sandbox",
|
|
1329
|
-
"allow-presentation",
|
|
1330
|
-
"allow-same-origin",
|
|
1331
|
-
"allow-scripts",
|
|
1332
|
-
"allow-storage-access-by-user-activation",
|
|
1333
|
-
"allow-top-navigation",
|
|
1334
|
-
"allow-top-navigation-by-user-activation"
|
|
1441
|
+
"DefaultLightningIntf"
|
|
1335
1442
|
],
|
|
1336
1443
|
"type": "option"
|
|
1337
1444
|
},
|
|
1338
|
-
"shell-title": {
|
|
1339
|
-
"description": "Written to the \"shell-title\" attribute on <lightning-ui-embedding> and used as the iframe's accessible name (announced by screen readers).",
|
|
1340
|
-
"name": "shell-title",
|
|
1341
|
-
"required": true,
|
|
1342
|
-
"summary": "Accessible title for the embedded iframe.",
|
|
1343
|
-
"hasDynamicHelp": false,
|
|
1344
|
-
"multiple": false,
|
|
1345
|
-
"type": "option"
|
|
1346
|
-
},
|
|
1347
1445
|
"output-dir": {
|
|
1348
1446
|
"aliases": [
|
|
1349
1447
|
"outputdir"
|
|
@@ -1389,15 +1487,13 @@
|
|
|
1389
1487
|
}
|
|
1390
1488
|
},
|
|
1391
1489
|
"hasDynamicHelp": false,
|
|
1392
|
-
"hidden": true,
|
|
1393
1490
|
"hiddenAliases": [],
|
|
1394
|
-
"id": "template:generate:
|
|
1491
|
+
"id": "template:generate:lightning:interface",
|
|
1395
1492
|
"pluginAlias": "@salesforce/plugin-templates",
|
|
1396
1493
|
"pluginName": "@salesforce/plugin-templates",
|
|
1397
1494
|
"pluginType": "core",
|
|
1398
|
-
"state": "beta",
|
|
1399
1495
|
"strict": true,
|
|
1400
|
-
"summary": "Generate a Lightning
|
|
1496
|
+
"summary": "Generate a Lightning Interface.",
|
|
1401
1497
|
"enableJsonFlag": true,
|
|
1402
1498
|
"isESM": true,
|
|
1403
1499
|
"relativePath": [
|
|
@@ -1405,41 +1501,90 @@
|
|
|
1405
1501
|
"commands",
|
|
1406
1502
|
"template",
|
|
1407
1503
|
"generate",
|
|
1408
|
-
"
|
|
1409
|
-
"
|
|
1410
|
-
],
|
|
1411
|
-
"aliasPermutations": [],
|
|
1412
|
-
"permutations": [
|
|
1413
|
-
"template:generate:ui-embedding",
|
|
1414
|
-
"generate:template:ui-embedding",
|
|
1415
|
-
"generate:ui-embedding:template",
|
|
1416
|
-
"template:ui-embedding:generate",
|
|
1417
|
-
"ui-embedding:template:generate",
|
|
1418
|
-
"ui-embedding:generate:template"
|
|
1419
|
-
]
|
|
1420
|
-
},
|
|
1421
|
-
"template:generate:visualforce:component": {
|
|
1422
|
-
"aliases": [
|
|
1423
|
-
"force:visualforce:component:create",
|
|
1424
|
-
"visualforce:generate:component"
|
|
1504
|
+
"lightning",
|
|
1505
|
+
"interface.js"
|
|
1425
1506
|
],
|
|
1426
|
-
"
|
|
1427
|
-
|
|
1428
|
-
|
|
1429
|
-
|
|
1430
|
-
"
|
|
1431
|
-
"
|
|
1507
|
+
"aliasPermutations": [
|
|
1508
|
+
"force:lightning:interface:create",
|
|
1509
|
+
"lightning:force:interface:create",
|
|
1510
|
+
"lightning:interface:force:create",
|
|
1511
|
+
"lightning:interface:create:force",
|
|
1512
|
+
"force:interface:lightning:create",
|
|
1513
|
+
"interface:force:lightning:create",
|
|
1514
|
+
"interface:lightning:force:create",
|
|
1515
|
+
"interface:lightning:create:force",
|
|
1516
|
+
"force:interface:create:lightning",
|
|
1517
|
+
"interface:force:create:lightning",
|
|
1518
|
+
"interface:create:force:lightning",
|
|
1519
|
+
"interface:create:lightning:force",
|
|
1520
|
+
"force:lightning:create:interface",
|
|
1521
|
+
"lightning:force:create:interface",
|
|
1522
|
+
"lightning:create:force:interface",
|
|
1523
|
+
"lightning:create:interface:force",
|
|
1524
|
+
"force:create:lightning:interface",
|
|
1525
|
+
"create:force:lightning:interface",
|
|
1526
|
+
"create:lightning:force:interface",
|
|
1527
|
+
"create:lightning:interface:force",
|
|
1528
|
+
"force:create:interface:lightning",
|
|
1529
|
+
"create:force:interface:lightning",
|
|
1530
|
+
"create:interface:force:lightning",
|
|
1531
|
+
"create:interface:lightning:force",
|
|
1532
|
+
"lightning:generate:interface",
|
|
1533
|
+
"generate:lightning:interface",
|
|
1534
|
+
"generate:interface:lightning",
|
|
1535
|
+
"lightning:interface:generate",
|
|
1536
|
+
"interface:lightning:generate",
|
|
1537
|
+
"interface:generate:lightning"
|
|
1432
1538
|
],
|
|
1433
|
-
"
|
|
1434
|
-
"
|
|
1435
|
-
|
|
1436
|
-
|
|
1437
|
-
|
|
1438
|
-
|
|
1439
|
-
|
|
1440
|
-
|
|
1441
|
-
"
|
|
1442
|
-
|
|
1539
|
+
"permutations": [
|
|
1540
|
+
"template:generate:lightning:interface",
|
|
1541
|
+
"generate:template:lightning:interface",
|
|
1542
|
+
"generate:lightning:template:interface",
|
|
1543
|
+
"generate:lightning:interface:template",
|
|
1544
|
+
"template:lightning:generate:interface",
|
|
1545
|
+
"lightning:template:generate:interface",
|
|
1546
|
+
"lightning:generate:template:interface",
|
|
1547
|
+
"lightning:generate:interface:template",
|
|
1548
|
+
"template:lightning:interface:generate",
|
|
1549
|
+
"lightning:template:interface:generate",
|
|
1550
|
+
"lightning:interface:template:generate",
|
|
1551
|
+
"lightning:interface:generate:template",
|
|
1552
|
+
"template:generate:interface:lightning",
|
|
1553
|
+
"generate:template:interface:lightning",
|
|
1554
|
+
"generate:interface:template:lightning",
|
|
1555
|
+
"generate:interface:lightning:template",
|
|
1556
|
+
"template:interface:generate:lightning",
|
|
1557
|
+
"interface:template:generate:lightning",
|
|
1558
|
+
"interface:generate:template:lightning",
|
|
1559
|
+
"interface:generate:lightning:template",
|
|
1560
|
+
"template:interface:lightning:generate",
|
|
1561
|
+
"interface:template:lightning:generate",
|
|
1562
|
+
"interface:lightning:template:generate",
|
|
1563
|
+
"interface:lightning:generate:template"
|
|
1564
|
+
]
|
|
1565
|
+
},
|
|
1566
|
+
"template:generate:lightning:test": {
|
|
1567
|
+
"aliases": [
|
|
1568
|
+
"force:lightning:test:create",
|
|
1569
|
+
"lightning:generate:test"
|
|
1570
|
+
],
|
|
1571
|
+
"args": {},
|
|
1572
|
+
"deprecateAliases": true,
|
|
1573
|
+
"description": "Generates the test in the specified directory or the current working directory. The .resource file and associated metadata file are generated.",
|
|
1574
|
+
"examples": [
|
|
1575
|
+
"Generate the metadata files for the Lightning test called MyLightningTest in the current directory:\n<%= config.bin %> <%= command.id %> --name MyLightningTest",
|
|
1576
|
+
"Similar to the previous example but generate the files in the \"force-app/main/default/lightningTests\" directory:\n<%= config.bin %> <%= command.id %> --name MyLightningTest --output-dir force-app/main/default/lightningTests"
|
|
1577
|
+
],
|
|
1578
|
+
"flags": {
|
|
1579
|
+
"json": {
|
|
1580
|
+
"description": "Format output as json.",
|
|
1581
|
+
"helpGroup": "GLOBAL",
|
|
1582
|
+
"name": "json",
|
|
1583
|
+
"allowNo": false,
|
|
1584
|
+
"type": "boolean"
|
|
1585
|
+
},
|
|
1586
|
+
"flags-dir": {
|
|
1587
|
+
"helpGroup": "GLOBAL",
|
|
1443
1588
|
"name": "flags-dir",
|
|
1444
1589
|
"summary": "Import flag values from a directory.",
|
|
1445
1590
|
"hasDynamicHelp": false,
|
|
@@ -1448,28 +1593,28 @@
|
|
|
1448
1593
|
},
|
|
1449
1594
|
"name": {
|
|
1450
1595
|
"aliases": [
|
|
1451
|
-
"
|
|
1596
|
+
"testname"
|
|
1452
1597
|
],
|
|
1453
1598
|
"char": "n",
|
|
1454
1599
|
"deprecateAliases": true,
|
|
1455
|
-
"description": "
|
|
1600
|
+
"description": "Name of the new Lightning test; can be up to 40 characters and must start with a letter.",
|
|
1456
1601
|
"name": "name",
|
|
1457
1602
|
"required": true,
|
|
1458
|
-
"summary": "Name of the generated
|
|
1603
|
+
"summary": "Name of the generated Lightning Test.",
|
|
1459
1604
|
"hasDynamicHelp": false,
|
|
1460
1605
|
"multiple": false,
|
|
1461
1606
|
"type": "option"
|
|
1462
1607
|
},
|
|
1463
1608
|
"template": {
|
|
1464
1609
|
"char": "t",
|
|
1465
|
-
"description": "Supplied parameter values or default values are filled into a copy of the template.",
|
|
1610
|
+
"description": "Supplied parameter values or default values are filled into a copy of the template. For Lightning Web Components, if this flag isn't specified, the CLI command automatically selects the template based on the \"defaultLwcLanguage\" field in the DX project's \"sfdx-project.json\" file.",
|
|
1466
1611
|
"name": "template",
|
|
1467
1612
|
"summary": "Template to use for file creation.",
|
|
1468
|
-
"default": "
|
|
1613
|
+
"default": "DefaultLightningTest",
|
|
1469
1614
|
"hasDynamicHelp": false,
|
|
1470
1615
|
"multiple": false,
|
|
1471
1616
|
"options": [
|
|
1472
|
-
"
|
|
1617
|
+
"DefaultLightningTest"
|
|
1473
1618
|
],
|
|
1474
1619
|
"type": "option"
|
|
1475
1620
|
},
|
|
@@ -1487,6 +1632,14 @@
|
|
|
1487
1632
|
"multiple": false,
|
|
1488
1633
|
"type": "option"
|
|
1489
1634
|
},
|
|
1635
|
+
"internal": {
|
|
1636
|
+
"char": "i",
|
|
1637
|
+
"hidden": true,
|
|
1638
|
+
"name": "internal",
|
|
1639
|
+
"summary": "Generate lightning bundles without creating a -meta.xml file.",
|
|
1640
|
+
"allowNo": false,
|
|
1641
|
+
"type": "boolean"
|
|
1642
|
+
},
|
|
1490
1643
|
"api-version": {
|
|
1491
1644
|
"aliases": [
|
|
1492
1645
|
"apiversion"
|
|
@@ -1498,15 +1651,6 @@
|
|
|
1498
1651
|
"multiple": false,
|
|
1499
1652
|
"type": "option"
|
|
1500
1653
|
},
|
|
1501
|
-
"label": {
|
|
1502
|
-
"char": "l",
|
|
1503
|
-
"name": "label",
|
|
1504
|
-
"required": true,
|
|
1505
|
-
"summary": "Visualforce Component label.",
|
|
1506
|
-
"hasDynamicHelp": false,
|
|
1507
|
-
"multiple": false,
|
|
1508
|
-
"type": "option"
|
|
1509
|
-
},
|
|
1510
1654
|
"loglevel": {
|
|
1511
1655
|
"deprecated": {
|
|
1512
1656
|
"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."
|
|
@@ -1520,12 +1664,12 @@
|
|
|
1520
1664
|
},
|
|
1521
1665
|
"hasDynamicHelp": false,
|
|
1522
1666
|
"hiddenAliases": [],
|
|
1523
|
-
"id": "template:generate:
|
|
1667
|
+
"id": "template:generate:lightning:test",
|
|
1524
1668
|
"pluginAlias": "@salesforce/plugin-templates",
|
|
1525
1669
|
"pluginName": "@salesforce/plugin-templates",
|
|
1526
1670
|
"pluginType": "core",
|
|
1527
1671
|
"strict": true,
|
|
1528
|
-
"summary": "Generate a
|
|
1672
|
+
"summary": "Generate a Lightning test.",
|
|
1529
1673
|
"enableJsonFlag": true,
|
|
1530
1674
|
"isESM": true,
|
|
1531
1675
|
"relativePath": [
|
|
@@ -1533,79 +1677,82 @@
|
|
|
1533
1677
|
"commands",
|
|
1534
1678
|
"template",
|
|
1535
1679
|
"generate",
|
|
1536
|
-
"
|
|
1537
|
-
"
|
|
1680
|
+
"lightning",
|
|
1681
|
+
"test.js"
|
|
1538
1682
|
],
|
|
1539
1683
|
"aliasPermutations": [
|
|
1540
|
-
"force:
|
|
1541
|
-
"
|
|
1542
|
-
"
|
|
1543
|
-
"
|
|
1544
|
-
"force:
|
|
1545
|
-
"
|
|
1546
|
-
"
|
|
1547
|
-
"
|
|
1548
|
-
"force:
|
|
1549
|
-
"
|
|
1550
|
-
"
|
|
1551
|
-
"
|
|
1552
|
-
"force:
|
|
1553
|
-
"
|
|
1554
|
-
"
|
|
1555
|
-
"
|
|
1556
|
-
"force:create:
|
|
1557
|
-
"create:force:
|
|
1558
|
-
"create:
|
|
1559
|
-
"create:
|
|
1560
|
-
"force:create:
|
|
1561
|
-
"create:force:
|
|
1562
|
-
"create:
|
|
1563
|
-
"create:
|
|
1564
|
-
"
|
|
1565
|
-
"generate:
|
|
1566
|
-
"generate:
|
|
1567
|
-
"
|
|
1568
|
-
"
|
|
1569
|
-
"
|
|
1684
|
+
"force:lightning:test:create",
|
|
1685
|
+
"lightning:force:test:create",
|
|
1686
|
+
"lightning:test:force:create",
|
|
1687
|
+
"lightning:test:create:force",
|
|
1688
|
+
"force:test:lightning:create",
|
|
1689
|
+
"test:force:lightning:create",
|
|
1690
|
+
"test:lightning:force:create",
|
|
1691
|
+
"test:lightning:create:force",
|
|
1692
|
+
"force:test:create:lightning",
|
|
1693
|
+
"test:force:create:lightning",
|
|
1694
|
+
"test:create:force:lightning",
|
|
1695
|
+
"test:create:lightning:force",
|
|
1696
|
+
"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"
|
|
1570
1714
|
],
|
|
1571
1715
|
"permutations": [
|
|
1572
|
-
"template:generate:
|
|
1573
|
-
"generate:template:
|
|
1574
|
-
"generate:
|
|
1575
|
-
"generate:
|
|
1576
|
-
"template:
|
|
1577
|
-
"
|
|
1578
|
-
"
|
|
1579
|
-
"
|
|
1580
|
-
"template:
|
|
1581
|
-
"
|
|
1582
|
-
"
|
|
1583
|
-
"
|
|
1584
|
-
"template:generate:
|
|
1585
|
-
"generate:template:
|
|
1586
|
-
"generate:
|
|
1587
|
-
"generate:
|
|
1588
|
-
"template:
|
|
1589
|
-
"
|
|
1590
|
-
"
|
|
1591
|
-
"
|
|
1592
|
-
"template:
|
|
1593
|
-
"
|
|
1594
|
-
"
|
|
1595
|
-
"
|
|
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"
|
|
1596
1740
|
]
|
|
1597
1741
|
},
|
|
1598
|
-
"template:generate:
|
|
1742
|
+
"template:generate:project": {
|
|
1599
1743
|
"aliases": [
|
|
1600
|
-
"force:
|
|
1601
|
-
"
|
|
1744
|
+
"force:project:create",
|
|
1745
|
+
"project:generate"
|
|
1602
1746
|
],
|
|
1603
1747
|
"args": {},
|
|
1604
1748
|
"deprecateAliases": true,
|
|
1605
|
-
"description": "
|
|
1749
|
+
"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\".",
|
|
1606
1750
|
"examples": [
|
|
1607
|
-
"Generate
|
|
1608
|
-
"Similar to previous example, but generate the files in
|
|
1751
|
+
"Generate a project called \"mywork\":\n<%= config.bin %> <%= command.id %> --name mywork",
|
|
1752
|
+
"Similar to previous example, but generate the files in a directory called \"myapp\":\n<%= config.bin %> <%= command.id %> --name mywork --default-package-dir myapp",
|
|
1753
|
+
"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",
|
|
1754
|
+
"Generate a project with the minimum files and directories:\n<%= config.bin %> <%= command.id %> --name mywork --template empty",
|
|
1755
|
+
"Generate a project in which the Lightning Web Components use TypeScript rather than the default JavaScript:\n<%= config.bin %> <%= command.id %> --name mywork --lwc-language typescript"
|
|
1609
1756
|
],
|
|
1610
1757
|
"flags": {
|
|
1611
1758
|
"json": {
|
|
@@ -1625,29 +1772,35 @@
|
|
|
1625
1772
|
},
|
|
1626
1773
|
"name": {
|
|
1627
1774
|
"aliases": [
|
|
1628
|
-
"
|
|
1775
|
+
"projectname"
|
|
1629
1776
|
],
|
|
1630
1777
|
"char": "n",
|
|
1631
1778
|
"deprecateAliases": true,
|
|
1632
|
-
"description": "
|
|
1779
|
+
"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.",
|
|
1633
1780
|
"name": "name",
|
|
1634
1781
|
"required": true,
|
|
1635
|
-
"summary": "Name of the generated
|
|
1782
|
+
"summary": "Name of the generated project.",
|
|
1636
1783
|
"hasDynamicHelp": false,
|
|
1637
1784
|
"multiple": false,
|
|
1638
1785
|
"type": "option"
|
|
1639
1786
|
},
|
|
1640
1787
|
"template": {
|
|
1641
1788
|
"char": "t",
|
|
1642
|
-
"description": "
|
|
1643
|
-
"hidden": true,
|
|
1789
|
+
"description": "The template determines the sample configuration files and directories that this command generates. For example, the empty template provides these files and directory to get you started.\n\n- .forceignore\n- config/project-scratch-def.json\n- sfdx-project.json\n- package.json\n- force-app (basic source directory structure)\n\nThe standard template provides a complete force-app directory structure so you know where to put your source. It also provides additional files and scripts, especially useful when using Salesforce Extensions for VS Code. For example:\n\n- .gitignore: Use Git for version control.\n- .prettierrc and .prettierignore: Use Prettier to format your Aura components.\n- .vscode/extensions.json: When launched, Visual Studio Code, prompts you to install the recommended extensions for your project.\n- .vscode/launch.json: Configures Replay Debugger.\n- .vscode/settings.json: Additional configuration settings.\n\nThe analytics template provides similar files and the force-app/main/default/waveTemplates directory.\n\nThe reactinternalapp and reactexternalapp templates provide React-based project scaffolding for internal and external UI bundle use cases.\n\nThe angularinternalapp and angularexternalapp templates provide Angular-based project scaffolding for internal and external UI bundle use cases.\n\nThe agent template provides project scaffolding for building Agentforce agents and includes a sample agent called Local Info Agent.",
|
|
1644
1790
|
"name": "template",
|
|
1645
|
-
"summary": "Template to use for
|
|
1646
|
-
"default": "
|
|
1791
|
+
"summary": "Template to use for project creation.",
|
|
1792
|
+
"default": "standard",
|
|
1647
1793
|
"hasDynamicHelp": false,
|
|
1648
1794
|
"multiple": false,
|
|
1649
1795
|
"options": [
|
|
1650
|
-
"
|
|
1796
|
+
"standard",
|
|
1797
|
+
"empty",
|
|
1798
|
+
"analytics",
|
|
1799
|
+
"reactinternalapp",
|
|
1800
|
+
"reactexternalapp",
|
|
1801
|
+
"angularinternalapp",
|
|
1802
|
+
"angularexternalapp",
|
|
1803
|
+
"agent"
|
|
1651
1804
|
],
|
|
1652
1805
|
"type": "option"
|
|
1653
1806
|
},
|
|
@@ -1665,24 +1818,62 @@
|
|
|
1665
1818
|
"multiple": false,
|
|
1666
1819
|
"type": "option"
|
|
1667
1820
|
},
|
|
1668
|
-
"
|
|
1821
|
+
"namespace": {
|
|
1822
|
+
"char": "s",
|
|
1823
|
+
"name": "namespace",
|
|
1824
|
+
"summary": "Namespace associated with this project and any connected scratch orgs.",
|
|
1825
|
+
"default": "",
|
|
1826
|
+
"hasDynamicHelp": false,
|
|
1827
|
+
"multiple": false,
|
|
1828
|
+
"type": "option"
|
|
1829
|
+
},
|
|
1830
|
+
"default-package-dir": {
|
|
1669
1831
|
"aliases": [
|
|
1670
|
-
"
|
|
1832
|
+
"defaultpackagedir"
|
|
1671
1833
|
],
|
|
1834
|
+
"char": "p",
|
|
1672
1835
|
"deprecateAliases": true,
|
|
1673
|
-
"description": "
|
|
1674
|
-
"name": "
|
|
1836
|
+
"description": "Metadata items such as classes and Lightning bundles are placed inside this folder.",
|
|
1837
|
+
"name": "default-package-dir",
|
|
1838
|
+
"summary": "Default package directory name.",
|
|
1839
|
+
"default": "force-app",
|
|
1675
1840
|
"hasDynamicHelp": false,
|
|
1676
1841
|
"multiple": false,
|
|
1677
1842
|
"type": "option"
|
|
1678
1843
|
},
|
|
1679
|
-
"
|
|
1680
|
-
"char": "
|
|
1681
|
-
"
|
|
1682
|
-
"
|
|
1683
|
-
"summary": "
|
|
1844
|
+
"manifest": {
|
|
1845
|
+
"char": "x",
|
|
1846
|
+
"description": "Generates a default manifest (package.xml) for fetching Apex, Visualforce, Lightning components, and static resources.",
|
|
1847
|
+
"name": "manifest",
|
|
1848
|
+
"summary": "Generate a manifest (package.xml) for change-set based development.",
|
|
1849
|
+
"allowNo": false,
|
|
1850
|
+
"type": "boolean"
|
|
1851
|
+
},
|
|
1852
|
+
"login-url": {
|
|
1853
|
+
"aliases": [
|
|
1854
|
+
"loginurl"
|
|
1855
|
+
],
|
|
1856
|
+
"char": "l",
|
|
1857
|
+
"deprecateAliases": true,
|
|
1858
|
+
"description": "Normally defaults to https://login.salesforce.com.",
|
|
1859
|
+
"hidden": true,
|
|
1860
|
+
"name": "login-url",
|
|
1861
|
+
"summary": "Salesforce instance login URL.",
|
|
1862
|
+
"default": "https://login.salesforce.com",
|
|
1863
|
+
"hasDynamicHelp": false,
|
|
1864
|
+
"multiple": false,
|
|
1865
|
+
"type": "option"
|
|
1866
|
+
},
|
|
1867
|
+
"lwc-language": {
|
|
1868
|
+
"description": "When set to `'typescript'`, generates TypeScript configuration files (tsconfig.json, package.json with TypeScript dependencies, and TypeScript-aware ESLint config). When you deploy the TypeScript-based Lightning Web Components, the TypeScript files are first compiled locally for validation and then the `.ts` files are deployed to your org for server-side type stripping.",
|
|
1869
|
+
"name": "lwc-language",
|
|
1870
|
+
"summary": "Language of the Lightning Web Components. If not specified, \"javascript\" is used.",
|
|
1684
1871
|
"hasDynamicHelp": false,
|
|
1685
1872
|
"multiple": false,
|
|
1873
|
+
"options": [
|
|
1874
|
+
"javascript",
|
|
1875
|
+
"typescript"
|
|
1876
|
+
],
|
|
1686
1877
|
"type": "option"
|
|
1687
1878
|
},
|
|
1688
1879
|
"loglevel": {
|
|
@@ -1694,16 +1885,24 @@
|
|
|
1694
1885
|
"hasDynamicHelp": false,
|
|
1695
1886
|
"multiple": false,
|
|
1696
1887
|
"type": "option"
|
|
1888
|
+
},
|
|
1889
|
+
"api-version": {
|
|
1890
|
+
"description": "Override the api version used for api requests made by this command",
|
|
1891
|
+
"name": "api-version",
|
|
1892
|
+
"summary": "Will set this version as sourceApiVersion in the sfdx-project.json file",
|
|
1893
|
+
"hasDynamicHelp": false,
|
|
1894
|
+
"multiple": false,
|
|
1895
|
+
"type": "option"
|
|
1697
1896
|
}
|
|
1698
1897
|
},
|
|
1699
1898
|
"hasDynamicHelp": false,
|
|
1700
1899
|
"hiddenAliases": [],
|
|
1701
|
-
"id": "template:generate:
|
|
1900
|
+
"id": "template:generate:project",
|
|
1702
1901
|
"pluginAlias": "@salesforce/plugin-templates",
|
|
1703
1902
|
"pluginName": "@salesforce/plugin-templates",
|
|
1704
1903
|
"pluginType": "core",
|
|
1705
1904
|
"strict": true,
|
|
1706
|
-
"summary": "Generate a
|
|
1905
|
+
"summary": "Generate a Salesforce DX project.",
|
|
1707
1906
|
"enableJsonFlag": true,
|
|
1708
1907
|
"isESM": true,
|
|
1709
1908
|
"relativePath": [
|
|
@@ -1711,79 +1910,40 @@
|
|
|
1711
1910
|
"commands",
|
|
1712
1911
|
"template",
|
|
1713
1912
|
"generate",
|
|
1714
|
-
"
|
|
1715
|
-
"
|
|
1913
|
+
"project",
|
|
1914
|
+
"index.js"
|
|
1716
1915
|
],
|
|
1717
1916
|
"aliasPermutations": [
|
|
1718
|
-
"force:
|
|
1719
|
-
"
|
|
1720
|
-
"
|
|
1721
|
-
"
|
|
1722
|
-
"force:
|
|
1723
|
-
"
|
|
1724
|
-
"
|
|
1725
|
-
"
|
|
1726
|
-
"force:page:create:visualforce",
|
|
1727
|
-
"page:force:create:visualforce",
|
|
1728
|
-
"page:create:force:visualforce",
|
|
1729
|
-
"page:create:visualforce:force",
|
|
1730
|
-
"force:visualforce:create:page",
|
|
1731
|
-
"visualforce:force:create:page",
|
|
1732
|
-
"visualforce:create:force:page",
|
|
1733
|
-
"visualforce:create:page:force",
|
|
1734
|
-
"force:create:visualforce:page",
|
|
1735
|
-
"create:force:visualforce:page",
|
|
1736
|
-
"create:visualforce:force:page",
|
|
1737
|
-
"create:visualforce:page:force",
|
|
1738
|
-
"force:create:page:visualforce",
|
|
1739
|
-
"create:force:page:visualforce",
|
|
1740
|
-
"create:page:force:visualforce",
|
|
1741
|
-
"create:page:visualforce:force",
|
|
1742
|
-
"visualforce:generate:page",
|
|
1743
|
-
"generate:visualforce:page",
|
|
1744
|
-
"generate:page:visualforce",
|
|
1745
|
-
"visualforce:page:generate",
|
|
1746
|
-
"page:visualforce:generate",
|
|
1747
|
-
"page:generate:visualforce"
|
|
1917
|
+
"force:project:create",
|
|
1918
|
+
"project:force:create",
|
|
1919
|
+
"project:create:force",
|
|
1920
|
+
"force:create:project",
|
|
1921
|
+
"create:force:project",
|
|
1922
|
+
"create:project:force",
|
|
1923
|
+
"project:generate",
|
|
1924
|
+
"generate:project"
|
|
1748
1925
|
],
|
|
1749
1926
|
"permutations": [
|
|
1750
|
-
"template:generate:
|
|
1751
|
-
"generate:template:
|
|
1752
|
-
"generate:
|
|
1753
|
-
"
|
|
1754
|
-
"template:
|
|
1755
|
-
"
|
|
1756
|
-
"visualforce:generate:template:page",
|
|
1757
|
-
"visualforce:generate:page:template",
|
|
1758
|
-
"template:visualforce:page:generate",
|
|
1759
|
-
"visualforce:template:page:generate",
|
|
1760
|
-
"visualforce:page:template:generate",
|
|
1761
|
-
"visualforce:page:generate:template",
|
|
1762
|
-
"template:generate:page:visualforce",
|
|
1763
|
-
"generate:template:page:visualforce",
|
|
1764
|
-
"generate:page:template:visualforce",
|
|
1765
|
-
"generate:page:visualforce:template",
|
|
1766
|
-
"template:page:generate:visualforce",
|
|
1767
|
-
"page:template:generate:visualforce",
|
|
1768
|
-
"page:generate:template:visualforce",
|
|
1769
|
-
"page:generate:visualforce:template",
|
|
1770
|
-
"template:page:visualforce:generate",
|
|
1771
|
-
"page:template:visualforce:generate",
|
|
1772
|
-
"page:visualforce:template:generate",
|
|
1773
|
-
"page:visualforce:generate:template"
|
|
1927
|
+
"template:generate:project",
|
|
1928
|
+
"generate:template:project",
|
|
1929
|
+
"generate:project:template",
|
|
1930
|
+
"template:project:generate",
|
|
1931
|
+
"project:template:generate",
|
|
1932
|
+
"project:generate:template"
|
|
1774
1933
|
]
|
|
1775
1934
|
},
|
|
1776
|
-
"template:generate:
|
|
1935
|
+
"template:generate:static-resource": {
|
|
1777
1936
|
"aliases": [
|
|
1778
|
-
"force:
|
|
1779
|
-
"
|
|
1937
|
+
"force:staticresource:create",
|
|
1938
|
+
"static-resource:generate"
|
|
1780
1939
|
],
|
|
1781
1940
|
"args": {},
|
|
1782
1941
|
"deprecateAliases": true,
|
|
1783
|
-
"description": "Generates
|
|
1942
|
+
"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.",
|
|
1784
1943
|
"examples": [
|
|
1785
|
-
"Generate the metadata
|
|
1786
|
-
"Similar to
|
|
1944
|
+
"Generate the metadata file for a static resource called MyResource in the current directory:\n<%= config.bin %> <%= command.id %> --name MyResource",
|
|
1945
|
+
"Similar to previous example, but specifies a MIME type of application/json:\n<%= config.bin %> <%= command.id %> --name MyResource --type application/json",
|
|
1946
|
+
"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"
|
|
1787
1947
|
],
|
|
1788
1948
|
"flags": {
|
|
1789
1949
|
"json": {
|
|
@@ -1803,29 +1963,29 @@
|
|
|
1803
1963
|
},
|
|
1804
1964
|
"name": {
|
|
1805
1965
|
"aliases": [
|
|
1806
|
-
"
|
|
1966
|
+
"resourcename"
|
|
1807
1967
|
],
|
|
1808
1968
|
"char": "n",
|
|
1809
1969
|
"deprecateAliases": true,
|
|
1810
|
-
"description": "
|
|
1970
|
+
"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.",
|
|
1811
1971
|
"name": "name",
|
|
1812
1972
|
"required": true,
|
|
1813
|
-
"summary": "Name of the generated
|
|
1973
|
+
"summary": "Name of the generated static resource.",
|
|
1814
1974
|
"hasDynamicHelp": false,
|
|
1815
1975
|
"multiple": false,
|
|
1816
1976
|
"type": "option"
|
|
1817
1977
|
},
|
|
1818
|
-
"
|
|
1819
|
-
"
|
|
1820
|
-
|
|
1821
|
-
|
|
1822
|
-
"
|
|
1823
|
-
"
|
|
1978
|
+
"type": {
|
|
1979
|
+
"aliases": [
|
|
1980
|
+
"contenttype"
|
|
1981
|
+
],
|
|
1982
|
+
"deprecateAliases": true,
|
|
1983
|
+
"description": "Must be a valid MIME type such as application/json, application/javascript, application/zip, text/plain, text/css, etc.",
|
|
1984
|
+
"name": "type",
|
|
1985
|
+
"summary": "Content type (mime type) of the generated static resource.",
|
|
1986
|
+
"default": "application/zip",
|
|
1824
1987
|
"hasDynamicHelp": false,
|
|
1825
1988
|
"multiple": false,
|
|
1826
|
-
"options": [
|
|
1827
|
-
"DefaultLightningApp"
|
|
1828
|
-
],
|
|
1829
1989
|
"type": "option"
|
|
1830
1990
|
},
|
|
1831
1991
|
"output-dir": {
|
|
@@ -1853,14 +2013,6 @@
|
|
|
1853
2013
|
"multiple": false,
|
|
1854
2014
|
"type": "option"
|
|
1855
2015
|
},
|
|
1856
|
-
"internal": {
|
|
1857
|
-
"char": "i",
|
|
1858
|
-
"hidden": true,
|
|
1859
|
-
"name": "internal",
|
|
1860
|
-
"summary": "Generate lightning bundles without creating a -meta.xml file.",
|
|
1861
|
-
"allowNo": false,
|
|
1862
|
-
"type": "boolean"
|
|
1863
|
-
},
|
|
1864
2016
|
"loglevel": {
|
|
1865
2017
|
"deprecated": {
|
|
1866
2018
|
"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."
|
|
@@ -1874,12 +2026,12 @@
|
|
|
1874
2026
|
},
|
|
1875
2027
|
"hasDynamicHelp": false,
|
|
1876
2028
|
"hiddenAliases": [],
|
|
1877
|
-
"id": "template:generate:
|
|
2029
|
+
"id": "template:generate:static-resource",
|
|
1878
2030
|
"pluginAlias": "@salesforce/plugin-templates",
|
|
1879
2031
|
"pluginName": "@salesforce/plugin-templates",
|
|
1880
2032
|
"pluginType": "core",
|
|
1881
2033
|
"strict": true,
|
|
1882
|
-
"summary": "Generate a
|
|
2034
|
+
"summary": "Generate a static resource.",
|
|
1883
2035
|
"enableJsonFlag": true,
|
|
1884
2036
|
"isESM": true,
|
|
1885
2037
|
"relativePath": [
|
|
@@ -1887,82 +2039,37 @@
|
|
|
1887
2039
|
"commands",
|
|
1888
2040
|
"template",
|
|
1889
2041
|
"generate",
|
|
1890
|
-
"
|
|
1891
|
-
"
|
|
2042
|
+
"static-resource",
|
|
2043
|
+
"index.js"
|
|
1892
2044
|
],
|
|
1893
2045
|
"aliasPermutations": [
|
|
1894
|
-
"force:
|
|
1895
|
-
"
|
|
1896
|
-
"
|
|
1897
|
-
"
|
|
1898
|
-
"force:
|
|
1899
|
-
"
|
|
1900
|
-
"
|
|
1901
|
-
"
|
|
1902
|
-
"force:app:create:lightning",
|
|
1903
|
-
"app:force:create:lightning",
|
|
1904
|
-
"app:create:force:lightning",
|
|
1905
|
-
"app:create:lightning:force",
|
|
1906
|
-
"force:lightning:create:app",
|
|
1907
|
-
"lightning:force:create:app",
|
|
1908
|
-
"lightning:create:force:app",
|
|
1909
|
-
"lightning:create:app:force",
|
|
1910
|
-
"force:create:lightning:app",
|
|
1911
|
-
"create:force:lightning:app",
|
|
1912
|
-
"create:lightning:force:app",
|
|
1913
|
-
"create:lightning:app:force",
|
|
1914
|
-
"force:create:app:lightning",
|
|
1915
|
-
"create:force:app:lightning",
|
|
1916
|
-
"create:app:force:lightning",
|
|
1917
|
-
"create:app:lightning:force",
|
|
1918
|
-
"lightning:generate:app",
|
|
1919
|
-
"generate:lightning:app",
|
|
1920
|
-
"generate:app:lightning",
|
|
1921
|
-
"lightning:app:generate",
|
|
1922
|
-
"app:lightning:generate",
|
|
1923
|
-
"app:generate:lightning"
|
|
2046
|
+
"force:staticresource:create",
|
|
2047
|
+
"staticresource:force:create",
|
|
2048
|
+
"staticresource:create:force",
|
|
2049
|
+
"force:create:staticresource",
|
|
2050
|
+
"create:force:staticresource",
|
|
2051
|
+
"create:staticresource:force",
|
|
2052
|
+
"static-resource:generate",
|
|
2053
|
+
"generate:static-resource"
|
|
1924
2054
|
],
|
|
1925
2055
|
"permutations": [
|
|
1926
|
-
"template:generate:
|
|
1927
|
-
"generate:template:
|
|
1928
|
-
"generate:
|
|
1929
|
-
"
|
|
1930
|
-
"template:
|
|
1931
|
-
"
|
|
1932
|
-
"lightning:generate:template:app",
|
|
1933
|
-
"lightning:generate:app:template",
|
|
1934
|
-
"template:lightning:app:generate",
|
|
1935
|
-
"lightning:template:app:generate",
|
|
1936
|
-
"lightning:app:template:generate",
|
|
1937
|
-
"lightning:app:generate:template",
|
|
1938
|
-
"template:generate:app:lightning",
|
|
1939
|
-
"generate:template:app:lightning",
|
|
1940
|
-
"generate:app:template:lightning",
|
|
1941
|
-
"generate:app:lightning:template",
|
|
1942
|
-
"template:app:generate:lightning",
|
|
1943
|
-
"app:template:generate:lightning",
|
|
1944
|
-
"app:generate:template:lightning",
|
|
1945
|
-
"app:generate:lightning:template",
|
|
1946
|
-
"template:app:lightning:generate",
|
|
1947
|
-
"app:template:lightning:generate",
|
|
1948
|
-
"app:lightning:template:generate",
|
|
1949
|
-
"app:lightning:generate:template"
|
|
2056
|
+
"template:generate:static-resource",
|
|
2057
|
+
"generate:template:static-resource",
|
|
2058
|
+
"generate:static-resource:template",
|
|
2059
|
+
"template:static-resource:generate",
|
|
2060
|
+
"static-resource:template:generate",
|
|
2061
|
+
"static-resource:generate:template"
|
|
1950
2062
|
]
|
|
1951
2063
|
},
|
|
1952
|
-
"template:generate:
|
|
1953
|
-
"aliases": [
|
|
1954
|
-
"force:lightning:component:create",
|
|
1955
|
-
"lightning:generate:component"
|
|
1956
|
-
],
|
|
2064
|
+
"template:generate:ui-bundle": {
|
|
2065
|
+
"aliases": [],
|
|
1957
2066
|
"args": {},
|
|
1958
|
-
"
|
|
1959
|
-
"description": "Generates the bundle in the specified directory or the current working directory. The bundle consists of multiple files in a directory with the designated name. Lightning web components are contained in the directory with name \"lwc\", Aura components in \"aura\".\n\nTo generate a Lightning web component, pass \"--type lwc\" to the command. If you don’t specify --type, Salesforce CLI generates an Aura component by default.",
|
|
2067
|
+
"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.",
|
|
1960
2068
|
"examples": [
|
|
1961
|
-
"Generate
|
|
1962
|
-
"Generate a
|
|
1963
|
-
"Generate an
|
|
1964
|
-
"Generate
|
|
1965
|
-
"Generate a TypeScript Lightning Web Component:\n<%= config.bin %> <%= command.id %> --name mycomponent --type lwc --template typescript"
|
|
2069
|
+
"Generate a UI bundle called MyUiBundle in the current directory:\n<%= config.bin %> <%= command.id %> --name MyUiBundle",
|
|
2070
|
+
"Generate a React-based UI bundle:\n<%= config.bin %> <%= command.id %> --name MyReactApp --template reactbasic",
|
|
2071
|
+
"Generate an Angular-based UI bundle:\n<%= config.bin %> <%= command.id %> --name MyAngularApp --template angularbasic",
|
|
2072
|
+
"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"
|
|
1966
2073
|
],
|
|
1967
2074
|
"flags": {
|
|
1968
2075
|
"json": {
|
|
@@ -1981,35 +2088,160 @@
|
|
|
1981
2088
|
"type": "option"
|
|
1982
2089
|
},
|
|
1983
2090
|
"name": {
|
|
1984
|
-
"aliases": [
|
|
1985
|
-
"componentname"
|
|
1986
|
-
],
|
|
1987
2091
|
"char": "n",
|
|
1988
|
-
"
|
|
1989
|
-
"description": "The name can be up to 40 characters and must start with a letter.",
|
|
2092
|
+
"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.",
|
|
1990
2093
|
"name": "name",
|
|
1991
2094
|
"required": true,
|
|
1992
|
-
"summary": "
|
|
2095
|
+
"summary": "API name of the generated UI bundle.",
|
|
1993
2096
|
"hasDynamicHelp": false,
|
|
1994
2097
|
"multiple": false,
|
|
1995
2098
|
"type": "option"
|
|
1996
2099
|
},
|
|
1997
2100
|
"template": {
|
|
1998
2101
|
"char": "t",
|
|
1999
|
-
"description": "Supplied parameter values or default values are filled into a copy of the template.
|
|
2102
|
+
"description": "Supplied parameter values or default values are filled into a copy of the template.",
|
|
2000
2103
|
"name": "template",
|
|
2001
|
-
"summary": "Template to use for
|
|
2104
|
+
"summary": "Template to use when creating the files for a specific UI framework.",
|
|
2002
2105
|
"default": "default",
|
|
2003
2106
|
"hasDynamicHelp": false,
|
|
2004
2107
|
"multiple": false,
|
|
2005
2108
|
"options": [
|
|
2006
2109
|
"default",
|
|
2007
|
-
"
|
|
2008
|
-
"
|
|
2009
|
-
|
|
2110
|
+
"reactbasic",
|
|
2111
|
+
"angularbasic"
|
|
2112
|
+
],
|
|
2113
|
+
"type": "option"
|
|
2114
|
+
},
|
|
2115
|
+
"label": {
|
|
2116
|
+
"char": "l",
|
|
2117
|
+
"description": "If not specified, the label is derived from the name.",
|
|
2118
|
+
"name": "label",
|
|
2119
|
+
"summary": "Master label for the UI bundle.",
|
|
2120
|
+
"hasDynamicHelp": false,
|
|
2121
|
+
"multiple": false,
|
|
2122
|
+
"type": "option"
|
|
2123
|
+
},
|
|
2124
|
+
"output-dir": {
|
|
2125
|
+
"char": "d",
|
|
2126
|
+
"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)",
|
|
2127
|
+
"name": "output-dir",
|
|
2128
|
+
"summary": "Directory into which the files are created.",
|
|
2129
|
+
"hasDynamicHelp": false,
|
|
2130
|
+
"multiple": false,
|
|
2131
|
+
"type": "option"
|
|
2132
|
+
},
|
|
2133
|
+
"api-version": {
|
|
2134
|
+
"description": "Override the api version used for api requests made by this command",
|
|
2135
|
+
"name": "api-version",
|
|
2136
|
+
"hasDynamicHelp": false,
|
|
2137
|
+
"multiple": false,
|
|
2138
|
+
"type": "option"
|
|
2139
|
+
}
|
|
2140
|
+
},
|
|
2141
|
+
"hasDynamicHelp": false,
|
|
2142
|
+
"hiddenAliases": [],
|
|
2143
|
+
"id": "template:generate:ui-bundle",
|
|
2144
|
+
"pluginAlias": "@salesforce/plugin-templates",
|
|
2145
|
+
"pluginName": "@salesforce/plugin-templates",
|
|
2146
|
+
"pluginType": "core",
|
|
2147
|
+
"strict": true,
|
|
2148
|
+
"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.",
|
|
2149
|
+
"enableJsonFlag": true,
|
|
2150
|
+
"isESM": true,
|
|
2151
|
+
"relativePath": [
|
|
2152
|
+
"lib",
|
|
2153
|
+
"commands",
|
|
2154
|
+
"template",
|
|
2155
|
+
"generate",
|
|
2156
|
+
"ui-bundle",
|
|
2157
|
+
"index.js"
|
|
2158
|
+
],
|
|
2159
|
+
"aliasPermutations": [],
|
|
2160
|
+
"permutations": [
|
|
2161
|
+
"template:generate:ui-bundle",
|
|
2162
|
+
"generate:template:ui-bundle",
|
|
2163
|
+
"generate:ui-bundle:template",
|
|
2164
|
+
"template:ui-bundle:generate",
|
|
2165
|
+
"ui-bundle:template:generate",
|
|
2166
|
+
"ui-bundle:generate:template"
|
|
2167
|
+
]
|
|
2168
|
+
},
|
|
2169
|
+
"template:generate:ui-embedding": {
|
|
2170
|
+
"aliases": [],
|
|
2171
|
+
"args": {},
|
|
2172
|
+
"description": "The generated LWC bundle consumes the first-party <lightning-ui-embedding> component, which is pre-wired with the three required attributes: the embedding URL (--src), iframe sandbox tokens, and an accessible iframe title (--title).\n\nThe generated LWC bundle contains four files (.html, .js, .js-meta.xml, .css) in a directory named with the camelCased component name. The bundle must live under a parent folder named \"lwc\".",
|
|
2173
|
+
"examples": [
|
|
2174
|
+
"Generate an embedding wrapper LWC in the current directory:\n<%= config.bin %> <%= command.id %> --name MyEmbeddingWrapper --src https://app.example.com --sandbox allow-forms --title \"Expense Report Embedding\"",
|
|
2175
|
+
"Generate an embedding wrapper LWC in the \"force-app/main/default/lwc\" directory with multiple sandbox tokens:\n<%= config.bin %> <%= command.id %> --name MyEmbeddingWrapper --src https://app.example.com --sandbox allow-forms --sandbox allow-scripts --title \"Expense Report Embedding\" --output-dir force-app/main/default/lwc"
|
|
2176
|
+
],
|
|
2177
|
+
"flags": {
|
|
2178
|
+
"json": {
|
|
2179
|
+
"description": "Format output as json.",
|
|
2180
|
+
"helpGroup": "GLOBAL",
|
|
2181
|
+
"name": "json",
|
|
2182
|
+
"allowNo": false,
|
|
2183
|
+
"type": "boolean"
|
|
2184
|
+
},
|
|
2185
|
+
"flags-dir": {
|
|
2186
|
+
"helpGroup": "GLOBAL",
|
|
2187
|
+
"name": "flags-dir",
|
|
2188
|
+
"summary": "Import flag values from a directory.",
|
|
2189
|
+
"hasDynamicHelp": false,
|
|
2190
|
+
"multiple": false,
|
|
2191
|
+
"type": "option"
|
|
2192
|
+
},
|
|
2193
|
+
"name": {
|
|
2194
|
+
"char": "n",
|
|
2195
|
+
"description": "The component name is also used (camelCased) as the LWC folder name and file stem. Must contain only alphanumeric characters and start with a letter.",
|
|
2196
|
+
"name": "name",
|
|
2197
|
+
"required": true,
|
|
2198
|
+
"summary": "Name of the generated component; must be in PascalCase format.",
|
|
2199
|
+
"hasDynamicHelp": false,
|
|
2200
|
+
"multiple": false,
|
|
2201
|
+
"type": "option"
|
|
2202
|
+
},
|
|
2203
|
+
"src": {
|
|
2204
|
+
"char": "s",
|
|
2205
|
+
"description": "The URL is bound to the <lightning-ui-embedding> \"src\" attribute as a reactive property in the generated LWC. Must use HTTPS; plain HTTP is allowed only for localhost or 127.0.0.1 (for local development).",
|
|
2206
|
+
"name": "src",
|
|
2207
|
+
"required": true,
|
|
2208
|
+
"summary": "Absolute HTTPS URL that the iframe will load.",
|
|
2209
|
+
"hasDynamicHelp": false,
|
|
2210
|
+
"multiple": false,
|
|
2211
|
+
"type": "option"
|
|
2212
|
+
},
|
|
2213
|
+
"sandbox": {
|
|
2214
|
+
"description": "Each token is written into the space-separated \"sandbox\" attribute on <lightning-ui-embedding>. Only W3C-defined sandbox tokens are accepted.",
|
|
2215
|
+
"name": "sandbox",
|
|
2216
|
+
"required": true,
|
|
2217
|
+
"summary": "Iframe sandbox token. Specify this flag multiple times to set more than one token.",
|
|
2218
|
+
"hasDynamicHelp": false,
|
|
2219
|
+
"multiple": true,
|
|
2220
|
+
"options": [
|
|
2221
|
+
"allow-forms",
|
|
2222
|
+
"allow-modals",
|
|
2223
|
+
"allow-orientation-lock",
|
|
2224
|
+
"allow-pointer-lock",
|
|
2225
|
+
"allow-popups",
|
|
2226
|
+
"allow-popups-to-escape-sandbox",
|
|
2227
|
+
"allow-presentation",
|
|
2228
|
+
"allow-same-origin",
|
|
2229
|
+
"allow-scripts",
|
|
2230
|
+
"allow-storage-access-by-user-activation",
|
|
2231
|
+
"allow-top-navigation",
|
|
2232
|
+
"allow-top-navigation-by-user-activation"
|
|
2010
2233
|
],
|
|
2011
2234
|
"type": "option"
|
|
2012
2235
|
},
|
|
2236
|
+
"title": {
|
|
2237
|
+
"description": "Written to the \"shell-title\" attribute on <lightning-ui-embedding> and used as the iframe's accessible name (announced by screen readers).",
|
|
2238
|
+
"name": "title",
|
|
2239
|
+
"required": true,
|
|
2240
|
+
"summary": "Accessible title for the embedded iframe.",
|
|
2241
|
+
"hasDynamicHelp": false,
|
|
2242
|
+
"multiple": false,
|
|
2243
|
+
"type": "option"
|
|
2244
|
+
},
|
|
2013
2245
|
"output-dir": {
|
|
2014
2246
|
"aliases": [
|
|
2015
2247
|
"outputdir"
|
|
@@ -2035,18 +2267,6 @@
|
|
|
2035
2267
|
"multiple": false,
|
|
2036
2268
|
"type": "option"
|
|
2037
2269
|
},
|
|
2038
|
-
"type": {
|
|
2039
|
-
"name": "type",
|
|
2040
|
-
"summary": "Type of the component bundle.",
|
|
2041
|
-
"default": "aura",
|
|
2042
|
-
"hasDynamicHelp": false,
|
|
2043
|
-
"multiple": false,
|
|
2044
|
-
"options": [
|
|
2045
|
-
"aura",
|
|
2046
|
-
"lwc"
|
|
2047
|
-
],
|
|
2048
|
-
"type": "option"
|
|
2049
|
-
},
|
|
2050
2270
|
"internal": {
|
|
2051
2271
|
"char": "i",
|
|
2052
2272
|
"hidden": true,
|
|
@@ -2068,12 +2288,12 @@
|
|
|
2068
2288
|
},
|
|
2069
2289
|
"hasDynamicHelp": false,
|
|
2070
2290
|
"hiddenAliases": [],
|
|
2071
|
-
"id": "template:generate:
|
|
2291
|
+
"id": "template:generate:ui-embedding",
|
|
2072
2292
|
"pluginAlias": "@salesforce/plugin-templates",
|
|
2073
2293
|
"pluginName": "@salesforce/plugin-templates",
|
|
2074
2294
|
"pluginType": "core",
|
|
2075
2295
|
"strict": true,
|
|
2076
|
-
"summary": "Generate a
|
|
2296
|
+
"summary": "Generate a Lightning Web Component (LWC) bundle that wraps the <lightning-ui-embedding> base component.",
|
|
2077
2297
|
"enableJsonFlag": true,
|
|
2078
2298
|
"isESM": true,
|
|
2079
2299
|
"relativePath": [
|
|
@@ -2081,79 +2301,30 @@
|
|
|
2081
2301
|
"commands",
|
|
2082
2302
|
"template",
|
|
2083
2303
|
"generate",
|
|
2084
|
-
"
|
|
2085
|
-
"
|
|
2086
|
-
],
|
|
2087
|
-
"aliasPermutations": [
|
|
2088
|
-
"force:lightning:component:create",
|
|
2089
|
-
"lightning:force:component:create",
|
|
2090
|
-
"lightning:component:force:create",
|
|
2091
|
-
"lightning:component:create:force",
|
|
2092
|
-
"force:component:lightning:create",
|
|
2093
|
-
"component:force:lightning:create",
|
|
2094
|
-
"component:lightning:force:create",
|
|
2095
|
-
"component:lightning:create:force",
|
|
2096
|
-
"force:component:create:lightning",
|
|
2097
|
-
"component:force:create:lightning",
|
|
2098
|
-
"component:create:force:lightning",
|
|
2099
|
-
"component:create:lightning:force",
|
|
2100
|
-
"force:lightning:create:component",
|
|
2101
|
-
"lightning:force:create:component",
|
|
2102
|
-
"lightning:create:force:component",
|
|
2103
|
-
"lightning:create:component:force",
|
|
2104
|
-
"force:create:lightning:component",
|
|
2105
|
-
"create:force:lightning:component",
|
|
2106
|
-
"create:lightning:force:component",
|
|
2107
|
-
"create:lightning:component:force",
|
|
2108
|
-
"force:create:component:lightning",
|
|
2109
|
-
"create:force:component:lightning",
|
|
2110
|
-
"create:component:force:lightning",
|
|
2111
|
-
"create:component:lightning:force",
|
|
2112
|
-
"lightning:generate:component",
|
|
2113
|
-
"generate:lightning:component",
|
|
2114
|
-
"generate:component:lightning",
|
|
2115
|
-
"lightning:component:generate",
|
|
2116
|
-
"component:lightning:generate",
|
|
2117
|
-
"component:generate:lightning"
|
|
2304
|
+
"ui-embedding",
|
|
2305
|
+
"index.js"
|
|
2118
2306
|
],
|
|
2307
|
+
"aliasPermutations": [],
|
|
2119
2308
|
"permutations": [
|
|
2120
|
-
"template:generate:
|
|
2121
|
-
"generate:template:
|
|
2122
|
-
"generate:
|
|
2123
|
-
"
|
|
2124
|
-
"template:
|
|
2125
|
-
"
|
|
2126
|
-
"lightning:generate:template:component",
|
|
2127
|
-
"lightning:generate:component:template",
|
|
2128
|
-
"template:lightning:component:generate",
|
|
2129
|
-
"lightning:template:component:generate",
|
|
2130
|
-
"lightning:component:template:generate",
|
|
2131
|
-
"lightning:component:generate:template",
|
|
2132
|
-
"template:generate:component:lightning",
|
|
2133
|
-
"generate:template:component:lightning",
|
|
2134
|
-
"generate:component:template:lightning",
|
|
2135
|
-
"generate:component:lightning:template",
|
|
2136
|
-
"template:component:generate:lightning",
|
|
2137
|
-
"component:template:generate:lightning",
|
|
2138
|
-
"component:generate:template:lightning",
|
|
2139
|
-
"component:generate:lightning:template",
|
|
2140
|
-
"template:component:lightning:generate",
|
|
2141
|
-
"component:template:lightning:generate",
|
|
2142
|
-
"component:lightning:template:generate",
|
|
2143
|
-
"component:lightning:generate:template"
|
|
2309
|
+
"template:generate:ui-embedding",
|
|
2310
|
+
"generate:template:ui-embedding",
|
|
2311
|
+
"generate:ui-embedding:template",
|
|
2312
|
+
"template:ui-embedding:generate",
|
|
2313
|
+
"ui-embedding:template:generate",
|
|
2314
|
+
"ui-embedding:generate:template"
|
|
2144
2315
|
]
|
|
2145
2316
|
},
|
|
2146
|
-
"template:generate:
|
|
2317
|
+
"template:generate:visualforce:component": {
|
|
2147
2318
|
"aliases": [
|
|
2148
|
-
"force:
|
|
2149
|
-
"
|
|
2319
|
+
"force:visualforce:component:create",
|
|
2320
|
+
"visualforce:generate:component"
|
|
2150
2321
|
],
|
|
2151
2322
|
"args": {},
|
|
2152
2323
|
"deprecateAliases": true,
|
|
2153
|
-
"description": "
|
|
2324
|
+
"description": "The command generates the .Component file and associated metadata file in the specified directory or the current working directory by default.",
|
|
2154
2325
|
"examples": [
|
|
2155
|
-
"Generate the metadata files for a
|
|
2156
|
-
"Similar to previous example, but generate the files in the \"force-app/main/default/
|
|
2326
|
+
"Generate the metadata files for a Visualforce component in the current directory:\n<%= config.bin %> <%= command.id %> --name mycomponent --label mylabel",
|
|
2327
|
+
"Similar to previous example, but generate the files in the directory \"force-app/main/default/components\":\n<%= config.bin %> <%= command.id %> --name mycomponent --label mylabel --output-dir components"
|
|
2157
2328
|
],
|
|
2158
2329
|
"flags": {
|
|
2159
2330
|
"json": {
|
|
@@ -2173,28 +2344,28 @@
|
|
|
2173
2344
|
},
|
|
2174
2345
|
"name": {
|
|
2175
2346
|
"aliases": [
|
|
2176
|
-
"
|
|
2347
|
+
"componentname"
|
|
2177
2348
|
],
|
|
2178
2349
|
"char": "n",
|
|
2179
2350
|
"deprecateAliases": true,
|
|
2180
2351
|
"description": "The name can be up to 40 characters and must start with a letter.",
|
|
2181
2352
|
"name": "name",
|
|
2182
2353
|
"required": true,
|
|
2183
|
-
"summary": "Name of the generated
|
|
2354
|
+
"summary": "Name of the generated Visualforce Component.",
|
|
2184
2355
|
"hasDynamicHelp": false,
|
|
2185
2356
|
"multiple": false,
|
|
2186
2357
|
"type": "option"
|
|
2187
2358
|
},
|
|
2188
2359
|
"template": {
|
|
2189
2360
|
"char": "t",
|
|
2190
|
-
"description": "Supplied parameter values or default values are filled into a copy of the template.
|
|
2361
|
+
"description": "Supplied parameter values or default values are filled into a copy of the template.",
|
|
2191
2362
|
"name": "template",
|
|
2192
2363
|
"summary": "Template to use for file creation.",
|
|
2193
|
-
"default": "
|
|
2364
|
+
"default": "DefaultVFComponent",
|
|
2194
2365
|
"hasDynamicHelp": false,
|
|
2195
2366
|
"multiple": false,
|
|
2196
2367
|
"options": [
|
|
2197
|
-
"
|
|
2368
|
+
"DefaultVFComponent"
|
|
2198
2369
|
],
|
|
2199
2370
|
"type": "option"
|
|
2200
2371
|
},
|
|
@@ -2223,190 +2394,15 @@
|
|
|
2223
2394
|
"multiple": false,
|
|
2224
2395
|
"type": "option"
|
|
2225
2396
|
},
|
|
2226
|
-
"
|
|
2227
|
-
"char": "
|
|
2228
|
-
"
|
|
2229
|
-
"name": "internal",
|
|
2230
|
-
"summary": "Generate lightning bundles without creating a -meta.xml file.",
|
|
2231
|
-
"allowNo": false,
|
|
2232
|
-
"type": "boolean"
|
|
2233
|
-
},
|
|
2234
|
-
"loglevel": {
|
|
2235
|
-
"deprecated": {
|
|
2236
|
-
"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."
|
|
2237
|
-
},
|
|
2238
|
-
"hidden": true,
|
|
2239
|
-
"name": "loglevel",
|
|
2240
|
-
"hasDynamicHelp": false,
|
|
2241
|
-
"multiple": false,
|
|
2242
|
-
"type": "option"
|
|
2243
|
-
}
|
|
2244
|
-
},
|
|
2245
|
-
"hasDynamicHelp": false,
|
|
2246
|
-
"hiddenAliases": [],
|
|
2247
|
-
"id": "template:generate:lightning:event",
|
|
2248
|
-
"pluginAlias": "@salesforce/plugin-templates",
|
|
2249
|
-
"pluginName": "@salesforce/plugin-templates",
|
|
2250
|
-
"pluginType": "core",
|
|
2251
|
-
"strict": true,
|
|
2252
|
-
"summary": "Generate a Lightning Event.",
|
|
2253
|
-
"enableJsonFlag": true,
|
|
2254
|
-
"isESM": true,
|
|
2255
|
-
"relativePath": [
|
|
2256
|
-
"lib",
|
|
2257
|
-
"commands",
|
|
2258
|
-
"template",
|
|
2259
|
-
"generate",
|
|
2260
|
-
"lightning",
|
|
2261
|
-
"event.js"
|
|
2262
|
-
],
|
|
2263
|
-
"aliasPermutations": [
|
|
2264
|
-
"force:lightning:event:create",
|
|
2265
|
-
"lightning:force:event:create",
|
|
2266
|
-
"lightning:event:force:create",
|
|
2267
|
-
"lightning:event:create:force",
|
|
2268
|
-
"force:event:lightning:create",
|
|
2269
|
-
"event:force:lightning:create",
|
|
2270
|
-
"event:lightning:force:create",
|
|
2271
|
-
"event:lightning:create:force",
|
|
2272
|
-
"force:event:create:lightning",
|
|
2273
|
-
"event:force:create:lightning",
|
|
2274
|
-
"event:create:force:lightning",
|
|
2275
|
-
"event:create:lightning:force",
|
|
2276
|
-
"force:lightning:create:event",
|
|
2277
|
-
"lightning:force:create:event",
|
|
2278
|
-
"lightning:create:force:event",
|
|
2279
|
-
"lightning:create:event:force",
|
|
2280
|
-
"force:create:lightning:event",
|
|
2281
|
-
"create:force:lightning:event",
|
|
2282
|
-
"create:lightning:force:event",
|
|
2283
|
-
"create:lightning:event:force",
|
|
2284
|
-
"force:create:event:lightning",
|
|
2285
|
-
"create:force:event:lightning",
|
|
2286
|
-
"create:event:force:lightning",
|
|
2287
|
-
"create:event:lightning:force",
|
|
2288
|
-
"lightning:generate:event",
|
|
2289
|
-
"generate:lightning:event",
|
|
2290
|
-
"generate:event:lightning",
|
|
2291
|
-
"lightning:event:generate",
|
|
2292
|
-
"event:lightning:generate",
|
|
2293
|
-
"event:generate:lightning"
|
|
2294
|
-
],
|
|
2295
|
-
"permutations": [
|
|
2296
|
-
"template:generate:lightning:event",
|
|
2297
|
-
"generate:template:lightning:event",
|
|
2298
|
-
"generate:lightning:template:event",
|
|
2299
|
-
"generate:lightning:event:template",
|
|
2300
|
-
"template:lightning:generate:event",
|
|
2301
|
-
"lightning:template:generate:event",
|
|
2302
|
-
"lightning:generate:template:event",
|
|
2303
|
-
"lightning:generate:event:template",
|
|
2304
|
-
"template:lightning:event:generate",
|
|
2305
|
-
"lightning:template:event:generate",
|
|
2306
|
-
"lightning:event:template:generate",
|
|
2307
|
-
"lightning:event:generate:template",
|
|
2308
|
-
"template:generate:event:lightning",
|
|
2309
|
-
"generate:template:event:lightning",
|
|
2310
|
-
"generate:event:template:lightning",
|
|
2311
|
-
"generate:event:lightning:template",
|
|
2312
|
-
"template:event:generate:lightning",
|
|
2313
|
-
"event:template:generate:lightning",
|
|
2314
|
-
"event:generate:template:lightning",
|
|
2315
|
-
"event:generate:lightning:template",
|
|
2316
|
-
"template:event:lightning:generate",
|
|
2317
|
-
"event:template:lightning:generate",
|
|
2318
|
-
"event:lightning:template:generate",
|
|
2319
|
-
"event:lightning:generate:template"
|
|
2320
|
-
]
|
|
2321
|
-
},
|
|
2322
|
-
"template:generate:lightning:interface": {
|
|
2323
|
-
"aliases": [
|
|
2324
|
-
"force:lightning:interface:create",
|
|
2325
|
-
"lightning:generate:interface"
|
|
2326
|
-
],
|
|
2327
|
-
"args": {},
|
|
2328
|
-
"deprecateAliases": true,
|
|
2329
|
-
"description": "Generates a Lightning Interface bundle in the specified directory or the current working directory. The bundle consists of multiple files in a folder with the designated name.",
|
|
2330
|
-
"examples": [
|
|
2331
|
-
"Generate the metadata files for a Lightning interface bundle called \"myinterface\" in the current directory:\n<%= config.bin %> <%= command.id %> --name myinterface",
|
|
2332
|
-
"Similar to the previous example but generate the files in the \"force-app/main/default/aura\" directory:\n<%= config.bin %> <%= command.id %> --name myinterface --output-dir force-app/main/default/aura"
|
|
2333
|
-
],
|
|
2334
|
-
"flags": {
|
|
2335
|
-
"json": {
|
|
2336
|
-
"description": "Format output as json.",
|
|
2337
|
-
"helpGroup": "GLOBAL",
|
|
2338
|
-
"name": "json",
|
|
2339
|
-
"allowNo": false,
|
|
2340
|
-
"type": "boolean"
|
|
2341
|
-
},
|
|
2342
|
-
"flags-dir": {
|
|
2343
|
-
"helpGroup": "GLOBAL",
|
|
2344
|
-
"name": "flags-dir",
|
|
2345
|
-
"summary": "Import flag values from a directory.",
|
|
2346
|
-
"hasDynamicHelp": false,
|
|
2347
|
-
"multiple": false,
|
|
2348
|
-
"type": "option"
|
|
2349
|
-
},
|
|
2350
|
-
"name": {
|
|
2351
|
-
"aliases": [
|
|
2352
|
-
"interfacename"
|
|
2353
|
-
],
|
|
2354
|
-
"char": "n",
|
|
2355
|
-
"deprecateAliases": true,
|
|
2356
|
-
"description": "The name can be up to 40 characters and must start with a letter.",
|
|
2357
|
-
"name": "name",
|
|
2397
|
+
"label": {
|
|
2398
|
+
"char": "l",
|
|
2399
|
+
"name": "label",
|
|
2358
2400
|
"required": true,
|
|
2359
|
-
"summary": "
|
|
2360
|
-
"hasDynamicHelp": false,
|
|
2361
|
-
"multiple": false,
|
|
2362
|
-
"type": "option"
|
|
2363
|
-
},
|
|
2364
|
-
"template": {
|
|
2365
|
-
"char": "t",
|
|
2366
|
-
"description": "Supplied parameter values or default values are filled into a copy of the template. For Lightning Web Components, if this flag isn't specified, the CLI command automatically selects the template based on the \"defaultLwcLanguage\" field in the DX project's \"sfdx-project.json\" file.",
|
|
2367
|
-
"name": "template",
|
|
2368
|
-
"summary": "Template to use for file creation.",
|
|
2369
|
-
"default": "DefaultLightningIntf",
|
|
2370
|
-
"hasDynamicHelp": false,
|
|
2371
|
-
"multiple": false,
|
|
2372
|
-
"options": [
|
|
2373
|
-
"DefaultLightningIntf"
|
|
2374
|
-
],
|
|
2375
|
-
"type": "option"
|
|
2376
|
-
},
|
|
2377
|
-
"output-dir": {
|
|
2378
|
-
"aliases": [
|
|
2379
|
-
"outputdir"
|
|
2380
|
-
],
|
|
2381
|
-
"char": "d",
|
|
2382
|
-
"deprecateAliases": true,
|
|
2383
|
-
"description": "The location can be an absolute path or relative to the current working directory. The default is the current directory.",
|
|
2384
|
-
"name": "output-dir",
|
|
2385
|
-
"summary": "Directory for saving the created files.",
|
|
2386
|
-
"default": ".",
|
|
2387
|
-
"hasDynamicHelp": false,
|
|
2388
|
-
"multiple": false,
|
|
2389
|
-
"type": "option"
|
|
2390
|
-
},
|
|
2391
|
-
"api-version": {
|
|
2392
|
-
"aliases": [
|
|
2393
|
-
"apiversion"
|
|
2394
|
-
],
|
|
2395
|
-
"deprecateAliases": true,
|
|
2396
|
-
"description": "Override the api version used for api requests made by this command",
|
|
2397
|
-
"name": "api-version",
|
|
2401
|
+
"summary": "Visualforce Component label.",
|
|
2398
2402
|
"hasDynamicHelp": false,
|
|
2399
2403
|
"multiple": false,
|
|
2400
2404
|
"type": "option"
|
|
2401
2405
|
},
|
|
2402
|
-
"internal": {
|
|
2403
|
-
"char": "i",
|
|
2404
|
-
"hidden": true,
|
|
2405
|
-
"name": "internal",
|
|
2406
|
-
"summary": "Generate lightning bundles without creating a -meta.xml file.",
|
|
2407
|
-
"allowNo": false,
|
|
2408
|
-
"type": "boolean"
|
|
2409
|
-
},
|
|
2410
2406
|
"loglevel": {
|
|
2411
2407
|
"deprecated": {
|
|
2412
2408
|
"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."
|
|
@@ -2420,12 +2416,12 @@
|
|
|
2420
2416
|
},
|
|
2421
2417
|
"hasDynamicHelp": false,
|
|
2422
2418
|
"hiddenAliases": [],
|
|
2423
|
-
"id": "template:generate:
|
|
2419
|
+
"id": "template:generate:visualforce:component",
|
|
2424
2420
|
"pluginAlias": "@salesforce/plugin-templates",
|
|
2425
2421
|
"pluginName": "@salesforce/plugin-templates",
|
|
2426
2422
|
"pluginType": "core",
|
|
2427
2423
|
"strict": true,
|
|
2428
|
-
"summary": "Generate a
|
|
2424
|
+
"summary": "Generate a Visualforce Component.",
|
|
2429
2425
|
"enableJsonFlag": true,
|
|
2430
2426
|
"isESM": true,
|
|
2431
2427
|
"relativePath": [
|
|
@@ -2433,79 +2429,79 @@
|
|
|
2433
2429
|
"commands",
|
|
2434
2430
|
"template",
|
|
2435
2431
|
"generate",
|
|
2436
|
-
"
|
|
2437
|
-
"
|
|
2432
|
+
"visualforce",
|
|
2433
|
+
"component.js"
|
|
2438
2434
|
],
|
|
2439
2435
|
"aliasPermutations": [
|
|
2440
|
-
"force:
|
|
2441
|
-
"
|
|
2442
|
-
"
|
|
2443
|
-
"
|
|
2444
|
-
"force:
|
|
2445
|
-
"
|
|
2446
|
-
"
|
|
2447
|
-
"
|
|
2448
|
-
"force:
|
|
2449
|
-
"
|
|
2450
|
-
"
|
|
2451
|
-
"
|
|
2452
|
-
"force:
|
|
2453
|
-
"
|
|
2454
|
-
"
|
|
2455
|
-
"
|
|
2456
|
-
"force:create:
|
|
2457
|
-
"create:force:
|
|
2458
|
-
"create:
|
|
2459
|
-
"create:
|
|
2460
|
-
"force:create:
|
|
2461
|
-
"create:force:
|
|
2462
|
-
"create:
|
|
2463
|
-
"create:
|
|
2464
|
-
"
|
|
2465
|
-
"generate:
|
|
2466
|
-
"generate:
|
|
2467
|
-
"
|
|
2468
|
-
"
|
|
2469
|
-
"
|
|
2436
|
+
"force:visualforce:component:create",
|
|
2437
|
+
"visualforce:force:component:create",
|
|
2438
|
+
"visualforce:component:force:create",
|
|
2439
|
+
"visualforce:component:create:force",
|
|
2440
|
+
"force:component:visualforce:create",
|
|
2441
|
+
"component:force:visualforce:create",
|
|
2442
|
+
"component:visualforce:force:create",
|
|
2443
|
+
"component:visualforce:create:force",
|
|
2444
|
+
"force:component:create:visualforce",
|
|
2445
|
+
"component:force:create:visualforce",
|
|
2446
|
+
"component:create:force:visualforce",
|
|
2447
|
+
"component:create:visualforce:force",
|
|
2448
|
+
"force:visualforce:create:component",
|
|
2449
|
+
"visualforce:force:create:component",
|
|
2450
|
+
"visualforce:create:force:component",
|
|
2451
|
+
"visualforce:create:component:force",
|
|
2452
|
+
"force:create:visualforce:component",
|
|
2453
|
+
"create:force:visualforce:component",
|
|
2454
|
+
"create:visualforce:force:component",
|
|
2455
|
+
"create:visualforce:component:force",
|
|
2456
|
+
"force:create:component:visualforce",
|
|
2457
|
+
"create:force:component:visualforce",
|
|
2458
|
+
"create:component:force:visualforce",
|
|
2459
|
+
"create:component:visualforce:force",
|
|
2460
|
+
"visualforce:generate:component",
|
|
2461
|
+
"generate:visualforce:component",
|
|
2462
|
+
"generate:component:visualforce",
|
|
2463
|
+
"visualforce:component:generate",
|
|
2464
|
+
"component:visualforce:generate",
|
|
2465
|
+
"component:generate:visualforce"
|
|
2470
2466
|
],
|
|
2471
2467
|
"permutations": [
|
|
2472
|
-
"template:generate:
|
|
2473
|
-
"generate:template:
|
|
2474
|
-
"generate:
|
|
2475
|
-
"generate:
|
|
2476
|
-
"template:
|
|
2477
|
-
"
|
|
2478
|
-
"
|
|
2479
|
-
"
|
|
2480
|
-
"template:
|
|
2481
|
-
"
|
|
2482
|
-
"
|
|
2483
|
-
"
|
|
2484
|
-
"template:generate:
|
|
2485
|
-
"generate:template:
|
|
2486
|
-
"generate:
|
|
2487
|
-
"generate:
|
|
2488
|
-
"template:
|
|
2489
|
-
"
|
|
2490
|
-
"
|
|
2491
|
-
"
|
|
2492
|
-
"template:
|
|
2493
|
-
"
|
|
2494
|
-
"
|
|
2495
|
-
"
|
|
2468
|
+
"template:generate:visualforce:component",
|
|
2469
|
+
"generate:template:visualforce:component",
|
|
2470
|
+
"generate:visualforce:template:component",
|
|
2471
|
+
"generate:visualforce:component:template",
|
|
2472
|
+
"template:visualforce:generate:component",
|
|
2473
|
+
"visualforce:template:generate:component",
|
|
2474
|
+
"visualforce:generate:template:component",
|
|
2475
|
+
"visualforce:generate:component:template",
|
|
2476
|
+
"template:visualforce:component:generate",
|
|
2477
|
+
"visualforce:template:component:generate",
|
|
2478
|
+
"visualforce:component:template:generate",
|
|
2479
|
+
"visualforce:component:generate:template",
|
|
2480
|
+
"template:generate:component:visualforce",
|
|
2481
|
+
"generate:template:component:visualforce",
|
|
2482
|
+
"generate:component:template:visualforce",
|
|
2483
|
+
"generate:component:visualforce:template",
|
|
2484
|
+
"template:component:generate:visualforce",
|
|
2485
|
+
"component:template:generate:visualforce",
|
|
2486
|
+
"component:generate:template:visualforce",
|
|
2487
|
+
"component:generate:visualforce:template",
|
|
2488
|
+
"template:component:visualforce:generate",
|
|
2489
|
+
"component:template:visualforce:generate",
|
|
2490
|
+
"component:visualforce:template:generate",
|
|
2491
|
+
"component:visualforce:generate:template"
|
|
2496
2492
|
]
|
|
2497
2493
|
},
|
|
2498
|
-
"template:generate:
|
|
2494
|
+
"template:generate:visualforce:page": {
|
|
2499
2495
|
"aliases": [
|
|
2500
|
-
"force:
|
|
2501
|
-
"
|
|
2496
|
+
"force:visualforce:page:create",
|
|
2497
|
+
"visualforce:generate:page"
|
|
2502
2498
|
],
|
|
2503
2499
|
"args": {},
|
|
2504
2500
|
"deprecateAliases": true,
|
|
2505
|
-
"description": "
|
|
2501
|
+
"description": "The command generates the .Page file and associated metadata file in the specified directory or the current working directory by default.",
|
|
2506
2502
|
"examples": [
|
|
2507
|
-
"Generate the metadata files for
|
|
2508
|
-
"Similar to
|
|
2503
|
+
"Generate the metadata files for a Visualforce page in the current directory:\n<%= config.bin %> <%= command.id %> --name mypage --label mylabel",
|
|
2504
|
+
"Similar to previous example, but generate the files in the directory \"force-app/main/default/pages\":\n<%= config.bin %> <%= command.id %> --name mypage --label mylabel --output-dir pages"
|
|
2509
2505
|
],
|
|
2510
2506
|
"flags": {
|
|
2511
2507
|
"json": {
|
|
@@ -2525,28 +2521,29 @@
|
|
|
2525
2521
|
},
|
|
2526
2522
|
"name": {
|
|
2527
2523
|
"aliases": [
|
|
2528
|
-
"
|
|
2524
|
+
"pagename"
|
|
2529
2525
|
],
|
|
2530
2526
|
"char": "n",
|
|
2531
2527
|
"deprecateAliases": true,
|
|
2532
|
-
"description": "
|
|
2528
|
+
"description": "The name can be up to 40 characters and must start with a letter.",
|
|
2533
2529
|
"name": "name",
|
|
2534
2530
|
"required": true,
|
|
2535
|
-
"summary": "Name of the generated
|
|
2531
|
+
"summary": "Name of the generated Visualforce Page.",
|
|
2536
2532
|
"hasDynamicHelp": false,
|
|
2537
2533
|
"multiple": false,
|
|
2538
2534
|
"type": "option"
|
|
2539
2535
|
},
|
|
2540
2536
|
"template": {
|
|
2541
2537
|
"char": "t",
|
|
2542
|
-
"description": "Supplied parameter values or default values are filled into a copy of the template.
|
|
2538
|
+
"description": "Supplied parameter values or default values are filled into a copy of the template.",
|
|
2539
|
+
"hidden": true,
|
|
2543
2540
|
"name": "template",
|
|
2544
2541
|
"summary": "Template to use for file creation.",
|
|
2545
|
-
"default": "
|
|
2542
|
+
"default": "DefaultVFPage",
|
|
2546
2543
|
"hasDynamicHelp": false,
|
|
2547
2544
|
"multiple": false,
|
|
2548
2545
|
"options": [
|
|
2549
|
-
"
|
|
2546
|
+
"DefaultVFPage"
|
|
2550
2547
|
],
|
|
2551
2548
|
"type": "option"
|
|
2552
2549
|
},
|
|
@@ -2564,14 +2561,6 @@
|
|
|
2564
2561
|
"multiple": false,
|
|
2565
2562
|
"type": "option"
|
|
2566
2563
|
},
|
|
2567
|
-
"internal": {
|
|
2568
|
-
"char": "i",
|
|
2569
|
-
"hidden": true,
|
|
2570
|
-
"name": "internal",
|
|
2571
|
-
"summary": "Generate lightning bundles without creating a -meta.xml file.",
|
|
2572
|
-
"allowNo": false,
|
|
2573
|
-
"type": "boolean"
|
|
2574
|
-
},
|
|
2575
2564
|
"api-version": {
|
|
2576
2565
|
"aliases": [
|
|
2577
2566
|
"apiversion"
|
|
@@ -2583,6 +2572,15 @@
|
|
|
2583
2572
|
"multiple": false,
|
|
2584
2573
|
"type": "option"
|
|
2585
2574
|
},
|
|
2575
|
+
"label": {
|
|
2576
|
+
"char": "l",
|
|
2577
|
+
"name": "label",
|
|
2578
|
+
"required": true,
|
|
2579
|
+
"summary": "Visualforce Page label.",
|
|
2580
|
+
"hasDynamicHelp": false,
|
|
2581
|
+
"multiple": false,
|
|
2582
|
+
"type": "option"
|
|
2583
|
+
},
|
|
2586
2584
|
"loglevel": {
|
|
2587
2585
|
"deprecated": {
|
|
2588
2586
|
"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."
|
|
@@ -2596,12 +2594,12 @@
|
|
|
2596
2594
|
},
|
|
2597
2595
|
"hasDynamicHelp": false,
|
|
2598
2596
|
"hiddenAliases": [],
|
|
2599
|
-
"id": "template:generate:
|
|
2597
|
+
"id": "template:generate:visualforce:page",
|
|
2600
2598
|
"pluginAlias": "@salesforce/plugin-templates",
|
|
2601
2599
|
"pluginName": "@salesforce/plugin-templates",
|
|
2602
2600
|
"pluginType": "core",
|
|
2603
2601
|
"strict": true,
|
|
2604
|
-
"summary": "Generate a
|
|
2602
|
+
"summary": "Generate a Visualforce Page.",
|
|
2605
2603
|
"enableJsonFlag": true,
|
|
2606
2604
|
"isESM": true,
|
|
2607
2605
|
"relativePath": [
|
|
@@ -2609,68 +2607,68 @@
|
|
|
2609
2607
|
"commands",
|
|
2610
2608
|
"template",
|
|
2611
2609
|
"generate",
|
|
2612
|
-
"
|
|
2613
|
-
"
|
|
2610
|
+
"visualforce",
|
|
2611
|
+
"page.js"
|
|
2614
2612
|
],
|
|
2615
2613
|
"aliasPermutations": [
|
|
2616
|
-
"force:
|
|
2617
|
-
"
|
|
2618
|
-
"
|
|
2619
|
-
"
|
|
2620
|
-
"force:
|
|
2621
|
-
"
|
|
2622
|
-
"
|
|
2623
|
-
"
|
|
2624
|
-
"force:
|
|
2625
|
-
"
|
|
2626
|
-
"
|
|
2627
|
-
"
|
|
2628
|
-
"force:
|
|
2629
|
-
"
|
|
2630
|
-
"
|
|
2631
|
-
"
|
|
2632
|
-
"force:create:
|
|
2633
|
-
"create:force:
|
|
2634
|
-
"create:
|
|
2635
|
-
"create:
|
|
2636
|
-
"force:create:
|
|
2637
|
-
"create:force:
|
|
2638
|
-
"create:
|
|
2639
|
-
"create:
|
|
2640
|
-
"
|
|
2641
|
-
"generate:
|
|
2642
|
-
"generate:
|
|
2643
|
-
"
|
|
2644
|
-
"
|
|
2645
|
-
"
|
|
2614
|
+
"force:visualforce:page:create",
|
|
2615
|
+
"visualforce:force:page:create",
|
|
2616
|
+
"visualforce:page:force:create",
|
|
2617
|
+
"visualforce:page:create:force",
|
|
2618
|
+
"force:page:visualforce:create",
|
|
2619
|
+
"page:force:visualforce:create",
|
|
2620
|
+
"page:visualforce:force:create",
|
|
2621
|
+
"page:visualforce:create:force",
|
|
2622
|
+
"force:page:create:visualforce",
|
|
2623
|
+
"page:force:create:visualforce",
|
|
2624
|
+
"page:create:force:visualforce",
|
|
2625
|
+
"page:create:visualforce:force",
|
|
2626
|
+
"force:visualforce:create:page",
|
|
2627
|
+
"visualforce:force:create:page",
|
|
2628
|
+
"visualforce:create:force:page",
|
|
2629
|
+
"visualforce:create:page:force",
|
|
2630
|
+
"force:create:visualforce:page",
|
|
2631
|
+
"create:force:visualforce:page",
|
|
2632
|
+
"create:visualforce:force:page",
|
|
2633
|
+
"create:visualforce:page:force",
|
|
2634
|
+
"force:create:page:visualforce",
|
|
2635
|
+
"create:force:page:visualforce",
|
|
2636
|
+
"create:page:force:visualforce",
|
|
2637
|
+
"create:page:visualforce:force",
|
|
2638
|
+
"visualforce:generate:page",
|
|
2639
|
+
"generate:visualforce:page",
|
|
2640
|
+
"generate:page:visualforce",
|
|
2641
|
+
"visualforce:page:generate",
|
|
2642
|
+
"page:visualforce:generate",
|
|
2643
|
+
"page:generate:visualforce"
|
|
2646
2644
|
],
|
|
2647
2645
|
"permutations": [
|
|
2648
|
-
"template:generate:
|
|
2649
|
-
"generate:template:
|
|
2650
|
-
"generate:
|
|
2651
|
-
"generate:
|
|
2652
|
-
"template:
|
|
2653
|
-
"
|
|
2654
|
-
"
|
|
2655
|
-
"
|
|
2656
|
-
"template:
|
|
2657
|
-
"
|
|
2658
|
-
"
|
|
2659
|
-
"
|
|
2660
|
-
"template:generate:
|
|
2661
|
-
"generate:template:
|
|
2662
|
-
"generate:
|
|
2663
|
-
"generate:
|
|
2664
|
-
"template:
|
|
2665
|
-
"
|
|
2666
|
-
"
|
|
2667
|
-
"
|
|
2668
|
-
"template:
|
|
2669
|
-
"
|
|
2670
|
-
"
|
|
2671
|
-
"
|
|
2646
|
+
"template:generate:visualforce:page",
|
|
2647
|
+
"generate:template:visualforce:page",
|
|
2648
|
+
"generate:visualforce:template:page",
|
|
2649
|
+
"generate:visualforce:page:template",
|
|
2650
|
+
"template:visualforce:generate:page",
|
|
2651
|
+
"visualforce:template:generate:page",
|
|
2652
|
+
"visualforce:generate:template:page",
|
|
2653
|
+
"visualforce:generate:page:template",
|
|
2654
|
+
"template:visualforce:page:generate",
|
|
2655
|
+
"visualforce:template:page:generate",
|
|
2656
|
+
"visualforce:page:template:generate",
|
|
2657
|
+
"visualforce:page:generate:template",
|
|
2658
|
+
"template:generate:page:visualforce",
|
|
2659
|
+
"generate:template:page:visualforce",
|
|
2660
|
+
"generate:page:template:visualforce",
|
|
2661
|
+
"generate:page:visualforce:template",
|
|
2662
|
+
"template:page:generate:visualforce",
|
|
2663
|
+
"page:template:generate:visualforce",
|
|
2664
|
+
"page:generate:template:visualforce",
|
|
2665
|
+
"page:generate:visualforce:template",
|
|
2666
|
+
"template:page:visualforce:generate",
|
|
2667
|
+
"page:template:visualforce:generate",
|
|
2668
|
+
"page:visualforce:template:generate",
|
|
2669
|
+
"page:visualforce:generate:template"
|
|
2672
2670
|
]
|
|
2673
2671
|
}
|
|
2674
2672
|
},
|
|
2675
|
-
"version": "57.
|
|
2673
|
+
"version": "57.3.0"
|
|
2676
2674
|
}
|