@salesforce/plugin-templates 56.12.0 → 56.13.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +15 -15
- package/lib/commands/template/generate/{webapp → ui-bundle}/index.d.ts +3 -3
- package/lib/commands/template/generate/{webapp → ui-bundle}/index.js +10 -10
- 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 +22 -23
- 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
|
@@ -176,7 +176,7 @@ FLAG DESCRIPTIONS
|
|
|
176
176
|
directory.
|
|
177
177
|
```
|
|
178
178
|
|
|
179
|
-
_See code: [src/commands/template/generate/analytics/template.ts](https://github.com/salesforcecli/plugin-templates/blob/56.
|
|
179
|
+
_See code: [src/commands/template/generate/analytics/template.ts](https://github.com/salesforcecli/plugin-templates/blob/56.13.0/src/commands/template/generate/analytics/template.ts)_
|
|
180
180
|
|
|
181
181
|
## `sf template generate apex class`
|
|
182
182
|
|
|
@@ -236,7 +236,7 @@ FLAG DESCRIPTIONS
|
|
|
236
236
|
Supplied parameter values or default values are filled into a copy of the template.
|
|
237
237
|
```
|
|
238
238
|
|
|
239
|
-
_See code: [src/commands/template/generate/apex/class.ts](https://github.com/salesforcecli/plugin-templates/blob/56.
|
|
239
|
+
_See code: [src/commands/template/generate/apex/class.ts](https://github.com/salesforcecli/plugin-templates/blob/56.13.0/src/commands/template/generate/apex/class.ts)_
|
|
240
240
|
|
|
241
241
|
## `sf template generate apex trigger`
|
|
242
242
|
|
|
@@ -306,7 +306,7 @@ FLAG DESCRIPTIONS
|
|
|
306
306
|
Supplied parameter values or default values are filled into a copy of the template.
|
|
307
307
|
```
|
|
308
308
|
|
|
309
|
-
_See code: [src/commands/template/generate/apex/trigger.ts](https://github.com/salesforcecli/plugin-templates/blob/56.
|
|
309
|
+
_See code: [src/commands/template/generate/apex/trigger.ts](https://github.com/salesforcecli/plugin-templates/blob/56.13.0/src/commands/template/generate/apex/trigger.ts)_
|
|
310
310
|
|
|
311
311
|
## `sf template generate digital-experience site`
|
|
312
312
|
|
|
@@ -360,7 +360,7 @@ FLAG DESCRIPTIONS
|
|
|
360
360
|
project, defaults to the current directory.
|
|
361
361
|
```
|
|
362
362
|
|
|
363
|
-
_See code: [src/commands/template/generate/digital-experience/site.ts](https://github.com/salesforcecli/plugin-templates/blob/56.
|
|
363
|
+
_See code: [src/commands/template/generate/digital-experience/site.ts](https://github.com/salesforcecli/plugin-templates/blob/56.13.0/src/commands/template/generate/digital-experience/site.ts)_
|
|
364
364
|
|
|
365
365
|
## `sf template generate flexipage`
|
|
366
366
|
|
|
@@ -442,7 +442,7 @@ FLAG DESCRIPTIONS
|
|
|
442
442
|
'Custom_Object__c'. This sets the `sobjectType` field in the FlexiPage metadata.
|
|
443
443
|
```
|
|
444
444
|
|
|
445
|
-
_See code: [src/commands/template/generate/flexipage/index.ts](https://github.com/salesforcecli/plugin-templates/blob/56.
|
|
445
|
+
_See code: [src/commands/template/generate/flexipage/index.ts](https://github.com/salesforcecli/plugin-templates/blob/56.13.0/src/commands/template/generate/flexipage/index.ts)_
|
|
446
446
|
|
|
447
447
|
## `sf template generate lightning app`
|
|
448
448
|
|
|
@@ -498,7 +498,7 @@ FLAG DESCRIPTIONS
|
|
|
498
498
|
Supplied parameter values or default values are filled into a copy of the template.
|
|
499
499
|
```
|
|
500
500
|
|
|
501
|
-
_See code: [src/commands/template/generate/lightning/app.ts](https://github.com/salesforcecli/plugin-templates/blob/56.
|
|
501
|
+
_See code: [src/commands/template/generate/lightning/app.ts](https://github.com/salesforcecli/plugin-templates/blob/56.13.0/src/commands/template/generate/lightning/app.ts)_
|
|
502
502
|
|
|
503
503
|
## `sf template generate lightning component`
|
|
504
504
|
|
|
@@ -568,7 +568,7 @@ FLAG DESCRIPTIONS
|
|
|
568
568
|
Supplied parameter values or default values are filled into a copy of the template.
|
|
569
569
|
```
|
|
570
570
|
|
|
571
|
-
_See code: [src/commands/template/generate/lightning/component.ts](https://github.com/salesforcecli/plugin-templates/blob/56.
|
|
571
|
+
_See code: [src/commands/template/generate/lightning/component.ts](https://github.com/salesforcecli/plugin-templates/blob/56.13.0/src/commands/template/generate/lightning/component.ts)_
|
|
572
572
|
|
|
573
573
|
## `sf template generate lightning event`
|
|
574
574
|
|
|
@@ -624,7 +624,7 @@ FLAG DESCRIPTIONS
|
|
|
624
624
|
Supplied parameter values or default values are filled into a copy of the template.
|
|
625
625
|
```
|
|
626
626
|
|
|
627
|
-
_See code: [src/commands/template/generate/lightning/event.ts](https://github.com/salesforcecli/plugin-templates/blob/56.
|
|
627
|
+
_See code: [src/commands/template/generate/lightning/event.ts](https://github.com/salesforcecli/plugin-templates/blob/56.13.0/src/commands/template/generate/lightning/event.ts)_
|
|
628
628
|
|
|
629
629
|
## `sf template generate lightning interface`
|
|
630
630
|
|
|
@@ -680,7 +680,7 @@ FLAG DESCRIPTIONS
|
|
|
680
680
|
Supplied parameter values or default values are filled into a copy of the template.
|
|
681
681
|
```
|
|
682
682
|
|
|
683
|
-
_See code: [src/commands/template/generate/lightning/interface.ts](https://github.com/salesforcecli/plugin-templates/blob/56.
|
|
683
|
+
_See code: [src/commands/template/generate/lightning/interface.ts](https://github.com/salesforcecli/plugin-templates/blob/56.13.0/src/commands/template/generate/lightning/interface.ts)_
|
|
684
684
|
|
|
685
685
|
## `sf template generate lightning test`
|
|
686
686
|
|
|
@@ -736,7 +736,7 @@ FLAG DESCRIPTIONS
|
|
|
736
736
|
Supplied parameter values or default values are filled into a copy of the template.
|
|
737
737
|
```
|
|
738
738
|
|
|
739
|
-
_See code: [src/commands/template/generate/lightning/test.ts](https://github.com/salesforcecli/plugin-templates/blob/56.
|
|
739
|
+
_See code: [src/commands/template/generate/lightning/test.ts](https://github.com/salesforcecli/plugin-templates/blob/56.13.0/src/commands/template/generate/lightning/test.ts)_
|
|
740
740
|
|
|
741
741
|
## `sf template generate project`
|
|
742
742
|
|
|
@@ -834,7 +834,7 @@ FLAG DESCRIPTIONS
|
|
|
834
834
|
The analytics template provides similar files and the force-app/main/default/waveTemplates directory.
|
|
835
835
|
|
|
836
836
|
The reactinternalapp and reactexternalapp templates provide React-based project scaffolding for internal and
|
|
837
|
-
external
|
|
837
|
+
external UI bundle use cases.
|
|
838
838
|
|
|
839
839
|
The agent template provides project scaffolding for building Agentforce agents and includes a sample agent called
|
|
840
840
|
Local Info Agent.
|
|
@@ -849,7 +849,7 @@ FLAG DESCRIPTIONS
|
|
|
849
849
|
Override the api version used for api requests made by this command
|
|
850
850
|
```
|
|
851
851
|
|
|
852
|
-
_See code: [src/commands/template/generate/project/index.ts](https://github.com/salesforcecli/plugin-templates/blob/56.
|
|
852
|
+
_See code: [src/commands/template/generate/project/index.ts](https://github.com/salesforcecli/plugin-templates/blob/56.13.0/src/commands/template/generate/project/index.ts)_
|
|
853
853
|
|
|
854
854
|
## `sf template generate static-resource`
|
|
855
855
|
|
|
@@ -912,7 +912,7 @@ FLAG DESCRIPTIONS
|
|
|
912
912
|
etc.
|
|
913
913
|
```
|
|
914
914
|
|
|
915
|
-
_See code: [src/commands/template/generate/static-resource/index.ts](https://github.com/salesforcecli/plugin-templates/blob/56.
|
|
915
|
+
_See code: [src/commands/template/generate/static-resource/index.ts](https://github.com/salesforcecli/plugin-templates/blob/56.13.0/src/commands/template/generate/static-resource/index.ts)_
|
|
916
916
|
|
|
917
917
|
## `sf template generate visualforce component`
|
|
918
918
|
|
|
@@ -969,7 +969,7 @@ FLAG DESCRIPTIONS
|
|
|
969
969
|
Supplied parameter values or default values are filled into a copy of the template.
|
|
970
970
|
```
|
|
971
971
|
|
|
972
|
-
_See code: [src/commands/template/generate/visualforce/component.ts](https://github.com/salesforcecli/plugin-templates/blob/56.
|
|
972
|
+
_See code: [src/commands/template/generate/visualforce/component.ts](https://github.com/salesforcecli/plugin-templates/blob/56.13.0/src/commands/template/generate/visualforce/component.ts)_
|
|
973
973
|
|
|
974
974
|
## `sf template generate visualforce page`
|
|
975
975
|
|
|
@@ -1020,6 +1020,6 @@ FLAG DESCRIPTIONS
|
|
|
1020
1020
|
The name can be up to 40 characters and must start with a letter.
|
|
1021
1021
|
```
|
|
1022
1022
|
|
|
1023
|
-
_See code: [src/commands/template/generate/visualforce/page.ts](https://github.com/salesforcecli/plugin-templates/blob/56.
|
|
1023
|
+
_See code: [src/commands/template/generate/visualforce/page.ts](https://github.com/salesforcecli/plugin-templates/blob/56.13.0/src/commands/template/generate/visualforce/page.ts)_
|
|
1024
1024
|
|
|
1025
1025
|
<!-- commandsstop -->
|
|
@@ -1,12 +1,12 @@
|
|
|
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
8
|
static readonly hidden = true;
|
|
8
9
|
static readonly aliases: string[];
|
|
9
|
-
static readonly deprecateAliases = true;
|
|
10
10
|
static readonly flags: {
|
|
11
11
|
name: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
|
|
12
12
|
template: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
|
|
@@ -16,7 +16,7 @@ export default class WebAppGenerate extends SfCommand<CreateOutput> {
|
|
|
16
16
|
};
|
|
17
17
|
/**
|
|
18
18
|
* Resolves the default output directory by reading the project's sfdx-project.json.
|
|
19
|
-
* Returns the path to
|
|
19
|
+
* Returns the path to uiBundles under the default package directory,
|
|
20
20
|
* or falls back to the current directory if not in a project context.
|
|
21
21
|
*/
|
|
22
22
|
private static getDefaultOutputDir;
|
|
@@ -10,14 +10,14 @@ 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
19
|
static hidden = true; // Hide from external developers until GA
|
|
19
|
-
static aliases = ['
|
|
20
|
-
static deprecateAliases = true;
|
|
20
|
+
static aliases = ['ui-bundle:generate'];
|
|
21
21
|
static flags = {
|
|
22
22
|
name: Flags.string({
|
|
23
23
|
char: 'n',
|
|
@@ -46,31 +46,31 @@ export default class WebAppGenerate extends SfCommand {
|
|
|
46
46
|
};
|
|
47
47
|
/**
|
|
48
48
|
* Resolves the default output directory by reading the project's sfdx-project.json.
|
|
49
|
-
* Returns the path to
|
|
49
|
+
* Returns the path to uiBundles under the default package directory,
|
|
50
50
|
* or falls back to the current directory if not in a project context.
|
|
51
51
|
*/
|
|
52
52
|
static async getDefaultOutputDir() {
|
|
53
53
|
try {
|
|
54
54
|
const project = await SfProject.resolve();
|
|
55
55
|
const defaultPackage = project.getDefaultPackage();
|
|
56
|
-
return path.join(defaultPackage.path, 'main', 'default',
|
|
56
|
+
return path.join(defaultPackage.path, 'main', 'default', UI_BUNDLES_DIR);
|
|
57
57
|
}
|
|
58
58
|
catch {
|
|
59
59
|
return '.';
|
|
60
60
|
}
|
|
61
61
|
}
|
|
62
62
|
async run() {
|
|
63
|
-
const { flags } = await this.parse(
|
|
64
|
-
const outputDir = flags['output-dir'] ?? (await
|
|
63
|
+
const { flags } = await this.parse(UiBundleGenerate);
|
|
64
|
+
const outputDir = flags['output-dir'] ?? (await UiBundleGenerate.getDefaultOutputDir());
|
|
65
65
|
const flagsAsOptions = {
|
|
66
|
-
|
|
66
|
+
bundlename: flags.name,
|
|
67
67
|
template: flags.template,
|
|
68
68
|
masterlabel: flags.label,
|
|
69
69
|
outputdir: outputDir,
|
|
70
70
|
apiversion: flags['api-version'],
|
|
71
71
|
};
|
|
72
72
|
return runGenerator({
|
|
73
|
-
templateType: TemplateType.
|
|
73
|
+
templateType: TemplateType.UIBundle,
|
|
74
74
|
opts: flagsAsOptions,
|
|
75
75
|
ux: new Ux({ jsonEnabled: this.jsonEnabled() }),
|
|
76
76
|
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,MAAM,GAAG,IAAI,CAAC,CAAC,yCAAyC;IACxE,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
|
@@ -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,
|
|
@@ -2123,12 +2122,12 @@
|
|
|
2123
2122
|
"hasDynamicHelp": false,
|
|
2124
2123
|
"hidden": true,
|
|
2125
2124
|
"hiddenAliases": [],
|
|
2126
|
-
"id": "template:generate:
|
|
2125
|
+
"id": "template:generate:ui-bundle",
|
|
2127
2126
|
"pluginAlias": "@salesforce/plugin-templates",
|
|
2128
2127
|
"pluginName": "@salesforce/plugin-templates",
|
|
2129
2128
|
"pluginType": "core",
|
|
2130
2129
|
"strict": true,
|
|
2131
|
-
"summary": "Generate a
|
|
2130
|
+
"summary": "Generate a UI bundle.",
|
|
2132
2131
|
"enableJsonFlag": true,
|
|
2133
2132
|
"isESM": true,
|
|
2134
2133
|
"relativePath": [
|
|
@@ -2136,20 +2135,20 @@
|
|
|
2136
2135
|
"commands",
|
|
2137
2136
|
"template",
|
|
2138
2137
|
"generate",
|
|
2139
|
-
"
|
|
2138
|
+
"ui-bundle",
|
|
2140
2139
|
"index.js"
|
|
2141
2140
|
],
|
|
2142
2141
|
"aliasPermutations": [
|
|
2143
|
-
"
|
|
2144
|
-
"generate:
|
|
2142
|
+
"ui-bundle:generate",
|
|
2143
|
+
"generate:ui-bundle"
|
|
2145
2144
|
],
|
|
2146
2145
|
"permutations": [
|
|
2147
|
-
"template:generate:
|
|
2148
|
-
"generate:template:
|
|
2149
|
-
"generate:
|
|
2150
|
-
"template:
|
|
2151
|
-
"
|
|
2152
|
-
"
|
|
2146
|
+
"template:generate:ui-bundle",
|
|
2147
|
+
"generate:template:ui-bundle",
|
|
2148
|
+
"generate:ui-bundle:template",
|
|
2149
|
+
"template:ui-bundle:generate",
|
|
2150
|
+
"ui-bundle:template:generate",
|
|
2151
|
+
"ui-bundle:generate:template"
|
|
2153
2152
|
]
|
|
2154
2153
|
},
|
|
2155
2154
|
"template:generate:visualforce:component": {
|
|
@@ -2508,5 +2507,5 @@
|
|
|
2508
2507
|
]
|
|
2509
2508
|
}
|
|
2510
2509
|
},
|
|
2511
|
-
"version": "56.
|
|
2510
|
+
"version": "56.13.0"
|
|
2512
2511
|
}
|
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.0",
|
|
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.0.crt",
|
|
256
|
+
"signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-templates/56.13.0.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.
|