Skip to content

Commit 21b892a

Browse files
refactor: rename webapp dev command and plugin to ui-bundle
Rename `sf webapp dev` command to `sf ui-bundle dev` and update plugin identity: - Rename src/commands/webapp/dev.ts to src/commands/ui-bundle/dev.ts - Rename messages/webapp.dev.md to messages/ui-bundle.dev.md - Rename schemas/webapp-dev.json to schemas/ui-bundle-dev.json - Rename SF_WEBAPP_DEV_GUIDE.md to SF_UI_BUNDLE_DEV_GUIDE.md - Rename test/commands/webapp/ to test/commands/ui-bundle/ - Rename plugin from @salesforce/plugin-app-dev to @salesforce/plugin-ui-bundle-dev - Update command-snapshot.json: webapp:dev → ui-bundle:dev - Update package.json: topics webapp → ui-bundle, homepage and repository URLs - Update webappDiscovery.ts: path segment and folder constant webui → uiBundles - Update COMMANDS.md and README.md with ui-bundle command and package references - Update src/proxy/ProxyServer.ts with associated changes W-21575874 Made-with: Cursor
1 parent f9647e1 commit 21b892a

21 files changed

Lines changed: 505 additions & 487 deletions

.env.template

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
#
44
# Option A: AUTH_URL (simplest — recommended for getting started)
55
# 1. sf org login web --alias nut-org
6-
# 2. sf org display -o nut-org --json | jq -r .result.sfdxAuthUrl
6+
# 2. sf org display -o nut-org --verbose --json | jq -r .result.sfdxAuthUrl
77
# 3. Paste the value below
88
# TESTKIT_AUTH_URL=
99

COMMANDS.md

Lines changed: 22 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -2,43 +2,47 @@
22

33
<!-- commands -->
44

