habits

package

v0.1.0 Latest Latest Go to latest Published: Jan 2, 2021 License: MIT Imports: 7 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

This section is empty.

func Load() (habitMap map[string]*Habit)

Load file if present, otherwise create and return empty map

func Save(habitMap map[string]*Habit)

Save persists the modified map to a file

type Habit struct {
	Name        string
	ShortName   string
	Tag         string
	Occurrences []time.Time
}

Habit is a represenation of a repeated task and its metadata Maintains a slice of timestamp occurrences

func New(name, shortName, tag string) *Habit

New creates a new habit and return a pointer to it

func (h *Habit) DaysSinceLastTick() int

DaysSinceLastTick returns the integer number of days that have passed since the last occurrence

func (h *Habit) Tick()

Tick indicates that an instance of the habit occurred by appending to `occurrences`

type HabitList []*Habit

HabitList is an array of Habit pointers

func (h HabitList) Len() int

func (h HabitList) Less(i, j int) bool

func (h HabitList) Swap(i, j int)

type HabitMap map[string]*Habit

HabitMap is a map of string to Habit pointers