errors

Documentation

Index

• Constants
• func New(text string) error
• type TaskCalledTooManyTimesError
  • func (err *TaskCalledTooManyTimesError) Code() int
  • func (err *TaskCalledTooManyTimesError) Error() string
• type TaskCancelledByUserError
  • func (err *TaskCancelledByUserError) Code() int
  • func (err *TaskCancelledByUserError) Error() string
• type TaskCancelledNoTerminalError
  • func (err *TaskCancelledNoTerminalError) Code() int
  • func (err *TaskCancelledNoTerminalError) Error() string
• type TaskError
• type TaskInternalError
  • func (err *TaskInternalError) Code() int
  • func (err *TaskInternalError) Error() string
• type TaskMissingRequiredVars
  • func (err *TaskMissingRequiredVars) Code() int
  • func (err *TaskMissingRequiredVars) Error() string
• type TaskNameConflictError
  • func (err *TaskNameConflictError) Code() int
  • func (err *TaskNameConflictError) Error() string
• type TaskNotFoundError
  • func (err *TaskNotFoundError) Code() int
  • func (err *TaskNotFoundError) Error() string
• type TaskRunError
  • func (err *TaskRunError) Code() int
  • func (err *TaskRunError) Error() string
  • func (err *TaskRunError) TaskExitCode() int
• type TaskfileAlreadyExistsError
  • func (err TaskfileAlreadyExistsError) Code() int
  • func (err TaskfileAlreadyExistsError) Error() string
• type TaskfileInvalidError
  • func (err TaskfileInvalidError) Code() int
  • func (err TaskfileInvalidError) Error() string
• type TaskfileNotFoundError
  • func (err TaskfileNotFoundError) Code() int
  • func (err TaskfileNotFoundError) Error() string

Constants

const (
	CodeOk      int = iota // Used when the program exits without errors
	CodeUnknown            // Used when no other exit code is appropriate
)

General exit codes

const (
	CodeTaskfileNotFound int = iota + 100
	CodeTaskfileAlreadyExists
	CodeTaskfileInvalid
)

Taskfile related exit codes

const (
	CodeTaskNotFound int = iota + 200
	CodeTaskRunError
	CodeTaskInternal
	CodeTaskNameConflict
	CodeTaskCalledTooManyTimes
	CodeTaskCancelled
	CodeTaskMissingRequiredVars
)

Task related exit codes

Functions

func New

func New(text string) error

New returns an error that formats as the given text. Each call to New returns a distinct error value even if the text is identical. This wraps the standard errors.New function so that we don't need to alias that package.

Types

type TaskCalledTooManyTimesError

type TaskCalledTooManyTimesError struct {
	TaskName        string
	MaximumTaskCall int
}

TaskCalledTooManyTimesError is returned when the maximum task call limit is exceeded. This is to prevent infinite loops and cyclic dependencies.

func (*TaskCalledTooManyTimesError) Code

func (err *TaskCalledTooManyTimesError) Code() int

func (*TaskCalledTooManyTimesError) Error

func (err *TaskCalledTooManyTimesError) Error() string

type TaskCancelledByUserError

type TaskCancelledByUserError struct {
	TaskName string
}

TaskCancelledByUserError is returned when the user does not accept an optional prompt to continue.

func (*TaskCancelledByUserError) Code

func (err *TaskCancelledByUserError) Code() int

func (*TaskCancelledByUserError) Error

func (err *TaskCancelledByUserError) Error() string

type TaskCancelledNoTerminalError

type TaskCancelledNoTerminalError struct {
	TaskName string
}

TaskCancelledNoTerminalError is returned when trying to run a task with a prompt in a non-terminal environment.

func (*TaskCancelledNoTerminalError) Code

func (err *TaskCancelledNoTerminalError) Code() int

func (*TaskCancelledNoTerminalError) Error

func (err *TaskCancelledNoTerminalError) Error() string

type TaskError

type TaskError interface {
	error
	Code() int
}

TaskError extends the standard error interface with a Code method. This code will be used as the exit code of the program which allows the user to distinguish between different types of errors.

type TaskInternalError

type TaskInternalError struct {
	TaskName string
}

TaskInternalError when the user attempts to invoke a task that is internal.

func (*TaskInternalError) Code

func (err *TaskInternalError) Code() int

func (*TaskInternalError) Error

func (err *TaskInternalError) Error() string

type TaskMissingRequiredVars

type TaskMissingRequiredVars struct {
	TaskName    string
	MissingVars []string
}

TaskMissingRequiredVars is returned when a task is missing required variables.

func (*TaskMissingRequiredVars) Code

func (err *TaskMissingRequiredVars) Code() int

func (*TaskMissingRequiredVars) Error

func (err *TaskMissingRequiredVars) Error() string

type TaskNameConflictError

type TaskNameConflictError struct {
	AliasName string
	TaskNames []string
}

TaskNameConflictError is returned when multiple tasks with the same name or alias are found.

func (*TaskNameConflictError) Code

func (err *TaskNameConflictError) Code() int

func (*TaskNameConflictError) Error

func (err *TaskNameConflictError) Error() string

type TaskNotFoundError

type TaskNotFoundError struct {
	TaskName   string
	DidYouMean string
}

TaskNotFoundError is returned when the specified task is not found in the Taskfile.

func (*TaskNotFoundError) Code

func (err *TaskNotFoundError) Code() int

func (*TaskNotFoundError) Error

func (err *TaskNotFoundError) Error() string

type TaskRunError

type TaskRunError struct {
	TaskName string
	Err      error
}

TaskRunError is returned when a command in a task returns a non-zero exit code.

func (*TaskRunError) Code

func (err *TaskRunError) Code() int

func (*TaskRunError) Error

func (err *TaskRunError) Error() string

func (*TaskRunError) TaskExitCode

func (err *TaskRunError) TaskExitCode() int

type TaskfileAlreadyExistsError

type TaskfileAlreadyExistsError struct{}

TaskfileAlreadyExistsError is returned on creating a Taskfile if one already exists.

func (TaskfileAlreadyExistsError) Code

func (err TaskfileAlreadyExistsError) Code() int

func (TaskfileAlreadyExistsError) Error

func (err TaskfileAlreadyExistsError) Error() string

type TaskfileInvalidError

type TaskfileInvalidError struct {
	FilePath string
	Err      error
}

TaskfileInvalidError is returned when the Taskfile contains syntax errors or cannot be parsed for some reason.

func (TaskfileInvalidError) Code

func (err TaskfileInvalidError) Code() int

func (TaskfileInvalidError) Error

func (err TaskfileInvalidError) Error() string

type TaskfileNotFoundError

type TaskfileNotFoundError struct {
	Dir  string
	Walk bool
}

TaskfileNotFoundError is returned when no appropriate Taskfile is found when searching the filesystem.

func (TaskfileNotFoundError) Code

func (err TaskfileNotFoundError) Code() int

func (TaskfileNotFoundError) Error

func (err TaskfileNotFoundError) Error() string