plugins

Documentation

Index

• Constants
• func BuildEnvVariable(name string) string
• func BuildEnvVariablePrefix(name string) (ret string)
• type Plugin
• type PluginBase
  • func (o *PluginBase) AddSetting(name string, required bool) (ret *Setting)
  • func (o *PluginBase) AddSetupQuestion(name string, required bool) (ret *SetupQuestion)
  • func (o *PluginBase) AddSetupQuestionCustom(name string, required bool, question string) (ret *SetupQuestion)
  • func (o *PluginBase) Configure() (err error)
  • func (o *PluginBase) GetName() string
  • func (o *PluginBase) GetSetupDescription() (ret string)
  • func (o *PluginBase) Setup() (err error)
  • func (o *PluginBase) SetupFillEnvFileContent(fileEnvFileContent *bytes.Buffer)
  • func (o *PluginBase) SetupOrSkip() (err error)
• type Setting
  • func NewSetting(envVariable string, required bool) *Setting
  • func (o *Setting) Configure() error
  • func (o *Setting) FillEnvFileContent(buffer *bytes.Buffer)
  • func (o *Setting) IsDefined() bool
  • func (o *Setting) IsValid() bool
  • func (o *Setting) IsValidErr() (err error)
  • func (o *Setting) Print()
• type Settings
  • func (o Settings) Configure() (err error)
  • func (o Settings) FillEnvFileContent(buffer *bytes.Buffer)
  • func (o Settings) IsConfigured() (ret bool)
• type SetupQuestion
  • func NewSetupQuestion(question string) *SetupQuestion
  • func (o *SetupQuestion) Ask(label string) (err error)
  • func (o *SetupQuestion) OnAnswer(answer string) (err error)
• type SetupQuestions
  • func (o SetupQuestions) Ask(label string) (err error)

Constants

const AnswerReset = "reset"

Functions

func BuildEnvVariable

func BuildEnvVariable(name string) string

func BuildEnvVariablePrefix

func BuildEnvVariablePrefix(name string) (ret string)

Types

type Plugin

type Plugin interface {
	GetName() string
	GetSetupDescription() string
	IsConfigured() bool
	Configure() error
	Setup() error
	SetupFillEnvFileContent(*bytes.Buffer)
}

type PluginBase

type PluginBase struct {
	Settings
	SetupQuestions

	Name             string
	SetupDescription string
	EnvNamePrefix    string

	ConfigureCustom func() error
}

func (*PluginBase) AddSetting

func (o *PluginBase) AddSetting(name string, required bool) (ret *Setting)

func (*PluginBase) AddSetupQuestion

func (o *PluginBase) AddSetupQuestion(name string, required bool) (ret *SetupQuestion)

func (*PluginBase) AddSetupQuestionCustom

func (o *PluginBase) AddSetupQuestionCustom(name string, required bool, question string) (ret *SetupQuestion)

func (*PluginBase) Configure

func (o *PluginBase) Configure() (err error)

func (*PluginBase) GetName

func (o *PluginBase) GetName() string

func (*PluginBase) GetSetupDescription

func (o *PluginBase) GetSetupDescription() (ret string)

func (*PluginBase) Setup

func (o *PluginBase) Setup() (err error)

func (*PluginBase) SetupFillEnvFileContent

func (o *PluginBase) SetupFillEnvFileContent(fileEnvFileContent *bytes.Buffer)

func (*PluginBase) SetupOrSkip

func (o *PluginBase) SetupOrSkip() (err error)

type Setting

type Setting struct {
	EnvVariable string
	Value       string
	Required    bool
}

func NewSetting

func NewSetting(envVariable string, required bool) *Setting

func (*Setting) Configure

func (o *Setting) Configure() error

func (*Setting) FillEnvFileContent

func (o *Setting) FillEnvFileContent(buffer *bytes.Buffer)

func (*Setting) IsDefined

func (o *Setting) IsDefined() bool

func (*Setting) IsValid

func (o *Setting) IsValid() bool

func (*Setting) IsValidErr

func (o *Setting) IsValidErr() (err error)

func (*Setting) Print

func (o *Setting) Print()

type Settings

type Settings []*Setting

func (Settings) Configure

func (o Settings) Configure() (err error)

func (Settings) FillEnvFileContent

func (o Settings) FillEnvFileContent(buffer *bytes.Buffer)

func (Settings) IsConfigured

func (o Settings) IsConfigured() (ret bool)

type SetupQuestion

type SetupQuestion struct {
	*Setting
	Question string
}

func NewSetupQuestion

func NewSetupQuestion(question string) *SetupQuestion

func (*SetupQuestion) Ask

func (o *SetupQuestion) Ask(label string) (err error)

func (*SetupQuestion) OnAnswer

func (o *SetupQuestion) OnAnswer(answer string) (err error)

type SetupQuestions

type SetupQuestions []*SetupQuestion

func (SetupQuestions) Ask

func (o SetupQuestions) Ask(label string) (err error)