tools

Documentation

Index

• Variables
• func DisplayWidth(s string) int
• func Indent(s, indent string) string
• func IsUserCancellation(err error) bool
• func MutuallyExclusive(message string, conditions ...bool) error
• func PrintError(out io.Writer, err error, cmd *cobra.Command, debug bool)
• func ReplaceExcessiveWhitespace(s string) string
• func Truncate(maxWidth int, s string) string
• func TruncateColumn(maxWidth int, s string) string
• type FlagError
  • func (fe FlagError) Error() string
  • func (fe FlagError) Unwrap() error

Variables

var CancelError = errors.New("CancelError")

CancelError signals user-initiated cancellation

var SilentError = errors.New("SilentError")

SilentError is an error that triggers exit code 1 without any error messaging

Functions

func DisplayWidth

func DisplayWidth(s string) int

DisplayWidth calculates what the rendered width of a string may be

func Indent

func Indent(s, indent string) string

func IsUserCancellation

func IsUserCancellation(err error) bool

func MutuallyExclusive

func MutuallyExclusive(message string, conditions ...bool) error

func PrintError

func PrintError(out io.Writer, err error, cmd *cobra.Command, debug bool)

func ReplaceExcessiveWhitespace

func ReplaceExcessiveWhitespace(s string) string

func Truncate

func Truncate(maxWidth int, s string) string

Truncate shortens a string to fit the maximum display width

func TruncateColumn

func TruncateColumn(maxWidth int, s string) string

TruncateColumn replaces the first new line character with an ellipsis and shortens a string to fit the maximum display width

Types

type FlagError

type FlagError struct {
	Err error
}

FlagError is the kind of error raised in flag processing

func (FlagError) Error

func (fe FlagError) Error() string

func (FlagError) Unwrap

func (fe FlagError) Unwrap() error