errs

Documentation

Overview

Package errs provides typed errors with exit codes and user-facing hints.

Index

• func GetExitCode(err error) int
• type CLIError
  • func AuthError(msg, hint string) *CLIError
  • func ConfigError(msg, hint string) *CLIError
  • func General(msg string) *CLIError
  • func Generalf(format string, args ...any) *CLIError
  • func NetworkError(msg string, cause error) *CLIError
  • func PermissionError(msg, hint string) *CLIError
  • func RateLimitError(msg, hint string) *CLIError
  • func RemoteAPIError(msg string, cause error) *CLIError
  • func UsageError(msg, hint string) *CLIError
  • func Wrap(code int, msg string, cause error) *CLIError
  • func (e *CLIError) Error() string
  • func (e *CLIError) ExitCode() int
  • func (e *CLIError) Format() string
  • func (e *CLIError) Unwrap() error

Functions

func GetExitCode

func GetExitCode(err error) int

GetExitCode extracts the exit code from an error, defaulting to 1.

Types

type CLIError

type CLIError struct {
	Code    int
	Message string
	Hint    string
	Cause   error
}

CLIError is a structured error with an exit code and optional hint.

func AuthError

func AuthError(msg, hint string) *CLIError

func ConfigError

func ConfigError(msg, hint string) *CLIError

func General

func General(msg string) *CLIError

func Generalf

func Generalf(format string, args ...any) *CLIError

func NetworkError

func NetworkError(msg string, cause error) *CLIError

func PermissionError

func PermissionError(msg, hint string) *CLIError

func RateLimitError

func RateLimitError(msg, hint string) *CLIError

func RemoteAPIError

func RemoteAPIError(msg string, cause error) *CLIError

func UsageError

func UsageError(msg, hint string) *CLIError

func Wrap

func Wrap(code int, msg string, cause error) *CLIError

func (*CLIError) Error

func (e *CLIError) Error() string

func (*CLIError) ExitCode

func (e *CLIError) ExitCode() int

func (*CLIError) Format

func (e *CLIError) Format() string

Format returns the full user-facing error message with hint.

func (*CLIError) Unwrap

func (e *CLIError) Unwrap() error