logger

Documentation

Index

• func IsInteractive() bool
• type Logger
• type Spinner
• type StdoutLogger
  • func (l *StdoutLogger) Log(msg string)
  • func (l *StdoutLogger) Logf(format string, args ...interface{})
• type UILogger
  • func NewUILogger() *UILogger
  • func (l *UILogger) Log(msg string)
  • func (l *UILogger) Logf(format string, args ...interface{})
  • func (l *UILogger) StartSpinner(text string) Spinner

Functions

func IsInteractive

func IsInteractive() bool

IsTerminal reports whether stdout is attached to a terminal. Used to decide when to use interactive UI elements like spinners.

Types

type Logger

type Logger interface {
	Logf(format string, args ...interface{})
	Log(msg string)
}

type Spinner

type Spinner interface {
	// Update changes the spinner text while running.
	Update(text string)
	// Stop stops the spinner and prints a success indicator.
	Stop()
	// Fail stops the spinner and prints a failure indicator.
	Fail()
}

Spinner displays progress for a long-running operation. Implementations should be safe for single-threaded Start/Stop/Fail usage.

type StdoutLogger

type StdoutLogger struct{}

func (*StdoutLogger) Log

func (l *StdoutLogger) Log(msg string)

func (*StdoutLogger) Logf

func (l *StdoutLogger) Logf(format string, args ...interface{})

type UILogger

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

func NewUILogger

func NewUILogger() *UILogger

func (*UILogger) Log

func (l *UILogger) Log(msg string)

func (*UILogger) Logf

func (l *UILogger) Logf(format string, args ...interface{})

func (*UILogger) StartSpinner

func (l *UILogger) StartSpinner(text string) Spinner