cli

Documentation

Index

• type Logger
  • func NewLogger(writer io.Writer, verbosity log.Level) *Logger
  • func (l *Logger) ColorEnabled() bool
  • func (l *Logger) Error(message string)
  • func (l *Logger) Errorf(format string, args ...interface{})
  • func (l *Logger) SetVerbosity(verbosity log.Level)
  • func (l *Logger) SetWriter(w io.Writer)
  • func (l *Logger) V(level log.Level) log.InfoLogger
  • func (l *Logger) Warn(message string)
  • func (l *Logger) Warnf(format string, args ...interface{})
• type Result
  • func CheckForError(err error) Result
• type Spinner
  • func NewSpinner(w io.Writer) *Spinner
  • func (s *Spinner) SetPrefix(prefix string)
  • func (s *Spinner) SetSuffix(suffix string)
  • func (s *Spinner) Start()
  • func (s *Spinner) Stop()
  • func (s *Spinner) Write(p []byte) (n int, err error)
• type Status
  • func NewStatus() *Status
  • func StatusForLogger(l log.Logger) *Status
  • func (s *Status) End(output Result)
  • func (s *Status) EndWithFailure(message string, a ...interface{})
  • func (s *Status) EndWithSuccess(message string, a ...interface{})
  • func (s *Status) EndWithWarning(message string, a ...interface{})
  • func (s *Status) HasFailureMessages() bool
  • func (s *Status) HasWarningMessages() bool
  • func (s *Status) QueueFailureMessage(message string)
  • func (s *Status) QueueSuccessMessage(message string)
  • func (s *Status) QueueWarningMessage(message string)
  • func (s *Status) ResultFromMessages() Result
  • func (s *Status) Start(status string)

Types

type Logger

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

Logger is the kind cli's log.Logger implementation

func NewLogger

func NewLogger(writer io.Writer, verbosity log.Level) *Logger

NewLogger returns a new Logger with the given verbosity

func (*Logger) ColorEnabled

func (l *Logger) ColorEnabled() bool

ColorEnabled returns true if the caller is OK to write colored output

func (*Logger) Error

func (l *Logger) Error(message string)

Error is part of the log.Logger interface

func (*Logger) Errorf

func (l *Logger) Errorf(format string, args ...interface{})

Errorf is part of the log.Logger interface

func (*Logger) SetVerbosity

func (l *Logger) SetVerbosity(verbosity log.Level)

SetVerbosity sets the loggers verbosity

func (*Logger) SetWriter

func (l *Logger) SetWriter(w io.Writer)

SetWriter sets the output writer

func (*Logger) V

func (l *Logger) V(level log.Level) log.InfoLogger

V is part of the log.Logger interface

func (*Logger) Warn

func (l *Logger) Warn(message string)

Warn is part of the log.Logger interface

func (*Logger) Warnf

func (l *Logger) Warnf(format string, args ...interface{})

Warnf is part of the log.Logger interface

type Result

type Result int

const (
	Success Result = iota
	Failure
	Warning
)

func CheckForError

func CheckForError(err error) Result

type Spinner

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

Spinner is a simple and efficient CLI loading spinner used by kind It is simplistic and assumes that the line length will not change.

func NewSpinner

func NewSpinner(w io.Writer) *Spinner

NewSpinner initializes and returns a new Spinner that will write to w NOTE: w should be os.Stderr or similar, and it should be a Terminal

func (*Spinner) SetPrefix

func (s *Spinner) SetPrefix(prefix string)

SetPrefix sets the prefix to print before the spinner

func (*Spinner) SetSuffix

func (s *Spinner) SetSuffix(suffix string)

SetSuffix sets the suffix to print after the spinner

func (*Spinner) Start

func (s *Spinner) Start()

Start starts the spinner running

func (*Spinner) Stop

func (s *Spinner) Stop()

Stop signals the spinner to stop

func (*Spinner) Write

func (s *Spinner) Write(p []byte) (n int, err error)

Write implements io.Writer, interrupting the spinner and writing to the inner writer

type Status

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

Status is used to track ongoing status in a CLI, with a nice loading spinner when attached to a terminal

func NewStatus

func NewStatus() *Status

func StatusForLogger

func StatusForLogger(l log.Logger) *Status

StatusForLogger returns a new status object for the logger l, if l is the kind cli logger and the writer is a Spinner, that spinner will be used for the status

func (*Status) End

func (s *Status) End(output Result)

End completes the current status, ending any previous spinning and marking the status as success or failure

func (*Status) EndWithFailure

func (s *Status) EndWithFailure(message string, a ...interface{})

func (*Status) EndWithSuccess

func (s *Status) EndWithSuccess(message string, a ...interface{})

func (*Status) EndWithWarning

func (s *Status) EndWithWarning(message string, a ...interface{})

func (*Status) HasFailureMessages

func (s *Status) HasFailureMessages() bool

func (*Status) HasWarningMessages

func (s *Status) HasWarningMessages() bool

func (*Status) QueueFailureMessage

func (s *Status) QueueFailureMessage(message string)

QueueFailureMessage queues up a message, which will be displayed once the status ends (using the failure format)

func (*Status) QueueSuccessMessage

func (s *Status) QueueSuccessMessage(message string)

QueueSuccessMessage queues up a message, which will be displayed once the status ends (using the success format)

func (*Status) QueueWarningMessage

func (s *Status) QueueWarningMessage(message string)

QueuewarningMessage queues up a message, which will be displayed once the status ends (using the warning format)

func (*Status) ResultFromMessages

func (s *Status) ResultFromMessages() Result

func (*Status) Start

func (s *Status) Start(status string)

Start starts a new phase of the status, if attached to a terminal there will be a loading spinner with this status