@salesforce/plugin-templates 56.10.1 → 56.10.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.
Files changed (3) hide show
  1. package/README.md +15 -14
  2. package/oclif.manifest.json +335 -335
  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.2/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.2/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.2/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.2/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.2/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.2/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.2/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.2/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.2/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.2/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.2/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.2/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.2/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.2/src/commands/template/generate/visualforce/page.ts)_
1019
1020
 
1020
1021
  <!-- commandsstop -->
@@ -1735,183 +1735,6 @@
1735
1735
  "test:lightning:generate:template"
1736
1736
  ]
1737
1737
  },
1738
- "template:generate:project": {
1739
- "aliases": [
1740
- "force:project:create",
1741
- "project:generate"
1742
- ],
1743
- "args": {},
1744
- "deprecateAliases": true,
1745
- "description": "A Salesforce DX project has a specific structure and a configuration file (sfdx-project.json) that identifies the directory as a Salesforce DX project. This command generates the necessary configuration files and directories to get you started.\n\nBy default, the generated sfdx-project.json file sets the sourceApiVersion property to the default API version currently used by Salesforce CLI. To specify a different version, set the apiVersion configuration variable. For example: \"sf config set apiVersion=57.0 --global\".",
1746
- "examples": [
1747
- "Generate a project called \"mywork\":\n<%= config.bin %> <%= command.id %> --name mywork",
1748
- "Similar to previous example, but generate the files in a directory called \"myapp\":\n<%= config.bin %> <%= command.id %> --name mywork --default-package-dir myapp",
1749
- "Similar to prevoius example, but also generate a default package.xml manifest file:\n<%= config.bin %> <%= command.id %> --name mywork --default-package-dir myapp --manifest",
1750
- "Generate a project with the minimum files and directories:\n<%= config.bin %> <%= command.id %> --name mywork --template empty"
1751
- ],
1752
- "flags": {
1753
- "json": {
1754
- "description": "Format output as json.",
1755
- "helpGroup": "GLOBAL",
1756
- "name": "json",
1757
- "allowNo": false,
1758
- "type": "boolean"
1759
- },
1760
- "flags-dir": {
1761
- "helpGroup": "GLOBAL",
1762
- "name": "flags-dir",
1763
- "summary": "Import flag values from a directory.",
1764
- "hasDynamicHelp": false,
1765
- "multiple": false,
1766
- "type": "option"
1767
- },
1768
- "name": {
1769
- "aliases": [
1770
- "projectname"
1771
- ],
1772
- "char": "n",
1773
- "deprecateAliases": true,
1774
- "description": "Generates a project directory with this name; any valid directory name is accepted. Also sets the \"name\" property in the sfdx-project.json file to this name.",
1775
- "name": "name",
1776
- "required": true,
1777
- "summary": "Name of the generated project.",
1778
- "hasDynamicHelp": false,
1779
- "multiple": false,
1780
- "type": "option"
1781
- },
1782
- "template": {
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 reactb2e and reactb2x templates provide React-based project scaffolding for B2E and B2X web application use cases.",
1785
- "name": "template",
1786
- "summary": "Template to use for project creation.",
1787
- "default": "standard",
1788
- "hasDynamicHelp": false,
1789
- "multiple": false,
1790
- "options": [
1791
- "standard",
1792
- "empty",
1793
- "analytics",
1794
- "reactb2e",
1795
- "reactb2x"
1796
- ],
1797
- "type": "option"
1798
- },
1799
- "output-dir": {
1800
- "aliases": [
1801
- "outputdir"
1802
- ],
1803
- "char": "d",
1804
- "deprecateAliases": true,
1805
- "description": "The location can be an absolute path or relative to the current working directory. The default is the current directory.",
1806
- "name": "output-dir",
1807
- "summary": "Directory for saving the created files.",
1808
- "default": ".",
1809
- "hasDynamicHelp": false,
1810
- "multiple": false,
1811
- "type": "option"
1812
- },
1813
- "namespace": {
1814
- "char": "s",
1815
- "name": "namespace",
1816
- "summary": "Namespace associated with this project and any connected scratch orgs.",
1817
- "default": "",
1818
- "hasDynamicHelp": false,
1819
- "multiple": false,
1820
- "type": "option"
1821
- },
1822
- "default-package-dir": {
1823
- "aliases": [
1824
- "defaultpackagedir"
1825
- ],
1826
- "char": "p",
1827
- "deprecateAliases": true,
1828
- "description": "Metadata items such as classes and Lightning bundles are placed inside this folder.",
1829
- "name": "default-package-dir",
1830
- "summary": "Default package directory name.",
1831
- "default": "force-app",
1832
- "hasDynamicHelp": false,
1833
- "multiple": false,
1834
- "type": "option"
1835
- },
1836
- "manifest": {
1837
- "char": "x",
1838
- "description": "Generates a default manifest (package.xml) for fetching Apex, Visualforce, Lightning components, and static resources.",
1839
- "name": "manifest",
1840
- "summary": "Generate a manifest (package.xml) for change-set based development.",
1841
- "allowNo": false,
1842
- "type": "boolean"
1843
- },
1844
- "login-url": {
1845
- "aliases": [
1846
- "loginurl"
1847
- ],
1848
- "char": "l",
1849
- "deprecateAliases": true,
1850
- "description": "Normally defaults to https://login.salesforce.com.",
1851
- "hidden": true,
1852
- "name": "login-url",
1853
- "summary": "Salesforce instance login URL.",
1854
- "default": "https://login.salesforce.com",
1855
- "hasDynamicHelp": false,
1856
- "multiple": false,
1857
- "type": "option"
1858
- },
1859
- "loglevel": {
1860
- "deprecated": {
1861
- "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."
1862
- },
1863
- "hidden": true,
1864
- "name": "loglevel",
1865
- "hasDynamicHelp": false,
1866
- "multiple": false,
1867
- "type": "option"
1868
- },
1869
- "api-version": {
1870
- "description": "Override the api version used for api requests made by this command",
1871
- "name": "api-version",
1872
- "summary": "Will set this version as sourceApiVersion in the sfdx-project.json file",
1873
- "hasDynamicHelp": false,
1874
- "multiple": false,
1875
- "type": "option"
1876
- }
1877
- },
1878
- "hasDynamicHelp": false,
1879
- "hiddenAliases": [],
1880
- "id": "template:generate:project",
1881
- "pluginAlias": "@salesforce/plugin-templates",
1882
- "pluginName": "@salesforce/plugin-templates",
1883
- "pluginType": "core",
1884
- "strict": true,
1885
- "summary": "Generate a Salesforce DX project.",
1886
- "enableJsonFlag": true,
1887
- "isESM": true,
1888
- "relativePath": [
1889
- "lib",
1890
- "commands",
1891
- "template",
1892
- "generate",
1893
- "project",
1894
- "index.js"
1895
- ],
1896
- "aliasPermutations": [
1897
- "force:project:create",
1898
- "project:force:create",
1899
- "project:create:force",
1900
- "force:create:project",
1901
- "create:force:project",
1902
- "create:project:force",
1903
- "project:generate",
1904
- "generate:project"
1905
- ],
1906
- "permutations": [
1907
- "template:generate:project",
1908
- "generate:template:project",
1909
- "generate:project:template",
1910
- "template:project:generate",
1911
- "project:template:generate",
1912
- "project:generate:template"
1913
- ]
1914
- },
1915
1738
  "template:generate:static-resource": {
1916
1739
  "aliases": [
1917
1740
  "force:staticresource:create",
@@ -2041,17 +1864,17 @@
2041
1864
  "static-resource:generate:template"
2042
1865
  ]
2043
1866
  },
