pterm

README

Documentation

Index

• Variables
• type Color
  • func (c Color) Print(a ...interface{})
  • func (c Color) Printf(format string, a ...interface{})
  • func (c Color) Println(a ...interface{})
  • func (c Color) Sprint(a ...interface{}) string
  • func (c Color) Sprintf(format string, a ...interface{}) string
  • func (c Color) Sprintln(a ...interface{}) string
  • func (c Color) String() string
• type GenericPrinter
• type Prefix
• type PrefixPrinter
  • func (p PrefixPrinter) GetFormattedMessage(a ...interface{}) string
  • func (p PrefixPrinter) GetFormattedPrefix() string
  • func (p PrefixPrinter) Print(a ...interface{})
  • func (p PrefixPrinter) Printf(format string, a ...interface{})
  • func (p PrefixPrinter) Println(a ...interface{})
  • func (p PrefixPrinter) Sprint(a ...interface{}) string
  • func (p PrefixPrinter) Sprintf(format string, a ...interface{}) string
  • func (p PrefixPrinter) Sprintln(a ...interface{}) string
  • func (p PrefixPrinter) WithScope(scope string, style ...Style) *PrefixPrinter
• type Scope
• type Style
  • func New(colors ...Color) Style
  • func (s Style) Code() string
  • func (s Style) Print(a ...interface{})
  • func (s Style) Printf(format string, a ...interface{})
  • func (s Style) Println(a ...interface{})
  • func (s Style) Sprint(a ...interface{}) string
  • func (s Style) Sprintf(format string, a ...interface{}) string
  • func (s Style) Sprintln(a ...interface{}) string
  • func (s Style) String() string

Variables

var (
	Print   = color.Print
	Printf  = color.Printf
	Println = color.Println

	Sprint  = color.Sprint
	Sprintf = color.Sprintf
)

var (
	Red     = FgRed.Sprint
	Cyan    = FgCyan.Sprint
	Gray    = FgGray.Sprint
	Blue    = FgBlue.Sprint
	Black   = FgBlack.Sprint
	Green   = FgGreen.Sprint
	White   = FgWhite.Sprint
	Yellow  = FgYellow.Sprint
	Magenta = FgMagenta.Sprint

	Normal = color.Normal.Sprint

	LightRed     = FgLightRed.Sprint
	LightCyan    = FgLightCyan.Sprint
	LightBlue    = FgLightBlue.Sprint
	LightGreen   = FgLightGreen.Sprint
	LightWhite   = FgLightWhite.Sprint
	LightYellow  = FgLightYellow.Sprint
	LightMagenta = FgLightMagenta.Sprint
)

var (
	InfoPrinter = PrefixPrinter{
		Prefix: Prefix{
			Text:  "INFO",
			Style: New(FgWhite, BgCyan),
		},
		MessageStyle: New(FgLightCyan),
	}

	WarningPrinter = PrefixPrinter{
		Prefix: Prefix{
			Text:  "WARNING",
			Style: New(FgWhite, BgYellow),
		},
		MessageStyle: New(FgYellow),
	}

	SuccessPrinter = PrefixPrinter{
		Prefix: Prefix{
			Text:  "SUCCESS",
			Style: New(FgWhite, BgGreen),
		},
		MessageStyle: New(FgGreen),
	}

	ErrorPrinter = PrefixPrinter{
		Prefix: Prefix{
			Text:  "ERROR",
			Style: New(FgWhite, BgLightRed),
		},
		MessageStyle: New(FgLightRed),
	}

	DescriptionPrinter = PrefixPrinter{
		Prefix: Prefix{
			Text:  "Description",
			Style: Style{BgDarkGray, FgLightWhite},
		},
		MessageStyle: Style{BgDarkGray, FgLightWhite},
	}

	AllPrinters = []PrefixPrinter{SuccessPrinter, InfoPrinter, WarningPrinter, ErrorPrinter, DescriptionPrinter}
)

var (
	GrayBoxStyle = New(BgGray, FgLightWhite)
)

Types

type Color

type Color uint8

const (
	FgBlack Color = iota + 30
	FgRed
	FgGreen
	FgYellow
	FgBlue
	FgMagenta // 品红
	FgCyan    // 青色
	FgWhite
	// FgDefault revert default FG
	FgDefault Color = 39
)

Foreground colors. basic foreground colors 30 - 37

