taskrunner

README

taskrunner

---

License: Apache-2.0
Created: 01.03.2025
Copyright: 2025 The Happy Authors

Documentation

Index

• type Action
• type Executor
  • func (e *Executor) AddTick()
  • func (e *Executor) Println(a ...any) (n int, err error)
  • func (e *Executor) Program() *tea.Program
  • func (e *Executor) Stdout() *os.File
  • func (e *Executor) Subtask(name string, action Action) TaskID
  • func (e *Executor) SubtaskD(dep TaskID, name string, action Action) TaskID
• type OutputMsg
• type Result
  • func Failure(msg string) Result
  • func Info(msg string) Result
  • func Notice(msg string) Result
  • func Skip(msg string) Result
  • func Success(msg string) Result
  • func Warn(msg string) Result
  • func (r Result) WithDesc(desc string) Result
• type Runner
  • func New() *Runner
  • func (tr *Runner) Add(name string, action Action) TaskID
  • func (tr *Runner) AddD(dep TaskID, name string, action Action) TaskID
  • func (tr *Runner) AddTask(task Task) TaskID
  • func (tr *Runner) Run() error
• type SetStatusMsg
• type State
• type Task
  • func NewTask(name string, action Action) Task
  • func (t Task) DependsOn(dep TaskID) Task
• type TaskID

Types

type Action

type Action func(ex *Executor) (res Result)

type Executor

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

func (*Executor) AddTick

func (e *Executor) AddTick()

AddTick adds a tick to the executor which is affecting the executor's progress bar.

func (*Executor) Println

func (e *Executor) Println(a ...any) (n int, err error)

func (*Executor) Program

func (e *Executor) Program() *tea.Program

func (*Executor) Stdout

func (e *Executor) Stdout() *os.File

func (*Executor) Subtask

func (e *Executor) Subtask(name string, action Action) TaskID

func (*Executor) SubtaskD

func (e *Executor) SubtaskD(dep TaskID, name string, action Action) TaskID

type OutputMsg

type OutputMsg string

type Result

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

func Failure

func Failure(msg string) Result

Failure utility function to create Result with state FAILURE

func Info

func Info(msg string) Result

Info utility function to create Result with state INFO

func Notice

func Notice(msg string) Result

Notice utility function to create Result with state INFO

func Skip

func Skip(msg string) Result

Skip utility function to create Result with state FAILURE

func Success

func Success(msg string) Result

Success utility function to create Result with state SUCCESS

func Warn

func Warn(msg string) Result

Warn utility function to create Result with state WARNING

func (Result) WithDesc

func (r Result) WithDesc(desc string) Result

type Runner

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

func New

func New() *Runner

func (*Runner) Add

func (tr *Runner) Add(name string, action Action) TaskID

Add adds a task without any dependencies.

func (*Runner) AddD

func (tr *Runner) AddD(dep TaskID, name string, action Action) TaskID

AddD adds a task with a dependency on other task.

func (*Runner) AddTask

func (tr *Runner) AddTask(task Task) TaskID

AddTask adds a task to runner.

func (*Runner) Run

func (tr *Runner) Run() error

type SetStatusMsg

type SetStatusMsg string

type State

type State uint

const (
	SKIPPED State = iota
	SUCCESS
	INFO
	NOTICE
	WARNING
	FAILURE
)

type Task

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

func NewTask

func NewTask(name string, action Action) Task

func (Task) DependsOn

func (t Task) DependsOn(dep TaskID) Task

type TaskID

type TaskID = uuid.UUID