@salesforce/plugin-templates 56.17.6 → 56.17.7
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +15 -15
- package/oclif.manifest.json +224 -224
- package/package.json +5 -5
package/README.md
CHANGED
|
@@ -177,7 +177,7 @@ FLAG DESCRIPTIONS
|
|
|
177
177
|
directory.
|
|
178
178
|
```
|
|
179
179
|
|
|
180
|
-
_See code: [src/commands/template/generate/analytics/template.ts](https://github.com/salesforcecli/plugin-templates/blob/56.17.
|
|
180
|
+
_See code: [src/commands/template/generate/analytics/template.ts](https://github.com/salesforcecli/plugin-templates/blob/56.17.7/src/commands/template/generate/analytics/template.ts)_
|
|
181
181
|
|
|
182
182
|
## `sf template generate apex class`
|
|
183
183
|
|
|
@@ -237,7 +237,7 @@ FLAG DESCRIPTIONS
|
|
|
237
237
|
Supplied parameter values or default values are filled into a copy of the template.
|
|
238
238
|
```
|
|
239
239
|
|
|
240
|
-
_See code: [src/commands/template/generate/apex/class.ts](https://github.com/salesforcecli/plugin-templates/blob/56.17.
|
|
240
|
+
_See code: [src/commands/template/generate/apex/class.ts](https://github.com/salesforcecli/plugin-templates/blob/56.17.7/src/commands/template/generate/apex/class.ts)_
|
|
241
241
|
|
|
242
242
|
## `sf template generate apex trigger`
|
|
243
243
|
|
|
@@ -307,7 +307,7 @@ FLAG DESCRIPTIONS
|
|
|
307
307
|
Supplied parameter values or default values are filled into a copy of the template.
|
|
308
308
|
```
|
|
309
309
|
|
|
310
|
-
_See code: [src/commands/template/generate/apex/trigger.ts](https://github.com/salesforcecli/plugin-templates/blob/56.17.
|
|
310
|
+
_See code: [src/commands/template/generate/apex/trigger.ts](https://github.com/salesforcecli/plugin-templates/blob/56.17.7/src/commands/template/generate/apex/trigger.ts)_
|
|
311
311
|
|
|
312
312
|
## `sf template generate digital-experience site`
|
|
313
313
|
|
|
@@ -361,7 +361,7 @@ FLAG DESCRIPTIONS
|
|
|
361
361
|
project, defaults to the current directory.
|
|
362
362
|
```
|
|
363
363
|
|
|
364
|
-
_See code: [src/commands/template/generate/digital-experience/site.ts](https://github.com/salesforcecli/plugin-templates/blob/56.17.
|
|
364
|
+
_See code: [src/commands/template/generate/digital-experience/site.ts](https://github.com/salesforcecli/plugin-templates/blob/56.17.7/src/commands/template/generate/digital-experience/site.ts)_
|
|
365
365
|
|
|
366
366
|
## `sf template generate flexipage`
|
|
367
367
|
|
|
@@ -443,7 +443,7 @@ FLAG DESCRIPTIONS
|
|
|
443
443
|
'Custom_Object__c'. This sets the `sobjectType` field in the FlexiPage metadata.
|
|
444
444
|
```
|
|
445
445
|
|
|
446
|
-
_See code: [src/commands/template/generate/flexipage/index.ts](https://github.com/salesforcecli/plugin-templates/blob/56.17.
|
|
446
|
+
_See code: [src/commands/template/generate/flexipage/index.ts](https://github.com/salesforcecli/plugin-templates/blob/56.17.7/src/commands/template/generate/flexipage/index.ts)_
|
|
447
447
|
|
|
448
448
|
## `sf template generate lightning app`
|
|
449
449
|
|
|
@@ -501,7 +501,7 @@ FLAG DESCRIPTIONS
|
|
|
501
501
|
field in the DX project's "sfdx-project.json" file.
|
|
502
502
|
```
|
|
503
503
|
|
|
504
|
-
_See code: [src/commands/template/generate/lightning/app.ts](https://github.com/salesforcecli/plugin-templates/blob/56.17.
|
|
504
|
+
_See code: [src/commands/template/generate/lightning/app.ts](https://github.com/salesforcecli/plugin-templates/blob/56.17.7/src/commands/template/generate/lightning/app.ts)_
|
|
505
505
|
|
|
506
506
|
## `sf template generate lightning component`
|
|
507
507
|
|
|
@@ -578,7 +578,7 @@ FLAG DESCRIPTIONS
|
|
|
578
578
|
field in the DX project's "sfdx-project.json" file.
|
|
579
579
|
```
|
|
580
580
|
|
|
581
|
-
_See code: [src/commands/template/generate/lightning/component.ts](https://github.com/salesforcecli/plugin-templates/blob/56.17.
|
|
581
|
+
_See code: [src/commands/template/generate/lightning/component.ts](https://github.com/salesforcecli/plugin-templates/blob/56.17.7/src/commands/template/generate/lightning/component.ts)_
|
|
582
582
|
|
|
583
583
|
## `sf template generate lightning event`
|
|
584
584
|
|
|
@@ -636,7 +636,7 @@ FLAG DESCRIPTIONS
|
|
|
636
636
|
field in the DX project's "sfdx-project.json" file.
|
|
637
637
|
```
|
|
638
638
|
|
|
639
|
-
_See code: [src/commands/template/generate/lightning/event.ts](https://github.com/salesforcecli/plugin-templates/blob/56.17.
|
|
639
|
+
_See code: [src/commands/template/generate/lightning/event.ts](https://github.com/salesforcecli/plugin-templates/blob/56.17.7/src/commands/template/generate/lightning/event.ts)_
|
|
640
640
|
|
|
641
641
|
## `sf template generate lightning interface`
|
|
642
642
|
|
|
@@ -694,7 +694,7 @@ FLAG DESCRIPTIONS
|
|
|
694
694
|
field in the DX project's "sfdx-project.json" file.
|
|
695
695
|
```
|
|
696
696
|
|
|
697
|
-
_See code: [src/commands/template/generate/lightning/interface.ts](https://github.com/salesforcecli/plugin-templates/blob/56.17.
|
|
697
|
+
_See code: [src/commands/template/generate/lightning/interface.ts](https://github.com/salesforcecli/plugin-templates/blob/56.17.7/src/commands/template/generate/lightning/interface.ts)_
|
|
698
698
|
|
|
699
699
|
## `sf template generate lightning test`
|
|
700
700
|
|
|
@@ -752,7 +752,7 @@ FLAG DESCRIPTIONS
|
|
|
752
752
|
field in the DX project's "sfdx-project.json" file.
|
|
753
753
|
```
|
|
754
754
|
|
|
755
|
-
_See code: [src/commands/template/generate/lightning/test.ts](https://github.com/salesforcecli/plugin-templates/blob/56.17.
|
|
755
|
+
_See code: [src/commands/template/generate/lightning/test.ts](https://github.com/salesforcecli/plugin-templates/blob/56.17.7/src/commands/template/generate/lightning/test.ts)_
|
|
756
756
|
|
|
757
757
|
## `sf template generate project`
|
|
758
758
|
|
|
@@ -878,7 +878,7 @@ FLAG DESCRIPTIONS
|
|
|
878
878
|
server-side type stripping.
|
|
879
879
|
```
|
|
880
880
|
|
|
881
|
-
_See code: [src/commands/template/generate/project/index.ts](https://github.com/salesforcecli/plugin-templates/blob/56.17.
|
|
881
|
+
_See code: [src/commands/template/generate/project/index.ts](https://github.com/salesforcecli/plugin-templates/blob/56.17.7/src/commands/template/generate/project/index.ts)_
|
|
882
882
|
|
|
883
883
|
## `sf template generate static-resource`
|
|
884
884
|
|
|
@@ -941,7 +941,7 @@ FLAG DESCRIPTIONS
|
|
|
941
941
|
etc.
|
|
942
942
|
```
|
|
943
943
|
|
|
944
|
-
_See code: [src/commands/template/generate/static-resource/index.ts](https://github.com/salesforcecli/plugin-templates/blob/56.17.
|
|
944
|
+
_See code: [src/commands/template/generate/static-resource/index.ts](https://github.com/salesforcecli/plugin-templates/blob/56.17.7/src/commands/template/generate/static-resource/index.ts)_
|
|
945
945
|
|
|
946
946
|
## `sf template generate ui-bundle`
|
|
947
947
|
|
|
@@ -1025,7 +1025,7 @@ FLAG DESCRIPTIONS
|
|
|
1025
1025
|
Supplied parameter values or default values are filled into a copy of the template.
|
|
1026
1026
|
```
|
|
1027
1027
|
|
|
1028
|
-
_See code: [src/commands/template/generate/ui-bundle/index.ts](https://github.com/salesforcecli/plugin-templates/blob/56.17.
|
|
1028
|
+
_See code: [src/commands/template/generate/ui-bundle/index.ts](https://github.com/salesforcecli/plugin-templates/blob/56.17.7/src/commands/template/generate/ui-bundle/index.ts)_
|
|
1029
1029
|
|
|
1030
1030
|
## `sf template generate visualforce component`
|
|
1031
1031
|
|
|
@@ -1082,7 +1082,7 @@ FLAG DESCRIPTIONS
|
|
|
1082
1082
|
Supplied parameter values or default values are filled into a copy of the template.
|
|
1083
1083
|
```
|
|
1084
1084
|
|
|
1085
|
-
_See code: [src/commands/template/generate/visualforce/component.ts](https://github.com/salesforcecli/plugin-templates/blob/56.17.
|
|
1085
|
+
_See code: [src/commands/template/generate/visualforce/component.ts](https://github.com/salesforcecli/plugin-templates/blob/56.17.7/src/commands/template/generate/visualforce/component.ts)_
|
|
1086
1086
|
|
|
1087
1087
|
## `sf template generate visualforce page`
|
|
1088
1088
|
|
|
@@ -1133,6 +1133,6 @@ FLAG DESCRIPTIONS
|
|
|
1133
1133
|
The name can be up to 40 characters and must start with a letter.
|
|
1134
1134
|
```
|
|
1135
1135
|
|
|
1136
|
-
_See code: [src/commands/template/generate/visualforce/page.ts](https://github.com/salesforcecli/plugin-templates/blob/56.17.
|
|
1136
|
+
_See code: [src/commands/template/generate/visualforce/page.ts](https://github.com/salesforcecli/plugin-templates/blob/56.17.7/src/commands/template/generate/visualforce/page.ts)_
|
|
1137
1137
|
|
|
1138
1138
|
<!-- commandsstop -->
|
package/oclif.manifest.json
CHANGED
|
@@ -839,6 +839,197 @@
|
|
|
839
839
|
"flexipage:generate:template"
|
|
840
840
|
]
|
|
841
841
|
},
|
|
842
|
+
"template:generate:project": {
|
|
843
|
+
"aliases": [
|
|
844
|
+
"force:project:create",
|
|
845
|
+
"project:generate"
|
|
846
|
+
],
|
|
847
|
+
"args": {},
|
|
848
|
+
"deprecateAliases": true,
|
|
849
|
+
"description": "A Salesforce DX project has a specific structure and a configuration file (sfdx-project.json) that identifies the directory as a Salesforce DX project. This command generates the necessary configuration files and directories to get you started.\n\nBy default, the generated sfdx-project.json file sets the sourceApiVersion property to the default API version currently used by Salesforce CLI. To specify a different version, set the apiVersion configuration variable. For example: \"sf config set apiVersion=57.0 --global\".",
|
|
850
|
+
"examples": [
|
|
851
|
+
"Generate a project called \"mywork\":\n<%= config.bin %> <%= command.id %> --name mywork",
|
|
852
|
+
"Similar to previous example, but generate the files in a directory called \"myapp\":\n<%= config.bin %> <%= command.id %> --name mywork --default-package-dir myapp",
|
|
853
|
+
"Similar to prevoius example, but also generate a default package.xml manifest file:\n<%= config.bin %> <%= command.id %> --name mywork --default-package-dir myapp --manifest",
|
|
854
|
+
"Generate a project with the minimum files and directories:\n<%= config.bin %> <%= command.id %> --name mywork --template empty",
|
|
855
|
+
"Generate a project in which the Lightning Web Components use TypeScript rather than the default JavaScript:\n<%= config.bin %> <%= command.id %> --name mywork --lwc-language typescript"
|
|
856
|
+
],
|
|
857
|
+
"flags": {
|
|
858
|
+
"json": {
|
|
859
|
+
"description": "Format output as json.",
|
|
860
|
+
"helpGroup": "GLOBAL",
|
|
861
|
+
"name": "json",
|
|
862
|
+
"allowNo": false,
|
|
863
|
+
"type": "boolean"
|
|
864
|
+
},
|
|
865
|
+
"flags-dir": {
|
|
866
|
+
"helpGroup": "GLOBAL",
|
|
867
|
+
"name": "flags-dir",
|
|
868
|
+
"summary": "Import flag values from a directory.",
|
|
869
|
+
"hasDynamicHelp": false,
|
|
870
|
+
"multiple": false,
|
|
871
|
+
"type": "option"
|
|
872
|
+
},
|
|
873
|
+
"name": {
|
|
874
|
+
"aliases": [
|
|
875
|
+
"projectname"
|
|
876
|
+
],
|
|
877
|
+
"char": "n",
|
|
878
|
+
"deprecateAliases": true,
|
|
879
|
+
"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.",
|
|
880
|
+
"name": "name",
|
|
881
|
+
"required": true,
|
|
882
|
+
"summary": "Name of the generated project.",
|
|
883
|
+
"hasDynamicHelp": false,
|
|
884
|
+
"multiple": false,
|
|
885
|
+
"type": "option"
|
|
886
|
+
},
|
|
887
|
+
"template": {
|
|
888
|
+
"char": "t",
|
|
889
|
+
"description": "The template determines the sample configuration files and directories that this command generates. For example, the empty template provides these files and directory to get you started.\n\n- .forceignore\n- config/project-scratch-def.json\n- sfdx-project.json\n- package.json\n- force-app (basic source directory structure)\n\nThe standard template provides a complete force-app directory structure so you know where to put your source. It also provides additional files and scripts, especially useful when using Salesforce Extensions for VS Code. For example:\n\n- .gitignore: Use Git for version control.\n- .prettierrc and .prettierignore: Use Prettier to format your Aura components.\n- .vscode/extensions.json: When launched, Visual Studio Code, prompts you to install the recommended extensions for your project.\n- .vscode/launch.json: Configures Replay Debugger.\n- .vscode/settings.json: Additional configuration settings.\n\nThe analytics template provides similar files and the force-app/main/default/waveTemplates directory.\n\nThe reactinternalapp and reactexternalapp templates provide React-based project scaffolding for internal and external UI bundle use cases.\n\nThe agent template provides project scaffolding for building Agentforce agents and includes a sample agent called Local Info Agent.",
|
|
890
|
+
"name": "template",
|
|
891
|
+
"summary": "Template to use for project creation.",
|
|
892
|
+
"default": "standard",
|
|
893
|
+
"hasDynamicHelp": false,
|
|
894
|
+
"multiple": false,
|
|
895
|
+
"options": [
|
|
896
|
+
"standard",
|
|
897
|
+
"empty",
|
|
898
|
+
"analytics",
|
|
899
|
+
"reactinternalapp",
|
|
900
|
+
"reactexternalapp",
|
|
901
|
+
"agent"
|
|
902
|
+
],
|
|
903
|
+
"type": "option"
|
|
904
|
+
},
|
|
905
|
+
"output-dir": {
|
|
906
|
+
"aliases": [
|
|
907
|
+
"outputdir"
|
|
908
|
+
],
|
|
909
|
+
"char": "d",
|
|
910
|
+
"deprecateAliases": true,
|
|
911
|
+
"description": "The location can be an absolute path or relative to the current working directory. The default is the current directory.",
|
|
912
|
+
"name": "output-dir",
|
|
913
|
+
"summary": "Directory for saving the created files.",
|
|
914
|
+
"default": ".",
|
|
915
|
+
"hasDynamicHelp": false,
|
|
916
|
+
"multiple": false,
|
|
917
|
+
"type": "option"
|
|
918
|
+
},
|
|
919
|
+
"namespace": {
|
|
920
|
+
"char": "s",
|
|
921
|
+
"name": "namespace",
|
|
922
|
+
"summary": "Namespace associated with this project and any connected scratch orgs.",
|
|
923
|
+
"default": "",
|
|
924
|
+
"hasDynamicHelp": false,
|
|
925
|
+
"multiple": false,
|
|
926
|
+
"type": "option"
|
|
927
|
+
},
|
|
928
|
+
"default-package-dir": {
|
|
929
|
+
"aliases": [
|
|
930
|
+
"defaultpackagedir"
|
|
931
|
+
],
|
|
932
|
+
"char": "p",
|
|
933
|
+
"deprecateAliases": true,
|
|
934
|
+
"description": "Metadata items such as classes and Lightning bundles are placed inside this folder.",
|
|
935
|
+
"name": "default-package-dir",
|
|
936
|
+
"summary": "Default package directory name.",
|
|
937
|
+
"default": "force-app",
|
|
938
|
+
"hasDynamicHelp": false,
|
|
939
|
+
"multiple": false,
|
|
940
|
+
"type": "option"
|
|
941
|
+
},
|
|
942
|
+
"manifest": {
|
|
943
|
+
"char": "x",
|
|
944
|
+
"description": "Generates a default manifest (package.xml) for fetching Apex, Visualforce, Lightning components, and static resources.",
|
|
945
|
+
"name": "manifest",
|
|
946
|
+
"summary": "Generate a manifest (package.xml) for change-set based development.",
|
|
947
|
+
"allowNo": false,
|
|
948
|
+
"type": "boolean"
|
|
949
|
+
},
|
|
950
|
+
"login-url": {
|
|
951
|
+
"aliases": [
|
|
952
|
+
"loginurl"
|
|
953
|
+
],
|
|
954
|
+
"char": "l",
|
|
955
|
+
"deprecateAliases": true,
|
|
956
|
+
"description": "Normally defaults to https://login.salesforce.com.",
|
|
957
|
+
"hidden": true,
|
|
958
|
+
"name": "login-url",
|
|
959
|
+
"summary": "Salesforce instance login URL.",
|
|
960
|
+
"default": "https://login.salesforce.com",
|
|
961
|
+
"hasDynamicHelp": false,
|
|
962
|
+
"multiple": false,
|
|
963
|
+
"type": "option"
|
|
964
|
+
},
|
|
965
|
+
"lwc-language": {
|
|
966
|
+
"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.",
|
|
967
|
+
"name": "lwc-language",
|
|
968
|
+
"summary": "Language of the Lightning Web Components. If not specified, \"javascript\" is used.",
|
|
969
|
+
"hasDynamicHelp": false,
|
|
970
|
+
"multiple": false,
|
|
971
|
+
"options": [
|
|
972
|
+
"javascript",
|
|
973
|
+
"typescript"
|
|
974
|
+
],
|
|
975
|
+
"type": "option"
|
|
976
|
+
},
|
|
977
|
+
"loglevel": {
|
|
978
|
+
"deprecated": {
|
|
979
|
+
"message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable."
|
|
980
|
+
},
|
|
981
|
+
"hidden": true,
|
|
982
|
+
"name": "loglevel",
|
|
983
|
+
"hasDynamicHelp": false,
|
|
984
|
+
"multiple": false,
|
|
985
|
+
"type": "option"
|
|
986
|
+
},
|
|
987
|
+
"api-version": {
|
|
988
|
+
"description": "Override the api version used for api requests made by this command",
|
|
989
|
+
"name": "api-version",
|
|
990
|
+
"summary": "Will set this version as sourceApiVersion in the sfdx-project.json file",
|
|
991
|
+
"hasDynamicHelp": false,
|
|
992
|
+
"multiple": false,
|
|
993
|
+
"type": "option"
|
|
994
|
+
}
|
|
995
|
+
},
|
|
996
|
+
"hasDynamicHelp": false,
|
|
997
|
+
"hiddenAliases": [],
|
|
998
|
+
"id": "template:generate:project",
|
|
999
|
+
"pluginAlias": "@salesforce/plugin-templates",
|
|
1000
|
+
"pluginName": "@salesforce/plugin-templates",
|
|
1001
|
+
"pluginType": "core",
|
|
1002
|
+
"strict": true,
|
|
1003
|
+
"summary": "Generate a Salesforce DX project.",
|
|
1004
|
+
"enableJsonFlag": true,
|
|
1005
|
+
"isESM": true,
|
|
1006
|
+
"relativePath": [
|
|
1007
|
+
"lib",
|
|
1008
|
+
"commands",
|
|
1009
|
+
"template",
|
|
1010
|
+
"generate",
|
|
1011
|
+
"project",
|
|
1012
|
+
"index.js"
|
|
1013
|
+
],
|
|
1014
|
+
"aliasPermutations": [
|
|
1015
|
+
"force:project:create",
|
|
1016
|
+
"project:force:create",
|
|
1017
|
+
"project:create:force",
|
|
1018
|
+
"force:create:project",
|
|
1019
|
+
"create:force:project",
|
|
1020
|
+
"create:project:force",
|
|
1021
|
+
"project:generate",
|
|
1022
|
+
"generate:project"
|
|
1023
|
+
],
|
|
1024
|
+
"permutations": [
|
|
1025
|
+
"template:generate:project",
|
|
1026
|
+
"generate:template:project",
|
|
1027
|
+
"generate:project:template",
|
|
1028
|
+
"template:project:generate",
|
|
1029
|
+
"project:template:generate",
|
|
1030
|
+
"project:generate:template"
|
|
1031
|
+
]
|
|
1032
|
+
},
|
|
842
1033
|
"template:generate:lightning:app": {
|
|
843
1034
|
"aliases": [
|
|
844
1035
|
"force:lightning:app:create",
|
|
@@ -1737,20 +1928,14 @@
|
|
|
1737
1928
|
"test:lightning:generate:template"
|
|
1738
1929
|
]
|
|
1739
1930
|
},
|
|
1740
|
-
"template:generate:
|
|
1741
|
-
"aliases": [
|
|
1742
|
-
"force:project:create",
|
|
1743
|
-
"project:generate"
|
|
1744
|
-
],
|
|
1931
|
+
"template:generate:ui-bundle": {
|
|
1932
|
+
"aliases": [],
|
|
1745
1933
|
"args": {},
|
|
1746
|
-
"
|
|
1747
|
-
"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\".",
|
|
1934
|
+
"description": "Salesforce provides native UI frameworks, such as Lighting Web Components (LWC), to build applications that run on the Salesforce Platform. But you can also use non-native JavaScript- or TypeScript-based UI frameworks, such as React, to build a UI experience for the Salesforce Platform and that you can launch from the App Launcher.\n\nThese non-native UI experiences are defined by the \"UIBundle\" metadata type in your DX project. Use this command to generate the required DX project structure and files. For example, when you run this command and specify the name MyUiBundle, then the files are generated into a \"uiBundles/MyUiBundle\" directory. Use the --output-dir flag to specify a different directory.\n\nUse the --template flag for generating the files to get started with a speciic UI framework, such as React. Check out the README.md file in the generated \"uiBundles/<bundlename>\" directory for more information about the template.",
|
|
1748
1935
|
"examples": [
|
|
1749
|
-
"Generate a
|
|
1750
|
-
"
|
|
1751
|
-
"
|
|
1752
|
-
"Generate a project with the minimum files and directories:\n<%= config.bin %> <%= command.id %> --name mywork --template empty",
|
|
1753
|
-
"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"
|
|
1936
|
+
"Generate a UI bundle called MyUiBundle in the current directory:\n<%= config.bin %> <%= command.id %> --name MyUiBundle",
|
|
1937
|
+
"Generate a React-based UI bundle:\n<%= config.bin %> <%= command.id %> --name MyReactApp --template reactbasic",
|
|
1938
|
+
"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"
|
|
1754
1939
|
],
|
|
1755
1940
|
"flags": {
|
|
1756
1941
|
"json": {
|
|
@@ -1769,115 +1954,43 @@
|
|
|
1769
1954
|
"type": "option"
|
|
1770
1955
|
},
|
|
1771
1956
|
"name": {
|
|
1772
|
-
"aliases": [
|
|
1773
|
-
"projectname"
|
|
1774
|
-
],
|
|
1775
1957
|
"char": "n",
|
|
1776
|
-
"
|
|
1777
|
-
"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.",
|
|
1958
|
+
"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.",
|
|
1778
1959
|
"name": "name",
|
|
1779
1960
|
"required": true,
|
|
1780
|
-
"summary": "
|
|
1961
|
+
"summary": "API name of the generated UI bundle.",
|
|
1781
1962
|
"hasDynamicHelp": false,
|
|
1782
1963
|
"multiple": false,
|
|
1783
1964
|
"type": "option"
|
|
1784
1965
|
},
|
|
1785
1966
|
"template": {
|
|
1786
1967
|
"char": "t",
|
|
1787
|
-
"description": "
|
|
1968
|
+
"description": "Supplied parameter values or default values are filled into a copy of the template.",
|
|
1788
1969
|
"name": "template",
|
|
1789
|
-
"summary": "Template to use for
|
|
1790
|
-
"default": "
|
|
1970
|
+
"summary": "Template to use when creating the files for a specific UI framework.",
|
|
1971
|
+
"default": "default",
|
|
1791
1972
|
"hasDynamicHelp": false,
|
|
1792
1973
|
"multiple": false,
|
|
1793
1974
|
"options": [
|
|
1794
|
-
"
|
|
1795
|
-
"
|
|
1796
|
-
"analytics",
|
|
1797
|
-
"reactinternalapp",
|
|
1798
|
-
"reactexternalapp",
|
|
1799
|
-
"agent"
|
|
1800
|
-
],
|
|
1801
|
-
"type": "option"
|
|
1802
|
-
},
|
|
1803
|
-
"output-dir": {
|
|
1804
|
-
"aliases": [
|
|
1805
|
-
"outputdir"
|
|
1806
|
-
],
|
|
1807
|
-
"char": "d",
|
|
1808
|
-
"deprecateAliases": true,
|
|
1809
|
-
"description": "The location can be an absolute path or relative to the current working directory. The default is the current directory.",
|
|
1810
|
-
"name": "output-dir",
|
|
1811
|
-
"summary": "Directory for saving the created files.",
|
|
1812
|
-
"default": ".",
|
|
1813
|
-
"hasDynamicHelp": false,
|
|
1814
|
-
"multiple": false,
|
|
1815
|
-
"type": "option"
|
|
1816
|
-
},
|
|
1817
|
-
"namespace": {
|
|
1818
|
-
"char": "s",
|
|
1819
|
-
"name": "namespace",
|
|
1820
|
-
"summary": "Namespace associated with this project and any connected scratch orgs.",
|
|
1821
|
-
"default": "",
|
|
1822
|
-
"hasDynamicHelp": false,
|
|
1823
|
-
"multiple": false,
|
|
1824
|
-
"type": "option"
|
|
1825
|
-
},
|
|
1826
|
-
"default-package-dir": {
|
|
1827
|
-
"aliases": [
|
|
1828
|
-
"defaultpackagedir"
|
|
1975
|
+
"default",
|
|
1976
|
+
"reactbasic"
|
|
1829
1977
|
],
|
|
1830
|
-
"char": "p",
|
|
1831
|
-
"deprecateAliases": true,
|
|
1832
|
-
"description": "Metadata items such as classes and Lightning bundles are placed inside this folder.",
|
|
1833
|
-
"name": "default-package-dir",
|
|
1834
|
-
"summary": "Default package directory name.",
|
|
1835
|
-
"default": "force-app",
|
|
1836
|
-
"hasDynamicHelp": false,
|
|
1837
|
-
"multiple": false,
|
|
1838
1978
|
"type": "option"
|
|
1839
1979
|
},
|
|
1840
|
-
"
|
|
1841
|
-
"char": "x",
|
|
1842
|
-
"description": "Generates a default manifest (package.xml) for fetching Apex, Visualforce, Lightning components, and static resources.",
|
|
1843
|
-
"name": "manifest",
|
|
1844
|
-
"summary": "Generate a manifest (package.xml) for change-set based development.",
|
|
1845
|
-
"allowNo": false,
|
|
1846
|
-
"type": "boolean"
|
|
1847
|
-
},
|
|
1848
|
-
"login-url": {
|
|
1849
|
-
"aliases": [
|
|
1850
|
-
"loginurl"
|
|
1851
|
-
],
|
|
1980
|
+
"label": {
|
|
1852
1981
|
"char": "l",
|
|
1853
|
-
"
|
|
1854
|
-
"
|
|
1855
|
-
"
|
|
1856
|
-
"name": "login-url",
|
|
1857
|
-
"summary": "Salesforce instance login URL.",
|
|
1858
|
-
"default": "https://login.salesforce.com",
|
|
1859
|
-
"hasDynamicHelp": false,
|
|
1860
|
-
"multiple": false,
|
|
1861
|
-
"type": "option"
|
|
1862
|
-
},
|
|
1863
|
-
"lwc-language": {
|
|
1864
|
-
"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.",
|
|
1865
|
-
"name": "lwc-language",
|
|
1866
|
-
"summary": "Language of the Lightning Web Components. If not specified, \"javascript\" is used.",
|
|
1982
|
+
"description": "If not specified, the label is derived from the name.",
|
|
1983
|
+
"name": "label",
|
|
1984
|
+
"summary": "Master label for the UI bundle.",
|
|
1867
1985
|
"hasDynamicHelp": false,
|
|
1868
1986
|
"multiple": false,
|
|
1869
|
-
"options": [
|
|
1870
|
-
"javascript",
|
|
1871
|
-
"typescript"
|
|
1872
|
-
],
|
|
1873
1987
|
"type": "option"
|
|
1874
1988
|
},
|
|
1875
|
-
"
|
|
1876
|
-
"
|
|
1877
|
-
|
|
1878
|
-
|
|
1879
|
-
"
|
|
1880
|
-
"name": "loglevel",
|
|
1989
|
+
"output-dir": {
|
|
1990
|
+
"char": "d",
|
|
1991
|
+
"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)",
|
|
1992
|
+
"name": "output-dir",
|
|
1993
|
+
"summary": "Directory into which the files are created.",
|
|
1881
1994
|
"hasDynamicHelp": false,
|
|
1882
1995
|
"multiple": false,
|
|
1883
1996
|
"type": "option"
|
|
@@ -1885,7 +1998,6 @@
|
|
|
1885
1998
|
"api-version": {
|
|
1886
1999
|
"description": "Override the api version used for api requests made by this command",
|
|
1887
2000
|
"name": "api-version",
|
|
1888
|
-
"summary": "Will set this version as sourceApiVersion in the sfdx-project.json file",
|
|
1889
2001
|
"hasDynamicHelp": false,
|
|
1890
2002
|
"multiple": false,
|
|
1891
2003
|
"type": "option"
|
|
@@ -1893,12 +2005,12 @@
|
|
|
1893
2005
|
},
|
|
1894
2006
|
"hasDynamicHelp": false,
|
|
1895
2007
|
"hiddenAliases": [],
|
|
1896
|
-
"id": "template:generate:
|
|
2008
|
+
"id": "template:generate:ui-bundle",
|
|
1897
2009
|
"pluginAlias": "@salesforce/plugin-templates",
|
|
1898
2010
|
"pluginName": "@salesforce/plugin-templates",
|
|
1899
2011
|
"pluginType": "core",
|
|
1900
2012
|
"strict": true,
|
|
1901
|
-
"summary": "Generate a Salesforce
|
|
2013
|
+
"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.",
|
|
1902
2014
|
"enableJsonFlag": true,
|
|
1903
2015
|
"isESM": true,
|
|
1904
2016
|
"relativePath": [
|
|
@@ -1906,26 +2018,17 @@
|
|
|
1906
2018
|
"commands",
|
|
1907
2019
|
"template",
|
|
1908
2020
|
"generate",
|
|
1909
|
-
"
|
|
2021
|
+
"ui-bundle",
|
|
1910
2022
|
"index.js"
|
|
1911
2023
|
],
|
|
1912
|
-
"aliasPermutations": [
|
|
1913
|
-
"force:project:create",
|
|
1914
|
-
"project:force:create",
|
|
1915
|
-
"project:create:force",
|
|
1916
|
-
"force:create:project",
|
|
1917
|
-
"create:force:project",
|
|
1918
|
-
"create:project:force",
|
|
1919
|
-
"project:generate",
|
|
1920
|
-
"generate:project"
|
|
1921
|
-
],
|
|
2024
|
+
"aliasPermutations": [],
|
|
1922
2025
|
"permutations": [
|
|
1923
|
-
"template:generate:
|
|
1924
|
-
"generate:template:
|
|
1925
|
-
"generate:
|
|
1926
|
-
"template:
|
|
1927
|
-
"
|
|
1928
|
-
"
|
|
2026
|
+
"template:generate:ui-bundle",
|
|
2027
|
+
"generate:template:ui-bundle",
|
|
2028
|
+
"generate:ui-bundle:template",
|
|
2029
|
+
"template:ui-bundle:generate",
|
|
2030
|
+
"ui-bundle:template:generate",
|
|
2031
|
+
"ui-bundle:generate:template"
|
|
1929
2032
|
]
|
|
1930
2033
|
},
|
|
1931
2034
|
"template:generate:static-resource": {
|
|
@@ -2057,109 +2160,6 @@
|
|
|
2057
2160
|
"static-resource:generate:template"
|
|
2058
2161
|
]
|
|
2059
2162
|
},
|
|
2060
|
-
"template:generate:ui-bundle": {
|
|
2061
|
-
"aliases": [],
|
|
2062
|
-
"args": {},
|
|
2063
|
-
"description": "Salesforce provides native UI frameworks, such as Lighting Web Components (LWC), to build applications that run on the Salesforce Platform. But you can also use non-native JavaScript- or TypeScript-based UI frameworks, such as React, to build a UI experience for the Salesforce Platform and that you can launch from the App Launcher.\n\nThese non-native UI experiences are defined by the \"UIBundle\" metadata type in your DX project. Use this command to generate the required DX project structure and files. For example, when you run this command and specify the name MyUiBundle, then the files are generated into a \"uiBundles/MyUiBundle\" directory. Use the --output-dir flag to specify a different directory.\n\nUse the --template flag for generating the files to get started with a speciic UI framework, such as React. Check out the README.md file in the generated \"uiBundles/<bundlename>\" directory for more information about the template.",
|
|
2064
|
-
"examples": [
|
|
2065
|
-
"Generate a UI bundle called MyUiBundle in the current directory:\n<%= config.bin %> <%= command.id %> --name MyUiBundle",
|
|
2066
|
-
"Generate a React-based UI bundle:\n<%= config.bin %> <%= command.id %> --name MyReactApp --template reactbasic",
|
|
2067
|
-
"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"
|
|
2068
|
-
],
|
|
2069
|
-
"flags": {
|
|
2070
|
-
"json": {
|
|
2071
|
-
"description": "Format output as json.",
|
|
2072
|
-
"helpGroup": "GLOBAL",
|
|
2073
|
-
"name": "json",
|
|
2074
|
-
"allowNo": false,
|
|
2075
|
-
"type": "boolean"
|
|
2076
|
-
},
|
|
2077
|
-
"flags-dir": {
|
|
2078
|
-
"helpGroup": "GLOBAL",
|
|
2079
|
-
"name": "flags-dir",
|
|
2080
|
-
"summary": "Import flag values from a directory.",
|
|
2081
|
-
"hasDynamicHelp": false,
|
|
2082
|
-
"multiple": false,
|
|
2083
|
-
"type": "option"
|
|
2084
|
-
},
|
|
2085
|
-
"name": {
|
|
2086
|
-
"char": "n",
|
|
2087
|
-
"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.",
|
|
2088
|
-
"name": "name",
|
|
2089
|
-
"required": true,
|
|
2090
|
-
"summary": "API name of the generated UI bundle.",
|
|
2091
|
-
"hasDynamicHelp": false,
|
|
2092
|
-
"multiple": false,
|
|
2093
|
-
"type": "option"
|
|
2094
|
-
},
|
|
2095
|
-
"template": {
|
|
2096
|
-
"char": "t",
|
|
2097
|
-
"description": "Supplied parameter values or default values are filled into a copy of the template.",
|
|
2098
|
-
"name": "template",
|
|
2099
|
-
"summary": "Template to use when creating the files for a specific UI framework.",
|
|
2100
|
-
"default": "default",
|
|
2101
|
-
"hasDynamicHelp": false,
|
|
2102
|
-
"multiple": false,
|
|
2103
|
-
"options": [
|
|
2104
|
-
"default",
|
|
2105
|
-
"reactbasic"
|
|
2106
|
-
],
|
|
2107
|
-
"type": "option"
|
|
2108
|
-
},
|
|
2109
|
-
"label": {
|
|
2110
|
-
"char": "l",
|
|
2111
|
-
"description": "If not specified, the label is derived from the name.",
|
|
2112
|
-
"name": "label",
|
|
2113
|
-
"summary": "Master label for the UI bundle.",
|
|
2114
|
-
"hasDynamicHelp": false,
|
|
2115
|
-
"multiple": false,
|
|
2116
|
-
"type": "option"
|
|
2117
|
-
},
|
|
2118
|
-
"output-dir": {
|
|
2119
|
-
"char": "d",
|
|
2120
|
-
"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)",
|
|
2121
|
-
"name": "output-dir",
|
|
2122
|
-
"summary": "Directory into which the files are created.",
|
|
2123
|
-
"hasDynamicHelp": false,
|
|
2124
|
-
"multiple": false,
|
|
2125
|
-
"type": "option"
|
|
2126
|
-
},
|
|
2127
|
-
"api-version": {
|
|
2128
|
-
"description": "Override the api version used for api requests made by this command",
|
|
2129
|
-
"name": "api-version",
|
|
2130
|
-
"hasDynamicHelp": false,
|
|
2131
|
-
"multiple": false,
|
|
2132
|
-
"type": "option"
|
|
2133
|
-
}
|
|
2134
|
-
},
|
|
2135
|
-
"hasDynamicHelp": false,
|
|
2136
|
-
"hiddenAliases": [],
|
|
2137
|
-
"id": "template:generate:ui-bundle",
|
|
2138
|
-
"pluginAlias": "@salesforce/plugin-templates",
|
|
2139
|
-
"pluginName": "@salesforce/plugin-templates",
|
|
2140
|
-
"pluginType": "core",
|
|
2141
|
-
"strict": true,
|
|
2142
|
-
"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.",
|
|
2143
|
-
"enableJsonFlag": true,
|
|
2144
|
-
"isESM": true,
|
|
2145
|
-
"relativePath": [
|
|
2146
|
-
"lib",
|
|
2147
|
-
"commands",
|
|
2148
|
-
"template",
|
|
2149
|
-
"generate",
|
|
2150
|
-
"ui-bundle",
|
|
2151
|
-
"index.js"
|
|
2152
|
-
],
|
|
2153
|
-
"aliasPermutations": [],
|
|
2154
|
-
"permutations": [
|
|
2155
|
-
"template:generate:ui-bundle",
|
|
2156
|
-
"generate:template:ui-bundle",
|
|
2157
|
-
"generate:ui-bundle:template",
|
|
2158
|
-
"template:ui-bundle:generate",
|
|
2159
|
-
"ui-bundle:template:generate",
|
|
2160
|
-
"ui-bundle:generate:template"
|
|
2161
|
-
]
|
|
2162
|
-
},
|
|
2163
2163
|
"template:generate:visualforce:component": {
|
|
2164
2164
|
"aliases": [
|
|
2165
2165
|
"force:visualforce:component:create",
|
|
@@ -2516,5 +2516,5 @@
|
|
|
2516
2516
|
]
|
|
2517
2517
|
}
|
|
2518
2518
|
},
|
|
2519
|
-
"version": "56.17.
|
|
2519
|
+
"version": "56.17.7"
|
|
2520
2520
|
}
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@salesforce/plugin-templates",
|
|
3
3
|
"description": "Commands to create metadata from a default or custom template",
|
|
4
|
-
"version": "56.17.
|
|
4
|
+
"version": "56.17.7",
|
|
5
5
|
"author": "Salesforce",
|
|
6
6
|
"bugs": "https://github.com/salesforcecli/plugin-templates/issues",
|
|
7
7
|
"enableO11y": true,
|
|
@@ -9,10 +9,10 @@
|
|
|
9
9
|
"dependencies": {
|
|
10
10
|
"@salesforce/core": "^8.31.0",
|
|
11
11
|
"@salesforce/sf-plugins-core": "^12",
|
|
12
|
-
"@salesforce/templates": "^66.9.
|
|
12
|
+
"@salesforce/templates": "^66.9.1"
|
|
13
13
|
},
|
|
14
14
|
"devDependencies": {
|
|
15
|
-
"@oclif/plugin-command-snapshot": "^5.3.
|
|
15
|
+
"@oclif/plugin-command-snapshot": "^5.3.22",
|
|
16
16
|
"@salesforce/cli-plugins-testkit": "^5.3.58",
|
|
17
17
|
"@salesforce/dev-scripts": "^11.0.4",
|
|
18
18
|
"@salesforce/plugin-command-reference": "^3.1.106",
|
|
@@ -249,7 +249,7 @@
|
|
|
249
249
|
"exports": "./lib/index.js",
|
|
250
250
|
"type": "module",
|
|
251
251
|
"sfdx": {
|
|
252
|
-
"publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-templates/56.17.
|
|
253
|
-
"signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-templates/56.17.
|
|
252
|
+
"publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-templates/56.17.7.crt",
|
|
253
|
+
"signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-templates/56.17.7.sig"
|
|
254
254
|
}
|
|
255
255
|
}
|