root

Documentation

Index

• func DefaultDir() string
• type Root
  • func Default() Root
  • func New(dir string) Root

Functions

func DefaultDir

func DefaultDir() string

DefaultDir derives the default Thelma root directory. It will be: * The value of the THELMA_ROOT env var, if set * If a valid home directory exists for current user, it will be $HOME/.thelma * Else, /tmp/.thelma.<pid> (worst-case fallback option in weird environments) Note that this function identifies the root directory path, but does NOT create the root directory; it may or may not exist.

Types

type Root

type Root interface {
	// Dir returns the Thelma installation root directory, usually ~/.thelma
	Dir() string
	// LogDir returns the path where Thelma debug logs are stored ($ROOT/logs)
	LogDir() string
	// CachesDir returns the Thelma cache directory ($ROOT/caches)
	CachesDir() string
	// CredentialsDir returns the path to Thelma credentials directory ($ROOT/credentials)
	CredentialsDir() string
	// ConfigDir returns the path to Thelma config directory
	ConfigDir() string
	// InstallDir returns the Thelma installation directory ($ROOT/install)
	InstallDir() string
	// CreateDirectories create directories if they do not exist. Will be called as part of Thelma initialization
	CreateDirectories() error
}

func Default

func Default() Root

Default returns a Root instance rooted at the default directory returned by DefaultDir

func New

func New(dir string) Root

New (FOR TESTING ONLY) returns a Root instance rooted at the given directory