@salesforce/plugin-templates 55.3.0 → 55.4.1

package/messages/lightning.md

@@ -0,0 +1,27 @@
+# summary
+
+Generate a Lightning %s.
+
+# description
+
+Generates a Lightning %s bundle in the specified directory or the current working directory. The bundle consists of multiple files in a folder with the designated name.
+
+# flags.name
+
+Name of the generated Lightning %s.
+
+# flags.name.description
+
+The name can be up to 40 characters and must start with a letter.
+
+# flags.internal
+
+Generate lightning bundles without creating a -meta.xml file.
+
+# flags.template
+
+Template to use for file creation.
+
+# flags.template.description
+
+Supplied parameter values or default values are filled into a copy of the template.

package/messages/lightningApp.md

@@ -0,0 +1,9 @@
+# examples
+
+- Generate the metadata files for a Lightning app bundle called "myapp" in the current directory:
+
+  <%= config.bin %> <%= command.id %> --name myapp
+
+- Similar to the previous example, but generate the files in the "force-app/main/default/aura" directory:
+
+  <%= config.bin %> <%= command.id %> --name myapp --output-dir force-app/main/default/aura

package/messages/lightningCmp.md

@@ -0,0 +1,31 @@
+# examples
+
+- Generate the metadata files for an Aura component bundle in the current directory:
+
+  <%= config.bin %> <%= command.id %> --name mycomponent
+
+- Generate a Lightning web component bundle in the current directory:
+
+  <%= config.bin %> <%= command.id %> --name mycomponent --type lwc
+
+- Generate an Aura component bundle in the "force-app/main/default/aura" directory:
+
+  <%= config.bin %> <%= command.id %> --name mycomponent --output-dir force-app/main/default/aura
+
+- Generate a Lightning web component bundle in the "force-app/main/default/lwc" directory:
+
+  <%= config.bin %> <%= command.id %> --name mycomponent --type lwc --output-dir force-app/main/default/lwc
+
+# summary
+
+Generate a bundle for an Aura component or a Lightning web component.
+
+# description
+
+Generates the bundle in the specified directory or the current working directory. The bundle consists of multiple files in a directory with the designated name.  Lightning web components are contained in the directory with name "lwc", Aura components in "aura".
+
+To generate a Lightning web component, pass "--type lwc" to the command. If you don’t specify --type, Salesforce CLI generates an Aura component by default.
+
+# flags.type
+
+Type of the component bundle.

package/messages/lightningEvent.md

@@ -0,0 +1,9 @@
+# examples
+
+- Generate the metadata files for a Lightning event bundle called "myevent" in the current directory:
+
+  <%= config.bin %> <%= command.id %> --name myevent
+ 
+- Similar to previous example, but generate the files in the "force-app/main/default/aura" directory:
+
+  <%= config.bin %> <%= command.id %> --name myevent --output-dir force-app/main/default/aura

package/messages/lightningInterface.md

@@ -0,0 +1,9 @@
+# examples
+
+- Generate the metadata files for a Lightning interface bundle called "myinterface" in the current directory:
+
+  <%= config.bin %> <%= command.id %> --name myinterface
+
+- Similar to the previous example but generate the files in the "force-app/main/default/aura" directory:
+
+  <%= config.bin %> <%= command.id %> --name myinterface --output-dir force-app/main/default/aura

package/messages/lightningTest.md

@@ -0,0 +1,21 @@
+# examples
+
+- Generate the metadata files for the Lightning test called MyLightningTest in the current directory:
+
+  <%= config.bin %> <%= command.id %> --name MyLightningTest
+
+- Similar to the previous example but generate the files in the "force-app/main/default/lightningTests" directory:
+
+  <%= config.bin %> <%= command.id %> --name MyLightningTest --output-dir force-app/main/default/lightningTests
+
+# summary
+
+Generate a Lightning test.
+
+# description
+
+Generates the test in the specified directory or the current working directory. The .resource file and associated metadata file are generated.
+
+# flags.name.description
+
+Name of the new Lightning test; can be up to 40 characters and must start with a letter.

package/messages/messages.md

@@ -0,0 +1,43 @@
+# flags.outputdir
+
+Directory for saving the created files.
+
+# flags.outputdir.description
+
+The location can be an absolute path or relative to the current working directory. The default is the current directory.
+
+# flags.outputdirLighting.description
+
+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.
+
+# flags.template
+
+Template to use for file creation.
+
+# flags.template.description
+
+Supplied parameter values or default values are filled into a copy of the template.
+
+# TargetDirOutput
+
+target dir = %s
+
+# MissingAuraFolder
+
+Lightning bundles must have a parent folder named 'aura'.
+
+# MissingLightningComponentTemplate
+
+Template %s not available for component type %s.
+
+# MissingLWCFolder
+
+Lightning bundles must have a parent folder named 'lwc'.
+
+# InvalidTemplate
+
+Expected --template=foo to be one of:
+
+# StandardReadMe
+
+Now that you’ve created a Salesforce DX project, what’s next?

