Skip to content

Commit e6639e6

Browse files
committed
chore: readme updates
1 parent 69dd550 commit e6639e6

File tree

2 files changed

+38
-39
lines changed

2 files changed

+38
-39
lines changed

PLUGIN_TEMPLATE.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
## Using the template
2+
3+
This repository provides a template for creating a plugin for the Salesforce CLI. To convert this template to a working plugin:
4+
5+
1. Please get in touch with the Platform CLI team. We want to help you develop your plugin.
6+
2. Generate your plugin:
7+
8+
```
9+
sf plugins install dev
10+
sf dev generate plugin
11+
12+
git init -b main
13+
git add . && git commit -m "chore: initial commit"
14+
```
15+
16+
3. Create your plugin's repo in the salesforcecli github org
17+
4. When you're ready, replace the contents of this README with the information you want.
18+
19+
## Learn about `sf` plugins
20+
21+
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.
22+
23+
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.
24+
25+
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.
26+
27+
### Tooling
28+
29+
- [@salesforce/core](https://github.com/forcedotcom/sfdx-core)
30+
- [@salesforce/kit](https://github.com/forcedotcom/kit)
31+
- [@salesforce/sf-plugins-core](https://github.com/salesforcecli/sf-plugins-core)
32+
- [@salesforce/ts-types](https://github.com/forcedotcom/ts-types)
33+
- [@salesforce/ts-sinon](https://github.com/forcedotcom/ts-sinon)
34+
- [@salesforce/dev-config](https://github.com/forcedotcom/dev-config)
35+
- [@salesforce/dev-scripts](https://github.com/forcedotcom/dev-scripts)
36+
37+
# Everything past here is only a suggestion as to what should be in your specific plugin's description

README.md

Lines changed: 1 addition & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
**NOTE: This template for sf plugins is not yet official. Please consult with the Platform CLI team before using this template.**
2-
31
# plugin-lightning-dev
42

53
[![NPM](https://img.shields.io/npm/v/@salesforce/plugin-lightning-dev.svg?label=@salesforce/plugin-lightning-dev)](https://www.npmjs.com/package/@salesforce/plugin-lightning-dev) [![Downloads/week](https://img.shields.io/npm/dw/@salesforce/plugin-lightning-dev.svg)](https://npmjs.org/package/@salesforce/plugin-lightning-dev) [![License](https://img.shields.io/badge/License-BSD%203--Clause-brightgreen.svg)](https://raw.githubusercontent.com/salesforcecli/plugin-lightning-dev/main/LICENSE.txt)
@@ -43,43 +41,7 @@ yarn && yarn build
4341
yarn update-snapshots
4442
```
4543

46-
## Using the template
47-
48-
This repository provides a template for creating a plugin for the Salesforce CLI. To convert this template to a working plugin:
49-
50-
1. Please get in touch with the Platform CLI team. We want to help you develop your plugin.
51-
2. Generate your plugin:
52-
53-
```
54-
sf plugins install dev
55-
sf dev generate plugin
56-
57-
git init -b main
58-
git add . && git commit -m "chore: initial commit"
59-
```
60-
61-
3. Create your plugin's repo in the salesforcecli github org
62-
4. When you're ready, replace the contents of this README with the information you want.
63-
64-
## Learn about `sf` plugins
65-
66-
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.
67-
68-
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.
69-
70-
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.
71-
72-
### Tooling
73-
74-
- [@salesforce/core](https://github.com/forcedotcom/sfdx-core)
75-
- [@salesforce/kit](https://github.com/forcedotcom/kit)
76-
- [@salesforce/sf-plugins-core](https://github.com/salesforcecli/sf-plugins-core)
77-
- [@salesforce/ts-types](https://github.com/forcedotcom/ts-types)
78-
- [@salesforce/ts-sinon](https://github.com/forcedotcom/ts-sinon)
79-
- [@salesforce/dev-config](https://github.com/forcedotcom/dev-config)
80-
- [@salesforce/dev-scripts](https://github.com/forcedotcom/dev-scripts)
81-
82-
# Everything past here is only a suggestion as to what should be in your specific plugin's description
44+
## TODO Update
8345

8446
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).
8547

0 commit comments

Comments
 (0)