Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
79 changes: 44 additions & 35 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ $ npm install -g @salesforce/cli
$ sf COMMAND
running command...
$ sf (--version|-v)
@salesforce/cli/2.130.5 linux-x64 node-v22.22.1
@salesforce/cli/2.130.6 linux-x64 node-v22.22.1
$ sf --help [COMMAND]
USAGE
$ sf COMMAND
Expand Down Expand Up @@ -9773,7 +9773,7 @@ FLAG DESCRIPTIONS
directory.
```

_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.13.1/src/commands/template/generate/analytics/template.ts)_
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.13.3/src/commands/template/generate/analytics/template.ts)_

## `sf template generate apex class`

Expand Down Expand Up @@ -9833,7 +9833,7 @@ FLAG DESCRIPTIONS
Supplied parameter values or default values are filled into a copy of the template.
```

_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.13.1/src/commands/template/generate/apex/class.ts)_
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.13.3/src/commands/template/generate/apex/class.ts)_

## `sf template generate apex trigger`

Expand Down Expand Up @@ -9903,7 +9903,7 @@ FLAG DESCRIPTIONS
Supplied parameter values or default values are filled into a copy of the template.
```

_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.13.1/src/commands/template/generate/apex/trigger.ts)_
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.13.3/src/commands/template/generate/apex/trigger.ts)_

## `sf template generate digital-experience site`

Expand Down Expand Up @@ -9957,7 +9957,7 @@ FLAG DESCRIPTIONS
project, defaults to the current directory.
```

_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.13.1/src/commands/template/generate/digital-experience/site.ts)_
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.13.3/src/commands/template/generate/digital-experience/site.ts)_

## `sf template generate flexipage`

Expand Down Expand Up @@ -10039,7 +10039,7 @@ FLAG DESCRIPTIONS
'Custom_Object__c'. This sets the `sobjectType` field in the FlexiPage metadata.
```

_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.13.1/src/commands/template/generate/flexipage/index.ts)_
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.13.3/src/commands/template/generate/flexipage/index.ts)_

## `sf template generate lightning app`

Expand Down Expand Up @@ -10095,7 +10095,7 @@ FLAG DESCRIPTIONS
Supplied parameter values or default values are filled into a copy of the template.
```

_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.13.1/src/commands/template/generate/lightning/app.ts)_
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.13.3/src/commands/template/generate/lightning/app.ts)_

## `sf template generate lightning component`

Expand Down Expand Up @@ -10165,7 +10165,7 @@ FLAG DESCRIPTIONS
Supplied parameter values or default values are filled into a copy of the template.
```

_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.13.1/src/commands/template/generate/lightning/component.ts)_
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.13.3/src/commands/template/generate/lightning/component.ts)_

## `sf template generate lightning event`

Expand Down Expand Up @@ -10221,7 +10221,7 @@ FLAG DESCRIPTIONS
Supplied parameter values or default values are filled into a copy of the template.
```

_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.13.1/src/commands/template/generate/lightning/event.ts)_
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.13.3/src/commands/template/generate/lightning/event.ts)_

## `sf template generate lightning interface`

Expand Down Expand Up @@ -10277,7 +10277,7 @@ FLAG DESCRIPTIONS
Supplied parameter values or default values are filled into a copy of the template.
```

_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.13.1/src/commands/template/generate/lightning/interface.ts)_
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.13.3/src/commands/template/generate/lightning/interface.ts)_

## `sf template generate lightning test`

Expand Down Expand Up @@ -10333,7 +10333,7 @@ FLAG DESCRIPTIONS
Supplied parameter values or default values are filled into a copy of the template.
```

_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.13.1/src/commands/template/generate/lightning/test.ts)_
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.13.3/src/commands/template/generate/lightning/test.ts)_

## `sf template generate project`

