plugins

Documentation

Index

• Constants
• type Plugin
  • func (p *Plugin) Aliases() []string
  • func (p *Plugin) IsBinary() bool
  • func (p *Plugin) IsLocal() bool
  • func (p *Plugin) Name() string
  • func (p *Plugin) Path() string
  • func (p *Plugin) URL() string
  • func (p *Plugin) UpdateAvailable() bool
• type PluginKind
• type PluginManager
  • func NewPluginManager(dataDir string, l log.Logger) *PluginManager
  • func (pm *PluginManager) Dispatch() error
  • func (pm *PluginManager) Install(repo string) error
  • func (pm *PluginManager) InstallLocal(repo string) error
  • func (pm *PluginManager) List() ([]Plugin, error)
• type PluginManifest
• type PluginOption
• type PluginTemplateType

Constants

const PluginManifestFile = "kraftkit-plugin.yaml"

const (
	PluginNamePrefix = "kraftkit-"
)

Types

type Plugin

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

func (*Plugin) Aliases

func (p *Plugin) Aliases() []string

func (*Plugin) IsBinary

func (p *Plugin) IsBinary() bool

func (*Plugin) IsLocal

func (p *Plugin) IsLocal() bool

func (*Plugin) Name

func (p *Plugin) Name() string

func (*Plugin) Path

func (p *Plugin) Path() string

func (*Plugin) URL

func (p *Plugin) URL() string

func (*Plugin) UpdateAvailable

func (p *Plugin) UpdateAvailable() bool

type PluginKind

type PluginKind int

const (
	GitKind PluginKind = iota
	BinaryKind
)

type PluginManager

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

func NewPluginManager

func NewPluginManager(dataDir string, l log.Logger) *PluginManager

func (*PluginManager) Dispatch

func (pm *PluginManager) Dispatch() error

func (*PluginManager) Install

func (pm *PluginManager) Install(repo string) error

func (*PluginManager) InstallLocal

func (pm *PluginManager) InstallLocal(repo string) error

func (*PluginManager) List

func (pm *PluginManager) List() ([]Plugin, error)

type PluginManifest

type PluginManifest struct {
	Name        string   `yaml:"name"`
	Version     string   `yaml:"version"`
	License     string   `yaml:"license,omitempty"`
	Author      string   `yaml:"author,omitempty"`
	Description string   `yaml:"description,omitempty"`
	Repo        string   `yaml:"repo,omitempty"`
	Tags        []string `yaml:"tags,omitempty"`
}

type PluginOption

type PluginOption func(p *Plugin)

type PluginTemplateType

type PluginTemplateType uint

const (
	GitTemplateType PluginTemplateType = iota
	GoBinTemplateType
	OtherBinTemplateType
)