@salesforce/plugin-templates 56.10.0 → 56.10.2

package/README.md

@@ -40,6 +40,7 @@ Please report any issues to https://github.com/salesforcecli/plugin-templates/is
 ## Contributing
 
 1. Familiarize yourself with the codebase by reading the docs and the templates [library](https://github.com/salesforcecli/plugin-templates).
+   - If you're adding a new template generator, see the [Development Guide](./DEVELOPMENT.md) for detailed instructions.
 1. Create a new issue before starting your project so that we can keep track of
    what you're trying to add/fix. That way, we can also offer suggestions or
    let you know if there is already an effort in progress.
@@ -175,7 +176,7 @@ FLAG DESCRIPTIONS
     directory.
 ```
 
-_See code: [src/commands/template/generate/analytics/template.ts](https://github.com/salesforcecli/plugin-templates/blob/56.10.0/src/commands/template/generate/analytics/template.ts)_
+_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)_
 
 ## `sf template generate apex class`
 
@@ -235,7 +236,7 @@ FLAG DESCRIPTIONS
     Supplied parameter values or default values are filled into a copy of the template.
 ```
 
-_See code: [src/commands/template/generate/apex/class.ts](https://github.com/salesforcecli/plugin-templates/blob/56.10.0/src/commands/template/generate/apex/class.ts)_
+_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)_
 
 ## `sf template generate apex trigger`
 
@@ -305,7 +306,7 @@ FLAG DESCRIPTIONS
     Supplied parameter values or default values are filled into a copy of the template.
 ```
 
-_See code: [src/commands/template/generate/apex/trigger.ts](https://github.com/salesforcecli/plugin-templates/blob/56.10.0/src/commands/template/generate/apex/trigger.ts)_
+_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)_
 
 ## `sf template generate digital-experience site`
 
@@ -359,7 +360,7 @@ FLAG DESCRIPTIONS
     project, defaults to the current directory.
 ```
 
-_See code: [src/commands/template/generate/digital-experience/site.ts](https://github.com/salesforcecli/plugin-templates/blob/56.10.0/src/commands/template/generate/digital-experience/site.ts)_
+_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)_
 
 ## `sf template generate flexipage`
 
@@ -441,7 +442,7 @@ FLAG DESCRIPTIONS
     'Custom_Object__c'. This sets the `sobjectType` field in the FlexiPage metadata.
 ```
 
-_See code: [src/commands/template/generate/flexipage/index.ts](https://github.com/salesforcecli/plugin-templates/blob/56.10.0/src/commands/template/generate/flexipage/index.ts)_
+_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)_
 
 ## `sf template generate lightning app`
 
@@ -497,7 +498,7 @@ FLAG DESCRIPTIONS
     Supplied parameter values or default values are filled into a copy of the template.
 ```
 
-_See code: [src/commands/template/generate/lightning/app.ts](https://github.com/salesforcecli/plugin-templates/blob/56.10.0/src/commands/template/generate/lightning/app.ts)_
+_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)_
 
 ## `sf template generate lightning component`
 
@@ -567,7 +568,7 @@ FLAG DESCRIPTIONS
     Supplied parameter values or default values are filled into a copy of the template.
 ```
 
-_See code: [src/commands/template/generate/lightning/component.ts](https://github.com/salesforcecli/plugin-templates/blob/56.10.0/src/commands/template/generate/lightning/component.ts)_
+_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)_
 
 ## `sf template generate lightning event`
 
@@ -623,7 +624,7 @@ FLAG DESCRIPTIONS
     Supplied parameter values or default values are filled into a copy of the template.
 ```
 
-_See code: [src/commands/template/generate/lightning/event.ts](https://github.com/salesforcecli/plugin-templates/blob/56.10.0/src/commands/template/generate/lightning/event.ts)_
+_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)_
 
 ## `sf template generate lightning interface`
 
@@ -679,7 +680,7 @@ FLAG DESCRIPTIONS
     Supplied parameter values or default values are filled into a copy of the template.
 ```
 
-_See code: [src/commands/template/generate/lightning/interface.ts](https://github.com/salesforcecli/plugin-templates/blob/56.10.0/src/commands/template/generate/lightning/interface.ts)_
+_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)_
 
 ## `sf template generate lightning test`
 
@@ -735,7 +736,7 @@ FLAG DESCRIPTIONS
     Supplied parameter values or default values are filled into a copy of the template.
 ```
 
-_See code: [src/commands/template/generate/lightning/test.ts](https://github.com/salesforcecli/plugin-templates/blob/56.10.0/src/commands/template/generate/lightning/test.ts)_
+_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)_
 
 ## `sf template generate project`
 
@@ -844,7 +845,7 @@ FLAG DESCRIPTIONS
     Override the api version used for api requests made by this command
 ```
 
-_See code: [src/commands/template/generate/project/index.ts](https://github.com/salesforcecli/plugin-templates/blob/56.10.0/src/commands/template/generate/project/index.ts)_
+_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)_
 
 ## `sf template generate static-resource`
 
@@ -907,7 +908,7 @@ FLAG DESCRIPTIONS
     etc.
 ```
 
-_See code: [src/commands/template/generate/static-resource/index.ts](https://github.com/salesforcecli/plugin-templates/blob/56.10.0/src/commands/template/generate/static-resource/index.ts)_
+_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)_
 
 ## `sf template generate visualforce component`
 
@@ -964,7 +965,7 @@ FLAG DESCRIPTIONS
     Supplied parameter values or default values are filled into a copy of the template.
 ```
 
-_See code: [src/commands/template/generate/visualforce/component.ts](https://github.com/salesforcecli/plugin-templates/blob/56.10.0/src/commands/template/generate/visualforce/component.ts)_
+_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)_
 
 ## `sf template generate visualforce page`
 
@@ -1015,6 +1016,6 @@ FLAG DESCRIPTIONS
     The name can be up to 40 characters and must start with a letter.
 ```
 
-_See code: [src/commands/template/generate/visualforce/page.ts](https://github.com/salesforcecli/plugin-templates/blob/56.10.0/src/commands/template/generate/visualforce/page.ts)_
+_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)_
 
 <!-- commandsstop -->

package/oclif.manifest.json

@@ -1735,183 +1735,6 @@
         "test:lightning:generate:template"
       ]
     },
-    "template:generate:project": {
-      "aliases": [
-        "force:project:create",
-        "project:generate"
-      ],
-      "args": {},
-      "deprecateAliases": true,
-      "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\".",
-      "examples": [
-        "Generate a project called \"mywork\":\n<%= config.bin %> <%= command.id %> --name mywork",
-        "Similar to previous example, but generate the files in a directory called \"myapp\":\n<%= config.bin %> <%= command.id %> --name mywork --default-package-dir myapp",
-        "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",
-        "Generate a project with the minimum files and directories:\n<%= config.bin %> <%= command.id %> --name mywork --template empty"
-      ],
-      "flags": {
-        "json": {
-          "description": "Format output as json.",
-          "helpGroup": "GLOBAL",
-          "name": "json",
-          "allowNo": false,
-          "type": "boolean"
-        },
-        "flags-dir": {
-          "helpGroup": "GLOBAL",
-          "name": "flags-dir",
-          "summary": "Import flag values from a directory.",
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "type": "option"
-        },
-        "name": {
-          "aliases": [
-            "projectname"
-          ],
-          "char": "n",
-          "deprecateAliases": true,
-          "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.",
-          "name": "name",
-          "required": true,
-          "summary": "Name of the generated project.",
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "type": "option"
-        },
-        "template": {
-          "char": "t",
-          "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.",
-          "name": "template",
-          "summary": "Template to use for project creation.",
-          "default": "standard",
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "options": [
-            "standard",
-            "empty",
-            "analytics",
-            "reactb2e",
-            "reactb2x"
-          ],
-          "type": "option"
-        },
-        "output-dir": {
-          "aliases": [
-            "outputdir"
-          ],
-          "char": "d",
-          "deprecateAliases": true,
-          "description": "The location can be an absolute path or relative to the current working directory. The default is the current directory.",
-          "name": "output-dir",
-          "summary": "Directory for saving the created files.",
-          "default": ".",
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "type": "option"
-        },
-        "namespace": {
-          "char": "s",
-          "name": "namespace",
-          "summary": "Namespace associated with this project and any connected scratch orgs.",
-          "default": "",
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "type": "option"
-        },
-        "default-package-dir": {
-          "aliases": [
-            "defaultpackagedir"
-          ],
-          "char": "p",
-          "deprecateAliases": true,
-          "description": "Metadata items such as classes and Lightning bundles are placed inside this folder.",
-          "name": "default-package-dir",
-          "summary": "Default package directory name.",
-          "default": "force-app",
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "type": "option"
-        },
-        "manifest": {
-          "char": "x",
-          "description": "Generates a default manifest (package.xml) for fetching Apex, Visualforce, Lightning components, and static resources.",
-          "name": "manifest",
-          "summary": "Generate a manifest (package.xml) for change-set based development.",
-          "allowNo": false,
-          "type": "boolean"
-        },
-        "login-url": {
-          "aliases": [
-            "loginurl"
-          ],
-          "char": "l",
-          "deprecateAliases": true,
-          "description": "Normally defaults to https://login.salesforce.com.",
-          "hidden": true,
-          "name": "login-url",
-          "summary": "Salesforce instance login URL.",
-          "default": "https://login.salesforce.com",
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "type": "option"
-        },
-        "loglevel": {
-          "deprecated": {
-            "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."
-          },
-          "hidden": true,
-          "name": "loglevel",
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "type": "option"
-        },
-        "api-version": {
-          "description": "Override the api version used for api requests made by this command",
-          "name": "api-version",
-          "summary": "Will set this version as sourceApiVersion in the sfdx-project.json file",
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "type": "option"
-        }
-      },
-      "hasDynamicHelp": false,
-      "hiddenAliases": [],
-      "id": "template:generate:project",
-      "pluginAlias": "@salesforce/plugin-templates",
-      "pluginName": "@salesforce/plugin-templates",
-      "pluginType": "core",
-      "strict": true,
-      "summary": "Generate a Salesforce DX project.",
-      "enableJsonFlag": true,
-      "isESM": true,
-      "relativePath": [
-        "lib",
-        "commands",
-        "template",
-        "generate",
-        "project",
-        "index.js"
-      ],
-      "aliasPermutations": [
-        "force:project:create",
-        "project:force:create",
-        "project:create:force",
-        "force:create:project",
-        "create:force:project",
-        "create:project:force",
-        "project:generate",
-        "generate:project"
-      ],
-      "permutations": [
-        "template:generate:project",
-        "generate:template:project",
-        "generate:project:template",
-        "template:project:generate",
-        "project:template:generate",
-        "project:generate:template"
-      ]
-    },
     "template:generate:static-resource": {
       "aliases": [
         "force:staticresource:create",
@@ -2396,6 +2219,183 @@
         "page:visualforce:generate:template"
       ]
     },
