fmtx

README

fmtx: beautiful and simple text interfaces

Documentation

Index

• Constants
• Variables
• func BgGreenS(s string) string
• func BgRedS(s string) string
• func BlueS(s string) string
• func BoldS(s string) string
• func ColorizeDist[T cmp.Ordered](s string, v T, points []T, colors []string) string
• func ColorizeMinMax[T comparable](s string, v, min, max T, minC, maxC string) string
• func DimS(s string) string
• func GreenS(s string) string
• func HeaderTo(w io.StringWriter, title string)
• func RedS(s string) string
• func Spark(counts map[int]int, width int) string
• func SparkLine(vals []int, maxVal, width int) string
• func VolumeBar[T int | int32 | int64 | float32 | float64](v, max T, width int) string
• func VolumeBar2[T int | int32 | int64](a, b, max T, width int) string
• func YellowS(s string) string
• type Alignment
  • func (a Alignment) Write(out interface{ ... }, s string, width int)
• type TablCol
  • func (s TablCol) Write(out interface{ ... }, v string)
• type TableWriter
  • func (s TableWriter) WriteHeader()
  • func (s TableWriter) WriteHeaderLine()
  • func (s TableWriter) WriteRow(vs ...string)
  • func (s TableWriter) WriteSubHeader(vs ...string)

Constants

const (
	Reset    = "\033[0m"
	Red      = "\033[91m"
	Green    = "\033[92m"
	Yellow   = "\033[93m"
	Blue     = "\033[94m"
	Magenta  = "\033[95m"
	Cyan     = "\033[96m"
	Dim      = "\033[2m"
	Bold     = "\033[1m"
	BgRed    = "\033[41m"
	BgGreen  = "\033[42m"
	BgYellow = "\033[43m"
)

Variables

var EnableColor = os.Getenv("NO_COLOR") == ""

var SparkBlocks = []rune{' ', '▁', '▂', '▃', '▄', '▅', '▆', '▇', '█'}

SparkBlocks are Unicode block characters for drawing sparklines, from empty (space) to full block. Levels 0..8.

Functions

func BgGreenS

func BgGreenS(s string) string

func BgRedS

func BgRedS(s string) string

func BlueS

func BlueS(s string) string

func BoldS

func BoldS(s string) string

func ColorizeDist

func ColorizeDist[T cmp.Ordered](s string, v T, points []T, colors []string) string

ColorizeDist colorizes s based on which interval v falls into. points must be sorted ascending; colors must have len(points)+1 elements. colors[0]: v < points[0] colors[i]: points[i-1] <= v < points[i] colors[len(points)]: v >= points[len(points)-1]

func ColorizeMinMax

func ColorizeMinMax[T comparable](s string, v, min, max T, minC, maxC string) string

func DimS

func DimS(s string) string

func GreenS

func GreenS(s string) string

func HeaderTo

func HeaderTo(w io.StringWriter, title string)

func RedS

func RedS(s string) string

func Spark

func Spark(counts map[int]int, width int) string

Spark renders a sparkline from a sparse bucket→count map. Each of the width positions maps to a SparkBlocks character whose level is proportional to its count relative to maxCount. Useful for rendering Probability Density Function (PDF) - X is value, Y is % of population.

func SparkLine

func SparkLine(vals []int, maxVal, width int) string

SparkLine renders a sparkline from a slice of values. Each value is mapped to a SparkBlocks character proportional to maxVal. The result is stretched to width characters.

func VolumeBar

func VolumeBar[T int | int32 | int64 | float32 | float64](v, max T, width int) string

func VolumeBar2

func VolumeBar2[T int | int32 | int64](a, b, max T, width int) string

func YellowS

func YellowS(s string) string

Types

type Alignment

type Alignment uint8

const (
	AlignUndefined Alignment = iota
	AlignLeft
	AlignRight
)

func (Alignment) Write

func (a Alignment) Write(out interface{ WriteString(string) (int, error) }, s string, width int)

type TablCol

type TablCol struct {
	Header    string
	Alignment Alignment
	Width     int
}

func (TablCol) Write

func (s TablCol) Write(out interface{ WriteString(string) (int, error) }, v string)

type TableWriter

type TableWriter struct {
	Indent string
	Cols   []TablCol
	Out    interface {
		WriteString(s string) (n int, err error)
	}
}

TableWriter provides simple table formatting with ANSI color support. Values that are too long will get truncated into column width.

func (TableWriter) WriteHeader

func (s TableWriter) WriteHeader()

func (TableWriter) WriteHeaderLine

func (s TableWriter) WriteHeaderLine()

func (TableWriter) WriteRow

func (s TableWriter) WriteRow(vs ...string)

func (TableWriter) WriteSubHeader

func (s TableWriter) WriteSubHeader(vs ...string)