Expand Down Expand Up @@ -10446,7 +10446,7 @@ FLAG DESCRIPTIONS
Override the api version used for api requests made by this command
```

_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.13.1/src/commands/template/generate/project/index.ts)_
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.13.3/src/commands/template/generate/project/index.ts)_

## `sf template generate static-resource`

Expand Down Expand Up @@ -10509,22 +10509,22 @@ FLAG DESCRIPTIONS
etc.
```

_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.13.1/src/commands/template/generate/static-resource/index.ts)_
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.13.3/src/commands/template/generate/static-resource/index.ts)_

## `sf template generate ui-bundle`

Generate a UI bundle.
Generate a UI bundle, which contains the code and metadata to build a UI experience that uses non-native Salesforce frameworks, such as React.

```
USAGE
$ sf template generate ui-bundle -n <value> [--json] [--flags-dir <value>] [-t default|reactbasic] [-l <value>] [-d <value>]
[--api-version <value>]

FLAGS
-d, --output-dir=<value> Directory for saving the created files.
-d, --output-dir=<value> Directory into which the files are created.
-l, --label=<value> Master label for the UI bundle.
-n, --name=<value> (required) Name of the generated UI bundle.
-t, --template=<option> [default: default] Template to use for file creation.
-n, --name=<value> (required) API name of the generated UI bundle.
-t, --template=<option> [default: default] Template to use when creating the files for a specific UI framework.
<options: default|reactbasic>
--api-version=<value> Override the api version used for api requests made by this command

Expand All @@ -10533,12 +10533,20 @@ GLOBAL FLAGS
--json Format output as json.

DESCRIPTION
Generate a UI bundle.
Generate a UI bundle, which contains the code and metadata to build a UI experience that uses non-native Salesforce
frameworks, such as React.

Salesforce provides native UI frameworks, such as Lighting Web Components (LWC), to build applications that run on the
Salesforce Platform. But you can also use non-native JavaScript- or TypeScript-based UI frameworks, such as React, to
build a UI experience for the Salesforce Platform and that you can launch from the App Launcher.

These non-native UI experiences are defined by the "UIBundle" metadata type in your DX project. Use this command to
generate the required DX project structure and files. For example, when you run this command and specify the name
MyUiBundle, then the files are generated into a "uiBundles/MyUiBundle" directory. Use the --output-dir flag to specify
a different directory.

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.
Use the --template flag for generating the files to get started with a speciic UI framework, such as React. Check out
the README.md file in the generated "uiBundles/<bundlename>" directory for more information about the template.

ALIASES
$ sf ui-bundle generate
Expand All @@ -10552,42 +10560,43 @@ EXAMPLES

$ sf template generate ui-bundle --name MyReactApp --template reactbasic

Generate the UI bundle in the "force-app/main/default/uiBundles" directory:
Generate the React-based UI bundle in the "force-app/main/default/uiBundles" directory:

$ sf template generate ui-bundle --name MyUiBundle --output-dir force-app/main/default/uiBundles
$ sf template generate ui-bundle --name MyUiBundle --template reactbasic --output-dir \
force-app/main/default/uiBundles

FLAG DESCRIPTIONS
-d, --output-dir=<value> Directory for saving the created files.
-d, --output-dir=<value> Directory into which the files are created.

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>".
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.

**Important:** This command 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.

-l, --label=<value> Master label for the UI bundle.

If not specified, the label is derived from the name.

-n, --name=<value> Name of the generated UI bundle.
-n, --name=<value> API name of the generated UI bundle.

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.

-t, --template=default|reactbasic Template to use for file creation.
-t, --template=default|reactbasic Template to use when creating the files for a specific UI framework.

Supplied parameter values or default values are filled into a copy of the template.
```

_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.13.1/src/commands/template/generate/ui-bundle/index.ts)_
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.13.3/src/commands/template/generate/ui-bundle/index.ts)_

## `sf template generate visualforce component`

Expand Down Expand Up @@ -10644,7 +10653,7 @@ FLAG DESCRIPTIONS
Supplied parameter values or default values are filled into a copy of the template.
```

_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.13.1/src/commands/template/generate/visualforce/component.ts)_
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.13.3/src/commands/template/generate/visualforce/component.ts)_

## `sf template generate visualforce page`

Expand Down Expand Up @@ -10695,7 +10704,7 @@ FLAG DESCRIPTIONS
The name can be up to 40 characters and must start with a letter.
```

_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.13.1/src/commands/template/generate/visualforce/page.ts)_
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.13.3/src/commands/template/generate/visualforce/page.ts)_

## `sf update [CHANNEL]`

Expand Down
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@salesforce/cli",
"description": "The Salesforce CLI",
"version": "2.130.5",
"version": "2.130.6",
"author": "Salesforce",
"bin": {
"sf": "./bin/run.js",
Expand Down Expand Up @@ -173,7 +173,7 @@
"@salesforce/plugin-settings": "2.4.63",
"@salesforce/plugin-sobject": "1.4.93",
"@salesforce/plugin-telemetry": "3.8.7",
"@salesforce/plugin-templates": "56.13.1",
"@salesforce/plugin-templates": "56.13.3",
"@salesforce/plugin-trust": "3.7.119",
"@salesforce/plugin-user": "3.8.2",
"@salesforce/sf-plugins-core": "12.2.6",
Expand Down
18 changes: 9 additions & 9 deletions yarn.lock
Original file line number Diff line number Diff line change
Expand Up @@ -2442,14 +2442,14 @@
"@salesforce/ts-types" "^2.0.12"
debug "^4.4.3"

"@salesforce/plugin-templates@56.13.1":
version "56.13.1"
resolved "https://registry.yarnpkg.com/@salesforce/plugin-templates/-/plugin-templates-56.13.1.tgz#d6b1723f18008cbe741c3b89ee52b78ce463cb0c"
integrity sha512-36kvEcg/6R11KI35PBL6xPqCWQIgHqjUuBoPaAoZk/5OPvGpxf4beWV8YwToO31Xrcx+jyeJDh1pegxTy0Rm2w==
"@salesforce/plugin-templates@56.13.3":
version "56.13.3"
resolved "https://registry.yarnpkg.com/@salesforce/plugin-templates/-/plugin-templates-56.13.3.tgz#f565851352cdafbe4c41e5b078f08bdf664315f0"
integrity sha512-qF6CXxc1Gl0i0UGpc1OxAzJgnvnGRqL+DwpNuj7TMAoPU8nsKIqzZNPUD0bLf+L7T4NPWIFWvM7lTfmxduOE8g==
dependencies:
"@salesforce/core" "^8.27.1"
"@salesforce/sf-plugins-core" "^12"
"@salesforce/templates" "^66.7.2"
"@salesforce/templates" "^66.7.4"

"@salesforce/plugin-trust@3.7.119", "@salesforce/plugin-trust@^3.7.69":
version "3.7.119"
Expand Down Expand Up @@ -2569,10 +2569,10 @@
o11y_schema "^260.52.0"
proxy-agent "^6.5.0"

"@salesforce/templates@^66.7.2":
version "66.7.3"
resolved "https://registry.yarnpkg.com/@salesforce/templates/-/templates-66.7.3.tgz#2be7889393a4b81744c5de6e40609888bb413741"
integrity sha512-E7VKG94RessXcbaF7IdNft5L+VY8+3DJUkI3svhQgsdoDMKLhX1hvumSLztUL6RKkjFeRt5nl+baq8MeDkI9bQ==
"@salesforce/templates@^66.7.4":
version "66.7.4"
resolved "https://registry.yarnpkg.com/@salesforce/templates/-/templates-66.7.4.tgz#bd4d69c08084535822e111dd94912a0a93e5551f"
integrity sha512-nELEovHB5ZAGQCp9Kn7WkTCslM5RvyqPZbES78hvKlidxWSWhIYamnRmjmJpsH0VVTK/Z6serEHGUwS1QurETw==
dependencies:
"@salesforce/kit" "^3.2.4"
ejs "^3.1.10"
Expand Down
Loading