@bud-tools/bt-plugins-core v0.9.0

Description

The @bud-tools/bt-plugins-core provides utilities for writing bt plugins.

Docs: https://budtoolscli.github.io/bt-plugins-core

BtCommand Abstract Class

The BtCommand 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 BudTools Unified CLI.

• BtCommand 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.

Bt Hooks

Interface that defines the well known Unified CLI command hooks. BtHooks takes advantage of the oclif hooks framework, which provides a set of predefined events and the provides ability to define your own.

A hook has a name, say bt:deploy and to participate in the hook's run call, one creates a hook consumer, that registers itself using the name bt:deploy. There can be more than one hook registered with the same name and when the hook is "run", oclif hook will run each registered hook consumer, collect all results and return those results to the caller.

• See oclif hooks API docs for a general description of hooks.
• See BtHooks for current hook definitions available in Unified CLI.
• See Command Deploy for and example of how to run a hook (search for BtHook.run in linked file).
• See @bud-tools/plugin-deploy-retrieve-metadataA#src/hooks/deploy.ts as an example implementation of a hook consumer.

Deployer Interface

Interface for deploying Deployables. See @bud-tools/plugin-deploy-retrieve-metadata#src/utils/metadataDeployer.ts as an example implementation.

Deauthorizer Abstract Class

The Deauthorizer is an abstract class that is used to implement a concrete implementations of deauthorizing an environment.

Prompter Class

A general purpose class that prompts a user for information. See inquirer NPM Module for more information.

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 BudTools 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
• budtoolsIdFlag
  • validates that IDs are valid budtools ID
  • optionally restrict to 15/18 char
  • optionally require it to be begin with a certain prefix