+    "template:generate:project": {
+      "aliases": [
+        "force:project:create",
+        "project:generate"
+      ],
+      "args": {},
+      "deprecateAliases": true,
+      "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\".",
+      "examples": [
+        "Generate a project called \"mywork\":\n<%= config.bin %> <%= command.id %> --name mywork",
+        "Similar to previous example, but generate the files in a directory called \"myapp\":\n<%= config.bin %> <%= command.id %> --name mywork --default-package-dir myapp",
+        "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",
+        "Generate a project with the minimum files and directories:\n<%= config.bin %> <%= command.id %> --name mywork --template empty"
+      ],
+      "flags": {
+        "json": {
+          "description": "Format output as json.",
+          "helpGroup": "GLOBAL",
+          "name": "json",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "flags-dir": {
+          "helpGroup": "GLOBAL",
+          "name": "flags-dir",
+          "summary": "Import flag values from a directory.",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "name": {
+          "aliases": [
+            "projectname"
+          ],
+          "char": "n",
+          "deprecateAliases": true,
+          "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.",
+          "name": "name",
+          "required": true,
+          "summary": "Name of the generated project.",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "template": {
+          "char": "t",
+          "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.",
+          "name": "template",
+          "summary": "Template to use for project creation.",
+          "default": "standard",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "options": [
+            "standard",
+            "empty",
+            "analytics",
+            "reactb2e",
+            "reactb2x"
+          ],
+          "type": "option"
+        },
+        "output-dir": {
+          "aliases": [
+            "outputdir"
+          ],
+          "char": "d",
+          "deprecateAliases": true,
+          "description": "The location can be an absolute path or relative to the current working directory. The default is the current directory.",
+          "name": "output-dir",
+          "summary": "Directory for saving the created files.",
+          "default": ".",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "namespace": {
+          "char": "s",
+          "name": "namespace",
+          "summary": "Namespace associated with this project and any connected scratch orgs.",
+          "default": "",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "default-package-dir": {
+          "aliases": [
+            "defaultpackagedir"
+          ],
+          "char": "p",
+          "deprecateAliases": true,
+          "description": "Metadata items such as classes and Lightning bundles are placed inside this folder.",
+          "name": "default-package-dir",
+          "summary": "Default package directory name.",
+          "default": "force-app",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "manifest": {
+          "char": "x",
+          "description": "Generates a default manifest (package.xml) for fetching Apex, Visualforce, Lightning components, and static resources.",
+          "name": "manifest",
+          "summary": "Generate a manifest (package.xml) for change-set based development.",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "login-url": {
+          "aliases": [
+            "loginurl"
+          ],
+          "char": "l",
+          "deprecateAliases": true,
+          "description": "Normally defaults to https://login.salesforce.com.",
+          "hidden": true,
+          "name": "login-url",
+          "summary": "Salesforce instance login URL.",
+          "default": "https://login.salesforce.com",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "loglevel": {
+          "deprecated": {
+            "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."
+          },
+          "hidden": true,
+          "name": "loglevel",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "api-version": {
+          "description": "Override the api version used for api requests made by this command",
+          "name": "api-version",
+          "summary": "Will set this version as sourceApiVersion in the sfdx-project.json file",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "template:generate:project",
+      "pluginAlias": "@salesforce/plugin-templates",
+      "pluginName": "@salesforce/plugin-templates",
+      "pluginType": "core",
+      "strict": true,
+      "summary": "Generate a Salesforce DX project.",
+      "enableJsonFlag": true,
+      "isESM": true,
+      "relativePath": [
+        "lib",
+        "commands",
+        "template",
+        "generate",
+        "project",
+        "index.js"
+      ],
+      "aliasPermutations": [
+        "force:project:create",
+        "project:force:create",
+        "project:create:force",
+        "force:create:project",
+        "create:force:project",
+        "create:project:force",
+        "project:generate",
+        "generate:project"
+      ],
+      "permutations": [
+        "template:generate:project",
+        "generate:template:project",
+        "generate:project:template",
+        "template:project:generate",
+        "project:template:generate",
+        "project:generate:template"
+      ]
+    },
     "template:generate:webapp": {
       "aliases": [
         "webapp:generate"
@@ -2507,5 +2507,5 @@
       ]
     }
   },
-  "version": "56.10.0"
+  "version": "56.10.2"
 }

package/package.json

@@ -1,24 +1,24 @@
 {
     "name": "@salesforce/plugin-templates",
     "description": "Commands to create metadata from a default or custom template",
-    "version": "56.10.0",
+    "version": "56.10.2",
     "author": "Salesforce",
     "bugs": "https://github.com/salesforcecli/plugin-templates/issues",
     "enableO11y": true,
     "o11yUploadEndpoint": "https://794testsite.my.site.com/byolwr/webruntime/log/metrics",
     "dependencies": {
-        "@salesforce/core": "^8.26.2",
+        "@salesforce/core": "^8.26.3",
         "@salesforce/sf-plugins-core": "^12",
         "@salesforce/templates": "^66.2.1"
     },
     "devDependencies": {
-        "@oclif/plugin-command-snapshot": "^5.3.9",
+        "@oclif/plugin-command-snapshot": "^5.3.10",
         "@salesforce/cli-plugins-testkit": "^5.3.41",
         "@salesforce/dev-scripts": "^11.0.4",
-        "@salesforce/plugin-command-reference": "^3.1.80",
+        "@salesforce/plugin-command-reference": "^3.1.81",
         "@types/yeoman-assert": "^3.1.4",
         "eslint-plugin-sf-plugin": "^1.20.33",
-        "oclif": "^4.22.79",
+        "oclif": "^4.22.81",
         "ts-node": "^10.9.2",
         "typescript": "^5.9.3",
         "yeoman-assert": "^3.1.1"
@@ -249,7 +249,7 @@
     "exports": "./lib/index.js",
     "type": "module",
     "sfdx": {
-        "publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-templates/56.10.0.crt",
-        "signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-templates/56.10.0.sig"
+        "publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-templates/56.10.2.crt",
+        "signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-templates/56.10.2.sig"
     }
 }