const (
	FgDarkGray Color = iota + 90 // 亮黑（灰）
	FgLightRed
	FgLightGreen
	FgLightYellow
	FgLightBlue
	FgLightMagenta
	FgLightCyan
	FgLightWhite
	// FgGray is alias of FgDarkGray
	FgGray Color = 90 // 亮黑（灰）
)

Extra foreground color 90 - 97(非标准)

const (
	BgBlack Color = iota + 40
	BgRed
	BgGreen
	BgYellow // BgBrown like yellow
	BgBlue
	BgMagenta
	BgCyan
	BgWhite
	// BgDefault revert default BG
	BgDefault Color = 49
)

Background colors. basic background colors 40 - 47

const (
	BgDarkGray Color = iota + 100
	BgLightRed
	BgLightGreen
	BgLightYellow
	BgLightBlue
	BgLightMagenta
	BgLightCyan
	BgLightWhite
	// BgGray is alias of BgDarkGray
	BgGray Color = 100
)

Extra background color 100 - 107(非标准)

const (
	Reset         Color = iota // 0 重置所有设置
	Bold                       // 1 加粗
	Fuzzy                      // 2 模糊(不是所有的终端仿真器都支持)
	Italic                     // 3 斜体(不是所有的终端仿真器都支持)
	Underscore                 // 4 下划线
	Blink                      // 5 闪烁
	FastBlink                  // 5 快速闪烁(未广泛支持)
	Reverse                    // 7 颠倒的 交换背景色与前景色
	Concealed                  // 8 隐匿的
	Strikethrough              // 9 删除的，删除线(未广泛支持)
)

Option settings

func (Color) Print

func (c Color) Print(a ...interface{})

func (Color) Printf

func (c Color) Printf(format string, a ...interface{})

func (Color) Println

func (c Color) Println(a ...interface{})

func (Color) Sprint

func (c Color) Sprint(a ...interface{}) string

func (Color) Sprintf

func (c Color) Sprintf(format string, a ...interface{}) string

func (Color) Sprintln

func (c Color) Sprintln(a ...interface{}) string

func (Color) String

func (c Color) String() string

String converts the color a string. eg "35"

type GenericPrinter

type GenericPrinter interface {
	Sprint(a ...interface{}) string
	Sprintln(a ...interface{}) string
	Sprintf(format string, a ...interface{}) string
	Print(a ...interface{})
	Println(a ...interface{})
	Printf(format string, a ...interface{})
}

type Prefix

type Prefix struct {
	Text  string
	Style Style
}

type PrefixPrinter

type PrefixPrinter struct {
	Prefix       Prefix
	Scope        Scope
	MessageStyle Style
}

func (PrefixPrinter) GetFormattedMessage

func (p PrefixPrinter) GetFormattedMessage(a ...interface{}) string

func (PrefixPrinter) GetFormattedPrefix

func (p PrefixPrinter) GetFormattedPrefix() string

func (PrefixPrinter) Print

func (p PrefixPrinter) Print(a ...interface{})

func (PrefixPrinter) Printf

func (p PrefixPrinter) Printf(format string, a ...interface{})

func (PrefixPrinter) Println

func (p PrefixPrinter) Println(a ...interface{})

func (PrefixPrinter) Sprint

func (p PrefixPrinter) Sprint(a ...interface{}) string

func (PrefixPrinter) Sprintf

func (p PrefixPrinter) Sprintf(format string, a ...interface{}) string

func (PrefixPrinter) Sprintln

func (p PrefixPrinter) Sprintln(a ...interface{}) string

func (PrefixPrinter) WithScope

func (p PrefixPrinter) WithScope(scope string, style ...Style) *PrefixPrinter

type Scope

type Scope struct {
	Text  string
	Style Style
}

type Style

type Style []Color

func New

func New(colors ...Color) Style

func (Style) Code

func (s Style) Code() string

Code convert to code string. returns like "32;45;3"

func (Style) Print

func (s Style) Print(a ...interface{})

func (Style) Printf

func (s Style) Printf(format string, a ...interface{})

func (Style) Println

func (s Style) Println(a ...interface{})

func (Style) Sprint

func (s Style) Sprint(a ...interface{}) string

func (Style) Sprintf

func (s Style) Sprintf(format string, a ...interface{}) string

func (Style) Sprintln

func (s Style) Sprintln(a ...interface{}) string

func (Style) String

func (s Style) String() string

String convert to code string. returns like "32;45;3"