cli

Documentation

Index

• Variables
• type CliLoggerOptions
• type ColorCode
• type DotPreloader
  • func NewDotPreloader(message string, interactiveMode bool) DotPreloader
• type StyledCliLogger
  • func NewStyledCliLogger(out io.Writer, err io.Writer, options *CliLoggerOptions) StyledCliLogger
• type StyledText
  • func CGreen(a any) StyledText
  • func CRed(a any) StyledText
  • func Colorize(color ColorCode, a any) StyledText
  • func Colorizef(color ColorCode, format string, a ...any) StyledText

Variables

var GreenText = "\033[32m"

var RedText = "\033[31m"

var YellowText = "\033[33m"

Types

type CliLoggerOptions

type CliLoggerOptions struct {
	ApplyStylingForOut bool
	ApplyStylingForErr bool
}

type ColorCode

type ColorCode = string

type DotPreloader

type DotPreloader interface {
	Start()
	Stop()
	StopWith(finishMessage string)
}

func NewDotPreloader

func NewDotPreloader(message string, interactiveMode bool) DotPreloader

NewDotPreloader factory to create new DotPreloader - message: message to show before preloader - interactiveMode: if true, preloader will be animated, otherwise it will be static

type StyledCliLogger

type StyledCliLogger interface {
	Infof(format string, a ...any)
	Info(a ...any)
	Errorf(format string, a ...any)
	Error(a ...any)
	Errorc(color ColorCode, a ...any)
	Errorfc(color ColorCode, format string, a ...any)
}

func NewStyledCliLogger

func NewStyledCliLogger(out io.Writer, err io.Writer, options *CliLoggerOptions) StyledCliLogger

type StyledText

type StyledText interface {
	String() string
}

func CGreen

func CGreen(a any) StyledText

func CRed

func CRed(a any) StyledText

func Colorize

func Colorize(color ColorCode, a any) StyledText

func Colorizef

func Colorizef(color ColorCode, format string, a ...any) StyledText