package/messages/project.md

@@ -0,0 +1,87 @@
+# summary
+
+Generate a Salesforce DX project.
+
+# 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.
+
+By 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":
+
+  <%= config.bin %> <%= command.id %> --name mywork
+
+- Similar to previous example, but generate the files in a directory called "myapp":
+
+  <%= config.bin %> <%= command.id %> --name mywork --default-package-dir myapp
+
+- Similar to prevoius example, but also generate a default package.xml manifest file:
+
+  <%= config.bin %> <%= command.id %> --name mywork --default-package-dir myapp --manifest
+
+- Generate a project with the minimum files and directories:
+
+  <%= config.bin %> <%= command.id %> --name mywork --template empty
+
+# flags.name
+
+Name of the generated project.
+
+# flags.name.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.
+
+# flags.template
+
+Template to use for project creation.
+
+# flags.template.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.
+
+- .forceignore
+- config/project-scratch-def.json
+- sfdx-project.json
+- package.json
+- force-app (basic source directory structure)
+
+The 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:
+
+- .gitignore: Use Git for version control.
+- .prettierrc and .prettierignore: Use Prettier to format your Aura components.
+- .vscode/extensions.json: When launched, Visual Studio Code, prompts you to install the recommended extensions for your project.
+- .vscode/launch.json: Configures Replay Debugger.
+- .vscode/settings.json: Additional configuration settings.
+
+The analytics template provides similar files and the force-app/main/default/waveTemplates directory.
+
+# flags.namespace
+
+Namespace associated with this project and any connected scratch orgs.
+
+# flags.packagedir
+
+Default package directory name.
+
+# flags.packagedir.description
+
+Metadata items such as classes and Lightning bundles are placed inside this folder.
+
+# flags.manifest
+
+Generate a manifest (package.xml) for change-set based development.
+
+# flags.manifest.description
+
+Generates a default manifest (package.xml) for fetching Apex, Visualforce, Lightning components, and static resources.
+
+# flags.loginurl
+
+Salesforce instance login URL.
+
+# flags.loginurl.description
+
+Normally defaults to https://login.salesforce.com.

package/messages/staticResource.md

@@ -0,0 +1,37 @@
+# summary
+
+Generate a static resource.
+
+# description
+
+Generates the metadata resource file in the specified directory or the current working directory. Static resource files must be contained in a parent directory called "staticresources" 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.
+
+# examples
+
+- Generate the metadata file for a static resource called MyResource in the current directory:
+
+  <%= config.bin %> <%= command.id %> --name MyResource
+
+- Similar to previous example, but specifies a MIME type of application/json:
+
+  <%= config.bin %> <%= command.id %> --name MyResource --type application/json
+
+- Generate the resource file in the "force-app/main/default/staticresources" directory:
+
+  <%= config.bin %> <%= command.id %> --name MyResource --output-dir force-app/main/default/staticresources
+
+# flags.name.summary
+
+Name of the generated static resource.
+
+# flags.name.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.
+
+# flags.type.summary
+
+Content type (mime type) of the generated static resource.
+
+# flags.type.description
+
+Must be a valid MIME type such as application/json, application/javascript, application/zip, text/plain, text/css, etc.

package/messages/vf.md

@@ -0,0 +1,39 @@
+# summary
+
+Generate a Visualforce %s.
+
+# description
+
+The command generates the .%s file and associated metadata file in the specified directory or the current working directory by default.
+
+# flags.name
+
+Name of the generated Visualforce %s.
+
+# flags.name.description
+
+The name can be up to 40 characters and must start with a letter.
+
+# flags.label
+
+Visualforce %s label.
+
+# examples.component
+
+- Generate the metadata files for a Visualforce component in the current directory:
+
+  <%= config.bin %> <%= command.id %> --name mycomponent --label mylabel
+
+- Similar to previous example, but generate the files in the directory "force-app/main/default/components":
+
+  <%= config.bin %> <%= command.id %> --name mycomponent --label mylabel --output-dir components
+
+# examples.page
+
+- Generate the metadata files for a Visualforce page in the current directory:
+
+  <%= config.bin %> <%= command.id %> --name mypage --label mylabel
+
+- Similar to previous example, but generate the files in the directory "force-app/main/default/pages":
+
+  <%= config.bin %> <%= command.id %> --name mypage --label mylabel --output-dir pages