9.0.7 • Published 10 days ago

@salesforce/sf-plugins-core v9.0.7

Weekly downloads
-
License
BSD-3-Clause
Repository
github
Last release
10 days ago

NPM

Description

The @salesforce/sf-plugins-core provides utilities for writing sf plugins.

Docs: https://salesforcecli.github.io/sf-plugins-core

SfCommand Abstract Class

The SfCommand abstract class extends @oclif/core's Command class for examples of how to build a definition. ) class and adds useful extensions to ease the development of commands for use in the Salesforce Unified CLI.

  • SfCommand takes a generic type that defines the success JSON result
  • Enable the json flag support by default
  • Provides functions that help place success messages, warnings and errors into the correct location in JSON results
  • Enables additional help sections to the standard oclif command help output
  • Provides access to the cli-ux cli actions. This avoids having to import that interface from cli-ux and manually handling the --json flag.
  • Provides simple, stubbable prompts for confirmation and secrets

Flags

Flags is a convenience reference to @oclif/core#Flags

Specialty Flags

These flags can be imported into a command and used like any other flag. See code examples in the links

  • orgApiVersionFlag
    • specifies a Salesforce API version.
    • reads from Config (if available)
    • validates version is still active
    • warns if version if deprecated
  • requiredOrgFlag
    • accepts a username or alias
    • aware of configuration defaults
    • throws if org or default doesn't exist or can't be found
  • optionalOrgFlag
    • accepts a username or alias
    • aware of configuration defaults
    • might be undefined if an org isn't found
  • requiredHubFlag
    • accepts a username or alias
    • aware of configuration defaults
    • throws if org or default doesn't exist or can't be found
    • throws if an org is found but is not a dev hub
  • durationFlag
    • specify a unit
    • optionally specify a min, max, and defaultValue
    • returns a Duration
    • can be undefined if you don't set the default
  • salesforceIdFlag
    • validates that IDs are valid salesforce ID
    • optionally restrict to 15/18 char
    • optionally require it to be begin with a certain prefix

Unit Test Helpers

