tl

Documentation

Index

• type OptionApplier
  • func WithExitOnError(exitOnError bool) OptionApplier
• type Result
• type Runner
  • func New(tasks []*Task, options ...OptionApplier) *Runner
  • func (runner *Runner) Run() error
• type Task
  • func NewTask(title string, run func(callback TaskCallback) error, options ...OptionApplier) *Task
  • func (t *Task) Id() string
• type TaskCallback
• type TaskList
  • func NewTaskList(tasks []*Task, options ...OptionApplier) *TaskList

Types

type OptionApplier

type OptionApplier func(o *option)

func WithExitOnError

func WithExitOnError(exitOnError bool) OptionApplier

type Result

type Result struct {
	Task     *Task
	TaskList *TaskList

	Enabled    bool
	Skipped    bool
	SkipReason string
	Hide       bool
	Error      bool
	Err        error

	SubResults []*Result
}

type Runner

type Runner struct {
	// contains filtered or unexported fields
}

func New

func New(tasks []*Task, options ...OptionApplier) *Runner

func (*Runner) Run

func (runner *Runner) Run() error

type Task

type Task struct {
	Title string
	Run   func(callback TaskCallback) error
	// PostRun runs after Run (even if Run failed) with result
	PostRun func(result *Result)
	Enable  func() bool

	Options []OptionApplier
	// contains filtered or unexported fields
}

func NewTask

func NewTask(title string, run func(callback TaskCallback) error, options ...OptionApplier) *Task

func (*Task) Id

func (t *Task) Id() string

Id only available after run

type TaskCallback

type TaskCallback interface {
	GetTask() *Task
	//Log(msg string)
	Hide()
	Skip(reason string)
	AddSubTaskList(taskList *TaskList)
	AddSubTask(tasks ...*Task)
}

type TaskList

type TaskList struct {
	Tasks   []*Task
	Options []OptionApplier
	// contains filtered or unexported fields
}

func NewTaskList

func NewTaskList(tasks []*Task, options ...OptionApplier) *TaskList