root

package
v1.1.40 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 8, 2024 License: BSD-3-Clause Imports: 7 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Lookup added in v1.0.41

func Lookup() string

Lookup derives the 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 added in v0.0.29

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
	// ReleasesDir returns the Thelma installation directory ($ROOT/releases)
	ReleasesDir() string
	// ShellDir path where Thelma generates shell scripts and utilities ($ROOT/shell)
	ShellDir() string
	// CreateDirectories create directories if they do not exist. Will be called as part of Thelma initialization
	CreateDirectories() error
}

func New added in v0.0.29

func New() Root

New returns a new Root instance rooted at the directory returned by Lookup

func NewAt added in v1.0.41

func NewAt(dir string) Root

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

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL