Skip to content

Commit 1721e4c

Browse files
Merge refactor-webapp-discovery into feat/vite-proxy-detection
Co-authored-by: Cursor <cursoragent@cursor.com>
2 parents c6b33f8 + 96be9de commit 1721e4c

9 files changed

Lines changed: 765 additions & 809 deletions

File tree

.github/workflows/create-github-release.yml

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
name: create-github-release
22

33
on:
4-
# push:
5-
# branches:
6-
# - main
7-
# - prerelease/**
8-
# tags-ignore:
9-
# - '*'
4+
push:
5+
branches:
6+
- main
7+
- prerelease/**
8+
tags-ignore:
9+
- '*'
1010
workflow_dispatch:
1111
inputs:
1212
prerelease:

.github/workflows/onRelease.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ jobs:
2525
uses: salesforcecli/github-workflows/.github/workflows/npmPublish.yml@main
2626
needs: [getDistTag]
2727
with:
28-
ctc: true
28+
#ctc: true
2929
sign: true
3030
tag: ${{ needs.getDistTag.outputs.tag || 'latest' }}
3131
githubTag: ${{ github.event.release.tag_name || inputs.tag }}

CHANGELOG.md

Lines changed: 11 additions & 742 deletions
Large diffs are not rendered by default.

README.md

Lines changed: 50 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -1,50 +1,10 @@
1-
**NOTE: This template for sf plugins is not yet official. Please consult with the Platform CLI team before using this template.**
1+
# plugin-app-dev
22

3-
# plugin-webapp
4-
5-
[![NPM](https://img.shields.io/npm/v/@salesforce/plugin-webapp.svg?label=@salesforce/plugin-webapp)](https://www.npmjs.com/package/@salesforce/plugin-webapp) [![Downloads/week](https://img.shields.io/npm/dw/@salesforce/plugin-webapp.svg)](https://npmjs.org/package/@salesforce/plugin-webapp) [![License](https://img.shields.io/badge/License-Apache--2.0-blue.svg)](https://opensource.org/license/apache-2-0)
6-
7-
## Using the template
8-
9-
This repository provides a template for creating a plugin for the Salesforce CLI. To convert this template to a working plugin:
10-
11-
1. Please get in touch with the Platform CLI team. We want to help you develop your plugin.
12-
2. Generate your plugin:
13-
14-
```
15-
sf plugins install dev
16-
sf dev generate plugin
17-
18-
git init -b main
19-
git add . && git commit -m "chore: initial commit"
20-
```
21-
22-
3. Create your plugin's repo in the salesforcecli github org
23-
4. When you're ready, replace the contents of this README with the information you want.
24-
25-
## Learn about `sf` plugins
26-
27-
Salesforce CLI plugins are based on the [oclif plugin framework](https://oclif.io/docs/introduction). Read the [plugin developer guide](https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_plugins.meta/sfdx_cli_plugins/cli_plugins_architecture_sf_cli.htm) to learn about Salesforce CLI plugin development.
28-
29-
This repository contains a lot of additional scripts and tools to help with general Salesforce node development and enforce coding standards. You should familiarize yourself with some of the [node developer packages](#tooling) used by Salesforce. There is also a default circleci config using the [release management orb](https://github.com/forcedotcom/npm-release-management-orb) standards.
30-
31-
Additionally, there are some additional tests that the Salesforce CLI will enforce if this plugin is ever bundled with the CLI. These test are included by default under the `posttest` script and it is required to keep these tests active in your plugin if you plan to have it bundled.
32-
33-
### Tooling
34-
35-
- [@salesforce/core](https://github.com/forcedotcom/sfdx-core)
36-
- [@salesforce/kit](https://github.com/forcedotcom/kit)
37-
- [@salesforce/sf-plugins-core](https://github.com/salesforcecli/sf-plugins-core)
38-
- [@salesforce/ts-types](https://github.com/forcedotcom/ts-types)
39-
- [@salesforce/ts-sinon](https://github.com/forcedotcom/ts-sinon)
40-
- [@salesforce/dev-config](https://github.com/forcedotcom/dev-config)
41-
- [@salesforce/dev-scripts](https://github.com/forcedotcom/dev-scripts)
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)
424

435
# Salesforce CLI Webapp Plugin
446

45-
> **Develop web applications with seamless Salesforce integration**
46-
47-
A Salesforce CLI plugin for building and deploying web applications that integrate with Salesforce. This plugin provides tools for local development, packaging, and deployment of webapps with built-in Salesforce authentication.
7+
A Salesforce CLI plugin for building web applications that integrate with Salesforce. This plugin provides tools for local development, packaging, and deployment of webapps with built-in Salesforce authentication.
488

499
This plugin is bundled with the [Salesforce CLI](https://developer.salesforce.com/tools/sfdxcli). For more information on the CLI, read the [getting started guide](https://developer.salesforce.com/docs/atlas.en-us.sfdx_setup.meta/sfdx_setup/sfdx_setup_intro.htm).
5010

@@ -63,12 +23,57 @@ We always recommend using the latest version of these commands bundled with the
6323
- **Health Monitoring**: Displays helpful error pages when dev server is down with auto-refresh
6424
- **Framework Agnostic**: Works with any web framework (React, Vue, Angular, etc.)
6525

66-
---
26+
## Quick Start
27+
28+
1. **Install the plugin:**
29+
30+
```bash
31+
sf plugins install @salesforce/plugin-app-dev
32+
```
33+
34+
2. **Authenticate with Salesforce:**
35+
36+
```bash
37+
sf org login web --alias myorg
38+
```
39+
40+
3. **Create webapplication.json:**
41+
42+
```json
43+
{
44+
"name": "myapp",
45+
"label": "My Web App",
46+
"version": "1.0.0",
47+
"apiVersion": "60.0",
48+
"outputDir": "dist",
49+
"dev": {
50+
"command": "npm run dev"
51+
}
52+
}
53+
```
54+
55+
4. **Start development:**
56+
```bash
57+
sf webapp dev --name myapp --target-org myorg --open
58+
```
59+
60+
## Documentation
61+
62+
📚 **[Complete Guide](SF_WEBAPP_DEV_GUIDE.md)** - Comprehensive documentation covering:
63+
64+
- Overview and architecture
65+
- Getting started (5-minute quick start)
66+
- Building the plugin
67+
- Command usage and options
68+
- File structure and components
69+
- VSCode integration
70+
- Advanced features (hot reload, error capture, etc.)
71+
- Troubleshooting and FAQ
6772

6873
## Install
6974

7075
```bash
71-
sf plugins install @salesforce/plugin-webapp@x.y.z
76+
sf plugins install @salesforce/plugin-app-dev@x.y.z
7277
```
7378

7479
---

0 commit comments

Comments
 (0)