NOTE: This template for sf plugins is not yet offical. Please consult with the Platform CLI team before using this template.

plugin-template-sf

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. Read the plugin developer guide 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 used by Salesforce. There is also a default circleci config using the 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
• @salesforce/kit
• @salesforce/sf-plugins-core
• @salesforce/ts-types
• @salesforce/ts-sinon
• @salesforce/dev-config
• @salesforce/dev-scripts

Hooks

For cross clouds commands, e.g. sf env list, we utilize oclif hooks to get the relevant information from installed plugins.

This plugin includes sample hooks in the src/hooks directory. You'll just need to add the appropriate logic. You can also delete any of the hooks if they aren't required for your plugin.

Everything past here is only a suggestion as to what should be in your specific plugin's description

This plugin is bundled with the Salesforce CLI. For more information on the CLI, read the getting started guide.

We always recommend using the latest version of these commands bundled with the CLI, however, you can install a specific version or tag if needed.

Install

sf plugins install @salesforce/[email protected]

Issues

Please report any issues at https://github.com/forcedotcom/cli/issues

Contributing

1. Please read our Code of Conduct
2. Create a new issue before starting your project so that we can keep track of what you are trying to add/fix. That way, we can also offer suggestions or let you know if there is already an effort in progress.
3. Fork this repository.
4. Build the plugin locally
5. Create a topic branch in your fork. Note, this step is recommended but technically not required if contributing using a fork.
6. Edit the code in your fork.
7. Write appropriate tests for your changes. Try to achieve at least 95% code coverage on any new code. No pull request will be accepted without unit tests.
8. Sign CLA (see CLA below).
9. Send us a pull request when you are done. We'll review your code, suggest any needed changes, and merge it in.

CLA

External contributors will be required to sign a Contributor's License Agreement. You can do so by going to https://cla.salesforce.com/sign-cla.

Build

To build the plugin locally, make sure to have yarn installed and run the following commands:

# Clone the repository
git clone [email protected]:salesforcecli/plugin-template-sf

# Install the dependencies and compile
yarn && yarn build

To use your plugin, run using the local ./bin/dev or ./bin/dev.cmd file.

# Run using local run file.
./bin/dev hello world

There should be no differences when running via the Salesforce CLI or using the local run file. However, it can be useful to link the plugin to do some additional testing or run your commands from anywhere on your machine.

# Link your plugin to the sf cli
sf plugins link .
# To verify
sf plugins

Commands

• sf generate metadata field
• sf generate metadata platformevent
• sf generate metadata sobject
• sf generate metadata tab

sf generate metadata field

Generate local metadata for a custom field on

USAGE
  $ sf generate metadata field -l <value> [-o <value>]

FLAGS
  -l, --label=<value>   (required) The label of the field.
  -o, --object=<value>  The directory of the object folder

DESCRIPTION
  Generate local metadata for a custom field on

  Interactively generate local metadata for a custom field. This requires that the custom object you're adding the field
  to be present locally

EXAMPLES
  - Create a field with a given Label (you'll be prompted to choose an object)
  $ sf generate metadata field --label "My Field"
  - Specify a local path to the object's folder
  $ sf generate metadata field --label "My Field" -o force-app/main/default/objects/MyObj\_\_c

FLAG DESCRIPTIONS
  -o, --object=<value>  The directory of the object folder

    The directory of object you're adding the field to. Include **c if the object is custom. For example,
    `force-app/main/default/objects/MyObj**c`

    If not provided, the command will prompt you to choose from your local objects.

sf generate metadata platformevent

Generate local metadata for a platform event

USAGE
  $ sf generate metadata platformevent -l <value>

FLAGS
  -l, --label=<value>  (required) The label of the event.

DESCRIPTION
  Generate local metadata for a platform event

  Interactively generate local metadata for a platform object

EXAMPLES
  - Create an platform event with the given

    $ sf generate metadata platformevent --label "Platform Evt"

sf generate metadata sobject

Generate local metadata for a custom object

USAGE
  $ sf generate metadata sobject -l <value> [-f]

FLAGS
  -f, --use-default-features  Enable all optional features without prompting.
  -l, --label=<value>         (required) The label of the object.

DESCRIPTION
  Generate local metadata for a custom object

  Interactively generate local metadata for a custom object

EXAMPLES
  - Create an object with a given Label and be prompted for additional information
  $ sf generate metadata sobject --label "My Object"
  - Create an object and opt in to most defaults (see flag help for details)
  $ sf generate metadata sobject --label "My Object" --use-default-features

FLAG DESCRIPTIONS
  -f, --use-default-features  Enable all optional features without prompting.

    Enables search, feeds, reports, history, activities, bulk API, sharing, and streaming API.

sf generate metadata tab

Generate a tab for a custom object.

USAGE
  $ sf generate metadata tab -o <value> -d <value> -i <value> [--json]

FLAGS
  -d, --directory=<value>  (required) Path to a `tabs` folder that your new tab will be created in.
  -i, --icon=<value>       (required) An icon number from <https://lightningdesignsystem.com/icons/#custom> from 1 to
                           100'
  -o, --object=<value>     (required) API name of the object to generate a tab for.

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Generate a tab for a custom object.

  Description of a command.

EXAMPLES
  $ sf generate metadata tab -o MyObj\_\_c -i 54 -d force-app/main/default/tabs

FLAG DESCRIPTIONS
  -o, --object=<value>  API name of the object to generate a tab for.

    API name of the object to generate a tab for. Custom objects should end in \_\_c. The object need not be present in
    your local source.