ecletus

README

ecletus

The Ecletus CLI package

Documentation

Index

• Constants
• Variables
• func NewSetupConfig(sitesConfig *sites.Config) *core.SetupConfig
• func NewSitesConfig(configDir *ConfigDir) *sites.Config
• type Application
  • func (app *Application) GetAssetFS() assetfsapi.Interface
  • func (app *Application) GetPlugins() []interface{}
  • func (app *Application) PostInit(a *Ecletus) error
  • func (app *Application) PreInit(a *Ecletus) error
  • func (app *Application) PrePlugins(a *Ecletus) error
• type ApplicationInterface
• type BasicSystemInfo
  • func (this *BasicSystemInfo) SetAllOrDefault(projectName, version, commit, buildDate, goPath string)
• type ConfigDir
  • func NewConfigDir(envPrefix ...string) *ConfigDir
  • func (c *ConfigDir) Dir() string
  • func (c *ConfigDir) Exists(pth ...string) (ok bool, err error)
  • func (c *ConfigDir) Load(config interface{}, files ...string) error
  • func (c *ConfigDir) Path(pth ...string) string
  • func (c *ConfigDir) Paths(pth ...string) []string
• type Ecletus
  • func FromOptions(options pluggable.Options) *Ecletus
  • func Get() *Ecletus
  • func LoadApplication(app ApplicationInterface) (*Ecletus, error)
  • func New() *Ecletus
  • func (this *Ecletus) Done(f ...func())
  • func (this *Ecletus) Init(plugins []interface{}) error
  • func (this *Ecletus) LoadLogLevels()
  • func (this *Ecletus) Main(main func())
  • func (this *Ecletus) Migrate(ctx context.Context) error
  • func (this *Ecletus) Options() *plug.Options
  • func (this *Ecletus) Plugins() *plug.Plugins
  • func (this *Ecletus) PreInit(f ...func(ecl *Ecletus) error) *Ecletus
  • func (this *Ecletus) PrePluginsRegister(f ...func(ecl *Ecletus) error) *Ecletus
  • func (this *Ecletus) Run() (err error)
  • func (this *Ecletus) Setup(ta task.Appender) (err error)
  • func (this *Ecletus) Start(done func()) (stop task.Stoper, err error)

Constants

const (
	ECLETUS      = "ecletus"
	SITES_CONFIG = "ecletus:SitesConfig"
	SETUP_CONFIG = "ecletus:SetupConfig"
	CONTAINER    = "ecletus:Container"
	ASSETFS      = "ecletus:Assetfs"
	CONFIG_DIR   = "ecletus:ConfigDir"

	DEFAULT_CONFIG_DIR = "config"
)

Variables

var (
	Root, _ = os.Getwd()
	HOME    = os.Getenv("HOME")
)

var (
	EmptyCommit  = strings.Repeat("-", 20)
	EmptyVersion = "0.0.0"
)

Functions

func NewSetupConfig

func NewSetupConfig(sitesConfig *sites.Config) *core.SetupConfig

func NewSitesConfig

func NewSitesConfig(configDir *ConfigDir) *sites.Config

Types

type Application

type Application struct {
	AssetFS         assetfsapi.Interface
	Plugins         []interface{}
	PrePluginstFunc func(a *Ecletus) error
	PreInitFunc     func(a *Ecletus) error
	PostInitFunc    func(a *Ecletus) error
}

func (*Application) GetAssetFS

func (app *Application) GetAssetFS() assetfsapi.Interface

func (*Application) GetPlugins

func (app *Application) GetPlugins() []interface{}

func (*Application) PostInit

func (app *Application) PostInit(a *Ecletus) error

func (*Application) PreInit

func (app *Application) PreInit(a *Ecletus) error

func (*Application) PrePlugins

func (app *Application) PrePlugins(a *Ecletus) error

type ApplicationInterface

type ApplicationInterface interface {
	GetAssetFS() assetfsapi.Interface
	GetPlugins() []interface{}
	PreInit(a *Ecletus) error
	PrePlugins(a *Ecletus) error
	PostInit(a *Ecletus) error
}

type BasicSystemInfo

type BasicSystemInfo struct {
	ProjectName, Version,
	Commit, BuildDate, GoPath string
}

func (*BasicSystemInfo) SetAllOrDefault

func (this *BasicSystemInfo) SetAllOrDefault(projectName, version, commit, buildDate, goPath string)

type ConfigDir

type ConfigDir struct {
	Configor *configor.Configor
	// contains filtered or unexported fields
}

func NewConfigDir

func NewConfigDir(envPrefix ...string) *ConfigDir

func (*ConfigDir) Dir

func (c *ConfigDir) Dir() string

func (*ConfigDir) Exists

func (c *ConfigDir) Exists(pth ...string) (ok bool, err error)

func (*ConfigDir) Load

func (c *ConfigDir) Load(config interface{}, files ...string) error

func (*ConfigDir) Path

func (c *ConfigDir) Path(pth ...string) string

func (*ConfigDir) Paths

func (c *ConfigDir) Paths(pth ...string) []string

type Ecletus

type Ecletus struct {
	task.Tasks
	AppName     string
	ConfigDir   *ConfigDir
	SitesConfig *sites.Config
	SetupConfig *core.SetupConfig
	AssetFS     assetfsapi.Interface
	PubicFS     *assetfs.AssetFileSystem
	TempFS      *assetfs.AssetFileSystem
	Container   *container.Container

	PrePluginsRegisterCallbacks []func(ecl *Ecletus) error
	PreInitCallbacks            []func(ecl *Ecletus) error

	Stderr          io.Writer
	BasicSystemInfo *BasicSystemInfo
	// contains filtered or unexported fields
}

func FromOptions

func FromOptions(options pluggable.Options) *Ecletus

func Get

func Get() *Ecletus

func LoadApplication

func LoadApplication(app ApplicationInterface) (*Ecletus, error)

func New

func New() *Ecletus

func (*Ecletus) Done

func (this *Ecletus) Done(f ...func())

func (*Ecletus) Init

func (this *Ecletus) Init(plugins []interface{}) error

func (*Ecletus) LoadLogLevels

func (this *Ecletus) LoadLogLevels()

func (*Ecletus) Main

func (this *Ecletus) Main(main func())

func (*Ecletus) Migrate

func (this *Ecletus) Migrate(ctx context.Context) error

func (*Ecletus) Options

func (this *Ecletus) Options() *plug.Options

func (*Ecletus) Plugins

func (this *Ecletus) Plugins() *plug.Plugins

func (*Ecletus) PreInit

func (this *Ecletus) PreInit(f ...func(ecl *Ecletus) error) *Ecletus

func (*Ecletus) PrePluginsRegister

func (this *Ecletus) PrePluginsRegister(f ...func(ecl *Ecletus) error) *Ecletus

func (*Ecletus) Run

func (this *Ecletus) Run() (err error)

func (*Ecletus) Setup

func (this *Ecletus) Setup(ta task.Appender) (err error)

func (*Ecletus) Start

func (this *Ecletus) Start(done func()) (stop task.Stoper, err error)