util

Documentation

Index

• func CheckUntil(interval time.Duration, timeout time.Duration, predicate func() (bool, error)) error
• func FormatErrorList(errList []error) error
• func HasErrors(errList []error) bool
• func MakeOutputDirectory(path string, overwrite bool) (string, error)
• func PathExists(path string) (fs.FileInfo, bool)
• func SplitPathForViper(path string) (string, string, string)

Functions

func CheckUntil

func CheckUntil(interval time.Duration, timeout time.Duration, predicate func() (bool, error)) error

CheckUntil regularly check a predicate until it's true or time out is reached.

func FormatErrorList

func FormatErrorList(errList []error) error

FormatErrorList() is a wrapper function that unifies error list formatting and makes printing error lists consistent.

NOTE: The error returned IS NOT an error in itself and may be a bit misleading. Instead, it is a single condensed error composed of all of the errors included in the errList argument.

func HasErrors

func HasErrors(errList []error) bool

HasErrors() is a simple wrapper function to check if an error list contains errors. Having a function that clearly states its purpose helps to improve readibility although it may seem pointless.

func MakeOutputDirectory

func MakeOutputDirectory(path string, overwrite bool) (string, error)

MakeOutputDirectory() creates a new directory at the path argument if the path does not exist.

Returns the final path that was created if no errors occurred. Otherwise, it returns an empty string with an error.

func PathExists

func PathExists(path string) (fs.FileInfo, bool)

PathExists() is a wrapper function that simplifies checking if a file or directory already exists at the provided path.

Returns whether the path exists and no error if successful, otherwise, it returns false with an error.

func SplitPathForViper

func SplitPathForViper(path string) (string, string, string)

SplitPathForViper() is an utility function to split a path into 3 parts: - directory - filename - extension The intent was to break a path into a format that's more easily consumable by spf13/viper's API. See the "LoadConfig()" function in internal/config.go for more details.

TODO: Rename function to something more generalized.