pkg

Documentation

Index

• func DebugMsg(message string)
• func EmojiMsg(emoji string, message string)
• func ErrorMsg(message string)
• func GetErrorHTMLPath() string
• func GetRubikConfigPath() string
• func GetStaticFolderPath() string
• func GetTemplateFolderPath() string
• func MakeAndGetCacheDirPath() string
• func OverrideValues(source, env map[string]interface{}) map[string]interface{}
• func WarnMsg(message string)
• type Config
  • func GetRubikConfig() *Config
• type Logger
• type Project

Functions

func DebugMsg

func DebugMsg(message string)

DebugMsg appends a debug before the log message

func EmojiMsg

func EmojiMsg(emoji string, message string)

EmojiMsg writes the booting message to stdout

func ErrorMsg

func ErrorMsg(message string)

ErrorMsg appends a error before the log message

func GetErrorHTMLPath

func GetErrorHTMLPath() string

GetErrorHTMLPath ...

func GetRubikConfigPath

func GetRubikConfigPath() string

GetRubikConfigPath returns path of rubik config of current project

func GetStaticFolderPath

func GetStaticFolderPath() string

GetStaticFolderPath returns the absolute static dir path

func GetTemplateFolderPath

func GetTemplateFolderPath() string

GetTemplateFolderPath returns the absolute template dir path

func MakeAndGetCacheDirPath

func MakeAndGetCacheDirPath() string

MakeAndGetCacheDirPath returns rubik's cache dir

func OverrideValues

func OverrideValues(source, env map[string]interface{}) map[string]interface{}

OverrideValues writes over the source map with env map

func WarnMsg

func WarnMsg(message string)

WarnMsg appends a warn before the log message

Types

type Config

type Config struct {
	ProjectName string `toml:"name"`
	Module      string `toml:"module"`
	IsFlat      bool   `toml:"flat"`
	MaxProcs    int    `toml:"maxprocs"`
	Log         bool
	App         []Project                    `toml:"app"`
	X           map[string]map[string]string `toml:"x"`
}

Config is the main config for your rubik runtime this is declared inside a rubik.toml file

func GetRubikConfig

func GetRubikConfig() *Config

GetRubikConfig returns Config: a structural representation of rubik.toml

type Logger

type Logger struct {
	CanLog bool
}

Logger is the go to logging struct for anything related to logs

type Project

type Project struct {
	Name         string `toml:"name"`
	Path         string `toml:"path"`
	Watchable    bool   `toml:"watch"`
	Communicable bool   `toml:"communicate"`
	Log          bool   `toml:"log"`
}

Project defines the struct representation of rubik.toml