Documentation
¶
Index ¶
- Constants
- Variables
- func CalculateDimensions(moduleConfig, globalConfig *config.Config) (int, int, error)
- func CenterText(str string, width int) string
- func Clamp(x, a, b int) int
- func ColorizePercent(percent float64) string
- func DoesNotInclude(strs []string, val string) bool
- func ExecuteCommand(cmd *exec.Cmd) string
- func ExpandHomeDir(path string) (string, error)
- func FindBetween(input string, left string, right string) []string
- func FindMatch(pattern string, data string) [][]string
- func HelpFromInterface(item interface{}) string
- func HighlightableHelper(view *tview.TextView, input string, idx, offset int) string
- func Includes(strs []string, val string) bool
- func Init(openFileUtil string, openUrlUtil []string)
- func IntsToUints(slice []int) []uint
- func MapToStrs(aMap map[string]interface{}) map[string]string
- func MaxInt(x, y int) int
- func NameFromEmail(email string) string
- func NamesFromEmails(emails []string) []string
- func OpenFile(path string)
- func ParseJSON(obj interface{}, text io.Reader) error
- func PrettyNumber(prtr *message.Printer, number float64) string
- func ReadFileBytes(filePath string) ([]byte, error)
- func RowPadding(offset int, max int) string
- func StringValueForProperty(ref interface{}, propName string) (string, error)
- func StripColorTags(input string) string
- func SumInts(vals []int) int
- func ToInts(slice []interface{}) []int
- func ToStrs(slice []interface{}) []string
- func ToUints(slice []interface{}) []uint
- func Truncate(src string, maxLen int, withEllipse bool) string
Constants ¶
const ( SimpleDateFormat = "Jan 2" SimpleTimeFormat = "15:04 MST" MinimumTimeFormat12 = "3:04 PM" MinimumTimeFormat24 = "15:04" FullDateFormat = "Monday, Jan 2" FriendlyDateFormat = "Mon, Jan 2" FriendlyDateTimeFormat = "Mon, Jan 2, 15:04" TimestampFormat = "2006-01-02T15:04:05-0700" )
Variables ¶
var OpenFileUtil = "open"
OpenFileUtil defines the system utility to use to open files
var OpenUrlUtil = []string{}
Functions ¶
func CalculateDimensions ¶
CalculateDimensions reads the module dimensions from the module and global config. The border is already subtracted.
func CenterText ¶
CenterText takes a string and a width and pads the left and right of the string with empty spaces to ensure that the string is in the middle of the returned value
Example:
x := CenterText("cat", 11)
> " cat "
func Clamp ¶
Clamp restricts values to a minimum and maximum value
Examples:
clamp(6, 3, 8) => 6 clamp(1, 3, 8) => 3 clamp(9, 3, 8) => 8
func ColorizePercent ¶
ColorizePercent provides a standard way to colorize percentages for which large numbers are good (green) and small numbers are bad (red).
func DoesNotInclude ¶
DoesNotInclude takes a slice of strings and a target string and returns TRUE if the slice does not include the target, FALSE if it does
Example:
x := DoesNotInclude([]string{"cat", "dog", "rat"}, "dog")
> false
x := DoesNotInclude([]string{"cat", "dog", "rat"}, "pig")
> true
func ExecuteCommand ¶
ExecuteCommand executes an external command on the local machine as the current user
func ExpandHomeDir ¶
ExpandHomeDir expands the path to include the home directory if the path is prefixed with `~`. If it isn't prefixed with `~`, the path is returned as-is.
func FindBetween ¶
FindBetween finds and returns the text between two strings
Example:
a := "{ cat } { dog }"
b := FindBetween(a, "{", "}")
> [" cat ", " dog "]
func FindMatch ¶
FindMatch takes a regex pattern and a string of data and returns back all the matches in that string
func HelpFromInterface ¶
func HelpFromInterface(item interface{}) string
func HighlightableHelper ¶
HighlightableHelper pads the given text with blank spaces to the width of the view containing it. This is helpful for extending row highlighting across the entire width of the view
func Includes ¶
Includes takes a slice of strings and a target string and returns TRUE if the slice includes the target, FALSE if it does not
Example:
x := Includes([]string{"cat", "dog", "rat"}, "dog")
> true
x := Includes([]string{"cat", "dog", "rat"}, "pig")
> false
func IntsToUints ¶
IntsToUints takes a slice of ints and returns a slice of uints
func NameFromEmail ¶
NameFromEmail takes an email address and returns the part that comes before the @ symbol
Example:
NameFromEmail("test_user@example.com")
> "Test_user"
func NamesFromEmails ¶
NamesFromEmails takes a slice of email addresses and returns a slice of the parts that come before the @ symbol
Example:
NamesFromEmail("test_user@example.com", "other_user@example.com")
> []string{"Test_user", "Other_user"}
func OpenFile ¶
func OpenFile(path string)
OpenFile opens the file defined in `path` via the operating system
func PrettyNumber ¶
PrettyNumber formats number as string with 1000 delimiters and, if necessary, rounds it to 2 decimals
func ReadFileBytes ¶
ReadFileBytes reads the contents of a file and returns those contents as a slice of bytes
func RowPadding ¶
RowPadding returns a padding for a row to make it the full width of the containing widget. Useful for ensuring row highlighting spans the full width (I suspect tcell has a better way to do this, but I haven't yet found it)
func StringValueForProperty ¶
StringValueForProperty returns a string value for the given property If the property doesn't exist, it returns an error
func StripColorTags ¶
StripColorTags removes tcell color tags from a given string
func ToInts ¶
func ToInts(slice []interface{}) []int
ToInts takes a slice of interfaces and returns a slice of ints
func ToStrs ¶
func ToStrs(slice []interface{}) []string
ToStrs takes a slice of interfaces and returns a slice of strings
Types ¶
This section is empty.
Source Files