text

Documentation

Overview

Package text is a set of utility functions for text processing and outputting to the terminal.

Index

• func DisplayWidth(s string) int
• func Indent(s, indent string) string
• func Pluralize(num int, thing string) string
• func RelativeTimeAgo(a, b time.Time) string
• func Truncate(maxWidth int, s string) string

Functions

func DisplayWidth

func DisplayWidth(s string) int

DisplayWidth calculates what the rendered width of string s will be.

func Indent

func Indent(s, indent string) string

Indent returns a copy of the string s with indent prefixed to it, will apply indent to each line of the string.

func Pluralize

func Pluralize(num int, thing string) string

Pluralize returns a concatenated string with num and the plural form of thing if necessary.

func RelativeTimeAgo

func RelativeTimeAgo(a, b time.Time) string

RelativeTimeAgo returns a human readable string of the time duration between a and b that is estimated to the nearest unit of time.

func Truncate

func Truncate(maxWidth int, s string) string

Truncate returns a copy of the string s that has been shortened to fit the maximum display width.