clierror

Documentation

Index

• Variables
• func AsFlagUsageError(flagName string, err error) error
• func AsFlagUsageErrorf(flagName, format string, a ...interface{}) error
• func AsUsageError(err error) error
• func AsUsageErrorf(format string, a ...interface{}) error
• func NewErrorHandler(logger logr.Logger) cli.ExitErrHandlerFunc

Variables

var (
	// ErrUsage is an error that is caused by an incorrect usage by the user.
	ErrUsage = errors.New("usage error")

	// ErrPipeline is an error that is caused by an action aborting a pipeline.
	ErrPipeline = errors.New("pipeline error")
)

Functions

func AsFlagUsageError

func AsFlagUsageError(flagName string, err error) error

AsFlagUsageError returns a flag ErrUsage with the given error.

func AsFlagUsageErrorf

func AsFlagUsageErrorf(flagName, format string, a ...interface{}) error

AsFlagUsageErrorf returns a flag ErrUsage with the given message.

func AsUsageError

func AsUsageError(err error) error

AsUsageError returns the given error wrapped in a ErrUsage.

func AsUsageErrorf

func AsUsageErrorf(format string, a ...interface{}) error

AsUsageErrorf returns a ErrUsage with the given format

func NewErrorHandler

func NewErrorHandler(logger logr.Logger) cli.ExitErrHandlerFunc

NewErrorHandler will print the CLI help and exit with code 2 if the given error is a ErrUsage.