Skip to content

Edit messages for "webapp dev" CLI command#15

Closed
jshackell-sfdc wants to merge 2 commits into
mainfrom
js/edit-messages
Closed

Edit messages for "webapp dev" CLI command#15
jshackell-sfdc wants to merge 2 commits into
mainfrom
js/edit-messages

Conversation

@jshackell-sfdc
Copy link
Copy Markdown

What does this PR do?

Edit messages for "webapp dev" CLI command

What issues does this PR fix or reference?

@-@

nrkruk and others added 2 commits February 3, 2026 18:52
Updated all references to webapp.json across the plugin-webapp codebase to use
webapplication.json, reflecting the new manifest file naming convention.

Changes include:
- Source files (ManifestWatcher, manifest, webappDiscovery, ErrorHandler, DevServerManager, dev.ts)
- Error page template
- CLI messages
- Documentation (README, SF_WEBAPP_DEV_GUIDE)
- Test files and fixtures
@jshackell-sfdc jshackell-sfdc requested a review from nrkruk February 4, 2026 00:46
@jshackell-sfdc jshackell-sfdc requested a review from a team as a code owner February 4, 2026 00:46
Base automatically changed from nkruk/rename-webapp-json-to-webapplication-json to main February 4, 2026 01:53
Comment thread messages/webapp.dev.md
# description

Starts a local development server for a Web Application, using the local project files. This enables rapid development with hot reloading and immediate feedback.
This command starts a local development server so you can preview a web application using the local metadata files in your DX project. Using a local preview helps you quickly develop web applications, because you don't have to continually deploy metadata to your org. It also provides hot reloading; because you don't have to manually refresh, you get immediate feedback about your code changes.
Copy link
Copy Markdown
Contributor

@bpbuch bpbuch Mar 6, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: The dev command does not always provide hot reload.

Our provided application toolchain and templates have hot reload, but there is a proxy mode which is intended to support external frameworks. Hot reload would need to be provided by the external dev server.

Comment thread messages/webapp.dev.md
This command starts a local development server so you can preview a web application using the local metadata files in your DX project. Using a local preview helps you quickly develop web applications, because you don't have to continually deploy metadata to your org. It also provides hot reloading; because you don't have to manually refresh, you get immediate feedback about your code changes.

The command launches a local proxy server that sits between your web application and Salesforce, automatically injecting authentication headers from the CLI's stored tokens. This allows your web app to make authenticated API calls to Salesforce without exposing credentials.
The command also launches a local proxy server that sits between your web application and Salesforce, automatically injecting authentication headers from Salesforce CLI's stored tokens. The proxy server allows your web app to make authenticated API calls to Salesforce without exposing credentials. When opening a browser to view the web application, you connect to the proxy server and not the development server.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: When running with our toolchain (templates integrated with Vite), the proxy is part of the dev server. Only one server will be running. When running with a custom toolchain, there will be two servers (proxy and custom dev server).

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@bpbuch , please just update (and then merge) the help as needed! I just did an editing pass, and sometimes I add stuff that, well, isn't correct. Sorry about that. I'll assume that you all will make the fixes and merge, okay?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants