term

package
v1.5.5 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 19, 2021 License: MIT Imports: 13 Imported by: 1

Documentation

Overview

Package term same as https://github.com/kubernetes-sigs/kind/tree/master/pkg/internal/env

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func IsSmartTerminal

func IsSmartTerminal(w io.Writer) bool

IsSmartTerminal returns true if the writer w is a terminal AND we think that the terminal is smart enough to use VT escape codes etc.

func IsTerminal

func IsTerminal(w io.Writer) bool

IsTerminal returns true if the writer w is a terminal.

Types

type Logger

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

Logger is the kind cli's log.Logger implementation nolint:maligned

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 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.

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 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(success bool)

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

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.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL