util

Documentation

Index

• Constants
• Variables
• func AtoInt32(text string) (int32, error)
• func BinaryLocation() (string, error)
• func CacheDir() (string, error)
• func ConfigDir() (string, error)
• func Contains(arr []string, str string) bool
• func CopyDir(src string, dst string) (err error)
• func CopyFile(src, dst string) (err error)
• func CreateUniqueDirectory(dir string, name string, maximumAttempts int) (string, error)
• func DownloadFile(filepath string, url string) (err error)
• func EnvironmentsDir() (string, error)
• func FileExists(path string) (bool, error)
• func FirstNotEmptyString(values ...string) string
• func GetCommandOutput(dir string, name string, args ...string) (string, error)
• func GetLatestVersionFromGitHub(githubOwner, githubRepo string) (semver.Version, error)
• func HomeDir() string
• func Int32ToA(n int32) string
• func InvalidArg(value string, values []string) error
• func InvalidArgError(value string, err error) error
• func InvalidArgf(value string, message string, a ...interface{}) error
• func InvalidOption(name string, value string, values []string) error
• func InvalidOptionError(option string, value string, err error) error
• func InvalidOptionf(option string, value string, message string, a ...interface{}) error
• func LoadCacheData(fileName string, loader CacheLoader) ([]byte, error)
• func MissingOption(name string) error
• func PickName(names []string, message string) (string, error)
• func PickNameWithDefault(names []string, message string, defaultValue string) (string, error)
• func PickNames(names []string, message string) ([]string, error)
• func RegexpSplit(text string, regexSeperator string) []string
• func ReverseStrings(a []string)
• func SortedMapKeys(m map[string]string) []string
• func StringArrayIndex(array []string, value string) int
• func StringIndexes(text string, value string) []int
• func SuggestionsFor(typedName string, values []string, suggestionsMinimumDistance int, ...) []string
• func UnTargz(tarball, target string, onlyFiles []string) error
• func Unzip(src, dest string) error
• func UrlJoin(paths ...string) string
• type CacheLoader

Constants

const (
	DefaultWritePermissions = 0760

	MaximumNewDirectoryAttempts = 1000
)

const (
	DefaultSuggestionsMinimumDistance = 2
)

Variables

var ColorError = color.New(color.FgRed).SprintFunc()

var ColorInfo = color.New(color.FgGreen).SprintFunc()

var ColorStatus = color.New(color.FgBlue).SprintFunc()

var ColorWarning = color.New(color.FgYellow).SprintFunc()

Functions

func AtoInt32

func AtoInt32(text string) (int32, error)

func BinaryLocation

func BinaryLocation() (string, error)

func CacheDir

func CacheDir() (string, error)

func ConfigDir

func ConfigDir() (string, error)

func Contains

func Contains(arr []string, str string) bool

func CopyDir

func CopyDir(src string, dst string) (err error)

credit https://gist.github.com/r0l1/92462b38df26839a3ca324697c8cba04

func CopyFile

func CopyFile(src, dst string) (err error)

credit https://gist.github.com/r0l1/92462b38df26839a3ca324697c8cba04

func CreateUniqueDirectory

func CreateUniqueDirectory(dir string, name string, maximumAttempts int) (string, error)

CreateUniqueDirectory creates a new directory but if the combination of dir and name exists then append a number until a unique name is found

func DownloadFile

func DownloadFile(filepath string, url string) (err error)

Download a file from the given URL

func EnvironmentsDir

func EnvironmentsDir() (string, error)

func FileExists

func FileExists(path string) (bool, error)

func FirstNotEmptyString

func FirstNotEmptyString(values ...string) string

FirstNotEmptyString returns the first non empty string or the empty string if none can be found

func GetCommandOutput

func GetCommandOutput(dir string, name string, args ...string) (string, error)

GetCommandOutput evaluates the given command and returns the trimmed output

func GetLatestVersionFromGitHub

func GetLatestVersionFromGitHub(githubOwner, githubRepo string) (semver.Version, error)

func HomeDir

func HomeDir() string

func Int32ToA

func Int32ToA(n int32) string

func InvalidArg

func InvalidArg(value string, values []string) error

func InvalidArgError

func InvalidArgError(value string, err error) error

func InvalidArgf

func InvalidArgf(value string, message string, a ...interface{}) error

func InvalidOption

func InvalidOption(name string, value string, values []string) error

func InvalidOptionError

func InvalidOptionError(option string, value string, err error) error

func InvalidOptionf

func InvalidOptionf(option string, value string, message string, a ...interface{}) error

func LoadCacheData

func LoadCacheData(fileName string, loader CacheLoader) ([]byte, error)

LoadCacheData loads cached data from the given cache file name and loader

func MissingOption

func MissingOption(name string) error

func PickName

func PickName(names []string, message string) (string, error)

func PickNameWithDefault

func PickNameWithDefault(names []string, message string, defaultValue string) (string, error)

func PickNames

func PickNames(names []string, message string) ([]string, error)

func RegexpSplit

func RegexpSplit(text string, regexSeperator string) []string

RegexpSplit splits a string into an array using the regexSep as a separator

func ReverseStrings

func ReverseStrings(a []string)

func SortedMapKeys

func SortedMapKeys(m map[string]string) []string

SortedMapKeys returns the sorted keys of the given map

func StringArrayIndex

func StringArrayIndex(array []string, value string) int

func StringIndexes

func StringIndexes(text string, value string) []int

StringIndexes returns all the indices where the value occurs in the given string

func SuggestionsFor

func SuggestionsFor(typedName string, values []string, suggestionsMinimumDistance int, explicitSuggestions ...string) []string

func UnTargz

func UnTargz(tarball, target string, onlyFiles []string) error

untargz a tarball to a target, from http://blog.ralch.com/tutorial/golang-working-with-tar-and-gzipf

func Unzip

func Unzip(src, dest string) error

func UrlJoin

func UrlJoin(paths ...string) string

UrlJoin joins the given paths so that there is only ever one '/' character between the paths

Types

type CacheLoader

type CacheLoader func() ([]byte, error)