-
Notifications
You must be signed in to change notification settings - Fork 13
refactor: rename webapp command to ui-bundle #894
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from all commits
f86dc7e
81f5ac0
541a7d9
0543783
28894e1
dc6fa3b
3e6c63e
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|
@@ -30,6 +30,7 @@ Command structure: | |||||||||||||
| src/commands/template/generate/{metadataType}/ | ||||||||||||||
|
|
||||||||||||||
| Files: | ||||||||||||||
|
|
||||||||||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||||||
| - index.ts → top-level generator | ||||||||||||||
| - {subTemplate}.ts → nested generator | ||||||||||||||
|
|
||||||||||||||
|
|
@@ -38,6 +39,7 @@ Naming pattern: | |||||||||||||
| sf template generate {metadataType} {optionalSubTemplate} | ||||||||||||||
|
|
||||||||||||||
| Examples: | ||||||||||||||
|
|
||||||||||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||||||
| - sf template generate flexipage | ||||||||||||||
| - sf template generate digital-experience site | ||||||||||||||
|
|
||||||||||||||
|
|
@@ -92,13 +94,13 @@ Only GA commands require permanent backwards compatibility. | |||||||||||||
| All generators should call: | ||||||||||||||
|
|
||||||||||||||
| runGenerator({ | ||||||||||||||
| templateType: TemplateType.X, | ||||||||||||||
| opts: flags, | ||||||||||||||
| ux | ||||||||||||||
| templateType: TemplateType.X, | ||||||||||||||
| opts: flags, | ||||||||||||||
| ux | ||||||||||||||
|
Comment on lines
+97
to
+99
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||||||
| }) | ||||||||||||||
|
|
||||||||||||||
| --- | ||||||||||||||
|
|
||||||||||||||
| ## Reference Docs | ||||||||||||||
|
|
||||||||||||||
| Use official Salesforce CLI docs when needed. | ||||||||||||||
| Use official Salesforce CLI docs when needed. | ||||||||||||||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,62 @@ | ||
| # summary | ||
|
|
||
| Generate a UI bundle. | ||
|
|
||
| # description | ||
|
|
||
| Generates a UI bundle in the specified directory or the current working directory. The UI bundle files are created in a folder with the designated name. UI bundle files must be contained in a parent directory called "uiBundles" 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 a UI bundle called MyUiBundle in the current directory: | ||
|
|
||
| <%= config.bin %> <%= command.id %> --name MyUiBundle | ||
|
|
||
| - Generate a React-based UI bundle: | ||
|
|
||
| <%= config.bin %> <%= command.id %> --name MyReactApp --template reactbasic | ||
|
|
||
| - Generate the UI bundle in the "force-app/main/default/uiBundles" directory: | ||
|
|
||
| <%= config.bin %> <%= command.id %> --name MyUiBundle --output-dir force-app/main/default/uiBundles | ||
|
|
||
| # flags.name.summary | ||
|
|
||
| Name of the generated UI bundle. | ||
|
|
||
| # 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.template.summary | ||
|
|
||
| Template to use for file creation. | ||
|
|
||
| # flags.template.description | ||
|
|
||
| Supplied parameter values or default values are filled into a copy of the template. | ||
|
|
||
| # flags.label.summary | ||
|
|
||
| Master label for the UI bundle. | ||
|
|
||
| # flags.label.description | ||
|
|
||
| If not specified, the label is derived from the name. | ||
|
|
||
| # flags.output-dir.summary | ||
|
|
||
| Directory for saving the created files. | ||
|
|
||
| # flags.output-dir.description | ||
|
|
||
| The location can be an absolute path or relative to the current working directory. | ||
|
|
||
| **Important:** The generator automatically ensures the output directory ends with "uiBundles". If your specified path doesn't end with "uiBundles", it's automatically appended. The UI bundle is created at "<output-dir>/<name>". | ||
|
|
||
| **Examples:** | ||
|
|
||
| - "--output-dir force-app/main/default" → Creates a UI bundle at "force-app/main/default/uiBundles/MyUiBundle/" | ||
| - "--output-dir force-app/main/default/uiBundles" → Creates a UI bundle at "force-app/main/default/uiBundles/MyUiBundle/" (no change) | ||
|
|
||
| If not specified, the command reads your sfdx-project.json and defaults to "uiBundles" directory within your default package directory. When running outside a Salesforce DX project, defaults to the current directory. |
This file was deleted.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't think we need to update this skill with the rename.