tux

README

TUX: Terminal UX

This package contains utilities that we used to render messages in our CLI app. For now, starting it within envsec, but if it grows, and we use it beyond envsec, it could become a top-level module, that we open source as well.

Documentation

Index

• func FTable(w io.Writer, rows [][]string)
• func Plural[T any](items []T, singular string, plural string) string
• func QuotedTerms(terms []string) []string
• func Render(styleSheet StyleSheet, class string, text string) string
• func StyleFunc(styleSheet StyleSheet) func(class string, text string) string
• func WriteHeader(w io.Writer, format string, a ...any) error
• type StyleRenderer
  • func Renderer(styleRule StyleRule, tokens map[string]string) StyleRenderer
• type StyleRule
• type StyleSheet
• type Tux
  • func New() *Tux
  • func (tux *Tux) MustPrintErr(a ...any)
  • func (tux *Tux) PrintT(text string, data any)
  • func (tux *Tux) SetErr(w io.Writer)
  • func (tux *Tux) SetIn(r io.Reader)
  • func (tux *Tux) SetOut(w io.Writer)
  • func (tux *Tux) SetStyleSheet(styleSheet StyleSheet)

Functions

func FTable

func FTable(w io.Writer, rows [][]string)

func Plural

func Plural[T any](items []T, singular string, plural string) string

func QuotedTerms

func QuotedTerms(terms []string) []string

QuotedTerms will wrap each term in single-quotation marks

func Render

func Render(styleSheet StyleSheet, class string, text string) string

func StyleFunc

func StyleFunc(styleSheet StyleSheet) func(class string, text string) string

func WriteHeader

func WriteHeader(w io.Writer, format string, a ...any) error

TODO: Migrate to style sheets

Types

type StyleRenderer

type StyleRenderer interface {
	Render(str ...string) string
}

func Renderer

func Renderer(styleRule StyleRule, tokens map[string]string) StyleRenderer

type StyleRule

type StyleRule struct {
	Bold               bool
	Italic             bool
	Underline          bool
	Strikethrough      bool
	Blink              bool
	Faint              bool
	Foreground         string
	ForegroundInverted string
	Background         string
	BackgroundInverted string
	PaddingTop         int
	PaddingRight       int
	PaddingBottom      int
	PaddingLeft        int
	MarginTop          int
	MarginRight        int
	MarginBottom       int
	MarginLeft         int
}

type StyleSheet

type StyleSheet struct {
	Styles map[string]StyleRule
	Tokens map[string]string
}

type Tux

type Tux struct {
	// contains filtered or unexported fields
}

func New

func New() *Tux

func (*Tux) MustPrintErr

func (tux *Tux) MustPrintErr(a ...any)

func (*Tux) PrintT

func (tux *Tux) PrintT(text string, data any)

func (*Tux) SetErr

func (tux *Tux) SetErr(w io.Writer)

func (*Tux) SetIn

func (tux *Tux) SetIn(r io.Reader)

func (*Tux) SetOut

func (tux *Tux) SetOut(w io.Writer)

func (*Tux) SetStyleSheet

func (tux *Tux) SetStyleSheet(styleSheet StyleSheet)