@salesforce/plugin-templates 56.15.0 → 56.15.2

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 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.15.0/src/commands/template/generate/analytics/template.ts)_
180
+ _See code: [src/commands/template/generate/analytics/template.ts](https://github.com/salesforcecli/plugin-templates/blob/56.15.2/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.15.0/src/commands/template/generate/apex/class.ts)_
240
+ _See code: [src/commands/template/generate/apex/class.ts](https://github.com/salesforcecli/plugin-templates/blob/56.15.2/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.15.0/src/commands/template/generate/apex/trigger.ts)_
310
+ _See code: [src/commands/template/generate/apex/trigger.ts](https://github.com/salesforcecli/plugin-templates/blob/56.15.2/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.15.0/src/commands/template/generate/digital-experience/site.ts)_
364
+ _See code: [src/commands/template/generate/digital-experience/site.ts](https://github.com/salesforcecli/plugin-templates/blob/56.15.2/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.15.0/src/commands/template/generate/flexipage/index.ts)_
446
+ _See code: [src/commands/template/generate/flexipage/index.ts](https://github.com/salesforcecli/plugin-templates/blob/56.15.2/src/commands/template/generate/flexipage/index.ts)_
447
447
 
448
448
  ## `sf template generate lightning app`
449
449
 
@@ -497,11 +497,11 @@ FLAG DESCRIPTIONS
497
497
  -t, --template=DefaultLightningApp Template to use for file creation.
498
498
 
499
499
  Supplied parameter values or default values are filled into a copy of the template. For Lightning Web Components, if
500
- not specified, the CLI automatically selects the template based on the project's sfdx-project.json
501
- "defaultLwcLanguage" field: TypeScript template for "typescript", JavaScript template for "javascript".
500
+ this flag isn't specified, the CLI command automatically selects the template based on the "defaultLwcLanguage"
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.15.0/src/commands/template/generate/lightning/app.ts)_
504
+ _See code: [src/commands/template/generate/lightning/app.ts](https://github.com/salesforcecli/plugin-templates/blob/56.15.2/src/commands/template/generate/lightning/app.ts)_
505
505
 
506
506
  ## `sf template generate lightning component`
507
507
 
@@ -557,7 +557,7 @@ EXAMPLES
557
557
 
558
558
  $ sf template generate lightning component --name mycomponent --type lwc --output-dir force-app/main/default/lwc
559
559
 
560
- Generate a TypeScript Lightning web component:
560
+ Generate a TypeScript Lightning Web Component:
561
561
 
562
562
  $ sf template generate lightning component --name mycomponent --type lwc --template typescript
563
563
 
@@ -574,11 +574,11 @@ FLAG DESCRIPTIONS
574
574
  -t, --template=default|analyticsDashboard|analyticsDashboardWithStep|typescript Template to use for file creation.
575
575
 
576
576
  Supplied parameter values or default values are filled into a copy of the template. For Lightning Web Components, if
577
- not specified, the CLI automatically selects the template based on the project's sfdx-project.json
578
- "defaultLwcLanguage" field: TypeScript template for "typescript", JavaScript template for "javascript".
577
+ this flag isn't specified, the CLI command automatically selects the template based on the "defaultLwcLanguage"
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.15.0/src/commands/template/generate/lightning/component.ts)_
581
+ _See code: [src/commands/template/generate/lightning/component.ts](https://github.com/salesforcecli/plugin-templates/blob/56.15.2/src/commands/template/generate/lightning/component.ts)_
582
582
 
583
583
  ## `sf template generate lightning event`
584
584
 
@@ -632,11 +632,11 @@ FLAG DESCRIPTIONS
632
632
  -t, --template=DefaultLightningEvt Template to use for file creation.
633
633
 
634
634
  Supplied parameter values or default values are filled into a copy of the template. For Lightning Web Components, if
635
- not specified, the CLI automatically selects the template based on the project's sfdx-project.json
636
- "defaultLwcLanguage" field: TypeScript template for "typescript", JavaScript template for "javascript".
635
+ this flag isn't specified, the CLI command automatically selects the template based on the "defaultLwcLanguage"
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.15.0/src/commands/template/generate/lightning/event.ts)_
639
+ _See code: [src/commands/template/generate/lightning/event.ts](https://github.com/salesforcecli/plugin-templates/blob/56.15.2/src/commands/template/generate/lightning/event.ts)_
640
640
 
641
641
  ## `sf template generate lightning interface`
642
642
 
@@ -690,11 +690,11 @@ FLAG DESCRIPTIONS
690
690
  -t, --template=DefaultLightningIntf Template to use for file creation.
691
691
 
692
692
  Supplied parameter values or default values are filled into a copy of the template. For Lightning Web Components, if
693
- not specified, the CLI automatically selects the template based on the project's sfdx-project.json
694
- "defaultLwcLanguage" field: TypeScript template for "typescript", JavaScript template for "javascript".
693
+ this flag isn't specified, the CLI command automatically selects the template based on the "defaultLwcLanguage"
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.15.0/src/commands/template/generate/lightning/interface.ts)_
697
+ _See code: [src/commands/template/generate/lightning/interface.ts](https://github.com/salesforcecli/plugin-templates/blob/56.15.2/src/commands/template/generate/lightning/interface.ts)_
698
698
 
699
699
  ## `sf template generate lightning test`
700
700
 
@@ -748,11 +748,11 @@ FLAG DESCRIPTIONS
748
748
  -t, --template=DefaultLightningTest Template to use for file creation.
749
749
 
750
750
  Supplied parameter values or default values are filled into a copy of the template. For Lightning Web Components, if
751
- not specified, the CLI automatically selects the template based on the project's sfdx-project.json
752
- "defaultLwcLanguage" field: TypeScript template for "typescript", JavaScript template for "javascript".
751
+ this flag isn't specified, the CLI command automatically selects the template based on the "defaultLwcLanguage"
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.15.0/src/commands/template/generate/lightning/test.ts)_
755
+ _See code: [src/commands/template/generate/lightning/test.ts](https://github.com/salesforcecli/plugin-templates/blob/56.15.2/src/commands/template/generate/lightning/test.ts)_
756
756
 
757
757
  ## `sf template generate project`
758
758
 
@@ -773,7 +773,7 @@ FLAGS
773
773
  <options: standard|empty|analytics|reactinternalapp|reactexternalapp|agent>
774
774
  -x, --manifest Generate a manifest (package.xml) for change-set based development.
775
775
  --api-version=<value> Will set this version as sourceApiVersion in the sfdx-project.json file
776
- --lwc-language=<option> Language of the Lightning Web Components. Default is "javascript".
776
+ --lwc-language=<option> Language of the Lightning Web Components. If not specified, "javascript" is used.
777
777
  <options: javascript|typescript>
778
778
 
779
779
  GLOBAL FLAGS
@@ -870,15 +870,15 @@ FLAG DESCRIPTIONS
870
870
 
871
871
  Override the api version used for api requests made by this command
872
872
 
873
- --lwc-language=javascript|typescript Language of the Lightning Web Components. Default is "javascript".
873
+ --lwc-language=javascript|typescript Language of the Lightning Web Components. If not specified, "javascript" is used.
874
874
 
875
- Sets the default language for Lightning Web Components in this project. When set to `'typescript'`, generates
876
- TypeScript configuration files (tsconfig.json, package.json with TypeScript dependencies, and TypeScript-aware
877
- ESLint config). TypeScript files are compiled locally for validation, and the TypeScript (`.ts`) files are deployed
878
- to Salesforce for server-side type stripping. If not specified, the project uses JavaScript.
875
+ When set to `'typescript'`, generates TypeScript configuration files (tsconfig.json, package.json with TypeScript
876
+ dependencies, and TypeScript-aware ESLint config). When you deploy the TypeScript-based Lightning Web Components,
877
+ the TypeScript files are first compiled locally for validation and then the `.ts` files are deployed to your org for
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.15.0/src/commands/template/generate/project/index.ts)_
881
+ _See code: [src/commands/template/generate/project/index.ts](https://github.com/salesforcecli/plugin-templates/blob/56.15.2/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.15.0/src/commands/template/generate/static-resource/index.ts)_
944
+ _See code: [src/commands/template/generate/static-resource/index.ts](https://github.com/salesforcecli/plugin-templates/blob/56.15.2/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.15.0/src/commands/template/generate/ui-bundle/index.ts)_
1028
+ _See code: [src/commands/template/generate/ui-bundle/index.ts](https://github.com/salesforcecli/plugin-templates/blob/56.15.2/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.15.0/src/commands/template/generate/visualforce/component.ts)_
1085
+ _See code: [src/commands/template/generate/visualforce/component.ts](https://github.com/salesforcecli/plugin-templates/blob/56.15.2/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.15.0/src/commands/template/generate/visualforce/page.ts)_
1136
+ _See code: [src/commands/template/generate/visualforce/page.ts](https://github.com/salesforcecli/plugin-templates/blob/56.15.2/src/commands/template/generate/visualforce/page.ts)_
1137
1137
 
1138
1138
  <!-- commandsstop -->
@@ -24,4 +24,4 @@ Template to use for file creation.
24
24
 
25
25
  # flags.template.description
26
26
 
27
- Supplied parameter values or default values are filled into a copy of the template. For Lightning Web Components, if not specified, the CLI automatically selects the template based on the project's sfdx-project.json "defaultLwcLanguage" field: TypeScript template for "typescript", JavaScript template for "javascript".
27
+ Supplied parameter values or default values are filled into a copy of the template. For Lightning Web Components, if this flag isn't specified, the CLI command automatically selects the template based on the "defaultLwcLanguage" field in the DX project's "sfdx-project.json" file.
@@ -16,7 +16,7 @@
16
16
 
17
17
  <%= config.bin %> <%= command.id %> --name mycomponent --type lwc --output-dir force-app/main/default/lwc
18
18
 
19
- - Generate a TypeScript Lightning web component:
19
+ - Generate a TypeScript Lightning Web Component:
20
20
 
21
21
  <%= config.bin %> <%= command.id %> --name mycomponent --type lwc --template typescript
22
22
 
@@ -8,7 +8,7 @@ The location can be an absolute path or relative to the current working director
8
8
 
9
9
  # flags.outputdirLighting.description
10
10
 
11
- If you don’t specify an outputdir, we create a subfolder in your current working directory with the name of your bundle. For example, if the current working directory is force-app and your Lightning bundle is called myBundle, we create force-app/myBundle/ to store the files in the bundle.
11
+ If you don’t specify an output-dir, we create a subfolder in your current working directory with the name of your bundle. For example, if the current working directory is force-app and your Lightning bundle is called myBundle, we create force-app/myBundle/ to store the files in the bundle.
12
12
 
13
13
  # flags.template.summary
14
14
 
@@ -100,8 +100,8 @@ Normally defaults to https://login.salesforce.com.
100
100
 
101
101
  # flags.lwc-language.summary
102
102
 
103
- Language of the Lightning Web Components. Default is "javascript".
103
+ Language of the Lightning Web Components. If not specified, "javascript" is used.
104
104
 
105
105
  # flags.lwc-language.description
106
106
 
107
- Sets the default language for Lightning Web Components in this project. When set to `'typescript'`, generates TypeScript configuration files (tsconfig.json, package.json with TypeScript dependencies, and TypeScript-aware ESLint config). TypeScript files are compiled locally for validation, and the TypeScript (`.ts`) files are deployed to Salesforce for server-side type stripping. If not specified, the project uses JavaScript.
107
+ 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.