utils

Documentation

Index

• func Abs(path string) (abs string, err error)
• func Basename(path string, ext string) string
• func CreateEmptyFile(path string) (err error)
• func CreateEmptyFileIfNotExists(path string) (err error)
• func CygwinizePath(path string) string
• func Dir(path string) string
• func ErrorIf(condition bool, message string) error
• func EvalSymlinks(path string) (string, error)
• func Executable() (exe string)
• func Filename(path string) string
• func FilterDirectories(paths []string) []string
• func Get[E comparable](v E, fallbacks ...E) E
• func GetCygwinAwareHomeDir() string
• func GetIndex[S ~[]E, E any](s S, index int, fallback E) E
• func GetShellHomeDir() string
• func GetTerminalType() string
• func GetUserHomeDir() string
• func Getwd() string
• func Join(paths ...string) string
• func OpenFileInDefaultApp(path string) (err error)
• func PanicIfError(err error)
• func PanicIfFalse(condition bool, message string)
• func PanicIfPathDoesNotExist(path string)
• func PanicIfPathExists(path string)
• func PanicIfTrue(condition bool, message string)
• func PathExists(filename string) bool
• func PathIsDir(filename string) bool
• func PathIsFile(filename string) bool
• func Rel(basepath string, targpath string) (string, error)
• func SafeWriteTemplateToFile(t *template.Template, path string, vars map[string]interface{}) (err error)
• func SortKeys[M ~map[K]V, K cmp.Ordered, V any](m M) []K
• func Ternary[T any](cond bool, a T, b T) T
• func ToSlash(path string) string
• func WriteTemplateToFile(tmpl *template.Template, path string, vars map[string]interface{}) (err error)
• func WriteTemplateToString(tmpl *template.Template, vars map[string]interface{}) (string, error)

Functions

func Abs

func Abs(path string) (abs string, err error)

func Basename

func Basename(path string, ext string) string

func CreateEmptyFile

func CreateEmptyFile(path string) (err error)

func CreateEmptyFileIfNotExists

func CreateEmptyFileIfNotExists(path string) (err error)

func CygwinizePath

func CygwinizePath(path string) string

func Dir

func Dir(path string) string

func ErrorIf

func ErrorIf(condition bool, message string) error

func EvalSymlinks

func EvalSymlinks(path string) (string, error)

func Executable

func Executable() (exe string)

func Filename

func Filename(path string) string

func FilterDirectories

func FilterDirectories(paths []string) []string

func Get

func Get[E comparable](v E, fallbacks ...E) E

func GetCygwinAwareHomeDir

func GetCygwinAwareHomeDir() string

GetCygpathHomeDir returns the user's ~/ dir from the cygpath command. If cygpath doesn't exist (either not on Windows or Cygwin is not installed) then the normal $USERPROFILE or /Users/<username> is returned. This method is only used to determine the location of the user's rc file for setup, in all other cases the user's home dir is the normal one. Note: on windows in powershell, this resolves to the cygwin home dir (unexpectedly)

func GetIndex

func GetIndex[S ~[]E, E any](s S, index int, fallback E) E

func GetShellHomeDir

func GetShellHomeDir() string

func GetTerminalType

func GetTerminalType() string

func GetUserHomeDir

func GetUserHomeDir() string

func Getwd

func Getwd() string

func Join

func Join(paths ...string) string

func OpenFileInDefaultApp

func OpenFileInDefaultApp(path string) (err error)

func PanicIfError

func PanicIfError(err error)

func PanicIfFalse

func PanicIfFalse(condition bool, message string)

func PanicIfPathDoesNotExist

func PanicIfPathDoesNotExist(path string)

func PanicIfPathExists

func PanicIfPathExists(path string)

func PanicIfTrue

func PanicIfTrue(condition bool, message string)

func PathExists

func PathExists(filename string) bool

func PathIsDir

func PathIsDir(filename string) bool

func PathIsFile

func PathIsFile(filename string) bool

func Rel

func Rel(basepath string, targpath string) (string, error)

func SafeWriteTemplateToFile

func SafeWriteTemplateToFile(t *template.Template, path string, vars map[string]interface{}) (err error)

func SortKeys

func SortKeys[M ~map[K]V, K cmp.Ordered, V any](m M) []K

func Ternary

func Ternary[T any](cond bool, a T, b T) T

func ToSlash

func ToSlash(path string) string

func WriteTemplateToFile

func WriteTemplateToFile(tmpl *template.Template, path string, vars map[string]interface{}) (err error)

func WriteTemplateToString

func WriteTemplateToString(tmpl *template.Template, vars map[string]interface{}) (string, error)