plugin

Documentation

Index

• Variables
• type Completion
  • func NewCompletion(path environment.Paths, cmd *cobra.Command, args []string) Completion
• type DefaultPluginHandler
  • func NewDefaultPluginHandler(validPrefixes []string) *DefaultPluginHandler
  • func (h *DefaultPluginHandler) Execute(executablePath string, cmdArgs, environment []string) error
  • func (h *DefaultPluginHandler) Lookup(filename string) (string, bool)
• type Handler
• type Plugins
  • func NewPlugin(ctx context.Context, path environment.Paths) Plugins

Variables

var ValidPluginFilenamePrefixes = []string{"ankor"}

Types

type Completion

type Completion interface {
	SetupCompletion() error
	SetPlugins(plugins []index.Plugin)
}

func NewCompletion

func NewCompletion(path environment.Paths, cmd *cobra.Command, args []string) Completion

type DefaultPluginHandler

type DefaultPluginHandler struct {
	ValidPrefixes []string
}

DefaultPluginHandler implements Handler

func NewDefaultPluginHandler

func NewDefaultPluginHandler(validPrefixes []string) *DefaultPluginHandler

NewDefaultPluginHandler instantiates the DefaultPluginHandler with a list of given filename prefixes used to identify valid plugin filenames.

func (*DefaultPluginHandler) Execute

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

Execute implements Handler

func (*DefaultPluginHandler) Lookup

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

Lookup implements Handler

type Handler

type Handler interface {
	// Lookup exists at the given filename, or a boolean false.
	// Lookup will iterate over a list of given prefixes
	// in order to recognize valid plugin filenames.
	// The first filepath to match a prefix is returned.
	Lookup(filename string) (string, bool)
	// Execute receives an executable's filepath, a slice
	// of arguments, and a slice of environment variables
	// to relay to the executable.
	Execute(executablePath string, cmdArgs, environment []string) error
}

Handler is capable of parsing command line arguments and performing executable filename lookups to search for valid plugin files, and execute found plugins.

type Plugins

type Plugins interface {
	List() ([]index.Plugin, error)
	AddPluginCommands() []*cobra.Command
}

func NewPlugin

func NewPlugin(ctx context.Context, path environment.Paths) Plugins