From e6639e601437ebb00bbd0ff699f77ce6f1b86a5e Mon Sep 17 00:00:00 2001 From: Nicolas Kruk Date: Thu, 15 Aug 2024 20:14:17 -0400 Subject: [PATCH 1/9] chore: readme updates --- PLUGIN_TEMPLATE.md | 37 +++++++++++++++++++++++++++++++++++++ README.md | 40 +--------------------------------------- 2 files changed, 38 insertions(+), 39 deletions(-) create mode 100644 PLUGIN_TEMPLATE.md diff --git a/PLUGIN_TEMPLATE.md b/PLUGIN_TEMPLATE.md new file mode 100644 index 00000000..dba82825 --- /dev/null +++ b/PLUGIN_TEMPLATE.md @@ -0,0 +1,37 @@ +## Using the template + +This repository provides a template for creating a plugin for the Salesforce CLI. To convert this template to a working plugin: + +1. Please get in touch with the Platform CLI team. We want to help you develop your plugin. +2. Generate your plugin: + + ``` + sf plugins install dev + sf dev generate plugin + + git init -b main + git add . && git commit -m "chore: initial commit" + ``` + +3. Create your plugin's repo in the salesforcecli github org +4. When you're ready, replace the contents of this README with the information you want. + +## Learn about `sf` plugins + +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. + +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. + +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. + +### Tooling + +- [@salesforce/core](https://github.com/forcedotcom/sfdx-core) +- [@salesforce/kit](https://github.com/forcedotcom/kit) +- [@salesforce/sf-plugins-core](https://github.com/salesforcecli/sf-plugins-core) +- [@salesforce/ts-types](https://github.com/forcedotcom/ts-types) +- [@salesforce/ts-sinon](https://github.com/forcedotcom/ts-sinon) +- [@salesforce/dev-config](https://github.com/forcedotcom/dev-config) +- [@salesforce/dev-scripts](https://github.com/forcedotcom/dev-scripts) + +# Everything past here is only a suggestion as to what should be in your specific plugin's description diff --git a/README.md b/README.md index 938aaf6f..342ad270 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,3 @@ -**NOTE: This template for sf plugins is not yet official. Please consult with the Platform CLI team before using this template.** - # plugin-lightning-dev [![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 yarn update-snapshots ``` -## Using the template - -This repository provides a template for creating a plugin for the Salesforce CLI. To convert this template to a working plugin: - -1. Please get in touch with the Platform CLI team. We want to help you develop your plugin. -2. Generate your plugin: - - ``` - sf plugins install dev - sf dev generate plugin - - git init -b main - git add . && git commit -m "chore: initial commit" - ``` - -3. Create your plugin's repo in the salesforcecli github org -4. When you're ready, replace the contents of this README with the information you want. - -## Learn about `sf` plugins - -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. - -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. - -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. - -### Tooling - -- [@salesforce/core](https://github.com/forcedotcom/sfdx-core) -- [@salesforce/kit](https://github.com/forcedotcom/kit) -- [@salesforce/sf-plugins-core](https://github.com/salesforcecli/sf-plugins-core) -- [@salesforce/ts-types](https://github.com/forcedotcom/ts-types) -- [@salesforce/ts-sinon](https://github.com/forcedotcom/ts-sinon) -- [@salesforce/dev-config](https://github.com/forcedotcom/dev-config) -- [@salesforce/dev-scripts](https://github.com/forcedotcom/dev-scripts) - -# Everything past here is only a suggestion as to what should be in your specific plugin's description +## TODO Update 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). From 9c76455476786795d8526f223fb20e80b743a8a4 Mon Sep 17 00:00:00 2001 From: svc-cli-bot Date: Fri, 16 Aug 2024 00:16:09 +0000 Subject: [PATCH 2/9] chore(release): 1.0.26-alpha.0 [skip ci] --- README.md | 107 +++++++++++++++++++++++++++++++++++++++++++-------- package.json | 2 +- 2 files changed, 93 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 342ad270..3b767eec 100644 --- a/README.md +++ b/README.md @@ -108,41 +108,118 @@ sf plugins -- [`sf hello world`](#sf-hello-world) +- [`sf lightning dev app`](#sf-lightning-dev-app) +- [`sf lightning dev site`](#sf-lightning-dev-site) -## `sf hello world` +## `sf lightning dev app` -Say hello. +Preview a Lightning Experience app locally and in real-time, without deploying it. ``` USAGE - $ sf hello world [--json] [--flags-dir ] [-n ] + $ sf lightning dev app -o [--json] [--flags-dir ] [-n ] [-t desktop|ios|android] [-i ] FLAGS - -n, --name= [default: World] The name of the person you'd like to say hello to. + -i, --device-id= ID of the mobile device to display the preview if device type is set to `ios` or + `android`. The default value is the ID of the first available mobile device. + -n, --name= Name of the Lightning Experience app to preview. + -o, --target-org= (required) Username or alias of the target org. Not required if the `target-org` + configuration variable is already set. + -t, --device-type=