terminal

Documentation

Index

• Constants
• Variables
• func ColorBlue(s string) string
• func ColorCyan(s string) string
• func ColorGreen(s string) string
• func ColorMagenta(s string) string
• func ColorRed(s string) string
• func ColorYellow(s string) string
• func Eprint(args ...any) (int, error)
• func Eprintf(format string, args ...any) (int, error)
• func Eprintln(args ...any) (int, error)
• func GetSize() (int, int, error)
• func IndentString(indent int) string
• func Options(options []string) string
• func Print(args ...any) (int, error)
• func PrintIndent(indent int)
• func Printf(format string, args ...any) (int, error)
• func Println(args ...any) (int, error)
• func StylizedOptions(options []string, colorizer Colorizer) string
• type Cleanup
  • func EnableColor(force bool) (Cleanup, error)
  • func ProcessColorizeFlag(colorize string) (Cleanup, error)
• type Colorizer
• type Stylist
  • func NewStylist(colorize bool) *Stylist
  • func (self *Stylist) Error(name string) string
  • func (self *Stylist) Heading(name string) string
  • func (self *Stylist) Name(name string) string
  • func (self *Stylist) Path(name string) string
  • func (self *Stylist) TypeName(name string) string
  • func (self *Stylist) Value(name string) string
• type Table
  • func NewTable(width int, headings ...string) *Table
  • func (self *Table) Add(cells ...string)
  • func (self *Table) ColumnWidths() (int, []int)
  • func (self *Table) Print()
  • func (self *Table) Wrap()
  • func (self *Table) Write(writer io.Writer, stylist *Stylist)
• type TableStyle
• type TreePrefix
  • func (self TreePrefix) Print(indent int, last bool)

Constants

const (
	ResetCode   = escapePrefix + "0" + escapeSuffix
	RedCode     = escapePrefix + "31" + escapeSuffix
	GreenCode   = escapePrefix + "32" + escapeSuffix
	YellowCode  = escapePrefix + "33" + escapeSuffix
	BlueCode    = escapePrefix + "34" + escapeSuffix
	MagentaCode = escapePrefix + "35" + escapeSuffix
	CyanCode    = escapePrefix + "36" + escapeSuffix
)

const (
	TopSeparatorTableStyle = 1 << iota
	ColumnSeparatorTableStyle
	RowSeparatorTableStyle
	BottomSeparatorTableStyle
)

const IndentSpaces = 2

Variables

var Colorize = false

var DefaultStylist = NewStylist(false)

var Indent = strings.Repeat(" ", IndentSpaces)

var Quiet bool = false

Functions

func ColorBlue

func ColorBlue(s string) string

Colorizer signature

func ColorCyan

func ColorCyan(s string) string

Colorizer signature

func ColorGreen

func ColorGreen(s string) string

Colorizer signature

func ColorMagenta

func ColorMagenta(s string) string

Colorizer signature

func ColorRed

func ColorRed(s string) string

Colorizer signature

func ColorYellow

func ColorYellow(s string) string

Colorizer signature

func Eprint

func Eprint(args ...any) (int, error)

func Eprintf

func Eprintf(format string, args ...any) (int, error)

func Eprintln

func Eprintln(args ...any) (int, error)

func GetSize

func GetSize() (int, int, error)

func IndentString

func IndentString(indent int) string

func Options

func Options(options []string) string

func Print

func Print(args ...any) (int, error)

func PrintIndent

func PrintIndent(indent int)

func Printf

func Printf(format string, args ...any) (int, error)

func Println

func Println(args ...any) (int, error)

func StylizedOptions

func StylizedOptions(options []string, colorizer Colorizer) string

Types

type Cleanup

type Cleanup func() error

func EnableColor

func EnableColor(force bool) (Cleanup, error)

func ProcessColorizeFlag

func ProcessColorizeFlag(colorize string) (Cleanup, error)

type Colorizer

type Colorizer func(name string) string

type Stylist

type Stylist struct {
	Colorize bool
}

func NewStylist

func NewStylist(colorize bool) *Stylist

func (*Stylist) Error

func (self *Stylist) Error(name string) string

Colorizer signature

func (*Stylist) Heading

func (self *Stylist) Heading(name string) string

Colorizer signature

func (*Stylist) Name

func (self *Stylist) Name(name string) string

Colorizer signature

func (*Stylist) Path

func (self *Stylist) Path(name string) string

Colorizer signature

func (*Stylist) TypeName

func (self *Stylist) TypeName(name string) string

Colorizer signature

func (*Stylist) Value

func (self *Stylist) Value(name string) string

Colorizer signature

type Table

type Table struct {
	Rows     [][][]string
	Style    TableStyle
	MaxWidth int

	HeadingSeparator       string
	RowSeparator           string
	TopDividerSeparator    string
	TopDivider             string
	MiddleDividerSeparator string
	MiddleDivider          string
	BottomDividerSeparator string
	BottomDivider          string
}

func NewTable

func NewTable(width int, headings ...string) *Table

func (*Table) Add

func (self *Table) Add(cells ...string)

func (*Table) ColumnWidths

func (self *Table) ColumnWidths() (int, []int)

func (*Table) Print

func (self *Table) Print()

func (*Table) Wrap

func (self *Table) Wrap()

func (*Table) Write

func (self *Table) Write(writer io.Writer, stylist *Stylist)

type TableStyle

type TableStyle uint8

type TreePrefix

type TreePrefix []bool

func (TreePrefix) Print

func (self TreePrefix) Print(indent int, last bool)