plugin

Documentation

Index

• Variables
• func HandlePluginCommand(pluginHandler Handler, cmdArgs []string) error
• 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

Variables

var DefaultPluginsPaths = []string{"~/.pulsarctl/plugins"}

var ValidPluginFilenamePrefixes = []string{"pulsarctl"}

Functions

func HandlePluginCommand

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

HandlePluginCommand receives a pluginHandler and command-line arguments and attempts to find a plugin executable on the PATH that satisfies the given arguments.

Types

type DefaultPluginHandler

type DefaultPluginHandler struct {
	ValidPrefixes []string
}

DefaultPluginHandler implements PluginHandler

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 PluginHandler

func (*DefaultPluginHandler) Lookup

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

Lookup implements PluginHandler

type Handler

type Handler interface {
	// 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.