@salesforce/plugin-templates 56.10.1 → 56.10.3

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.
Files changed (3) hide show
  1. package/README.md +15 -14
  2. package/oclif.manifest.json +111 -111
  3. package/package.json +3 -3
package/README.md CHANGED
@@ -40,6 +40,7 @@ Please report any issues to https://github.com/salesforcecli/plugin-templates/is
40
40
  ## Contributing
41
41
 
42
42
  1. Familiarize yourself with the codebase by reading the docs and the templates [library](https://github.com/salesforcecli/plugin-templates).
43
+ - If you're adding a new template generator, see the [Development Guide](./DEVELOPMENT.md) for detailed instructions.
43
44
  1. Create a new issue before starting your project so that we can keep track of
44
45
  what you're trying to add/fix. That way, we can also offer suggestions or
45
46
  let you know if there is already an effort in progress.
@@ -175,7 +176,7 @@ FLAG DESCRIPTIONS
175
176
  directory.
176
177
  ```
177
178
 
178
- _See code: [src/commands/template/generate/analytics/template.ts](https://github.com/salesforcecli/plugin-templates/blob/56.10.1/src/commands/template/generate/analytics/template.ts)_
179
+ _See code: [src/commands/template/generate/analytics/template.ts](https://github.com/salesforcecli/plugin-templates/blob/56.10.3/src/commands/template/generate/analytics/template.ts)_
179
180
 
180
181
  ## `sf template generate apex class`
181
182
 
@@ -235,7 +236,7 @@ FLAG DESCRIPTIONS
235
236
  Supplied parameter values or default values are filled into a copy of the template.
236
237
  ```
237
238
 
238
- _See code: [src/commands/template/generate/apex/class.ts](https://github.com/salesforcecli/plugin-templates/blob/56.10.1/src/commands/template/generate/apex/class.ts)_
239
+ _See code: [src/commands/template/generate/apex/class.ts](https://github.com/salesforcecli/plugin-templates/blob/56.10.3/src/commands/template/generate/apex/class.ts)_
239
240
 
240
241
  ## `sf template generate apex trigger`
241
242
 
@@ -305,7 +306,7 @@ FLAG DESCRIPTIONS
305
306
  Supplied parameter values or default values are filled into a copy of the template.
306
307
  ```
307
308
 
308
- _See code: [src/commands/template/generate/apex/trigger.ts](https://github.com/salesforcecli/plugin-templates/blob/56.10.1/src/commands/template/generate/apex/trigger.ts)_
309
+ _See code: [src/commands/template/generate/apex/trigger.ts](https://github.com/salesforcecli/plugin-templates/blob/56.10.3/src/commands/template/generate/apex/trigger.ts)_
309
310
 
310
311
  ## `sf template generate digital-experience site`
311
312
 
@@ -359,7 +360,7 @@ FLAG DESCRIPTIONS
359
360
  project, defaults to the current directory.
360
361
  ```
361
362
 
362
- _See code: [src/commands/template/generate/digital-experience/site.ts](https://github.com/salesforcecli/plugin-templates/blob/56.10.1/src/commands/template/generate/digital-experience/site.ts)_
363
+ _See code: [src/commands/template/generate/digital-experience/site.ts](https://github.com/salesforcecli/plugin-templates/blob/56.10.3/src/commands/template/generate/digital-experience/site.ts)_
363
364
 
364
365
  ## `sf template generate flexipage`
365
366
 
@@ -441,7 +442,7 @@ FLAG DESCRIPTIONS
441
442
  'Custom_Object__c'. This sets the `sobjectType` field in the FlexiPage metadata.
442
443
  ```
443
444
 
444
- _See code: [src/commands/template/generate/flexipage/index.ts](https://github.com/salesforcecli/plugin-templates/blob/56.10.1/src/commands/template/generate/flexipage/index.ts)_
445
+ _See code: [src/commands/template/generate/flexipage/index.ts](https://github.com/salesforcecli/plugin-templates/blob/56.10.3/src/commands/template/generate/flexipage/index.ts)_
445
446
 
446
447
  ## `sf template generate lightning app`
447
448
 
@@ -497,7 +498,7 @@ FLAG DESCRIPTIONS
497
498
  Supplied parameter values or default values are filled into a copy of the template.
498
499
  ```
499
500
 
500
- _See code: [src/commands/template/generate/lightning/app.ts](https://github.com/salesforcecli/plugin-templates/blob/56.10.1/src/commands/template/generate/lightning/app.ts)_
501
+ _See code: [src/commands/template/generate/lightning/app.ts](https://github.com/salesforcecli/plugin-templates/blob/56.10.3/src/commands/template/generate/lightning/app.ts)_
501
502
 
502
503
  ## `sf template generate lightning component`
503
504
 
@@ -567,7 +568,7 @@ FLAG DESCRIPTIONS
567
568
  Supplied parameter values or default values are filled into a copy of the template.
568
569
  ```
569
570
 
570
- _See code: [src/commands/template/generate/lightning/component.ts](https://github.com/salesforcecli/plugin-templates/blob/56.10.1/src/commands/template/generate/lightning/component.ts)_
571
+ _See code: [src/commands/template/generate/lightning/component.ts](https://github.com/salesforcecli/plugin-templates/blob/56.10.3/src/commands/template/generate/lightning/component.ts)_
571
572
 
572
573
  ## `sf template generate lightning event`
573
574
 
@@ -623,7 +624,7 @@ FLAG DESCRIPTIONS
623
624
  Supplied parameter values or default values are filled into a copy of the template.
624
625
  ```
625
626
 
626
- _See code: [src/commands/template/generate/lightning/event.ts](https://github.com/salesforcecli/plugin-templates/blob/56.10.1/src/commands/template/generate/lightning/event.ts)_
627
+ _See code: [src/commands/template/generate/lightning/event.ts](https://github.com/salesforcecli/plugin-templates/blob/56.10.3/src/commands/template/generate/lightning/event.ts)_
627
628
 
628
629
  ## `sf template generate lightning interface`
629
630
 
@@ -679,7 +680,7 @@ FLAG DESCRIPTIONS
679
680
  Supplied parameter values or default values are filled into a copy of the template.
680
681
  ```
681
682
 
682
- _See code: [src/commands/template/generate/lightning/interface.ts](https://github.com/salesforcecli/plugin-templates/blob/56.10.1/src/commands/template/generate/lightning/interface.ts)_
683
+ _See code: [src/commands/template/generate/lightning/interface.ts](https://github.com/salesforcecli/plugin-templates/blob/56.10.3/src/commands/template/generate/lightning/interface.ts)_
683
684
 
684
685
  ## `sf template generate lightning test`
685
686
 
@@ -735,7 +736,7 @@ FLAG DESCRIPTIONS
735
736
  Supplied parameter values or default values are filled into a copy of the template.
736
737
  ```
737
738
 
738
- _See code: [src/commands/template/generate/lightning/test.ts](https://github.com/salesforcecli/plugin-templates/blob/56.10.1/src/commands/template/generate/lightning/test.ts)_
739
+ _See code: [src/commands/template/generate/lightning/test.ts](https://github.com/salesforcecli/plugin-templates/blob/56.10.3/src/commands/template/generate/lightning/test.ts)_
739
740
 
740
741
  ## `sf template generate project`
741
742
 
@@ -844,7 +845,7 @@ FLAG DESCRIPTIONS
844
845
  Override the api version used for api requests made by this command
845
846
  ```
846
847
 
847
- _See code: [src/commands/template/generate/project/index.ts](https://github.com/salesforcecli/plugin-templates/blob/56.10.1/src/commands/template/generate/project/index.ts)_
848
+ _See code: [src/commands/template/generate/project/index.ts](https://github.com/salesforcecli/plugin-templates/blob/56.10.3/src/commands/template/generate/project/index.ts)_
848
849
 
849
850
  ## `sf template generate static-resource`
850
851
 
@@ -907,7 +908,7 @@ FLAG DESCRIPTIONS
907
908
  etc.
908
909
  ```
909
910
 
910
- _See code: [src/commands/template/generate/static-resource/index.ts](https://github.com/salesforcecli/plugin-templates/blob/56.10.1/src/commands/template/generate/static-resource/index.ts)_
911
+ _See code: [src/commands/template/generate/static-resource/index.ts](https://github.com/salesforcecli/plugin-templates/blob/56.10.3/src/commands/template/generate/static-resource/index.ts)_
911
912
 
912
913
  ## `sf template generate visualforce component`
913
914
 
@@ -964,7 +965,7 @@ FLAG DESCRIPTIONS
964
965
  Supplied parameter values or default values are filled into a copy of the template.
965
966
  ```
966
967
 
967
- _See code: [src/commands/template/generate/visualforce/component.ts](https://github.com/salesforcecli/plugin-templates/blob/56.10.1/src/commands/template/generate/visualforce/component.ts)_
968
+ _See code: [src/commands/template/generate/visualforce/component.ts](https://github.com/salesforcecli/plugin-templates/blob/56.10.3/src/commands/template/generate/visualforce/component.ts)_
968
969
 
969
970
  ## `sf template generate visualforce page`
970
971
 
@@ -1015,6 +1016,6 @@ FLAG DESCRIPTIONS
1015
1016
  The name can be up to 40 characters and must start with a letter.
1016
1017
  ```
1017
1018
 
1018
- _See code: [src/commands/template/generate/visualforce/page.ts](https://github.com/salesforcecli/plugin-templates/blob/56.10.1/src/commands/template/generate/visualforce/page.ts)_
1019
+ _See code: [src/commands/template/generate/visualforce/page.ts](https://github.com/salesforcecli/plugin-templates/blob/56.10.3/src/commands/template/generate/visualforce/page.ts)_
1019
1020
 
1020
1021
  <!-- commandsstop -->
@@ -2041,116 +2041,6 @@
2041
2041
  "static-resource:generate:template"
2042
2042
  ]
2043
2043
  },
2044
- "template:generate:webapp": {
2045
- "aliases": [
2046
- "webapp:generate"
2047
- ],
2048
- "args": {},
2049
- "deprecateAliases": true,
2050
- "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.",
2051
- "examples": [
2052
- "Generate a web application called MyWebApp in the current directory:\n<%= config.bin %> <%= command.id %> --name MyWebApp",
2053
- "Generate a React-based web application:\n<%= config.bin %> <%= command.id %> --name MyReactApp --template reactbasic",
2054
- "Generate the web application in the \"force-app/main/default/webapplications\" directory:\n<%= config.bin %> <%= command.id %> --name MyWebApp --output-dir force-app/main/default/webapplications"
2055
- ],
2056
- "flags": {
2057
- "json": {
2058
- "description": "Format output as json.",
2059
- "helpGroup": "GLOBAL",
2060
- "name": "json",
2061
- "allowNo": false,
2062
- "type": "boolean"
2063
- },
2064
- "flags-dir": {
2065
- "helpGroup": "GLOBAL",
2066
- "name": "flags-dir",
2067
- "summary": "Import flag values from a directory.",
2068
- "hasDynamicHelp": false,
2069
- "multiple": false,
2070
- "type": "option"
2071
- },
2072
- "name": {
2073
- "char": "n",
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.",
2075
- "name": "name",
2076
- "required": true,
2077
- "summary": "Name of the generated web application.",
2078
- "hasDynamicHelp": false,
2079
- "multiple": false,
2080
- "type": "option"
2081
- },
2082
- "template": {
2083
- "char": "t",
2084
- "description": "Supplied parameter values or default values are filled into a copy of the template.",
2085
- "name": "template",
2086
- "summary": "Template to use for file creation.",
2087
- "default": "default",
2088
- "hasDynamicHelp": false,
2089
- "multiple": false,
2090
- "options": [
2091
- "default",
2092
- "reactbasic"
2093
- ],
2094
- "type": "option"
2095
- },
2096
- "label": {
2097
- "char": "l",
2098
- "description": "If not specified, the label is derived from the name.",
2099
- "name": "label",
2100
- "summary": "Master label for the web application.",
2101
- "hasDynamicHelp": false,
2102
- "multiple": false,
2103
- "type": "option"
2104
- },
2105
- "output-dir": {
2106
- "char": "d",
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 \"webapplications\". If your specified path doesn't end with \"webapplications\", it's automatically appended. The web application is created at \"<output-dir>/<webappname>\".\n\n**Examples:**\n- \"--output-dir force-app/main/default\" → Creates a web application at \"force-app/main/default/webapplications/MyWebApp/\"\n- \"--output-dir force-app/main/default/webapplications\" → Creates a web application at \"force-app/main/default/webapplications/MyWebApp/\" (no change)\n\nIf 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.",
2108
- "name": "output-dir",
2109
- "summary": "Directory for saving the created files.",
2110
- "hasDynamicHelp": false,
2111
- "multiple": false,
2112
- "type": "option"
2113
- },
2114
- "api-version": {
2115
- "description": "Override the api version used for api requests made by this command",
2116
- "name": "api-version",
2117
- "hasDynamicHelp": false,
2118
- "multiple": false,
2119
- "type": "option"
2120
- }
2121
- },
2122
- "hasDynamicHelp": false,
2123
- "hidden": true,
2124
- "hiddenAliases": [],
2125
- "id": "template:generate:webapp",
2126
- "pluginAlias": "@salesforce/plugin-templates",
2127
- "pluginName": "@salesforce/plugin-templates",
2128
- "pluginType": "core",
2129
- "strict": true,
2130
- "summary": "Generate a web application.",
2131
- "enableJsonFlag": true,
2132
- "isESM": true,
2133
- "relativePath": [
2134
- "lib",
2135
- "commands",
2136
- "template",
2137
- "generate",
2138
- "webapp",
2139
- "index.js"
2140
- ],
2141
- "aliasPermutations": [
2142
- "webapp:generate",
2143
- "generate:webapp"
2144
- ],
2145
- "permutations": [
2146
- "template:generate:webapp",
2147
- "generate:template:webapp",
2148
- "generate:webapp:template",
2149
- "template:webapp:generate",
2150
- "webapp:template:generate",
2151
- "webapp:generate:template"
2152
- ]
2153
- },
2154
2044
  "template:generate:visualforce:component": {
2155
2045
  "aliases": [
2156
2046
  "force:visualforce:component:create",
@@ -2505,7 +2395,117 @@
2505
2395
  "page:visualforce:template:generate",
2506
2396
  "page:visualforce:generate:template"
2507
2397
  ]
2398
+ },
2399
+ "template:generate:webapp": {
2400
+ "aliases": [
2401
+ "webapp:generate"
2402
+ ],
2403
+ "args": {},
2404
+ "deprecateAliases": true,
2405
+ "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.",
2406
+ "examples": [
2407
+ "Generate a web application called MyWebApp in the current directory:\n<%= config.bin %> <%= command.id %> --name MyWebApp",
2408
+ "Generate a React-based web application:\n<%= config.bin %> <%= command.id %> --name MyReactApp --template reactbasic",
2409
+ "Generate the web application in the \"force-app/main/default/webapplications\" directory:\n<%= config.bin %> <%= command.id %> --name MyWebApp --output-dir force-app/main/default/webapplications"
2410
+ ],
2411
+ "flags": {
2412
+ "json": {
2413
+ "description": "Format output as json.",
2414
+ "helpGroup": "GLOBAL",
2415
+ "name": "json",
2416
+ "allowNo": false,
2417
+ "type": "boolean"
2418
+ },
2419
+ "flags-dir": {
2420
+ "helpGroup": "GLOBAL",
2421
+ "name": "flags-dir",
2422
+ "summary": "Import flag values from a directory.",
2423
+ "hasDynamicHelp": false,
2424
+ "multiple": false,
2425
+ "type": "option"
2426
+ },
2427
+ "name": {
2428
+ "char": "n",
2429
+ "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.",
2430
+ "name": "name",
2431
+ "required": true,
2432
+ "summary": "Name of the generated web application.",
2433
+ "hasDynamicHelp": false,
2434
+ "multiple": false,
2435
+ "type": "option"
2436
+ },
2437
+ "template": {
2438
+ "char": "t",
2439
+ "description": "Supplied parameter values or default values are filled into a copy of the template.",
2440
+ "name": "template",
2441
+ "summary": "Template to use for file creation.",
2442
+ "default": "default",
2443
+ "hasDynamicHelp": false,
2444
+ "multiple": false,
2445
+ "options": [
2446
+ "default",
2447
+ "reactbasic"
2448
+ ],
2449
+ "type": "option"
2450
+ },
2451
+ "label": {
2452
+ "char": "l",
2453
+ "description": "If not specified, the label is derived from the name.",
2454
+ "name": "label",
2455
+ "summary": "Master label for the web application.",
2456
+ "hasDynamicHelp": false,
2457
+ "multiple": false,
2458
+ "type": "option"
2459
+ },
2460
+ "output-dir": {
2461
+ "char": "d",
2462
+ "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 \"webapplications\". If your specified path doesn't end with \"webapplications\", it's automatically appended. The web application is created at \"<output-dir>/<webappname>\".\n\n**Examples:**\n- \"--output-dir force-app/main/default\" → Creates a web application at \"force-app/main/default/webapplications/MyWebApp/\"\n- \"--output-dir force-app/main/default/webapplications\" → Creates a web application at \"force-app/main/default/webapplications/MyWebApp/\" (no change)\n\nIf 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.",
2463
+ "name": "output-dir",
2464
+ "summary": "Directory for saving the created files.",
2465
+ "hasDynamicHelp": false,
2466
+ "multiple": false,
2467
+ "type": "option"
2468
+ },
2469
+ "api-version": {
2470
+ "description": "Override the api version used for api requests made by this command",
2471
+ "name": "api-version",
2472
+ "hasDynamicHelp": false,
2473
+ "multiple": false,
2474
+ "type": "option"
2475
+ }
2476
+ },
2477
+ "hasDynamicHelp": false,
2478
+ "hidden": true,
2479
+ "hiddenAliases": [],
2480
+ "id": "template:generate:webapp",
2481
+ "pluginAlias": "@salesforce/plugin-templates",
2482
+ "pluginName": "@salesforce/plugin-templates",
2483
+ "pluginType": "core",
2484
+ "strict": true,
2485
+ "summary": "Generate a web application.",
2486
+ "enableJsonFlag": true,
2487
+ "isESM": true,
2488
+ "relativePath": [
2489
+ "lib",
2490
+ "commands",
2491
+ "template",
2492
+ "generate",
2493
+ "webapp",
2494
+ "index.js"
2495
+ ],
2496
+ "aliasPermutations": [
2497
+ "webapp:generate",
2498
+ "generate:webapp"
2499
+ ],
2500
+ "permutations": [
2501
+ "template:generate:webapp",
2502
+ "generate:template:webapp",
2503
+ "generate:webapp:template",
2504
+ "template:webapp:generate",
2505
+ "webapp:template:generate",
2506
+ "webapp:generate:template"
2507
+ ]
2508
2508
  }
2509
2509
  },
2510
- "version": "56.10.1"
2510
+ "version": "56.10.3"
2511
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.10.1",
4
+ "version": "56.10.3",
5
5
  "author": "Salesforce",
6
6
  "bugs": "https://github.com/salesforcecli/plugin-templates/issues",
7
7
  "enableO11y": true,
@@ -249,7 +249,7 @@
249
249
  "exports": "./lib/index.js",
250
250
  "type": "module",
251
251
  "sfdx": {
252
- "publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-templates/56.10.1.crt",
253
- "signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-templates/56.10.1.sig"
252
+ "publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-templates/56.10.3.crt",
253
+ "signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-templates/56.10.3.sig"
254
254
  }
255
255
  }