plugins

Documentation

Index

• Variables
• type CommandSpec
• type Config
• type ConfigSpec
  • func ResolveDynamic(c ConfigSpec, e *Engine) (cfg ConfigSpec, err error)
• type Engine
  • func NewEngine(opts ...Option) *Engine
  • func (e *Engine) Execute(pluginName string, args []string) (err error)
  • func (e *Engine) LoadPlugin(manifestPath string) (p *Plugin, err error)
  • func (e *Engine) LoadPlugins() (plugins Plugins)
  • func (e *Engine) NewExecutablePlugin(p *Plugin, config map[string]interface{}) (execP *ExecutablePlugin, err error)
• type ExecutablePlugin
  • func (execP *ExecutablePlugin) Exec(args []string) (err error)
• type Manifest
• type Option
• type Plugin
• type PluginSpec
• type Plugins

Variables

var ErrNoPluginWithNameFound = fmt.Errorf("no plugin with that name could be found in the pluginCache")

Types

type CommandSpec

type CommandSpec struct {
	Cmd         string        `yaml:"cmd"`
	Help        string        `yaml:"help,omitempty"`
	Subcommands []CommandSpec `yaml:"subcommands,omitempty"`
}

type Config

type Config struct {
	Out    io.Writer
	Fs     afero.Fs
	Pather devctlpath.Pather
}

type ConfigSpec

type ConfigSpec struct {
	Values  map[string]string
	Static  map[string]interface{}
	Dynamic map[string]string
}

func ResolveDynamic

func ResolveDynamic(c ConfigSpec, e *Engine) (cfg ConfigSpec, err error)

type Engine

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

func NewEngine

func NewEngine(opts ...Option) *Engine

func (*Engine) Execute

func (e *Engine) Execute(pluginName string, args []string) (err error)

Execute tries to execute a named plugin from the cache

func (*Engine) LoadPlugin

func (e *Engine) LoadPlugin(manifestPath string) (p *Plugin, err error)

func (*Engine) LoadPlugins

func (e *Engine) LoadPlugins() (plugins Plugins)

func (*Engine) NewExecutablePlugin

func (e *Engine) NewExecutablePlugin(p *Plugin, config map[string]interface{}) (execP *ExecutablePlugin, err error)

type ExecutablePlugin

type ExecutablePlugin struct {
	*Plugin
	Config reflect.Value
	ExecFn reflect.Value
}

func (*ExecutablePlugin) Exec

func (execP *ExecutablePlugin) Exec(args []string) (err error)

type Manifest

type Manifest struct {
	Version    string `yaml:"version"`
	PluginSpec `yaml:"plugin"`
}

type Option

type Option func(c *Config) *Config

type Plugin

type Plugin struct {
	*Manifest
	Source   string
	RootPath string
}

type PluginSpec

type PluginSpec struct {
	*CommandSpec `yaml:"cmd,inline"`
	Name         string     `yaml:"name"`
	Pkg          string     `yaml:"pkg"`
	Config       ConfigSpec `yaml:"config,omitempty"`
}

type Plugins

type Plugins []*Plugin