today

README

today

A task tracking app for unit based tasks spread over a long period of time

Documentation

Index

• func Delete(name string) error
• func Print(output io.Writer, verbose bool)
• func Save(t *Task) error
• type Mod
• type Task
  • func Load(name string) (*Task, error)
  • func LoadAll() ([]*Task, error)
  • func (t *Task) EffectiveCurrent() int
  • func (t *Task) Progress() int
  • func (t *Task) SetCurrent(current int) error
  • func (t *Task) ToGo() int
  • func (t *Task) Today() int
  • func (t *Task) UnitsPerDay() int

Functions

func Delete

func Delete(name string) error

Delete deletes a named task if present

func Print

func Print(output io.Writer, verbose bool)

func Save

func Save(t *Task) error

Save saves a task to store.

Types

type Mod

type Mod struct {
	Date  time.Time
	Value int
}

type Task

type Task struct {
	Name    string
	Total   int
	Current int
	Changes []Mod
	EndDate time.Time
}

Task is a unit based task with an end date.

func Load

func Load(name string) (*Task, error)

Load loads a task if present

func LoadAll

func LoadAll() ([]*Task, error)

LoadAll loads all the tasks in store.

func (*Task) EffectiveCurrent

func (t *Task) EffectiveCurrent() int

func (*Task) Progress

func (t *Task) Progress() int

func (*Task) SetCurrent

func (t *Task) SetCurrent(current int) error

SetCurrent sets the current unit index of the task.

func (*Task) ToGo

func (t *Task) ToGo() int

func (*Task) Today

func (t *Task) Today() int

Today is the desired unit index to be achieved today.

func (*Task) UnitsPerDay

func (t *Task) UnitsPerDay() int