appboot

Documentation

Index

• Constants
• func Create(app Application, force bool, beforeScripts []string, afterScripts []string, ...) error
• func CreateWithCallback(app Application, force bool, beforeScripts []string, afterScripts []string, ...) error
• func GetTemplates() []string
• func GetTemplatesGitHash() string
• func UpdateAllTemplates() error
• func UpdateAllTemplatesWithDownloader(downloader Downloader) error
• func UpdateTemplate(name string) error
• func UpdateTemplateWithDownloader(name string, downloader Downloader) error
• type Application
  • func (app *Application) Clean()
  • func (app Application) CreateFiles() error
  • func (app *Application) Description() string
  • func (app *Application) GetParameters() (map[string]string, error)
  • func (app *Application) GetTemplatePath() string
  • func (app *Application) IsValid() bool
• type Callback
• type CreateCallback
• type Downloader
  • func NewDownloader() Downloader
• type FloatParameter
• type IntParameter
• type Parameter
• type Scripts
• type SelectParameter
• type StringParameter
• type TemplateConfig
  • func GetTemplateConfig(template string) (*TemplateConfig, error)
  • func GetTemplateConfigFromYaml(yamlPath string) (config *TemplateConfig, err error)
  • func (p *TemplateConfig) UnmarshalYAML(unmarshal func(interface{}) error) error

Constants

const (
	// Name template Name
	Name = "Name"
	// Path template Path
	Path = "Path"

	// ConfigFolder appboot configuration items
	ConfigFolder = "appboot"
)

Functions

func Create

func Create(app Application,
	force bool,
	beforeScripts []string,
	afterScripts []string,
	skipBeforeScripts bool,
	skipAfterScripts bool) error

Create an application

func CreateWithCallback

func CreateWithCallback(app Application,
	force bool,
	beforeScripts []string,
	afterScripts []string,
	skipBeforeScripts bool,
	skipAfterScripts bool,
	callback *CreateCallback) error

CreateWithCallback create an application with callback

func GetTemplates

func GetTemplates() []string

GetTemplates get templates

func GetTemplatesGitHash

func GetTemplatesGitHash() string

func UpdateAllTemplates

func UpdateAllTemplates() error

UpdateAllTemplates update all templates with git

func UpdateAllTemplatesWithDownloader

func UpdateAllTemplatesWithDownloader(downloader Downloader) error

UpdateAllTemplatesWithDownloader update all templates

func UpdateTemplate

func UpdateTemplate(name string) error

UpdateTemplate update template with Git

func UpdateTemplateWithDownloader

func UpdateTemplateWithDownloader(name string, downloader Downloader) error

UpdateTemplateWithDownloader update template

Types

type Application

type Application struct {
	Name       string
	Path       string
	Template   string
	Parameters string
}

Application data struct

func (*Application) Clean

func (app *Application) Clean()

Clean clean config folder

func (Application) CreateFiles

func (app Application) CreateFiles() error

CreateFiles create files

func (*Application) Description

func (app *Application) Description() string

Description application description

func (*Application) GetParameters

func (app *Application) GetParameters() (map[string]string, error)

GetParameters get application parameters

func (*Application) GetTemplatePath

func (app *Application) GetTemplatePath() string

GetTemplatePath application template path

func (*Application) IsValid

func (app *Application) IsValid() bool

IsValid is it valid

type Callback

type Callback func(app Application) error

Callback app callback

type CreateCallback

type CreateCallback struct {
	OnCreating Callback
	DidCreated Callback
}

CreateCallback create callback

type Downloader

type Downloader interface {
	Run(source string, destination string) error
}

Downloader downloader interface

func NewDownloader

func NewDownloader() Downloader

NewDownloader new downloader

type FloatParameter

type FloatParameter struct {
	Parameter
	Min     float64 `yaml:"min" json:"min"`
	Max     float64 `yaml:"max" json:"max"`
	Default float64 `yaml:"default" json:"default"`
}

FloatParameter float parameter

type IntParameter

type IntParameter struct {
	Parameter
	Min     int `yaml:"min" json:"min"`
	Max     int `yaml:"max" json:"max"`
	Default int `yaml:"default" json:"default"`
}

IntParameter int parameter

type Parameter

type Parameter struct {
	Key  string `yaml:"key" json:"key"`
	Type string `yaml:"type" json:"type"`
	Tip  string `yaml:"tip" json:"tip"`
}

type Scripts

type Scripts struct {
	Before []string `yaml:"before" json:"before"`
	After  []string `yaml:"after" json:"after"`
}

Scripts scripts

type SelectParameter

type SelectParameter struct {
	Parameter
	Options []string `yaml:"options" json:"options"`
	Default string   `yaml:"default" json:"default"`
}

SelectParameter select parameter

type StringParameter

type StringParameter struct {
	Parameter
	Default     string `yaml:"default" json:"default"`
	Placeholder string `yaml:"placeholder" json:"placeholder"`
}

type TemplateConfig

type TemplateConfig struct {
	Parameters []interface{} `yaml:"parameters" json:"parameters"`
	Desc       string        `yaml:"desc" json:"desc"`
	Scripts    Scripts       `yaml:"scripts" json:"scripts"`
}

TemplateConfig appboot config from appboot.yaml

func GetTemplateConfig

func GetTemplateConfig(template string) (*TemplateConfig, error)

GetTemplateConfig get template config

func GetTemplateConfigFromYaml

func GetTemplateConfigFromYaml(yamlPath string) (config *TemplateConfig, err error)

GetTemplateConfigFromYaml get config from yaml path

func (*TemplateConfig) UnmarshalYAML

func (p *TemplateConfig) UnmarshalYAML(unmarshal func(interface{}) error) error

UnmarshalYAML unmarshalYAML