README
¶
termtext is a Go package to deal with monospace text as interpreted by terminals.
Mostly intended to neatly align/wrap stuff terminal. There are a few tricky bits with this:
- Multiple codepoints can be combined to render one character (or "grapheme cluster" in Unicode speak).
- Some characters are rendered as double-width, such as East-Asian characters, some emojis, and a number of others.
- A single tab can render as multiple spaces, and the number of spaces depends on its position in the string.
- Some characters aren't actually printed to the screen, such as the zero-width space and escape sequences to set the colour.
This package takes care of these issue.
Import as zgo.at/termtext – godoc: https://godocs.io/zgo.at/termtext
The main function is termtext.Width():
Width("\ta") → 9 Tab expands to 8 spaces, followed by "a".
Width("a\t") → 8 Tab expands to 7 spaces.
Width("🧑\t🧑") → 10 🧑 is double-width
Width("\x1b[1mbold\x1b[0m") → 4 Escape sequences are ignored.
You can configure the tab width by setting termtext.TabWidth.
There are a few other functions too:
Expand() Expand tabs.
Slice() Slice a string by display width, like str[n:m].
AlignLeft() Align a string, filling up the remainder with spaces.
AlignRight()
AlignCenter()
Wrap() Wrap a string. This is a simple wrap which just breaks
if a line's width is too long.
WordWrap() Word-wrap a string: lines are at most w wide, but don't
break in the middle of words.
Documentation
¶
Overview ¶
Package termtext deals with monospace text as interpreted by terminals.
Index ¶
- Variables
- func AlignCenter(s string, w int) string
- func AlignLeft(s string, w int) string
- func AlignRight(s string, w int) string
- func Expand(s string) string
- func Slice(s string, start, stop int) string
- func Width(s string) int
- func WordWrap(s string, w int, prefix string) string
- func Wrap(s string, w int, prefix string) string
Constants ¶
This section is empty.
Variables ¶
var TabWidth = 8
Number of spaces to count a tab as.
var Widths map[rune]int
Widths sets the width for the given runes.
This can be useful in some cases where the written text is different. For example when encoding JSON some characters get written as a \-escape. To account for this, you can override the width for those:
termtext.Escapes = map[rune]int{
'\b': 2,
'\f': 2,
'\n': 2,
'\r': 2,
'\t': 2,
}
Functions ¶
func AlignCenter ¶
AlignCenter centre-aligns a string, filling up any remaining width with spaces.
Tabs will be expanded to spaces.
func AlignLeft ¶
AlignLeft left-aligns a string, filling up any remaining width with spaces.
Tabs will be expanded to spaces.
func AlignRight ¶
AlignRight right-aligns a string, filling up any remaining width with spaces.
Tabs will be expanded to spaces.
func Slice ¶
Slice a string by character index. This works the same as str[n:m] slicing.
Tabs will be expanded to spaces.
func Width ¶
Width gets the display width of a string.
The "display width" is the number of columns a string will occupy in a monospace terminal.
Types ¶
This section is empty.
Source Files