mods

Documentation

Index

• func NewLimePlugin(name, description, buildVersion, buildDate string, ...) specs.LimePlugin
• func Run(p specs.LimePlugin, executableName string)
• type BaseLimePlugin
  • func (p *BaseLimePlugin) BuildDate() time.Time
  • func (p *BaseLimePlugin) Description() string
  • func (p *BaseLimePlugin) Exports() map[string]interface{}
  • func (p *BaseLimePlugin) Name() string
  • func (p *BaseLimePlugin) Type() specs.LimePluginType
  • func (p *BaseLimePlugin) Version() *common.Version
• type Context
• type Globals
• type VersionCommand
  • func (v *VersionCommand) Run(ctx *Context) error

Functions

func NewLimePlugin

func NewLimePlugin(name,
	description,
	buildVersion,
	buildDate string,
	pluginType specs.LimePluginType,
	exports map[string]interface{}) specs.LimePlugin

NewLimePlugin returns a new LimePlugin

func Run

func Run(p specs.LimePlugin, executableName string)

Run runs a LimePlugin

Types

type BaseLimePlugin

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

BaseLimePlugin is a LimePlugin base struct

func (*BaseLimePlugin) BuildDate

func (p *BaseLimePlugin) BuildDate() time.Time

BuildDate returns the date the plugin was built

func (*BaseLimePlugin) Description

func (p *BaseLimePlugin) Description() string

Description returns the description of the plugin

func (*BaseLimePlugin) Exports

func (p *BaseLimePlugin) Exports() map[string]interface{}

Exports exposes the symbols exported by the plugin

func (*BaseLimePlugin) Name

func (p *BaseLimePlugin) Name() string

Name returns the name of the plugin

func (*BaseLimePlugin) Type

func (p *BaseLimePlugin) Type() specs.LimePluginType

Type returns the LimePluginType

func (*BaseLimePlugin) Version

func (p *BaseLimePlugin) Version() *common.Version

Version returns the version of the plugin

type Context

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

Context represents the command context

type Globals

type Globals struct {
	LogLevel string `help:"The logging level (debug|info|warn|error)" enum:"debug,info,warn,error" default:"info" env:"LIME_PACKER_LOG_LEVEL"`
	Verbose  bool   `short:"v" help:"Shortcut for log-level debug." env:"LIME_PACKER_VERBOSE" xor:"verbosity"`
	Silent   bool   `short:"s" help:"Disables output." env:"LIME_PACKER_SILENT" xor:"verbosity"`
}

Globals represents global flags

type VersionCommand

type VersionCommand struct {
}

VersionCommand runs a command to display the current version

func (*VersionCommand) Run

func (v *VersionCommand) Run(ctx *Context) error

Run runs the version command