taskin

README

📋 Add user-friendly tasks to your terminal

[!TIP]

All output is Github Action friendly! You can view the output of each example here

Installation

go get github.com/fumeapp/taskin

Examples

Simplest way to line up and fire off tasks

https://github.com/fumeapp/taskin/blob/3cd766c21e5eaba5edb33f38d3781d6cf814f9f9/examples/simple/main.go#L11-L33

Using a progress bar for a task

https://github.com/fumeapp/taskin/blob/06b4d112f7d2dcf9fb4ee9b210f0be2d5cda03b5/examples/progress/main.go#L11-L24

Customize colors, spinner, and progress bar

https://github.com/fumeapp/taskin/blob/3cd766c21e5eaba5edb33f38d3781d6cf814f9f9/examples/custom/main.go#L13-L54

Disable UI animations and spinners

https://github.com/fumeapp/taskin/blob/4a1b680400f53dbb5f813ec96fca50544e12b14d/examples/disable-ui/main.go#L49-L57

This is useful when you want plain text output without animations, similar to CI mode but controllable via configuration.

Nest tasks inside tasks

https://github.com/fumeapp/taskin/blob/3cd766c21e5eaba5edb33f38d3781d6cf814f9f9/examples/multi/main.go#L23-L34

Usage inside a task

The *taskin.Task struct passeed into your task has some useful properties that you can use to customize the task view.

Change the title

Already demonstrated in most of the examples, you can change t.Title at any time

Hide a view

Sometimes you might need to temporarily hide you task view in order to prompt a user for input. You can do this by toggling the task.HideView boolean.

Task: func(T *taskin.Task ) error {
	t.HideView = true
	if err := PromptForInput(); err != nil {
		t.HideView = false
        return err
    }
    t.HideView = false
	t.Title = "Input received"
	return nil
}

Documentation

Index

• Variables
• func Color(c lipgloss.TerminalColor, r string) string
• func IsCI() bool
• type Config
• type ConfigChars
• type ConfigColors
• type ConfigOptions
• type Model
  • func (m *Model) Init() tea.Cmd
  • func (m *Model) SetShutdown(err error)
  • func (m *Model) Update(msg tea.Msg) (tea.Model, tea.Cmd)
  • func (m *Model) View() string
• type Runner
  • func NewRunner(task Task, cfg Config) Runner
• type Runners
  • func New(tasks Tasks, cfg Config) Runners
  • func (r *Runners) Run() error
• type Task
  • func (task *Task) Progress(current, total int)
• type TaskProgress
• type TaskState
• type Tasks
• type TerminateWithError

Variables

var Defaults = Config{
	Options: ConfigOptions{
		ExitOnFailure: true,
	},
	Spinner: spinner.Dot,
	ProgressOptions: []progress.Option{
		progress.WithDefaultGradient(),
		progress.WithoutPercentage(),
		progress.WithWidth(10),
	},
	Colors: ConfigColors{
		Spinner:       lipgloss.Color("214"),
		Pending:       lipgloss.Color("lightgrey"),
		Success:       lipgloss.Color("46"),
		Failure:       lipgloss.Color("196"),
		ParentStarted: lipgloss.Color("214"),
	},
	Chars: ConfigChars{
		NotStarted:    "○",
		Success:       "✔",
		Failure:       "✗",
		ParentStarted: "»",
	},
}

Functions

func Color

func Color(c lipgloss.TerminalColor, r string) string

func IsCI

func IsCI() bool

Types

type Config

type Config struct {
	Colors          ConfigColors
	Chars           ConfigChars
	Spinner         spinner.Spinner
	Options         ConfigOptions
	ProgressOptions []progress.Option
	DisableUI       bool // Disable animations and spinners
}

type ConfigChars

type ConfigChars struct {
	ParentStarted string
	NotStarted    string
	Success       string
	Failure       string
}

type ConfigColors

type ConfigColors struct {
	Spinner       lipgloss.Color
	Pending       lipgloss.Color
	Success       lipgloss.Color
	Failure       lipgloss.Color
	ParentStarted lipgloss.Color
}

type ConfigOptions

type ConfigOptions struct {
	ExitOnFailure bool
}

type Model

type Model struct {
	Runners       Runners
	HideView      bool
	Shutdown      bool
	ShutdownError error
}

func (*Model) Init

func (m *Model) Init() tea.Cmd

func (*Model) SetShutdown

func (m *Model) SetShutdown(err error)

func (*Model) Update

func (m *Model) Update(msg tea.Msg) (tea.Model, tea.Cmd)

func (*Model) View

func (m *Model) View() string

type Runner

type Runner struct {
	Task     Task
	State    TaskState
	Spinner  *spinner.Model
	Config   Config
	Children Runners
}

func NewRunner

func NewRunner(task Task, cfg Config) Runner

type Runners

type Runners []Runner

func New

func New(tasks Tasks, cfg Config) Runners

func (*Runners) Run

func (r *Runners) Run() error

type Task

type Task struct {
	Title        string
	Task         func(*Task) error
	ShowProgress TaskProgress
	Bar          progress.Model
	Config       Config
	Tasks        Tasks
	HideView     bool
}

func (*Task) Progress

func (task *Task) Progress(current, total int)

type TaskProgress

type TaskProgress struct {
	Current int
	Total   int
}

type TaskState

type TaskState int

const (
	NotStarted TaskState = iota
	Running
	Completed
	Failed
)

type Tasks

type Tasks []Task

type TerminateWithError

type TerminateWithError struct {
	Error error
}