logger

Documentation

Index

• Variables
• type Color
• type Logger
  • func (l *Logger) Errf(color Color, s string, args ...any)
  • func (l *Logger) FOutf(w io.Writer, color Color, s string, args ...any)
  • func (l *Logger) Outf(color Color, s string, args ...any)
  • func (l *Logger) Prompt(color Color, prompt string, defaultValue string, continueValues ...string) error
  • func (l *Logger) VerboseErrf(color Color, s string, args ...any)
  • func (l *Logger) VerboseOutf(color Color, s string, args ...any)
• type PrintFunc
  • func Blue() PrintFunc
  • func Cyan() PrintFunc
  • func Default() PrintFunc
  • func Green() PrintFunc
  • func Magenta() PrintFunc
  • func Red() PrintFunc
  • func Yellow() PrintFunc

Variables

var (
	ErrPromptCancelled = errors.New("prompt cancelled")
	ErrNoTerminal      = errors.New("no terminal")
)

Types

type Color

type Color func() PrintFunc

type Logger

type Logger struct {
	Stdin      io.Reader
	Stdout     io.Writer
	Stderr     io.Writer
	Verbose    bool
	Color      bool
	AssumeYes  bool
	AssumeTerm bool // Used for testing
}

Logger is just a wrapper that prints stuff to STDOUT or STDERR, with optional color.

func (*Logger) Errf

func (l *Logger) Errf(color Color, s string, args ...any)

Errf prints stuff to STDERR.

func (*Logger) FOutf

func (l *Logger) FOutf(w io.Writer, color Color, s string, args ...any)

FOutf prints stuff to the given writer.

func (*Logger) Outf

func (l *Logger) Outf(color Color, s string, args ...any)

Outf prints stuff to STDOUT.

func (*Logger) Prompt

func (l *Logger) Prompt(color Color, prompt string, defaultValue string, continueValues ...string) error

func (*Logger) VerboseErrf

func (l *Logger) VerboseErrf(color Color, s string, args ...any)

VerboseErrf prints stuff to STDERR if verbose mode is enabled.

func (*Logger) VerboseOutf

func (l *Logger) VerboseOutf(color Color, s string, args ...any)

VerboseOutf prints stuff to STDOUT if verbose mode is enabled.

type PrintFunc

type PrintFunc func(io.Writer, string, ...any)

func Blue

func Blue() PrintFunc

func Cyan

func Cyan() PrintFunc

func Default

func Default() PrintFunc

func Green

func Green() PrintFunc

func Magenta

func Magenta() PrintFunc

func Red

func Red() PrintFunc

func Yellow

func Yellow() PrintFunc