utils

Documentation

Index

• func AsJson(i interface{}) string
• func ColoredString(str string, colorAttributes ...color.Attribute) string
• func ColoredStringDirect(str string, colour *color.Color) string
• func Decolorise(str string) string
• func DifferenceInt(a, b []int) []int
• func FindStringSubmatch(str string, regexpStr string) (bool, []string)
• func GetCurrentRepoName() string
• func GetProjectRoot() string
• func IncludesInt(list []int, a int) bool
• func IncludesString(list []string, a string) bool
• func Loader() string
• func Min(x, y int) int
• func ModuloWithWrap(n, max int) int
• func MustConvertToInt(s string) int
• func NewDummyLog() *logrus.Entry
• func NextIndex(numbers []int, currentNumber int) int
• func NextIntInCycle(sl []int, current int) int
• func NormalizeLinefeeds(str string) string
• func PrevIndex(numbers []int, currentNumber int) int
• func PrevIntInCycle(sl []int, current int) int
• func RenderDisplayStrings(displayStringsArr [][]string) string
• func ResolvePlaceholderString(str string, arguments map[string]string) string
• func ResolveTemplate(templateStr string, object interface{}) (string, error)
• func Safe(f func())
• func SplitLines(multilineString string) []string
• func StringArraysOverlap(strArrA []string, strArrB []string) bool
• func TrimTrailingNewline(str string) string
• func TruncateWithEllipsis(str string, limit int) string
• func UnionInt(a, b []int) []int
• func UnixToDate(timestamp int64) string
• func UnixToTimeAgo(timestamp int64) string
• func WithPadding(str string, padding int) string
• func WrapError(err error) error

Functions

func AsJson

func AsJson(i interface{}) string

func ColoredString

func ColoredString(str string, colorAttributes ...color.Attribute) string

ColoredString takes a string and a colour attribute and returns a colored string with that attribute

func ColoredStringDirect

func ColoredStringDirect(str string, colour *color.Color) string

ColoredStringDirect used for aggregating a few color attributes rather than just sending a single one

func Decolorise

func Decolorise(str string) string

Decolorise strips a string of color

func DifferenceInt

func DifferenceInt(a, b []int) []int

DifferenceInt returns the difference of two int arrays

func FindStringSubmatch

func FindStringSubmatch(str string, regexpStr string) (bool, []string)

func GetCurrentRepoName

func GetCurrentRepoName() string

GetCurrentRepoName gets the repo's base name

func GetProjectRoot

func GetProjectRoot() string

GetProjectRoot returns the path to the root of the project. Only to be used in testing contexts, as with binaries it's unlikely this path will exist on the machine

func IncludesInt

func IncludesInt(list []int, a int) bool

IncludesInt if the list contains the Int

func IncludesString

func IncludesString(list []string, a string) bool

IncludesString if the list contains the string

func Loader

func Loader() string

Loader dumps a string to be displayed as a loader

func Min

func Min(x, y int) int

Min returns the minimum of two integers

func ModuloWithWrap

func ModuloWithWrap(n, max int) int

used to keep a number n between 0 and max, allowing for wraparounds

func MustConvertToInt

func MustConvertToInt(s string) int

func NewDummyLog

func NewDummyLog() *logrus.Entry

NewDummyLog creates a new dummy Log for testing

func NextIndex

func NextIndex(numbers []int, currentNumber int) int

NextIndex returns the index of the element that comes after the given number

func NextIntInCycle

func NextIntInCycle(sl []int, current int) int

NextIntInCycle returns the next int in a slice, returning to the first index if we've reached the end

func NormalizeLinefeeds

func NormalizeLinefeeds(str string) string

NormalizeLinefeeds - Removes all Windows and Mac style line feeds

func PrevIndex

func PrevIndex(numbers []int, currentNumber int) int

PrevIndex returns the index that comes before the given number, cycling if we reach the end

func PrevIntInCycle

func PrevIntInCycle(sl []int, current int) int

PrevIntInCycle returns the prev int in a slice, returning to the first index if we've reached the end

func RenderDisplayStrings

func RenderDisplayStrings(displayStringsArr [][]string) string

func ResolvePlaceholderString

func ResolvePlaceholderString(str string, arguments map[string]string) string

ResolvePlaceholderString populates a template with values

func ResolveTemplate

func ResolveTemplate(templateStr string, object interface{}) (string, error)

func Safe

func Safe(f func())

Safe will close termbox if a panic occurs so that we don't end up in a malformed terminal state

func SplitLines

func SplitLines(multilineString string) []string

SplitLines takes a multiline string and splits it on newlines currently we are also stripping \r's which may have adverse effects for windows users (but no issues have been raised yet)

func StringArraysOverlap

func StringArraysOverlap(strArrA []string, strArrB []string) bool

func TrimTrailingNewline

func TrimTrailingNewline(str string) string

TrimTrailingNewline - Trims the trailing newline TODO: replace with `chomp` after refactor

func TruncateWithEllipsis

func TruncateWithEllipsis(str string, limit int) string

TruncateWithEllipsis returns a string, truncated to a certain length, with an ellipsis

func UnionInt

func UnionInt(a, b []int) []int

UnionInt returns the union of two int arrays

func UnixToDate

func UnixToDate(timestamp int64) string

func UnixToTimeAgo

func UnixToTimeAgo(timestamp int64) string

func WithPadding

func WithPadding(str string, padding int) string

WithPadding pads a string as much as you want

func WrapError

func WrapError(err error) error

WrapError wraps an error for the sake of showing a stack trace at the top level the go-errors package, for some reason, does not return nil when you try to wrap a non-error, so we're just doing it here