pluginmanager

Documentation

Index

• type PluginConfFile
• type PluginManager
  • func New(fr Reader, apiType string, isDevMode bool) *PluginManager
  • func (p *PluginManager) LoadBuiltinPlugin() error
  • func (p *PluginManager) LoadUserPlugins(userPlugins PluginConfFile) error
  • func (p *PluginManager) OverrideRules(userOverrides map[string]PluginUserOverride) error
  • func (p *PluginManager) ReadPluginCode(path string) (string, error)
• type PluginRule
• type PluginUserOverride
• type Reader

Types

type PluginConfFile

type PluginConfFile struct {
	Rules map[string]PluginRule
}

type PluginManager

type PluginManager struct {
	Rules     map[string]*PluginRule
	Reader    Reader
	ApiType   string
	IsDevMode bool
}

Builtin will packaged as zip Installed on runtime

func New

func New(fr Reader, apiType string, isDevMode bool) *PluginManager

func (*PluginManager) LoadBuiltinPlugin

func (p *PluginManager) LoadBuiltinPlugin() error

func (*PluginManager) LoadUserPlugins

func (p *PluginManager) LoadUserPlugins(userPlugins PluginConfFile) error

func (*PluginManager) OverrideRules

func (p *PluginManager) OverrideRules(userOverrides map[string]PluginUserOverride) error

func (*PluginManager) ReadPluginCode

func (p *PluginManager) ReadPluginCode(path string) (string, error)

type PluginRule

type PluginRule struct {
	File    string
	Disable bool
	Options map[string]any
}

these are the

type PluginUserOverride

type PluginUserOverride struct {
	Disable *bool          `json:"omitempty" yaml:"omitempty" toml:"omitempty"`
	Options map[string]any `json:"omitempty" yaml:"omitempty" toml:"omitempty"`
}

type Reader

type Reader interface {
	// data contains the container for which data will be loaded
	ReadFile(location string, data any) error
	ReadIntoRawBytes(location string) ([]byte, error)
}