plugin

Documentation

Index

• Constants
• func HandlePluginCommand(pluginHandler PluginHandler, cmdArgs []string) error
• func NewCommandPlugin(options *app.Options) *cobra.Command
• type CommandOverrideVerifier
  • func (v *CommandOverrideVerifier) Verify(path string) []error
• type DefaultPluginHandler
  • func NewDefaultPluginHandler() *DefaultPluginHandler
  • func (h *DefaultPluginHandler) Execute(executablePath string, cmdArgs, environment []string) error
  • func (h *DefaultPluginHandler) Lookup(filename string) (string, bool)
• type PathVerifier
• type PluginHandler
• type PluginOptions
  • func (o *PluginOptions) Run() error

Constants

const (
	PluginFilenamePrefix = "cbctl"
	PluginDirectory      = "plugins"
)

Functions

func HandlePluginCommand

func HandlePluginCommand(pluginHandler PluginHandler, cmdArgs []string) error

func NewCommandPlugin

func NewCommandPlugin(options *app.Options) *cobra.Command

returns a cobra command

Types

type CommandOverrideVerifier

type CommandOverrideVerifier struct {
	// contains filtered or unexported fields
}

func (*CommandOverrideVerifier) Verify

func (v *CommandOverrideVerifier) Verify(path string) []error

implements PathVerifier and determines if a given path

type DefaultPluginHandler

type DefaultPluginHandler struct {
	// contains filtered or unexported fields
}

func NewDefaultPluginHandler

func NewDefaultPluginHandler() *DefaultPluginHandler

func (*DefaultPluginHandler) Execute

func (h *DefaultPluginHandler) Execute(executablePath string, cmdArgs, environment []string) error

func (*DefaultPluginHandler) Lookup

func (h *DefaultPluginHandler) Lookup(filename string) (string, bool)

type PathVerifier

type PathVerifier interface {
	Verify(path string) []error
}

type PluginHandler

type PluginHandler interface {
	Lookup(filename string) (string, bool)
	Execute(executablePath string, cmdArgs, environment []string) error
}

type PluginOptions

type PluginOptions struct {
	*app.Options
	PluginPaths []string
	NameOnly    bool
	Verifier    PathVerifier
	// contains filtered or unexported fields
}

a struct to support command

func (*PluginOptions) Run

func (o *PluginOptions) Run() error