@salesforce/plugin-templates 56.12.1 → 56.13.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +94 -15
- package/lib/commands/template/generate/{webapp → ui-bundle}/index.d.ts +3 -4
- package/lib/commands/template/generate/{webapp → ui-bundle}/index.js +10 -11
- package/lib/commands/template/generate/ui-bundle/index.js.map +1 -0
- package/messages/project.md +1 -1
- package/messages/ui-bundle.generate.md +62 -0
- package/oclif.manifest.json +175 -177
- package/package.json +9 -6
- package/lib/commands/template/generate/webapp/index.js.map +0 -1
- package/messages/webApplication.md +0 -61
package/README.md
CHANGED
|
@@ -131,6 +131,7 @@ Congrats, you are debugging!
|
|
|
131
131
|
- [`sf template generate lightning test`](#sf-template-generate-lightning-test)
|
|
132
132
|
- [`sf template generate project`](#sf-template-generate-project)
|
|
133
133
|
- [`sf template generate static-resource`](#sf-template-generate-static-resource)
|
|
134
|
+
- [`sf template generate ui-bundle`](#sf-template-generate-ui-bundle)
|
|
134
135
|
- [`sf template generate visualforce component`](#sf-template-generate-visualforce-component)
|
|
135
136
|
- [`sf template generate visualforce page`](#sf-template-generate-visualforce-page)
|
|
136
137
|
|
|
@@ -176,7 +177,7 @@ FLAG DESCRIPTIONS
|
|
|
176
177
|
directory.
|
|
177
178
|
```
|
|
178
179
|
|
|
179
|
-
_See code: [src/commands/template/generate/analytics/template.ts](https://github.com/salesforcecli/plugin-templates/blob/56.
|
|
180
|
+
_See code: [src/commands/template/generate/analytics/template.ts](https://github.com/salesforcecli/plugin-templates/blob/56.13.1/src/commands/template/generate/analytics/template.ts)_
|
|
180
181
|
|
|
181
182
|
## `sf template generate apex class`
|
|
182
183
|
|
|
@@ -236,7 +237,7 @@ FLAG DESCRIPTIONS
|
|
|
236
237
|
Supplied parameter values or default values are filled into a copy of the template.
|
|
237
238
|
```
|
|
238
239
|
|
|
239
|
-
_See code: [src/commands/template/generate/apex/class.ts](https://github.com/salesforcecli/plugin-templates/blob/56.
|
|
240
|
+
_See code: [src/commands/template/generate/apex/class.ts](https://github.com/salesforcecli/plugin-templates/blob/56.13.1/src/commands/template/generate/apex/class.ts)_
|
|
240
241
|
|
|
241
242
|
## `sf template generate apex trigger`
|
|
242
243
|
|
|
@@ -306,7 +307,7 @@ FLAG DESCRIPTIONS
|
|
|
306
307
|
Supplied parameter values or default values are filled into a copy of the template.
|
|
307
308
|
```
|
|
308
309
|
|
|
309
|
-
_See code: [src/commands/template/generate/apex/trigger.ts](https://github.com/salesforcecli/plugin-templates/blob/56.
|
|
310
|
+
_See code: [src/commands/template/generate/apex/trigger.ts](https://github.com/salesforcecli/plugin-templates/blob/56.13.1/src/commands/template/generate/apex/trigger.ts)_
|
|
310
311
|
|
|
311
312
|
## `sf template generate digital-experience site`
|
|
312
313
|
|
|
@@ -360,7 +361,7 @@ FLAG DESCRIPTIONS
|
|
|
360
361
|
project, defaults to the current directory.
|
|
361
362
|
```
|
|
362
363
|
|
|
363
|
-
_See code: [src/commands/template/generate/digital-experience/site.ts](https://github.com/salesforcecli/plugin-templates/blob/56.
|
|
364
|
+
_See code: [src/commands/template/generate/digital-experience/site.ts](https://github.com/salesforcecli/plugin-templates/blob/56.13.1/src/commands/template/generate/digital-experience/site.ts)_
|
|
364
365
|
|
|
365
366
|
## `sf template generate flexipage`
|
|
366
367
|
|
|
@@ -442,7 +443,7 @@ FLAG DESCRIPTIONS
|
|
|
442
443
|
'Custom_Object__c'. This sets the `sobjectType` field in the FlexiPage metadata.
|
|
443
444
|
```
|
|
444
445
|
|
|
445
|
-
_See code: [src/commands/template/generate/flexipage/index.ts](https://github.com/salesforcecli/plugin-templates/blob/56.
|
|
446
|
+
_See code: [src/commands/template/generate/flexipage/index.ts](https://github.com/salesforcecli/plugin-templates/blob/56.13.1/src/commands/template/generate/flexipage/index.ts)_
|
|
446
447
|
|
|
447
448
|
## `sf template generate lightning app`
|
|
448
449
|
|
|
@@ -498,7 +499,7 @@ FLAG DESCRIPTIONS
|
|
|
498
499
|
Supplied parameter values or default values are filled into a copy of the template.
|
|
499
500
|
```
|
|
500
501
|
|
|
501
|
-
_See code: [src/commands/template/generate/lightning/app.ts](https://github.com/salesforcecli/plugin-templates/blob/56.
|
|
502
|
+
_See code: [src/commands/template/generate/lightning/app.ts](https://github.com/salesforcecli/plugin-templates/blob/56.13.1/src/commands/template/generate/lightning/app.ts)_
|
|
502
503
|
|
|
503
504
|
## `sf template generate lightning component`
|
|
504
505
|
|
|
@@ -568,7 +569,7 @@ FLAG DESCRIPTIONS
|
|
|
568
569
|
Supplied parameter values or default values are filled into a copy of the template.
|
|
569
570
|
```
|
|
570
571
|
|
|
571
|
-
_See code: [src/commands/template/generate/lightning/component.ts](https://github.com/salesforcecli/plugin-templates/blob/56.
|
|
572
|
+
_See code: [src/commands/template/generate/lightning/component.ts](https://github.com/salesforcecli/plugin-templates/blob/56.13.1/src/commands/template/generate/lightning/component.ts)_
|
|
572
573
|
|
|
573
574
|
## `sf template generate lightning event`
|
|
574
575
|
|
|
@@ -624,7 +625,7 @@ FLAG DESCRIPTIONS
|
|
|
624
625
|
Supplied parameter values or default values are filled into a copy of the template.
|
|
625
626
|
```
|
|
626
627
|
|
|
627
|
-
_See code: [src/commands/template/generate/lightning/event.ts](https://github.com/salesforcecli/plugin-templates/blob/56.
|
|
628
|
+
_See code: [src/commands/template/generate/lightning/event.ts](https://github.com/salesforcecli/plugin-templates/blob/56.13.1/src/commands/template/generate/lightning/event.ts)_
|
|
628
629
|
|
|
629
630
|
## `sf template generate lightning interface`
|
|
630
631
|
|
|
@@ -680,7 +681,7 @@ FLAG DESCRIPTIONS
|
|
|
680
681
|
Supplied parameter values or default values are filled into a copy of the template.
|
|
681
682
|
```
|
|
682
683
|
|
|
683
|
-
_See code: [src/commands/template/generate/lightning/interface.ts](https://github.com/salesforcecli/plugin-templates/blob/56.
|
|
684
|
+
_See code: [src/commands/template/generate/lightning/interface.ts](https://github.com/salesforcecli/plugin-templates/blob/56.13.1/src/commands/template/generate/lightning/interface.ts)_
|
|
684
685
|
|
|
685
686
|
## `sf template generate lightning test`
|
|
686
687
|
|
|
@@ -736,7 +737,7 @@ FLAG DESCRIPTIONS
|
|
|
736
737
|
Supplied parameter values or default values are filled into a copy of the template.
|
|
737
738
|
```
|
|
738
739
|
|
|
739
|
-
_See code: [src/commands/template/generate/lightning/test.ts](https://github.com/salesforcecli/plugin-templates/blob/56.
|
|
740
|
+
_See code: [src/commands/template/generate/lightning/test.ts](https://github.com/salesforcecli/plugin-templates/blob/56.13.1/src/commands/template/generate/lightning/test.ts)_
|
|
740
741
|
|
|
741
742
|
## `sf template generate project`
|
|
742
743
|
|
|
@@ -834,7 +835,7 @@ FLAG DESCRIPTIONS
|
|
|
834
835
|
The analytics template provides similar files and the force-app/main/default/waveTemplates directory.
|
|
835
836
|
|
|
836
837
|
The reactinternalapp and reactexternalapp templates provide React-based project scaffolding for internal and
|
|
837
|
-
external
|
|
838
|
+
external UI bundle use cases.
|
|
838
839
|
|
|
839
840
|
The agent template provides project scaffolding for building Agentforce agents and includes a sample agent called
|
|
840
841
|
Local Info Agent.
|
|
@@ -849,7 +850,7 @@ FLAG DESCRIPTIONS
|
|
|
849
850
|
Override the api version used for api requests made by this command
|
|
850
851
|
```
|
|
851
852
|
|
|
852
|
-
_See code: [src/commands/template/generate/project/index.ts](https://github.com/salesforcecli/plugin-templates/blob/56.
|
|
853
|
+
_See code: [src/commands/template/generate/project/index.ts](https://github.com/salesforcecli/plugin-templates/blob/56.13.1/src/commands/template/generate/project/index.ts)_
|
|
853
854
|
|
|
854
855
|
## `sf template generate static-resource`
|
|
855
856
|
|
|
@@ -912,7 +913,85 @@ FLAG DESCRIPTIONS
|
|
|
912
913
|
etc.
|
|
913
914
|
```
|
|
914
915
|
|
|
915
|
-
_See code: [src/commands/template/generate/static-resource/index.ts](https://github.com/salesforcecli/plugin-templates/blob/56.
|
|
916
|
+
_See code: [src/commands/template/generate/static-resource/index.ts](https://github.com/salesforcecli/plugin-templates/blob/56.13.1/src/commands/template/generate/static-resource/index.ts)_
|
|
917
|
+
|
|
918
|
+
## `sf template generate ui-bundle`
|
|
919
|
+
|
|
920
|
+
Generate a UI bundle.
|
|
921
|
+
|
|
922
|
+
```
|
|
923
|
+
USAGE
|
|
924
|
+
$ sf template generate ui-bundle -n <value> [--json] [--flags-dir <value>] [-t default|reactbasic] [-l <value>] [-d <value>]
|
|
925
|
+
[--api-version <value>]
|
|
926
|
+
|
|
927
|
+
FLAGS
|
|
928
|
+
-d, --output-dir=<value> Directory for saving the created files.
|
|
929
|
+
-l, --label=<value> Master label for the UI bundle.
|
|
930
|
+
-n, --name=<value> (required) Name of the generated UI bundle.
|
|
931
|
+
-t, --template=<option> [default: default] Template to use for file creation.
|
|
932
|
+
<options: default|reactbasic>
|
|
933
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
934
|
+
|
|
935
|
+
GLOBAL FLAGS
|
|
936
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
937
|
+
--json Format output as json.
|
|
938
|
+
|
|
939
|
+
DESCRIPTION
|
|
940
|
+
Generate a UI bundle.
|
|
941
|
+
|
|
942
|
+
Generates a UI bundle in the specified directory or the current working directory. The UI bundle files are created in
|
|
943
|
+
a folder with the designated name. UI bundle files must be contained in a parent directory called "uiBundles" in your
|
|
944
|
+
package directory. Either run this command from an existing directory of this name, or use the --output-dir flag to
|
|
945
|
+
create one or point to an existing one.
|
|
946
|
+
|
|
947
|
+
ALIASES
|
|
948
|
+
$ sf ui-bundle generate
|
|
949
|
+
|
|
950
|
+
EXAMPLES
|
|
951
|
+
Generate a UI bundle called MyUiBundle in the current directory:
|
|
952
|
+
|
|
953
|
+
$ sf template generate ui-bundle --name MyUiBundle
|
|
954
|
+
|
|
955
|
+
Generate a React-based UI bundle:
|
|
956
|
+
|
|
957
|
+
$ sf template generate ui-bundle --name MyReactApp --template reactbasic
|
|
958
|
+
|
|
959
|
+
Generate the UI bundle in the "force-app/main/default/uiBundles" directory:
|
|
960
|
+
|
|
961
|
+
$ sf template generate ui-bundle --name MyUiBundle --output-dir force-app/main/default/uiBundles
|
|
962
|
+
|
|
963
|
+
FLAG DESCRIPTIONS
|
|
964
|
+
-d, --output-dir=<value> Directory for saving the created files.
|
|
965
|
+
|
|
966
|
+
The location can be an absolute path or relative to the current working directory.
|
|
967
|
+
|
|
968
|
+
**Important:** The generator automatically ensures the output directory ends with "uiBundles". If your specified
|
|
969
|
+
path doesn't end with "uiBundles", it's automatically appended. The UI bundle is created at "<output-dir>/<name>".
|
|
970
|
+
|
|
971
|
+
**Examples:**
|
|
972
|
+
|
|
973
|
+
- "--output-dir force-app/main/default" → Creates a UI bundle at "force-app/main/default/uiBundles/MyUiBundle/"
|
|
974
|
+
- "--output-dir force-app/main/default/uiBundles" → Creates a UI bundle at
|
|
975
|
+
"force-app/main/default/uiBundles/MyUiBundle/" (no change)
|
|
976
|
+
|
|
977
|
+
If not specified, the command reads your sfdx-project.json and defaults to "uiBundles" directory within your default
|
|
978
|
+
package directory. When running outside a Salesforce DX project, defaults to the current directory.
|
|
979
|
+
|
|
980
|
+
-l, --label=<value> Master label for the UI bundle.
|
|
981
|
+
|
|
982
|
+
If not specified, the label is derived from the name.
|
|
983
|
+
|
|
984
|
+
-n, --name=<value> Name of the generated UI bundle.
|
|
985
|
+
|
|
986
|
+
This name can contain only underscores and alphanumeric characters, and must be unique in your org. It must begin
|
|
987
|
+
with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores.
|
|
988
|
+
|
|
989
|
+
-t, --template=default|reactbasic Template to use for file creation.
|
|
990
|
+
|
|
991
|
+
Supplied parameter values or default values are filled into a copy of the template.
|
|
992
|
+
```
|
|
993
|
+
|
|
994
|
+
_See code: [src/commands/template/generate/ui-bundle/index.ts](https://github.com/salesforcecli/plugin-templates/blob/56.13.1/src/commands/template/generate/ui-bundle/index.ts)_
|
|
916
995
|
|
|
917
996
|
## `sf template generate visualforce component`
|
|
918
997
|
|
|
@@ -969,7 +1048,7 @@ FLAG DESCRIPTIONS
|
|
|
969
1048
|
Supplied parameter values or default values are filled into a copy of the template.
|
|
970
1049
|
```
|
|
971
1050
|
|
|
972
|
-
_See code: [src/commands/template/generate/visualforce/component.ts](https://github.com/salesforcecli/plugin-templates/blob/56.
|
|
1051
|
+
_See code: [src/commands/template/generate/visualforce/component.ts](https://github.com/salesforcecli/plugin-templates/blob/56.13.1/src/commands/template/generate/visualforce/component.ts)_
|
|
973
1052
|
|
|
974
1053
|
## `sf template generate visualforce page`
|
|
975
1054
|
|
|
@@ -1020,6 +1099,6 @@ FLAG DESCRIPTIONS
|
|
|
1020
1099
|
The name can be up to 40 characters and must start with a letter.
|
|
1021
1100
|
```
|
|
1022
1101
|
|
|
1023
|
-
_See code: [src/commands/template/generate/visualforce/page.ts](https://github.com/salesforcecli/plugin-templates/blob/56.
|
|
1102
|
+
_See code: [src/commands/template/generate/visualforce/page.ts](https://github.com/salesforcecli/plugin-templates/blob/56.13.1/src/commands/template/generate/visualforce/page.ts)_
|
|
1024
1103
|
|
|
1025
1104
|
<!-- commandsstop -->
|
|
@@ -1,12 +1,11 @@
|
|
|
1
1
|
import { SfCommand } from '@salesforce/sf-plugins-core';
|
|
2
2
|
import { CreateOutput } from '@salesforce/templates';
|
|
3
|
-
export
|
|
3
|
+
export declare const UI_BUNDLES_DIR = "uiBundles";
|
|
4
|
+
export default class UiBundleGenerate extends SfCommand<CreateOutput> {
|
|
4
5
|
static readonly summary: string;
|
|
5
6
|
static readonly description: string;
|
|
6
7
|
static readonly examples: string[];
|
|
7
|
-
static readonly hidden = true;
|
|
8
8
|
static readonly aliases: string[];
|
|
9
|
-
static readonly deprecateAliases = true;
|
|
10
9
|
static readonly flags: {
|
|
11
10
|
name: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
|
|
12
11
|
template: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
|
|
@@ -16,7 +15,7 @@ export default class WebAppGenerate extends SfCommand<CreateOutput> {
|
|
|
16
15
|
};
|
|
17
16
|
/**
|
|
18
17
|
* Resolves the default output directory by reading the project's sfdx-project.json.
|
|
19
|
-
* Returns the path to
|
|
18
|
+
* Returns the path to uiBundles under the default package directory,
|
|
20
19
|
* or falls back to the current directory if not in a project context.
|
|
21
20
|
*/
|
|
22
21
|
private static getDefaultOutputDir;
|
|
@@ -10,14 +10,13 @@ import { TemplateType } from '@salesforce/templates';
|
|
|
10
10
|
import { Messages, SfProject } from '@salesforce/core';
|
|
11
11
|
import { getCustomTemplates, runGenerator } from '../../../../utils/templateCommand.js';
|
|
12
12
|
Messages.importMessagesDirectoryFromMetaUrl(import.meta.url);
|
|
13
|
-
const messages = Messages.loadMessages('@salesforce/plugin-templates', '
|
|
14
|
-
export
|
|
13
|
+
const messages = Messages.loadMessages('@salesforce/plugin-templates', 'ui-bundle.generate');
|
|
14
|
+
export const UI_BUNDLES_DIR = 'uiBundles';
|
|
15
|
+
export default class UiBundleGenerate extends SfCommand {
|
|
15
16
|
static summary = messages.getMessage('summary');
|
|
16
17
|
static description = messages.getMessage('description');
|
|
17
18
|
static examples = messages.getMessages('examples');
|
|
18
|
-
static
|
|
19
|
-
static aliases = ['webapp:generate'];
|
|
20
|
-
static deprecateAliases = true;
|
|
19
|
+
static aliases = ['ui-bundle:generate'];
|
|
21
20
|
static flags = {
|
|
22
21
|
name: Flags.string({
|
|
23
22
|
char: 'n',
|
|
@@ -46,31 +45,31 @@ export default class WebAppGenerate extends SfCommand {
|
|
|
46
45
|
};
|
|
47
46
|
/**
|
|
48
47
|
* Resolves the default output directory by reading the project's sfdx-project.json.
|
|
49
|
-
* Returns the path to
|
|
48
|
+
* Returns the path to uiBundles under the default package directory,
|
|
50
49
|
* or falls back to the current directory if not in a project context.
|
|
51
50
|
*/
|
|
52
51
|
static async getDefaultOutputDir() {
|
|
53
52
|
try {
|
|
54
53
|
const project = await SfProject.resolve();
|
|
55
54
|
const defaultPackage = project.getDefaultPackage();
|
|
56
|
-
return path.join(defaultPackage.path, 'main', 'default',
|
|
55
|
+
return path.join(defaultPackage.path, 'main', 'default', UI_BUNDLES_DIR);
|
|
57
56
|
}
|
|
58
57
|
catch {
|
|
59
58
|
return '.';
|
|
60
59
|
}
|
|
61
60
|
}
|
|
62
61
|
async run() {
|
|
63
|
-
const { flags } = await this.parse(
|
|
64
|
-
const outputDir = flags['output-dir'] ?? (await
|
|
62
|
+
const { flags } = await this.parse(UiBundleGenerate);
|
|
63
|
+
const outputDir = flags['output-dir'] ?? (await UiBundleGenerate.getDefaultOutputDir());
|
|
65
64
|
const flagsAsOptions = {
|
|
66
|
-
|
|
65
|
+
bundlename: flags.name,
|
|
67
66
|
template: flags.template,
|
|
68
67
|
masterlabel: flags.label,
|
|
69
68
|
outputdir: outputDir,
|
|
70
69
|
apiversion: flags['api-version'],
|
|
71
70
|
};
|
|
72
71
|
return runGenerator({
|
|
73
|
-
templateType: TemplateType.
|
|
72
|
+
templateType: TemplateType.UIBundle,
|
|
74
73
|
opts: flagsAsOptions,
|
|
75
74
|
ux: new Ux({ jsonEnabled: this.jsonEnabled() }),
|
|
76
75
|
templates: getCustomTemplates(this.configAggregator),
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../src/commands/template/generate/ui-bundle/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,IAAI,MAAM,WAAW,CAAC;AAC7B,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,EAAE,EAAE,MAAM,6BAA6B,CAAC;AACnE,OAAO,EAAiC,YAAY,EAAE,MAAM,uBAAuB,CAAC;AACpF,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AACvD,OAAO,EAAE,kBAAkB,EAAE,YAAY,EAAE,MAAM,sCAAsC,CAAC;AAExF,QAAQ,CAAC,kCAAkC,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAC7D,MAAM,QAAQ,GAAG,QAAQ,CAAC,YAAY,CAAC,8BAA8B,EAAE,oBAAoB,CAAC,CAAC;AAE7F,MAAM,CAAC,MAAM,cAAc,GAAG,WAAW,CAAC;AAE1C,MAAM,CAAC,OAAO,OAAO,gBAAiB,SAAQ,SAAuB;IAC5D,MAAM,CAAU,OAAO,GAAG,QAAQ,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;IACzD,MAAM,CAAU,WAAW,GAAG,QAAQ,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC;IACjE,MAAM,CAAU,QAAQ,GAAG,QAAQ,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC;IAC5D,MAAM,CAAU,OAAO,GAAG,CAAC,oBAAoB,CAAC,CAAC;IACjD,MAAM,CAAU,KAAK,GAAG;QAC7B,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC;YACjB,IAAI,EAAE,GAAG;YACT,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,oBAAoB,CAAC;YAClD,WAAW,EAAE,QAAQ,CAAC,UAAU,CAAC,wBAAwB,CAAC;YAC1D,QAAQ,EAAE,IAAI;SACf,CAAC;QACF,QAAQ,EAAE,KAAK,CAAC,MAAM,CAAC;YACrB,IAAI,EAAE,GAAG;YACT,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,wBAAwB,CAAC;YACtD,WAAW,EAAE,QAAQ,CAAC,UAAU,CAAC,4BAA4B,CAAC;YAC9D,OAAO,EAAE,SAAS;YAClB,OAAO,EAAE,CAAC,SAAS,EAAE,YAAY,CAAC;SACnC,CAAC;QACF,KAAK,EAAE,KAAK,CAAC,MAAM,CAAC;YAClB,IAAI,EAAE,GAAG;YACT,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,qBAAqB,CAAC;YACnD,WAAW,EAAE,QAAQ,CAAC,UAAU,CAAC,yBAAyB,CAAC;SAC5D,CAAC;QACF,YAAY,EAAE,KAAK,CAAC,SAAS,CAAC;YAC5B,IAAI,EAAE,GAAG;YACT,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,0BAA0B,CAAC;YACxD,WAAW,EAAE,QAAQ,CAAC,UAAU,CAAC,8BAA8B,CAAC;SACjE,CAAC;QACF,aAAa,EAAE,KAAK,CAAC,aAAa,EAAE;KACrC,CAAC;IAEF;;;;OAIG;IACK,MAAM,CAAC,KAAK,CAAC,mBAAmB;QACtC,IAAI,CAAC;YACH,MAAM,OAAO,GAAG,MAAM,SAAS,CAAC,OAAO,EAAE,CAAC;YAC1C,MAAM,cAAc,GAAG,OAAO,CAAC,iBAAiB,EAAE,CAAC;YACnD,OAAO,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,IAAI,EAAE,MAAM,EAAE,SAAS,EAAE,cAAc,CAAC,CAAC;QAC3E,CAAC;QAAC,MAAM,CAAC;YACP,OAAO,GAAG,CAAC;QACb,CAAC;IACH,CAAC;IAEM,KAAK,CAAC,GAAG;QACd,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC;QAErD,MAAM,SAAS,GAAG,KAAK,CAAC,YAAY,CAAC,IAAI,CAAC,MAAM,gBAAgB,CAAC,mBAAmB,EAAE,CAAC,CAAC;QAExF,MAAM,cAAc,GAAoB;YACtC,UAAU,EAAE,KAAK,CAAC,IAAI;YACtB,QAAQ,EAAE,KAAK,CAAC,QAAQ;YACxB,WAAW,EAAE,KAAK,CAAC,KAAK;YACxB,SAAS,EAAE,SAAS;YACpB,UAAU,EAAE,KAAK,CAAC,aAAa,CAAC;SACjC,CAAC;QAEF,OAAO,YAAY,CAAC;YAClB,YAAY,EAAE,YAAY,CAAC,QAAQ;YACnC,IAAI,EAAE,cAAc;YACpB,EAAE,EAAE,IAAI,EAAE,CAAC,EAAE,WAAW,EAAE,IAAI,CAAC,WAAW,EAAE,EAAE,CAAC;YAC/C,SAAS,EAAE,kBAAkB,CAAC,IAAI,CAAC,gBAAgB,CAAC;SACrD,CAAC,CAAC;IACL,CAAC"}
|
package/messages/project.md
CHANGED
|
@@ -58,7 +58,7 @@ The standard template provides a complete force-app directory structure so you k
|
|
|
58
58
|
|
|
59
59
|
The analytics template provides similar files and the force-app/main/default/waveTemplates directory.
|
|
60
60
|
|
|
61
|
-
The reactinternalapp and reactexternalapp templates provide React-based project scaffolding for internal and external
|
|
61
|
+
The reactinternalapp and reactexternalapp templates provide React-based project scaffolding for internal and external UI bundle use cases.
|
|
62
62
|
|
|
63
63
|
The agent template provides project scaffolding for building Agentforce agents and includes a sample agent called Local Info Agent.
|
|
64
64
|
|
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
# summary
|
|
2
|
+
|
|
3
|
+
Generate a UI bundle.
|
|
4
|
+
|
|
5
|
+
# description
|
|
6
|
+
|
|
7
|
+
Generates a UI bundle in the specified directory or the current working directory. The UI bundle files are created in a folder with the designated name. UI bundle files must be contained in a parent directory called "uiBundles" 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.
|
|
8
|
+
|
|
9
|
+
# examples
|
|
10
|
+
|
|
11
|
+
- Generate a UI bundle called MyUiBundle in the current directory:
|
|
12
|
+
|
|
13
|
+
<%= config.bin %> <%= command.id %> --name MyUiBundle
|
|
14
|
+
|
|
15
|
+
- Generate a React-based UI bundle:
|
|
16
|
+
|
|
17
|
+
<%= config.bin %> <%= command.id %> --name MyReactApp --template reactbasic
|
|
18
|
+
|
|
19
|
+
- Generate the UI bundle in the "force-app/main/default/uiBundles" directory:
|
|
20
|
+
|
|
21
|
+
<%= config.bin %> <%= command.id %> --name MyUiBundle --output-dir force-app/main/default/uiBundles
|
|
22
|
+
|
|
23
|
+
# flags.name.summary
|
|
24
|
+
|
|
25
|
+
Name of the generated UI bundle.
|
|
26
|
+
|
|
27
|
+
# flags.name.description
|
|
28
|
+
|
|
29
|
+
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.
|
|
30
|
+
|
|
31
|
+
# flags.template.summary
|
|
32
|
+
|
|
33
|
+
Template to use for file creation.
|
|
34
|
+
|
|
35
|
+
# flags.template.description
|
|
36
|
+
|
|
37
|
+
Supplied parameter values or default values are filled into a copy of the template.
|
|
38
|
+
|
|
39
|
+
# flags.label.summary
|
|
40
|
+
|
|
41
|
+
Master label for the UI bundle.
|
|
42
|
+
|
|
43
|
+
# flags.label.description
|
|
44
|
+
|
|
45
|
+
If not specified, the label is derived from the name.
|
|
46
|
+
|
|
47
|
+
# flags.output-dir.summary
|
|
48
|
+
|
|
49
|
+
Directory for saving the created files.
|
|
50
|
+
|
|
51
|
+
# flags.output-dir.description
|
|
52
|
+
|
|
53
|
+
The location can be an absolute path or relative to the current working directory.
|
|
54
|
+
|
|
55
|
+
**Important:** The generator 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>".
|
|
56
|
+
|
|
57
|
+
**Examples:**
|
|
58
|
+
|
|
59
|
+
- "--output-dir force-app/main/default" → Creates a UI bundle at "force-app/main/default/uiBundles/MyUiBundle/"
|
|
60
|
+
- "--output-dir force-app/main/default/uiBundles" → Creates a UI bundle at "force-app/main/default/uiBundles/MyUiBundle/" (no change)
|
|
61
|
+
|
|
62
|
+
If 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.
|
package/oclif.manifest.json
CHANGED
|
@@ -1,158 +1,5 @@
|
|
|
1
1
|
{
|
|
2
2
|
"commands": {
|
|
3
|
-
"template:generate:analytics:template": {
|
|
4
|
-
"aliases": [
|
|
5
|
-
"force:analytics:template:create",
|
|
6
|
-
"analytics:generate:template"
|
|
7
|
-
],
|
|
8
|
-
"args": {},
|
|
9
|
-
"deprecateAliases": true,
|
|
10
|
-
"description": "The metadata files associated with the Analytics template must be contained in a parent directory called \"waveTemplates\" in your package directory. Either run this command from an existing directory of this name, or use the --output-dir flag to generate one or point to an existing one.",
|
|
11
|
-
"examples": [
|
|
12
|
-
"Generate the metadata files for a simple Analytics template file called myTemplate in the force-app/main/default/waveTemplates directory:\n<%= config.bin %> <%= command.id %> --name myTemplate --output-dir force-app/main/default/waveTemplates"
|
|
13
|
-
],
|
|
14
|
-
"flags": {
|
|
15
|
-
"json": {
|
|
16
|
-
"description": "Format output as json.",
|
|
17
|
-
"helpGroup": "GLOBAL",
|
|
18
|
-
"name": "json",
|
|
19
|
-
"allowNo": false,
|
|
20
|
-
"type": "boolean"
|
|
21
|
-
},
|
|
22
|
-
"flags-dir": {
|
|
23
|
-
"helpGroup": "GLOBAL",
|
|
24
|
-
"name": "flags-dir",
|
|
25
|
-
"summary": "Import flag values from a directory.",
|
|
26
|
-
"hasDynamicHelp": false,
|
|
27
|
-
"multiple": false,
|
|
28
|
-
"type": "option"
|
|
29
|
-
},
|
|
30
|
-
"output-dir": {
|
|
31
|
-
"aliases": [
|
|
32
|
-
"outputdir"
|
|
33
|
-
],
|
|
34
|
-
"char": "d",
|
|
35
|
-
"deprecateAliases": true,
|
|
36
|
-
"description": "The location can be an absolute path or relative to the current working directory. The default is the current directory.",
|
|
37
|
-
"name": "output-dir",
|
|
38
|
-
"summary": "Directory for saving the created files.",
|
|
39
|
-
"default": ".",
|
|
40
|
-
"hasDynamicHelp": false,
|
|
41
|
-
"multiple": false,
|
|
42
|
-
"type": "option"
|
|
43
|
-
},
|
|
44
|
-
"api-version": {
|
|
45
|
-
"aliases": [
|
|
46
|
-
"apiversion"
|
|
47
|
-
],
|
|
48
|
-
"deprecateAliases": true,
|
|
49
|
-
"description": "Override the api version used for api requests made by this command",
|
|
50
|
-
"name": "api-version",
|
|
51
|
-
"hasDynamicHelp": false,
|
|
52
|
-
"multiple": false,
|
|
53
|
-
"type": "option"
|
|
54
|
-
},
|
|
55
|
-
"name": {
|
|
56
|
-
"aliases": [
|
|
57
|
-
"templatename"
|
|
58
|
-
],
|
|
59
|
-
"char": "n",
|
|
60
|
-
"deprecateAliases": true,
|
|
61
|
-
"name": "name",
|
|
62
|
-
"required": true,
|
|
63
|
-
"summary": "Name of the Analytics template.",
|
|
64
|
-
"hasDynamicHelp": false,
|
|
65
|
-
"multiple": false,
|
|
66
|
-
"type": "option"
|
|
67
|
-
},
|
|
68
|
-
"loglevel": {
|
|
69
|
-
"deprecated": {
|
|
70
|
-
"message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable."
|
|
71
|
-
},
|
|
72
|
-
"hidden": true,
|
|
73
|
-
"name": "loglevel",
|
|
74
|
-
"hasDynamicHelp": false,
|
|
75
|
-
"multiple": false,
|
|
76
|
-
"type": "option"
|
|
77
|
-
}
|
|
78
|
-
},
|
|
79
|
-
"hasDynamicHelp": false,
|
|
80
|
-
"hiddenAliases": [],
|
|
81
|
-
"id": "template:generate:analytics:template",
|
|
82
|
-
"pluginAlias": "@salesforce/plugin-templates",
|
|
83
|
-
"pluginName": "@salesforce/plugin-templates",
|
|
84
|
-
"pluginType": "core",
|
|
85
|
-
"strict": true,
|
|
86
|
-
"summary": "Generate a simple Analytics template.",
|
|
87
|
-
"enableJsonFlag": true,
|
|
88
|
-
"isESM": true,
|
|
89
|
-
"relativePath": [
|
|
90
|
-
"lib",
|
|
91
|
-
"commands",
|
|
92
|
-
"template",
|
|
93
|
-
"generate",
|
|
94
|
-
"analytics",
|
|
95
|
-
"template.js"
|
|
96
|
-
],
|
|
97
|
-
"aliasPermutations": [
|
|
98
|
-
"force:analytics:template:create",
|
|
99
|
-
"analytics:force:template:create",
|
|
100
|
-
"analytics:template:force:create",
|
|
101
|
-
"analytics:template:create:force",
|
|
102
|
-
"force:template:analytics:create",
|
|
103
|
-
"template:force:analytics:create",
|
|
104
|
-
"template:analytics:force:create",
|
|
105
|
-
"template:analytics:create:force",
|
|
106
|
-
"force:template:create:analytics",
|
|
107
|
-
"template:force:create:analytics",
|
|
108
|
-
"template:create:force:analytics",
|
|
109
|
-
"template:create:analytics:force",
|
|
110
|
-
"force:analytics:create:template",
|
|
111
|
-
"analytics:force:create:template",
|
|
112
|
-
"analytics:create:force:template",
|
|
113
|
-
"analytics:create:template:force",
|
|
114
|
-
"force:create:analytics:template",
|
|
115
|
-
"create:force:analytics:template",
|
|
116
|
-
"create:analytics:force:template",
|
|
117
|
-
"create:analytics:template:force",
|
|
118
|
-
"force:create:template:analytics",
|
|
119
|
-
"create:force:template:analytics",
|
|
120
|
-
"create:template:force:analytics",
|
|
121
|
-
"create:template:analytics:force",
|
|
122
|
-
"analytics:generate:template",
|
|
123
|
-
"generate:analytics:template",
|
|
124
|
-
"generate:template:analytics",
|
|
125
|
-
"analytics:template:generate",
|
|
126
|
-
"template:analytics:generate",
|
|
127
|
-
"template:generate:analytics"
|
|
128
|
-
],
|
|
129
|
-
"permutations": [
|
|
130
|
-
"template:generate:analytics:template",
|
|
131
|
-
"generate:template:analytics:template",
|
|
132
|
-
"generate:analytics:template:template",
|
|
133
|
-
"generate:analytics:template:template",
|
|
134
|
-
"template:analytics:generate:template",
|
|
135
|
-
"analytics:template:generate:template",
|
|
136
|
-
"analytics:generate:template:template",
|
|
137
|
-
"analytics:generate:template:template",
|
|
138
|
-
"template:analytics:template:generate",
|
|
139
|
-
"analytics:template:template:generate",
|
|
140
|
-
"analytics:template:template:generate",
|
|
141
|
-
"analytics:template:generate:template",
|
|
142
|
-
"template:generate:template:analytics",
|
|
143
|
-
"generate:template:template:analytics",
|
|
144
|
-
"generate:template:template:analytics",
|
|
145
|
-
"generate:template:analytics:template",
|
|
146
|
-
"template:template:generate:analytics",
|
|
147
|
-
"template:template:generate:analytics",
|
|
148
|
-
"template:generate:template:analytics",
|
|
149
|
-
"template:generate:analytics:template",
|
|
150
|
-
"template:template:analytics:generate",
|
|
151
|
-
"template:template:analytics:generate",
|
|
152
|
-
"template:analytics:template:generate",
|
|
153
|
-
"template:analytics:generate:template"
|
|
154
|
-
]
|
|
155
|
-
},
|
|
156
3
|
"template:generate:apex:class": {
|
|
157
4
|
"aliases": [
|
|
158
5
|
"force:apex:class:create",
|
|
@@ -839,6 +686,159 @@
|
|
|
839
686
|
"flexipage:generate:template"
|
|
840
687
|
]
|
|
841
688
|
},
|
|
689
|
+
"template:generate:analytics:template": {
|
|
690
|
+
"aliases": [
|
|
691
|
+
"force:analytics:template:create",
|
|
692
|
+
"analytics:generate:template"
|
|
693
|
+
],
|
|
694
|
+
"args": {},
|
|
695
|
+
"deprecateAliases": true,
|
|
696
|
+
"description": "The metadata files associated with the Analytics template must be contained in a parent directory called \"waveTemplates\" in your package directory. Either run this command from an existing directory of this name, or use the --output-dir flag to generate one or point to an existing one.",
|
|
697
|
+
"examples": [
|
|
698
|
+
"Generate the metadata files for a simple Analytics template file called myTemplate in the force-app/main/default/waveTemplates directory:\n<%= config.bin %> <%= command.id %> --name myTemplate --output-dir force-app/main/default/waveTemplates"
|
|
699
|
+
],
|
|
700
|
+
"flags": {
|
|
701
|
+
"json": {
|
|
702
|
+
"description": "Format output as json.",
|
|
703
|
+
"helpGroup": "GLOBAL",
|
|
704
|
+
"name": "json",
|
|
705
|
+
"allowNo": false,
|
|
706
|
+
"type": "boolean"
|
|
707
|
+
},
|
|
708
|
+
"flags-dir": {
|
|
709
|
+
"helpGroup": "GLOBAL",
|
|
710
|
+
"name": "flags-dir",
|
|
711
|
+
"summary": "Import flag values from a directory.",
|
|
712
|
+
"hasDynamicHelp": false,
|
|
713
|
+
"multiple": false,
|
|
714
|
+
"type": "option"
|
|
715
|
+
},
|
|
716
|
+
"output-dir": {
|
|
717
|
+
"aliases": [
|
|
718
|
+
"outputdir"
|
|
719
|
+
],
|
|
720
|
+
"char": "d",
|
|
721
|
+
"deprecateAliases": true,
|
|
722
|
+
"description": "The location can be an absolute path or relative to the current working directory. The default is the current directory.",
|
|
723
|
+
"name": "output-dir",
|
|
724
|
+
"summary": "Directory for saving the created files.",
|
|
725
|
+
"default": ".",
|
|
726
|
+
"hasDynamicHelp": false,
|
|
727
|
+
"multiple": false,
|
|
728
|
+
"type": "option"
|
|
729
|
+
},
|
|
730
|
+
"api-version": {
|
|
731
|
+
"aliases": [
|
|
732
|
+
"apiversion"
|
|
733
|
+
],
|
|
734
|
+
"deprecateAliases": true,
|
|
735
|
+
"description": "Override the api version used for api requests made by this command",
|
|
736
|
+
"name": "api-version",
|
|
737
|
+
"hasDynamicHelp": false,
|
|
738
|
+
"multiple": false,
|
|
739
|
+
"type": "option"
|
|
740
|
+
},
|
|
741
|
+
"name": {
|
|
742
|
+
"aliases": [
|
|
743
|
+
"templatename"
|
|
744
|
+
],
|
|
745
|
+
"char": "n",
|
|
746
|
+
"deprecateAliases": true,
|
|
747
|
+
"name": "name",
|
|
748
|
+
"required": true,
|
|
749
|
+
"summary": "Name of the Analytics template.",
|
|
750
|
+
"hasDynamicHelp": false,
|
|
751
|
+
"multiple": false,
|
|
752
|
+
"type": "option"
|
|
753
|
+
},
|
|
754
|
+
"loglevel": {
|
|
755
|
+
"deprecated": {
|
|
756
|
+
"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."
|
|
757
|
+
},
|
|
758
|
+
"hidden": true,
|
|
759
|
+
"name": "loglevel",
|
|
760
|
+
"hasDynamicHelp": false,
|
|
761
|
+
"multiple": false,
|
|
762
|
+
"type": "option"
|
|
763
|
+
}
|
|
764
|
+
},
|
|
765
|
+
"hasDynamicHelp": false,
|
|
766
|
+
"hiddenAliases": [],
|
|
767
|
+
"id": "template:generate:analytics:template",
|
|
768
|
+
"pluginAlias": "@salesforce/plugin-templates",
|
|
769
|
+
"pluginName": "@salesforce/plugin-templates",
|
|
770
|
+
"pluginType": "core",
|
|
771
|
+
"strict": true,
|
|
772
|
+
"summary": "Generate a simple Analytics template.",
|
|
773
|
+
"enableJsonFlag": true,
|
|
774
|
+
"isESM": true,
|
|
775
|
+
"relativePath": [
|
|
776
|
+
"lib",
|
|
777
|
+
"commands",
|
|
778
|
+
"template",
|
|
779
|
+
"generate",
|
|
780
|
+
"analytics",
|
|
781
|
+
"template.js"
|
|
782
|
+
],
|
|
783
|
+
"aliasPermutations": [
|
|
784
|
+
"force:analytics:template:create",
|
|
785
|
+
"analytics:force:template:create",
|
|
786
|
+
"analytics:template:force:create",
|
|
787
|
+
"analytics:template:create:force",
|
|
788
|
+
"force:template:analytics:create",
|
|
789
|
+
"template:force:analytics:create",
|
|
790
|
+
"template:analytics:force:create",
|
|
791
|
+
"template:analytics:create:force",
|
|
792
|
+
"force:template:create:analytics",
|
|
793
|
+
"template:force:create:analytics",
|
|
794
|
+
"template:create:force:analytics",
|
|
795
|
+
"template:create:analytics:force",
|
|
796
|
+
"force:analytics:create:template",
|
|
797
|
+
"analytics:force:create:template",
|
|
798
|
+
"analytics:create:force:template",
|
|
799
|
+
"analytics:create:template:force",
|
|
800
|
+
"force:create:analytics:template",
|
|
801
|
+
"create:force:analytics:template",
|
|
802
|
+
"create:analytics:force:template",
|
|
803
|
+
"create:analytics:template:force",
|
|
804
|
+
"force:create:template:analytics",
|
|
805
|
+
"create:force:template:analytics",
|
|
806
|
+
"create:template:force:analytics",
|
|
807
|
+
"create:template:analytics:force",
|
|
808
|
+
"analytics:generate:template",
|
|
809
|
+
"generate:analytics:template",
|
|
810
|
+
"generate:template:analytics",
|
|
811
|
+
"analytics:template:generate",
|
|
812
|
+
"template:analytics:generate",
|
|
813
|
+
"template:generate:analytics"
|
|
814
|
+
],
|
|
815
|
+
"permutations": [
|
|
816
|
+
"template:generate:analytics:template",
|
|
817
|
+
"generate:template:analytics:template",
|
|
818
|
+
"generate:analytics:template:template",
|
|
819
|
+
"generate:analytics:template:template",
|
|
820
|
+
"template:analytics:generate:template",
|
|
821
|
+
"analytics:template:generate:template",
|
|
822
|
+
"analytics:generate:template:template",
|
|
823
|
+
"analytics:generate:template:template",
|
|
824
|
+
"template:analytics:template:generate",
|
|
825
|
+
"analytics:template:template:generate",
|
|
826
|
+
"analytics:template:template:generate",
|
|
827
|
+
"analytics:template:generate:template",
|
|
828
|
+
"template:generate:template:analytics",
|
|
829
|
+
"generate:template:template:analytics",
|
|
830
|
+
"generate:template:template:analytics",
|
|
831
|
+
"generate:template:analytics:template",
|
|
832
|
+
"template:template:generate:analytics",
|
|
833
|
+
"template:template:generate:analytics",
|
|
834
|
+
"template:generate:template:analytics",
|
|
835
|
+
"template:generate:analytics:template",
|
|
836
|
+
"template:template:analytics:generate",
|
|
837
|
+
"template:template:analytics:generate",
|
|
838
|
+
"template:analytics:template:generate",
|
|
839
|
+
"template:analytics:generate:template"
|
|
840
|
+
]
|
|
841
|
+
},
|
|
842
842
|
"template:generate:lightning:app": {
|
|
843
843
|
"aliases": [
|
|
844
844
|
"force:lightning:app:create",
|
|
@@ -1781,7 +1781,7 @@
|
|
|
1781
1781
|
},
|
|
1782
1782
|
"template": {
|
|
1783
1783
|
"char": "t",
|
|
1784
|
-
"description": "The template determines the sample configuration files and directories that this command generates. For example, the empty template provides these files and directory to get you started.\n\n- .forceignore\n- config/project-scratch-def.json\n- sfdx-project.json\n- package.json\n- force-app (basic source directory structure)\n\nThe standard template provides a complete force-app directory structure so you know where to put your source. It also provides additional files and scripts, especially useful when using Salesforce Extensions for VS Code. For example:\n\n- .gitignore: Use Git for version control.\n- .prettierrc and .prettierignore: Use Prettier to format your Aura components.\n- .vscode/extensions.json: When launched, Visual Studio Code, prompts you to install the recommended extensions for your project.\n- .vscode/launch.json: Configures Replay Debugger.\n- .vscode/settings.json: Additional configuration settings.\n\nThe analytics template provides similar files and the force-app/main/default/waveTemplates directory.\n\nThe reactinternalapp and reactexternalapp templates provide React-based project scaffolding for internal and external
|
|
1784
|
+
"description": "The template determines the sample configuration files and directories that this command generates. For example, the empty template provides these files and directory to get you started.\n\n- .forceignore\n- config/project-scratch-def.json\n- sfdx-project.json\n- package.json\n- force-app (basic source directory structure)\n\nThe standard template provides a complete force-app directory structure so you know where to put your source. It also provides additional files and scripts, especially useful when using Salesforce Extensions for VS Code. For example:\n\n- .gitignore: Use Git for version control.\n- .prettierrc and .prettierignore: Use Prettier to format your Aura components.\n- .vscode/extensions.json: When launched, Visual Studio Code, prompts you to install the recommended extensions for your project.\n- .vscode/launch.json: Configures Replay Debugger.\n- .vscode/settings.json: Additional configuration settings.\n\nThe analytics template provides similar files and the force-app/main/default/waveTemplates directory.\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.",
|
|
1785
1785
|
"name": "template",
|
|
1786
1786
|
"summary": "Template to use for project creation.",
|
|
1787
1787
|
"default": "standard",
|
|
@@ -2042,17 +2042,16 @@
|
|
|
2042
2042
|
"static-resource:generate:template"
|
|
2043
2043
|
]
|
|
2044
2044
|
},
|
|
2045
|
-
"template:generate:
|
|
2045
|
+
"template:generate:ui-bundle": {
|
|
2046
2046
|
"aliases": [
|
|
2047
|
-
"
|
|
2047
|
+
"ui-bundle:generate"
|
|
2048
2048
|
],
|
|
2049
2049
|
"args": {},
|
|
2050
|
-
"
|
|
2051
|
-
"description": "Generates a web application in the specified directory or the current working directory. The web application files are created in a folder with the designated name. Web application files must be contained in a parent directory called \"webapplications\" in your package directory. Either run this command from an existing directory of this name, or use the --output-dir flag to create one or point to an existing one.",
|
|
2050
|
+
"description": "Generates a UI bundle in the specified directory or the current working directory. The UI bundle files are created in a folder with the designated name. UI bundle files must be contained in a parent directory called \"uiBundles\" 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.",
|
|
2052
2051
|
"examples": [
|
|
2053
|
-
"Generate a
|
|
2054
|
-
"Generate a React-based
|
|
2055
|
-
"Generate the
|
|
2052
|
+
"Generate a UI bundle called MyUiBundle in the current directory:\n<%= config.bin %> <%= command.id %> --name MyUiBundle",
|
|
2053
|
+
"Generate a React-based UI bundle:\n<%= config.bin %> <%= command.id %> --name MyReactApp --template reactbasic",
|
|
2054
|
+
"Generate the UI bundle in the \"force-app/main/default/uiBundles\" directory:\n<%= config.bin %> <%= command.id %> --name MyUiBundle --output-dir force-app/main/default/uiBundles"
|
|
2056
2055
|
],
|
|
2057
2056
|
"flags": {
|
|
2058
2057
|
"json": {
|
|
@@ -2075,7 +2074,7 @@
|
|
|
2075
2074
|
"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.",
|
|
2076
2075
|
"name": "name",
|
|
2077
2076
|
"required": true,
|
|
2078
|
-
"summary": "Name of the generated
|
|
2077
|
+
"summary": "Name of the generated UI bundle.",
|
|
2079
2078
|
"hasDynamicHelp": false,
|
|
2080
2079
|
"multiple": false,
|
|
2081
2080
|
"type": "option"
|
|
@@ -2098,14 +2097,14 @@
|
|
|
2098
2097
|
"char": "l",
|
|
2099
2098
|
"description": "If not specified, the label is derived from the name.",
|
|
2100
2099
|
"name": "label",
|
|
2101
|
-
"summary": "Master label for the
|
|
2100
|
+
"summary": "Master label for the UI bundle.",
|
|
2102
2101
|
"hasDynamicHelp": false,
|
|
2103
2102
|
"multiple": false,
|
|
2104
2103
|
"type": "option"
|
|
2105
2104
|
},
|
|
2106
2105
|
"output-dir": {
|
|
2107
2106
|
"char": "d",
|
|
2108
|
-
"description": "The location can be an absolute path or relative to the current working directory
|
|
2107
|
+
"description": "The location can be an absolute path or relative to the current working directory.\n\n**Important:** The generator automatically ensures the output directory ends with \"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)\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.",
|
|
2109
2108
|
"name": "output-dir",
|
|
2110
2109
|
"summary": "Directory for saving the created files.",
|
|
2111
2110
|
"hasDynamicHelp": false,
|
|
@@ -2121,14 +2120,13 @@
|
|
|
2121
2120
|
}
|
|
2122
2121
|
},
|
|
2123
2122
|
"hasDynamicHelp": false,
|
|
2124
|
-
"hidden": true,
|
|
2125
2123
|
"hiddenAliases": [],
|
|
2126
|
-
"id": "template:generate:
|
|
2124
|
+
"id": "template:generate:ui-bundle",
|
|
2127
2125
|
"pluginAlias": "@salesforce/plugin-templates",
|
|
2128
2126
|
"pluginName": "@salesforce/plugin-templates",
|
|
2129
2127
|
"pluginType": "core",
|
|
2130
2128
|
"strict": true,
|
|
2131
|
-
"summary": "Generate a
|
|
2129
|
+
"summary": "Generate a UI bundle.",
|
|
2132
2130
|
"enableJsonFlag": true,
|
|
2133
2131
|
"isESM": true,
|
|
2134
2132
|
"relativePath": [
|
|
@@ -2136,20 +2134,20 @@
|
|
|
2136
2134
|
"commands",
|
|
2137
2135
|
"template",
|
|
2138
2136
|
"generate",
|
|
2139
|
-
"
|
|
2137
|
+
"ui-bundle",
|
|
2140
2138
|
"index.js"
|
|
2141
2139
|
],
|
|
2142
2140
|
"aliasPermutations": [
|
|
2143
|
-
"
|
|
2144
|
-
"generate:
|
|
2141
|
+
"ui-bundle:generate",
|
|
2142
|
+
"generate:ui-bundle"
|
|
2145
2143
|
],
|
|
2146
2144
|
"permutations": [
|
|
2147
|
-
"template:generate:
|
|
2148
|
-
"generate:template:
|
|
2149
|
-
"generate:
|
|
2150
|
-
"template:
|
|
2151
|
-
"
|
|
2152
|
-
"
|
|
2145
|
+
"template:generate:ui-bundle",
|
|
2146
|
+
"generate:template:ui-bundle",
|
|
2147
|
+
"generate:ui-bundle:template",
|
|
2148
|
+
"template:ui-bundle:generate",
|
|
2149
|
+
"ui-bundle:template:generate",
|
|
2150
|
+
"ui-bundle:generate:template"
|
|
2153
2151
|
]
|
|
2154
2152
|
},
|
|
2155
2153
|
"template:generate:visualforce:component": {
|
|
@@ -2508,5 +2506,5 @@
|
|
|
2508
2506
|
]
|
|
2509
2507
|
}
|
|
2510
2508
|
},
|
|
2511
|
-
"version": "56.
|
|
2509
|
+
"version": "56.13.1"
|
|
2512
2510
|
}
|
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.
|
|
4
|
+
"version": "56.13.1",
|
|
5
5
|
"author": "Salesforce",
|
|
6
6
|
"bugs": "https://github.com/salesforcecli/plugin-templates/issues",
|
|
7
7
|
"enableO11y": true,
|
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
"dependencies": {
|
|
10
10
|
"@salesforce/core": "^8.27.1",
|
|
11
11
|
"@salesforce/sf-plugins-core": "^12",
|
|
12
|
-
"@salesforce/templates": "^66.
|
|
12
|
+
"@salesforce/templates": "^66.7.2"
|
|
13
13
|
},
|
|
14
14
|
"devDependencies": {
|
|
15
15
|
"@oclif/plugin-command-snapshot": "^5.3.13",
|
|
@@ -84,12 +84,15 @@
|
|
|
84
84
|
"visualforce": {
|
|
85
85
|
"description": "Create a visualforce page or component."
|
|
86
86
|
},
|
|
87
|
-
"
|
|
88
|
-
"description": "
|
|
87
|
+
"ui-bundle": {
|
|
88
|
+
"description": "Generate a UI bundle."
|
|
89
89
|
}
|
|
90
90
|
}
|
|
91
91
|
}
|
|
92
92
|
}
|
|
93
|
+
},
|
|
94
|
+
"ui-bundle": {
|
|
95
|
+
"description": "Work with UI bundles."
|
|
93
96
|
}
|
|
94
97
|
},
|
|
95
98
|
"flexibleTaxonomy": true,
|
|
@@ -249,7 +252,7 @@
|
|
|
249
252
|
"exports": "./lib/index.js",
|
|
250
253
|
"type": "module",
|
|
251
254
|
"sfdx": {
|
|
252
|
-
"publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-templates/56.
|
|
253
|
-
"signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-templates/56.
|
|
255
|
+
"publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-templates/56.13.1.crt",
|
|
256
|
+
"signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-templates/56.13.1.sig"
|
|
254
257
|
}
|
|
255
258
|
}
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../src/commands/template/generate/webapp/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,IAAI,MAAM,WAAW,CAAC;AAC7B,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,EAAE,EAAE,MAAM,6BAA6B,CAAC;AACnE,OAAO,EAAuC,YAAY,EAAE,MAAM,uBAAuB,CAAC;AAC1F,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AACvD,OAAO,EAAE,kBAAkB,EAAE,YAAY,EAAE,MAAM,sCAAsC,CAAC;AAExF,QAAQ,CAAC,kCAAkC,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAC7D,MAAM,QAAQ,GAAG,QAAQ,CAAC,YAAY,CAAC,8BAA8B,EAAE,gBAAgB,CAAC,CAAC;AAEzF,MAAM,CAAC,OAAO,OAAO,cAAe,SAAQ,SAAuB;IAC1D,MAAM,CAAU,OAAO,GAAG,QAAQ,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;IACzD,MAAM,CAAU,WAAW,GAAG,QAAQ,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC;IACjE,MAAM,CAAU,QAAQ,GAAG,QAAQ,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC;IAC5D,MAAM,CAAU,MAAM,GAAG,IAAI,CAAC,CAAC,yCAAyC;IACxE,MAAM,CAAU,OAAO,GAAG,CAAC,iBAAiB,CAAC,CAAC;IAC9C,MAAM,CAAU,gBAAgB,GAAG,IAAI,CAAC;IACxC,MAAM,CAAU,KAAK,GAAG;QAC7B,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC;YACjB,IAAI,EAAE,GAAG;YACT,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,oBAAoB,CAAC;YAClD,WAAW,EAAE,QAAQ,CAAC,UAAU,CAAC,wBAAwB,CAAC;YAC1D,QAAQ,EAAE,IAAI;SACf,CAAC;QACF,QAAQ,EAAE,KAAK,CAAC,MAAM,CAAC;YACrB,IAAI,EAAE,GAAG;YACT,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,wBAAwB,CAAC;YACtD,WAAW,EAAE,QAAQ,CAAC,UAAU,CAAC,4BAA4B,CAAC;YAC9D,OAAO,EAAE,SAAS;YAClB,OAAO,EAAE,CAAC,SAAS,EAAE,YAAY,CAAC;SACnC,CAAC;QACF,KAAK,EAAE,KAAK,CAAC,MAAM,CAAC;YAClB,IAAI,EAAE,GAAG;YACT,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,qBAAqB,CAAC;YACnD,WAAW,EAAE,QAAQ,CAAC,UAAU,CAAC,yBAAyB,CAAC;SAC5D,CAAC;QACF,YAAY,EAAE,KAAK,CAAC,SAAS,CAAC;YAC5B,IAAI,EAAE,GAAG;YACT,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,0BAA0B,CAAC;YACxD,WAAW,EAAE,QAAQ,CAAC,UAAU,CAAC,8BAA8B,CAAC;SACjE,CAAC;QACF,aAAa,EAAE,KAAK,CAAC,aAAa,EAAE;KACrC,CAAC;IAEF;;;;OAIG;IACK,MAAM,CAAC,KAAK,CAAC,mBAAmB;QACtC,IAAI,CAAC;YACH,MAAM,OAAO,GAAG,MAAM,SAAS,CAAC,OAAO,EAAE,CAAC;YAC1C,MAAM,cAAc,GAAG,OAAO,CAAC,iBAAiB,EAAE,CAAC;YACnD,OAAO,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,IAAI,EAAE,MAAM,EAAE,SAAS,EAAE,iBAAiB,CAAC,CAAC;QAC9E,CAAC;QAAC,MAAM,CAAC;YACP,OAAO,GAAG,CAAC;QACb,CAAC;IACH,CAAC;IAEM,KAAK,CAAC,GAAG;QACd,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC;QAEnD,MAAM,SAAS,GAAG,KAAK,CAAC,YAAY,CAAC,IAAI,CAAC,MAAM,cAAc,CAAC,mBAAmB,EAAE,CAAC,CAAC;QAEtF,MAAM,cAAc,GAA0B;YAC5C,UAAU,EAAE,KAAK,CAAC,IAAI;YACtB,QAAQ,EAAE,KAAK,CAAC,QAAQ;YACxB,WAAW,EAAE,KAAK,CAAC,KAAK;YACxB,SAAS,EAAE,SAAS;YACpB,UAAU,EAAE,KAAK,CAAC,aAAa,CAAC;SACjC,CAAC;QAEF,OAAO,YAAY,CAAC;YAClB,YAAY,EAAE,YAAY,CAAC,cAAc;YACzC,IAAI,EAAE,cAAc;YACpB,EAAE,EAAE,IAAI,EAAE,CAAC,EAAE,WAAW,EAAE,IAAI,CAAC,WAAW,EAAE,EAAE,CAAC;YAC/C,SAAS,EAAE,kBAAkB,CAAC,IAAI,CAAC,gBAAgB,CAAC;SACrD,CAAC,CAAC;IACL,CAAC"}
|
|
@@ -1,61 +0,0 @@
|
|
|
1
|
-
# summary
|
|
2
|
-
|
|
3
|
-
Generate a web application.
|
|
4
|
-
|
|
5
|
-
# description
|
|
6
|
-
|
|
7
|
-
Generates a web application in the specified directory or the current working directory. The web application files are created in a folder with the designated name. Web application files must be contained in a parent directory called "webapplications" in your package directory. Either run this command from an existing directory of this name, or use the --output-dir flag to create one or point to an existing one.
|
|
8
|
-
|
|
9
|
-
# examples
|
|
10
|
-
|
|
11
|
-
- Generate a web application called MyWebApp in the current directory:
|
|
12
|
-
|
|
13
|
-
<%= config.bin %> <%= command.id %> --name MyWebApp
|
|
14
|
-
|
|
15
|
-
- Generate a React-based web application:
|
|
16
|
-
|
|
17
|
-
<%= config.bin %> <%= command.id %> --name MyReactApp --template reactbasic
|
|
18
|
-
|
|
19
|
-
- Generate the web application in the "force-app/main/default/webapplications" directory:
|
|
20
|
-
|
|
21
|
-
<%= config.bin %> <%= command.id %> --name MyWebApp --output-dir force-app/main/default/webapplications
|
|
22
|
-
|
|
23
|
-
# flags.name.summary
|
|
24
|
-
|
|
25
|
-
Name of the generated web application.
|
|
26
|
-
|
|
27
|
-
# flags.name.description
|
|
28
|
-
|
|
29
|
-
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.
|
|
30
|
-
|
|
31
|
-
# flags.template.summary
|
|
32
|
-
|
|
33
|
-
Template to use for file creation.
|
|
34
|
-
|
|
35
|
-
# flags.template.description
|
|
36
|
-
|
|
37
|
-
Supplied parameter values or default values are filled into a copy of the template.
|
|
38
|
-
|
|
39
|
-
# flags.label.summary
|
|
40
|
-
|
|
41
|
-
Master label for the web application.
|
|
42
|
-
|
|
43
|
-
# flags.label.description
|
|
44
|
-
|
|
45
|
-
If not specified, the label is derived from the name.
|
|
46
|
-
|
|
47
|
-
# flags.output-dir.summary
|
|
48
|
-
|
|
49
|
-
Directory for saving the created files.
|
|
50
|
-
|
|
51
|
-
# flags.output-dir.description
|
|
52
|
-
|
|
53
|
-
The location can be an absolute path or relative to the current working directory.
|
|
54
|
-
|
|
55
|
-
**Important:** The generator automatically ensures the output directory ends with "webapplications". If your specified path doesn't end with "webapplications", it's automatically appended. The web application is created at "<output-dir>/<webappname>".
|
|
56
|
-
|
|
57
|
-
**Examples:**
|
|
58
|
-
- "--output-dir force-app/main/default" → Creates a web application at "force-app/main/default/webapplications/MyWebApp/"
|
|
59
|
-
- "--output-dir force-app/main/default/webapplications" → Creates a web application at "force-app/main/default/webapplications/MyWebApp/" (no change)
|
|
60
|
-
|
|
61
|
-
If not specified, the command reads your sfdx-project.json and defaults to "webapplications" directory within your default package directory. When running outside a Salesforce DX project, defaults to the current directory.
|