plugins

Documentation

Index

• Variables
• func Config(pluginName string, conf interface{}) error
• func DeriveName(pluginURL string) string
• func Executable(cmd string) (string, error)
• func Help(cmd string) error
• func List() ([]string, error)
• func NormalizeURL(pluginURL string) string
• func Path() (string, error)
• func Run(cmd string) (bool, error)
• func Shortname(name string) string

Variables

var ErrBadPluginRepository = errors.New("Invalid repository URL")

ErrBadPluginRepository represents an error when the plugin url is invalidu

var ErrFailedToRead = errors.New("Failed to read plugins directory")

ErrFailedToRead is returned when you the plugins directory cannot be read

Functions

func Config

func Config(pluginName string, conf interface{}) error

Config returns the key value configuration found in the plugin directory

func DeriveName

func DeriveName(pluginURL string) string

DeriveName returns the name of the plugin based on git repo url

func Executable

func Executable(cmd string) (string, error)

Executable returns the executable path

func Help

func Help(cmd string) error

Help executes the plugin's help command

func List

func List() ([]string, error)

List returns a list of available plugin commands

func NormalizeURL

func NormalizeURL(pluginURL string) string

NormalizeURL returns a normalized git url

func Path

func Path() (string, error)

Path returns the plugin directory's path

func Run

func Run(cmd string) (bool, error)

Run executes the requested plugin command and redirects stdout

func Shortname

func Shortname(name string) string

Shortname returns the shortened name of the plugin