utils

Documentation

Index

• func AsJson(i interface{}) string
• func ColoredString(str string, colorAttribute color.Attribute) string
• func ColoredStringDirect(str string, colour *color.Color) string
• func Decolorise(str string) string
• func GetCurrentRepoName() string
• func GetProjectRoot() string
• func IncludesString(list []string, a string) bool
• func Loader() string
• func Min(x, y int) int
• func NextIndex(numbers []int, currentNumber int) int
• func NormalizeLinefeeds(str string) string
• func PrevIndex(numbers []int, currentNumber int) int
• func RenderList(slice interface{}, isFocused bool) (string, error)
• func ResolvePlaceholderString(str string, arguments map[string]string) string
• func SplitLines(multilineString string) []string
• func TrimTrailingNewline(str string) string
• func WithPadding(str string, padding int) string
• type Displayable

Functions

func AsJson

func AsJson(i interface{}) string

func ColoredString

func ColoredString(str string, colorAttribute 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 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 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 NextIndex

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

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

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 RenderList

func RenderList(slice interface{}, isFocused bool) (string, error)

RenderList takes a slice of items, confirms they implement the Displayable interface, then generates a list of their displaystrings to write to a panel's buffer

func ResolvePlaceholderString

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

ResolvePlaceholderString populates a template with values

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 TrimTrailingNewline

func TrimTrailingNewline(str string) string

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

func WithPadding

func WithPadding(str string, padding int) string

WithPadding pads a string as much as you want

Types

type Displayable

type Displayable interface {
	GetDisplayStrings(bool) []string
}