common

Documentation

Index

• Constants
• func ResultErrorFromStats(s stats.Stats) error
• func SprintfWithColor(color Color, format string, a ...interface{}) string
• type Color
  • func ColorForStatus(s status.Status) (color Color, setColor bool)
• type ResultError
  • func (a *ResultError) Error() string

Constants

const (
	// RESET is the escape sequence for unsetting any previous commands.
	RESET = 0
	// ESC is the escape sequence used to send ANSI commands in the terminal.
	ESC = 27
)

Functions

func ResultErrorFromStats

func ResultErrorFromStats(s stats.Stats) error

ResultErrorFromStats takes a stats object and returns either a ResultError or nil depending on whether the stats reports that resources failed apply/prune/delete or reconciliation.

func SprintfWithColor

func SprintfWithColor(color Color, format string, a ...interface{}) string

SprintfWithColor formats according to the provided pattern and returns the result as a string with the necessary ansii escape codes for color

Types

type Color

type Color int

color is a type that captures the ANSI code for colors on the terminal.

var (
	RED    Color = 31
	GREEN  Color = 32
	YELLOW Color = 33
)

func ColorForStatus

func ColorForStatus(s status.Status) (color Color, setColor bool)

ColorForStatus returns the appropriate Color, which represents the ansii escape code, for different status values.

type ResultError

type ResultError struct {
	Stats stats.Stats
}

ResultError is returned from printers when the apply/destroy operations completed, but one or more resources either failed apply/prune/delete, or failed to reconcile.

func (*ResultError) Error

func (a *ResultError) Error() string