5-
- [`sf webapp dev`](#sf-webapp-dev)
5+
- [`sf ui-bundle dev`](#sf-webui-dev)
66

7-
## `sf webapp dev`
7+
## `sf ui-bundle dev`
88

9-
Preview a web app locally without needing to deploy
9+
Start a local development proxy server for webui ui-bundle development with Salesforce authentication.
1010

1111
```
1212
USAGE
13-
$ sf webapp dev -n <value> [--json] [--flags-dir <value>] [-t <value>] [-p <value>]
13+
$ sf ui-bundle dev -n <value> -o <value> [--json] [--flags-dir <value>] [-u <value>] [-p <value>] [--open]
1414
15-
FLAGS
16-
-n, --name=<value> (required) Identifies the Web Application
17-
-p, --port=<value> [default: 5173] Port for the dev server
18-
-t, --target=<value> Selects which Web Application target to use for the preview (e.g., Lightning App, Site)
15+
REQUIRED FLAGS
16+
-n, --name=<value> Name of the webapp (must match webapplication.json)
17+
-o, --target-org=<value> Salesforce org to authenticate against
18+
19+
OPTIONAL FLAGS
20+
-u, --url=<value> Dev server URL. Command mode: override default 5173. URL-only: required (server must be running)
21+
-p, --port=<value> Proxy server port (default: 4545)
22+
--open Open browser automatically
1923
2024
GLOBAL FLAGS
2125
--flags-dir=<value> Import flag values from a directory.
2226
--json Format output as json.
2327
2428
DESCRIPTION
25-
Preview a web app locally without needing to deploy
26-
27-
Starts a local development server for a Web Application, using the local project files. This enables rapid
28-
development with hot reloading and immediate feedback.
29+
Starts a local HTTP proxy that injects Salesforce authentication and routes
30+
requests between your dev server and Salesforce APIs. In command mode,
31+
spawns and monitors the dev server (default URL: localhost:5173). In
32+
URL-only mode, connects to an already-running dev server.
2933
3034
EXAMPLES
31-
Start the development server:
35+
Command mode (CLI starts dev server, default port 5173):
3236
33-
$ sf webapp dev --name myWebApp
37+
$ sf ui-bundle dev --name myapp --target-org myorg --open
3438
35-
Start the development server with a specific target:
39+
URL-only mode (dev server already running):
3640
37-
$ sf webapp dev --name myWebApp --target "LightningApp"
41+
$ sf ui-bundle dev --name myapp --target-org myorg --url http://localhost:5173 --open
3842
39-
Start the development server on a custom port:
43+
Custom proxy port:
4044
41-
$ sf webapp dev --name myWebApp --port 8080
45+
$ sf ui-bundle dev --name myapp --target-org myorg --port 8080 --open
4246
```
4347

4448
<!-- commandsstop -->

README.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# plugin-app-dev
1+
# plugin-ui-bundle-dev
22

3-
[![NPM](https://img.shields.io/npm/v/@salesforce/plugin-app-dev.svg?label=@salesforce/plugin-app-dev)](https://www.npmjs.com/package/@salesforce/plugin-app-dev) [![Downloads/week](https://img.shields.io/npm/dw/@salesforce/plugin-app-dev.svg)](https://npmjs.org/package/@salesforce/plugin-app-dev) [![License](https://img.shields.io/badge/License-Apache--2.0-blue.svg)](https://opensource.org/license/apache-2-0)
3+
[![NPM](https://img.shields.io/npm/v/@salesforce/plugin-ui-bundle-dev.svg?label=@salesforce/plugin-ui-bundle-dev)](https://www.npmjs.com/package/@salesforce/plugin-ui-bundle-dev) [![Downloads/week](https://img.shields.io/npm/dw/@salesforce/plugin-ui-bundle-dev.svg)](https://npmjs.org/package/@salesforce/plugin-ui-bundle-dev) [![License](https://img.shields.io/badge/License-Apache--2.0-blue.svg)](https://opensource.org/license/apache-2-0)
44

55
# Salesforce CLI App Dev Plugin
66

@@ -24,7 +24,7 @@ We always recommend using the latest version of these commands bundled with the
2424
1. **Install the plugin:**
2525

2626
```bash
27-
sf plugins install @salesforce/plugin-app-dev
27+
sf plugins install @salesforce/plugin-ui-bundle-dev
2828
```
2929

3030
2. **Authenticate with Salesforce:**
@@ -50,12 +50,12 @@ We always recommend using the latest version of these commands bundled with the
5050

5151
4. **Start development:**
5252
```bash
53-
sf webapp dev --name myapp --target-org myorg --open
53+
sf ui-bundle dev --name myapp --target-org myorg --open
5454
```
5555

5656
## Documentation
5757

58-
📚 **[Complete Guide](SF_WEBAPP_DEV_GUIDE.md)** - Comprehensive documentation covering:
58+
📚 **[Complete Guide](SF_UI_BUNDLE_DEV_GUIDE.md)** - Comprehensive documentation covering:
5959

6060
- Overview and architecture
6161
- Getting started (5-minute quick start)
@@ -69,7 +69,7 @@ We always recommend using the latest version of these commands bundled with the
6969
## Install
7070

7171
```bash
72-
sf plugins install @salesforce/plugin-app-dev@x.y.z
72+
sf plugins install @salesforce/plugin-ui-bundle-dev@x.y.z
7373
```
7474

7575
## Issues
@@ -101,7 +101,7 @@ To build the plugin locally, make sure to have yarn installed and run the follow
101101

102102
```bash
103103
# Clone the repository
104-
git clone git@github.com:salesforcecli/plugin-app-dev
104+
git clone git@github.com:salesforcecli/plugin-ui-bundle-dev
105105

106106
# Install the dependencies and compile
107107
yarn && yarn build
@@ -125,9 +125,9 @@ sf plugins
125125

126126
## Commands
127127

128-
### `sf webapp dev`
128+
### `sf ui-bundle dev`
129129

130-
Start a local development proxy server for webapp development with Salesforce authentication.
130+
Start a local development proxy server for ui-bundle development with Salesforce authentication.
131131

132132
**Two operating modes:**
133133

@@ -136,7 +136,7 @@ Start a local development proxy server for webapp development with Salesforce au
136136

137137
```bash
138138
USAGE
139-
$ sf webapp dev --name <webapp-name> --target-org <org-alias> [options]
139+
$ sf ui-bundle dev --name <webapp-name> --target-org <org-alias> [options]
140140

141141
REQUIRED FLAGS
142142
-n, --name=<value> Name of the webapp (must match webapplication.json)
@@ -156,18 +156,18 @@ DESCRIPTION
156156
EXAMPLES
157157
Command mode (CLI starts dev server, default port 5173):
158158

159-
$ sf webapp dev --name myapp --target-org myorg --open
159+
$ sf ui-bundle dev --name myapp --target-org myorg --open
160160

161161
URL-only mode (dev server already running):
162162

163-
$ sf webapp dev --name myapp --target-org myorg --url http://localhost:5173 --open
163+
$ sf ui-bundle dev --name myapp --target-org myorg --url http://localhost:5173 --open
164164

165165
Custom proxy port:
166166

167-
$ sf webapp dev --name myapp --target-org myorg --port 8080 --open
167+
$ sf ui-bundle dev --name myapp --target-org myorg --port 8080 --open
168168

169169
SEE ALSO
170-
- Complete Guide: SF_WEBAPP_DEV_GUIDE.md
170+
- Complete Guide: SF_UI_BUNDLE_DEV_GUIDE.md
171171
```
172172

173173
<!-- commandsstop -->

0 commit comments

Comments
 (0)