Want to verify SfCommand Ux behavior (warnings, tables, spinners, prompts)? Check out the functions in `stubUx.

@inquirer/confirm@inquirer/password@oclif/core@salesforce/core@salesforce/kit@salesforce/ts-typeschalk
@salesforce/cli@infinitebrahmanuniverse/nolb-_salseql-sfdxvttesthw@everything-registry/sub-chunk-803@ziemniakoss/sf-purge-pluginhuttemove-qcp@aandreouprodly/testsfcli@dxatscale/browserforceplugin-analytics-connected-objectsplugin-atlasplugin-permissionsplugin-switchplugin-switch-npplugin-template-sf-externalprodlysfclisfdc-license-checksf-ravensf-org-summarysf-orgdevmode-buildssf-permssf-plugin-check-coveragesfdx-autocmpltsfdx-browserforce-pluginsfdx-clisfdx-decomposersfdx-kgo-pluginsfdocs-sfdx-pluginsfdx-ez-pluginsfdx-metadata-patchersfdx-predeploy-hook-org-envsfdx-plugin-package-xmlsfdx-plugin-source-readsfdx-papers-pleasesfdx-plugin-auth-urlsf-trace-pluginsf-warpsf-comparesf-debug-logsf-decomposersf-delta-testssf-chipps-datasf-chipps-packagerapido-sf-pluginrapiddxtexei-sfdx-pluginsvmxa360-sfsvmxc-sfvtsytsiuratesthw@tribeplatform/cli@ziemniakoss/sf-flow-management-plugin@tmh-bis-salesforce/tmh-bis-salesforce-cli-pluginteetools-pluginaura-helper-sf@bit2winlab/bit2win-tempoapex-code-coverage-transformerapex-tests-git-delta@cloudpremise/reactforce@cgi-fr/salesforce-toolboxbitbucket-codeinsights-reporter@zalastax/nolb-_salafthonia@dx-cli-toolbox/sf-toolbox-aep-utils@dx-cli-toolbox/sfdx-toolbox-utilsbbaidxbdxfolders@copado/copado-cli@ind-rcg/modeler-sfdx-cli-plugin@jayree/sfdx-plugin-org@jayree/sfdx-plugin-prettier@jayree/sfdx-plugin-source@jayree/sfdx-plugin-manifest@marcelinollano/plugin-sample@marsson/ciutils@6street/6street-cli@cristiand391/sf-plugin-api@brightgen/isaudit@hiregenius/hg-plugin@kratapps/sf-plugin@kratapps/sfdx-pluginenshift-sfdx-plugin@julianduque/rest-api-pluginexpereo-sfdx-plugin@newbytebv/dx-pooling@kitalive/sfdx-plugin@mikeburr/sf-repl@sharinpix/spx-connected-app@salesforce/analytics@salesforce/change-case-management@salesforce/lwc-dev-mobile@salesforce/lwc-dev-mobile-core@salesforce/plugin-apex@slalom-salesforce/plugin-post-codereview-comments@pacificpoint/pplib@rocko1204/b2wforce-fiesta@omegacrm/omega-dx@pdfbutler/migration-cli
9.0.7

10 days ago

9.0.6

10 days ago

9.0.3-beta.1

16 days ago

9.0.3-beta.0

16 days ago

9.0.5

20 days ago

9.0.4

23 days ago

9.0.3

23 days ago

9.0.2

27 days ago

9.0.1

29 days ago

8.0.5-qa.0

1 month ago

9.0.0

1 month ago

8.0.4

1 month ago

8.0.3

1 month ago

8.0.2

2 months ago

8.0.1

2 months ago

8.0.0

2 months ago

7.1.16

2 months ago

7.1.15

2 months ago

7.1.14

2 months ago

7.1.13

3 months ago

7.1.12

3 months ago

7.1.11

3 months ago

7.1.10

3 months ago

7.1.9

3 months ago

7.1.7

3 months ago

7.1.6

3 months ago

7.1.5

3 months ago

7.1.8

3 months ago

7.1.4

4 months ago

7.1.3

4 months ago

7.1.2

4 months ago

7.1.1

4 months ago

7.1.0

4 months ago

7.0.0

4 months ago

5.0.14-dev.2

4 months ago

5.0.14-dev.0

4 months ago

5.0.14-dev.1

4 months ago

5.0.13

5 months ago

5.0.12

5 months ago

5.0.11

5 months ago

5.0.9

5 months ago

5.0.10

5 months ago

5.0.8

5 months ago

5.0.7

5 months ago

5.0.6

5 months ago

4.0.0

7 months ago

5.0.5

5 months ago

5.0.4

6 months ago

5.0.3

6 months ago

5.0.2

6 months ago

5.0.1

6 months ago

3.1.13-dev.0

10 months ago

3.1.21-beta.0

8 months ago

3.1.7

10 months ago

3.1.6

10 months ago

3.1.5

10 months ago

3.1.4

10 months ago

3.1.12

10 months ago

4.0.1-dev.0

6 months ago

3.1.11

10 months ago

3.1.14

9 months ago

3.1.13

9 months ago

4.0.1-dev.3

6 months ago

3.1.16

9 months ago

4.0.1-dev.4

6 months ago

3.1.15

9 months ago

4.0.1-dev.1

6 months ago

3.1.18

9 months ago

4.0.1-dev.2

6 months ago

3.1.17

9 months ago

4.0.1-dev.6

6 months ago

3.1.10

10 months ago

3.1.9

10 months ago

3.1.8

10 months ago

3.1.23

8 months ago

3.1.22

8 months ago

3.1.25

8 months ago

3.1.24

8 months ago

3.1.27

7 months ago

3.1.26

7 months ago

3.1.28

7 months ago

3.1.21

8 months ago

3.1.20

9 months ago

3.1.19

9 months ago

4.0.0-beta.5

7 months ago

4.0.0-beta.4

7 months ago

4.0.0-beta.3

8 months ago

4.0.0-beta.2

8 months ago

4.0.0-beta.1

8 months ago

4.1.3

6 months ago

4.1.0

6 months ago

4.1.2

6 months ago

4.1.1

6 months ago

2.4.1

1 year ago

2.4.3

12 months ago

2.4.2

1 year ago

3.1.3

11 months ago

3.1.2

11 months ago

3.1.1

11 months ago

3.1.0

11 months ago

3.0.4

11 months ago

3.0.3

11 months ago

3.0.2

12 months ago

3.0.1

12 months ago

2.2.8-qa.1

1 year ago

2.4.0

1 year ago

2.3.0-qa.3

1 year ago

2.3.0-qa.2

1 year ago

2.3.0-qa.1

1 year ago

2.2.6-beta.2

1 year ago

2.2.6-beta.1

1 year ago

2.2.6-beta.4

1 year ago

2.2.6-beta.3

1 year ago

2.2.6-beta.5

1 year ago

2.3.0

1 year ago

2.2.10-beta.1

1 year ago

2.2.5

1 year ago

2.2.4

1 year ago

2.2.11

1 year ago

2.2.7

1 year ago

2.2.6

1 year ago

2.2.10

1 year ago

2.2.9

1 year ago

2.2.8

1 year ago

2.0.2

1 year ago

2.0.1

1 year ago

2.0.0-beta.9

1 year ago

1.22.3

1 year ago

2.2.1

1 year ago

2.2.0

1 year ago

2.2.3

1 year ago

2.2.2

1 year ago

2.1.2

1 year ago

2.1.1

1 year ago

2.1.3

1 year ago

2.1.0

1 year ago

1.21.0

1 year ago

1.21.1

1 year ago

1.21.4

1 year ago

1.21.5

1 year ago

1.21.2

1 year ago

1.21.3

1 year ago

1.21.8

1 year ago

1.21.6

1 year ago

1.21.7

1 year ago

2.0.0-beta.8

1 year ago

2.0.0-beta.7

1 year ago

1.19.3

1 year ago

1.19.2

1 year ago

1.19.1

1 year ago

2.0.0-beta.2

1 year ago

2.0.0-beta.1

1 year ago

2.0.0-beta.6

1 year ago

2.0.0-beta.5

1 year ago

1.22.0

1 year ago

2.0.0-beta.4

1 year ago

2.0.0-beta.3

1 year ago

1.22.1

1 year ago

1.22.2

1 year ago

1.20.0

1 year ago

1.18.1

1 year ago

1.18.0

1 year ago

1.16.1

2 years ago

1.16.0

2 years ago

1.15.0

2 years ago

1.19.0

1 year ago

1.17.2

2 years ago

1.17.1

2 years ago

1.17.0

2 years ago

1.15.2

2 years ago

1.15.1

2 years ago

1.17.6

1 year ago

1.17.5

1 year ago

1.17.4

2 years ago

1.17.3

2 years ago

1.17.7

1 year ago

1.14.1

2 years ago

1.14.0

2 years ago

1.13.2

2 years ago

1.13.1

2 years ago

1.12.3

2 years ago

1.12.2

2 years ago

1.13.0

2 years ago

1.12.1

2 years ago

1.12.0

2 years ago

1.11.3

2 years ago

1.11.2

2 years ago

1.11.1

2 years ago

1.11.0

2 years ago

1.10.0

2 years ago

1.7.3

2 years ago

1.9.0

2 years ago

1.8.1

2 years ago

1.7.2

2 years ago

1.8.0

2 years ago

1.7.1

2 years ago

1.5.3

2 years ago

1.7.0

2 years ago

1.6.1

2 years ago

1.5.2

2 years ago

1.6.0

2 years ago

1.5.1

2 years ago

1.2.0

2 years ago

1.1.0

2 years ago

1.5.0

2 years ago

1.4.1

2 years ago

1.4.0

2 years ago

1.3.0

2 years ago

1.2.1

2 years ago

1.0.5

2 years ago

1.0.2

3 years ago

1.0.4

3 years ago

1.0.3

3 years ago

1.0.1

3 years ago

1.0.0

3 years ago

0.0.26

3 years ago

0.0.27

3 years ago

0.0.28

3 years ago

0.0.25

3 years ago

0.0.21

3 years ago

0.0.22

3 years ago

0.0.23

3 years ago

0.0.24

3 years ago

0.0.20

3 years ago

0.0.19

3 years ago

0.0.17

3 years ago

0.0.18

3 years ago

0.0.16

3 years ago

0.0.15

3 years ago

0.0.14

3 years ago

0.0.13

3 years ago

0.0.12

3 years ago

0.0.11

3 years ago