2044
- "template:generate:webapp": {
1867
+ "template:generate:visualforce:component": {
2045
1868
  "aliases": [
2046
- "webapp:generate"
1869
+ "force:visualforce:component:create",
1870
+ "visualforce:generate:component"
2047
1871
  ],
2048
1872
  "args": {},
2049
1873
  "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.",
1874
+ "description": "The command generates the .Component file and associated metadata file in the specified directory or the current working directory by default.",
2051
1875
  "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"
1876
+ "Generate the metadata files for a Visualforce component in the current directory:\n<%= config.bin %> <%= command.id %> --name mycomponent --label mylabel",
1877
+ "Similar to previous example, but generate the files in the directory \"force-app/main/default/components\":\n<%= config.bin %> <%= command.id %> --name mycomponent --label mylabel --output-dir components"
2055
1878
  ],
2056
1879
  "flags": {
2057
1880
  "json": {
@@ -2070,11 +1893,15 @@
2070
1893
  "type": "option"
2071
1894
  },
2072
1895
  "name": {
1896
+ "aliases": [
1897
+ "componentname"
1898
+ ],
2073
1899
  "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.",
1900
+ "deprecateAliases": true,
1901
+ "description": "The name can be up to 40 characters and must start with a letter.",
2075
1902
  "name": "name",
2076
1903
  "required": true,
2077
- "summary": "Name of the generated web application.",
1904
+ "summary": "Name of the generated Visualforce Component.",
2078
1905
  "hasDynamicHelp": false,
2079
1906
  "multiple": false,
2080
1907
  "type": "option"
@@ -2084,50 +1911,67 @@
2084
1911
  "description": "Supplied parameter values or default values are filled into a copy of the template.",
2085
1912
  "name": "template",
2086
1913
  "summary": "Template to use for file creation.",
2087
- "default": "default",
1914
+ "default": "DefaultVFComponent",
2088
1915
  "hasDynamicHelp": false,
2089
1916
  "multiple": false,
2090
1917
  "options": [
2091
- "default",
2092
- "reactbasic"
1918
+ "DefaultVFComponent"
2093
1919
  ],
2094
1920
  "type": "option"
2095
1921
  },
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
1922
  "output-dir": {
1923
+ "aliases": [
1924
+ "outputdir"
1925
+ ],
2106
1926
  "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.",
1927
+ "deprecateAliases": true,
1928
+ "description": "The location can be an absolute path or relative to the current working directory. The default is the current directory.",
2108
1929
  "name": "output-dir",
2109
1930
  "summary": "Directory for saving the created files.",
1931
+ "default": ".",
2110
1932
  "hasDynamicHelp": false,
2111
1933
  "multiple": false,
2112
1934
  "type": "option"
2113
1935
  },
2114
1936
  "api-version": {
1937
+ "aliases": [
1938
+ "apiversion"
1939
+ ],
1940
+ "deprecateAliases": true,
2115
1941
  "description": "Override the api version used for api requests made by this command",
2116
1942
  "name": "api-version",
2117
1943
  "hasDynamicHelp": false,
2118
1944
  "multiple": false,
2119
1945
  "type": "option"
1946
+ },
1947
+ "label": {
1948
+ "char": "l",
1949
+ "name": "label",
1950
+ "required": true,
1951
+ "summary": "Visualforce Component label.",
1952
+ "hasDynamicHelp": false,
1953
+ "multiple": false,
1954
+ "type": "option"
1955
+ },
1956
+ "loglevel": {
1957
+ "deprecated": {
1958
+ "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."
1959
+ },
1960
+ "hidden": true,
1961
+ "name": "loglevel",
1962
+ "hasDynamicHelp": false,
1963
+ "multiple": false,
1964
+ "type": "option"
2120
1965
  }
2121
1966
  },
2122
1967
  "hasDynamicHelp": false,
2123
- "hidden": true,
2124
1968
  "hiddenAliases": [],
2125
- "id": "template:generate:webapp",
1969
+ "id": "template:generate:visualforce:component",
2126
1970
  "pluginAlias": "@salesforce/plugin-templates",
2127
1971
  "pluginName": "@salesforce/plugin-templates",
2128
1972
  "pluginType": "core",
2129
1973
  "strict": true,
2130
- "summary": "Generate a web application.",
1974
+ "summary": "Generate a Visualforce Component.",
2131
1975
  "enableJsonFlag": true,
2132
1976
  "isESM": true,
2133
1977
  "relativePath": [
@@ -2135,139 +1979,8 @@
2135
1979
  "commands",
2136
1980
  "template",
2137
1981
  "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
- "template:generate:visualforce:component": {
2155
- "aliases": [
2156
- "force:visualforce:component:create",
2157
- "visualforce:generate:component"
2158
- ],
2159
- "args": {},
2160
- "deprecateAliases": true,
2161
- "description": "The command generates the .Component file and associated metadata file in the specified directory or the current working directory by default.",
2162
- "examples": [
2163
- "Generate the metadata files for a Visualforce component in the current directory:\n<%= config.bin %> <%= command.id %> --name mycomponent --label mylabel",
2164
- "Similar to previous example, but generate the files in the directory \"force-app/main/default/components\":\n<%= config.bin %> <%= command.id %> --name mycomponent --label mylabel --output-dir components"
2165
- ],
2166
- "flags": {
2167
- "json": {
2168
- "description": "Format output as json.",
2169
- "helpGroup": "GLOBAL",
2170
- "name": "json",
2171
- "allowNo": false,
2172
- "type": "boolean"
2173
- },
2174
- "flags-dir": {
2175
- "helpGroup": "GLOBAL",
2176
- "name": "flags-dir",
2177
- "summary": "Import flag values from a directory.",
2178
- "hasDynamicHelp": false,
2179
- "multiple": false,
2180
- "type": "option"
2181
- },
2182
- "name": {
2183
- "aliases": [
2184
- "componentname"
2185
- ],
2186
- "char": "n",
2187
- "deprecateAliases": true,
2188
- "description": "The name can be up to 40 characters and must start with a letter.",
2189
- "name": "name",
2190
- "required": true,
2191
- "summary": "Name of the generated Visualforce Component.",
2192
- "hasDynamicHelp": false,
2193
- "multiple": false,
2194
- "type": "option"
2195
- },
2196
- "template": {
2197
- "char": "t",
2198
- "description": "Supplied parameter values or default values are filled into a copy of the template.",
2199
- "name": "template",
2200
- "summary": "Template to use for file creation.",
2201
- "default": "DefaultVFComponent",
2202
- "hasDynamicHelp": false,
2203
- "multiple": false,
2204
- "options": [
2205
- "DefaultVFComponent"
2206
- ],
2207
- "type": "option"
2208
- },
2209
- "output-dir": {
2210
- "aliases": [
2211
- "outputdir"
2212
- ],
2213
- "char": "d",
2214
- "deprecateAliases": true,
2215
- "description": "The location can be an absolute path or relative to the current working directory. The default is the current directory.",
2216
- "name": "output-dir",
2217
- "summary": "Directory for saving the created files.",
2218
- "default": ".",
2219
- "hasDynamicHelp": false,
2220
- "multiple": false,
2221
- "type": "option"
2222
- },
2223
- "api-version": {
2224
- "aliases": [
2225
- "apiversion"
2226
- ],
2227
- "deprecateAliases": true,
2228
- "description": "Override the api version used for api requests made by this command",
2229
- "name": "api-version",
2230
- "hasDynamicHelp": false,
2231
- "multiple": false,
2232
- "type": "option"
2233
- },
2234
- "label": {
2235
- "char": "l",
2236
- "name": "label",
2237
- "required": true,
2238
- "summary": "Visualforce Component label.",
2239
- "hasDynamicHelp": false,
2240
- "multiple": false,
2241
- "type": "option"
2242
- },
2243
- "loglevel": {
2244
- "deprecated": {
2245
- "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."
2246
- },
2247
- "hidden": true,
2248
- "name": "loglevel",
2249
- "hasDynamicHelp": false,
2250
- "multiple": false,
2251
- "type": "option"
2252
- }
2253
- },
2254
- "hasDynamicHelp": false,
2255
- "hiddenAliases": [],
2256
- "id": "template:generate:visualforce:component",
2257
- "pluginAlias": "@salesforce/plugin-templates",
2258
- "pluginName": "@salesforce/plugin-templates",
2259
- "pluginType": "core",
2260
- "strict": true,
2261
- "summary": "Generate a Visualforce Component.",
2262
- "enableJsonFlag": true,
2263
- "isESM": true,
2264
- "relativePath": [
2265
- "lib",
2266
- "commands",
2267
- "template",
2268
- "generate",
2269
- "visualforce",
2270
- "component.js"
1982
+ "visualforce",
1983
+ "component.js"
2271
1984
  ],
2272
1985
  "aliasPermutations": [
2273
1986
  "force:visualforce:component:create",
@@ -2505,7 +2218,294 @@
2505
2218
  "page:visualforce:template:generate",
2506
2219
  "page:visualforce:generate:template"
2507
2220
  ]
2221
+ },
2222
+ "template:generate:project": {
2223
+ "aliases": [
2224
+ "force:project:create",
2225
+ "project:generate"
2226
+ ],
2227
+ "args": {},
2228
+ "deprecateAliases": true,
2229
+ "description": "A Salesforce DX project has a specific structure and a configuration file (sfdx-project.json) that identifies the directory as a Salesforce DX project. This command generates the necessary configuration files and directories to get you started.\n\nBy default, the generated sfdx-project.json file sets the sourceApiVersion property to the default API version currently used by Salesforce CLI. To specify a different version, set the apiVersion configuration variable. For example: \"sf config set apiVersion=57.0 --global\".",
2230
+ "examples": [
2231
+ "Generate a project called \"mywork\":\n<%= config.bin %> <%= command.id %> --name mywork",
2232
+ "Similar to previous example, but generate the files in a directory called \"myapp\":\n<%= config.bin %> <%= command.id %> --name mywork --default-package-dir myapp",
2233
+ "Similar to prevoius example, but also generate a default package.xml manifest file:\n<%= config.bin %> <%= command.id %> --name mywork --default-package-dir myapp --manifest",
2234
+ "Generate a project with the minimum files and directories:\n<%= config.bin %> <%= command.id %> --name mywork --template empty"
2235
+ ],
2236
+ "flags": {
2237
+ "json": {
2238
+ "description": "Format output as json.",
2239
+ "helpGroup": "GLOBAL",
2240
+ "name": "json",
2241
+ "allowNo": false,
2242
+ "type": "boolean"
2243
+ },
2244
+ "flags-dir": {
2245
+ "helpGroup": "GLOBAL",
2246
+ "name": "flags-dir",
2247
+ "summary": "Import flag values from a directory.",
2248
+ "hasDynamicHelp": false,
2249
+ "multiple": false,
2250
+ "type": "option"
2251
+ },
2252
+ "name": {
2253
+ "aliases": [
2254
+ "projectname"
2255
+ ],
2256
+ "char": "n",
2257
+ "deprecateAliases": true,
2258
+ "description": "Generates a project directory with this name; any valid directory name is accepted. Also sets the \"name\" property in the sfdx-project.json file to this name.",
2259
+ "name": "name",
2260
+ "required": true,
2261
+ "summary": "Name of the generated project.",
2262
+ "hasDynamicHelp": false,
2263
+ "multiple": false,
2264
+ "type": "option"
2265
+ },
2266
+ "template": {
2267
+ "char": "t",
2268
+ "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 reactb2e and reactb2x templates provide React-based project scaffolding for B2E and B2X web application use cases.",
2269
+ "name": "template",
2270
+ "summary": "Template to use for project creation.",
2271
+ "default": "standard",
2272
+ "hasDynamicHelp": false,
2273
+ "multiple": false,
2274
+ "options": [
2275
+ "standard",
2276
+ "empty",
2277
+ "analytics",
2278
+ "reactb2e",
2279
+ "reactb2x"
2280
+ ],
2281
+ "type": "option"
2282
+ },
2283
+ "output-dir": {
2284
+ "aliases": [
2285
+ "outputdir"
2286
+ ],
2287
+ "char": "d",
2288
+ "deprecateAliases": true,
2289
+ "description": "The location can be an absolute path or relative to the current working directory. The default is the current directory.",
2290
+ "name": "output-dir",
2291
+ "summary": "Directory for saving the created files.",
2292
+ "default": ".",
2293
+ "hasDynamicHelp": false,
2294
+ "multiple": false,
2295
+ "type": "option"
2296
+ },
2297
+ "namespace": {
2298
+ "char": "s",
2299
+ "name": "namespace",
2300
+ "summary": "Namespace associated with this project and any connected scratch orgs.",
2301
+ "default": "",
2302
+ "hasDynamicHelp": false,
2303
+ "multiple": false,
2304
+ "type": "option"
2305
+ },
2306
+ "default-package-dir": {
2307
+ "aliases": [
2308
+ "defaultpackagedir"
2309
+ ],
2310
+ "char": "p",
2311
+ "deprecateAliases": true,
2312
+ "description": "Metadata items such as classes and Lightning bundles are placed inside this folder.",
2313
+ "name": "default-package-dir",
2314
+ "summary": "Default package directory name.",
2315
+ "default": "force-app",
2316
+ "hasDynamicHelp": false,
2317
+ "multiple": false,
2318
+ "type": "option"
2319
+ },
2320
+ "manifest": {
2321
+ "char": "x",
2322
+ "description": "Generates a default manifest (package.xml) for fetching Apex, Visualforce, Lightning components, and static resources.",
2323
+ "name": "manifest",
2324
+ "summary": "Generate a manifest (package.xml) for change-set based development.",
2325
+ "allowNo": false,
2326
+ "type": "boolean"
2327
+ },
2328
+ "login-url": {
2329
+ "aliases": [
2330
+ "loginurl"
2331
+ ],
2332
+ "char": "l",
2333
+ "deprecateAliases": true,
2334
+ "description": "Normally defaults to https://login.salesforce.com.",
2335
+ "hidden": true,
2336
+ "name": "login-url",
2337
+ "summary": "Salesforce instance login URL.",
2338
+ "default": "https://login.salesforce.com",
2339
+ "hasDynamicHelp": false,
2340
+ "multiple": false,
2341
+ "type": "option"
2342
+ },
2343
+ "loglevel": {
2344
+ "deprecated": {
2345
+ "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."
2346
+ },
2347
+ "hidden": true,
2348
+ "name": "loglevel",
2349
+ "hasDynamicHelp": false,
2350
+ "multiple": false,
2351
+ "type": "option"
2352
+ },
2353
+ "api-version": {
2354
+ "description": "Override the api version used for api requests made by this command",
2355
+ "name": "api-version",
2356
+ "summary": "Will set this version as sourceApiVersion in the sfdx-project.json file",
2357
+ "hasDynamicHelp": false,
2358
+ "multiple": false,
2359
+ "type": "option"
2360
+ }
2361
+ },
2362
+ "hasDynamicHelp": false,
2363
+ "hiddenAliases": [],
2364
+ "id": "template:generate:project",
2365
+ "pluginAlias": "@salesforce/plugin-templates",
2366
+ "pluginName": "@salesforce/plugin-templates",
2367
+ "pluginType": "core",
2368
+ "strict": true,
2369
+ "summary": "Generate a Salesforce DX project.",
2370
+ "enableJsonFlag": true,
2371
+ "isESM": true,
2372
+ "relativePath": [
2373
+ "lib",
2374
+ "commands",
2375
+ "template",
2376
+ "generate",
2377
+ "project",
2378
+ "index.js"
2379
+ ],
2380
+ "aliasPermutations": [
2381
+ "force:project:create",
2382
+ "project:force:create",
2383
+ "project:create:force",
2384
+ "force:create:project",
2385
+ "create:force:project",
2386
+ "create:project:force",
2387
+ "project:generate",
2388
+ "generate:project"
2389
+ ],
2390
+ "permutations": [
2391
+ "template:generate:project",
2392
+ "generate:template:project",
2393
+ "generate:project:template",
2394
+ "template:project:generate",
2395
+ "project:template:generate",
2396
+ "project:generate:template"
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.2"
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.2",
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.2.crt",
253
+ "signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-templates/56.10.2.sig"
254
254
  }
255
255
  }