hook

Documentation

Index

• Variables
• func NewRecurrence(tags RecurrenceTags, opts ...func(Recurrence) Recurrence) todotxt.Hook
• func NewTagExpansion(unknownTags bool, tags map[string]qselect.DType) todotxt.Hook
• func NewTagExpansionWithNowFunc(unknownTags bool, tags map[string]qselect.DType, now func() time.Time) todotxt.Hook
• func WithNowFunc(now func() time.Time) func(r Recurrence) Recurrence
• func WithPreservePriority(preserve bool) func(r Recurrence) Recurrence
• type ClearOnDone
  • func (c ClearOnDone) OnMod(list *todotxt.List, event todotxt.ModEvent) error
  • func (c ClearOnDone) OnValidate(list *todotxt.List, event todotxt.ValidationEvent) error
• type Recurrence
  • func (r Recurrence) OnMod(list *todotxt.List, event todotxt.ModEvent) error
  • func (r Recurrence) OnValidate(list *todotxt.List, event todotxt.ValidationEvent) error
• type RecurrenceTags
• type TagExpansion
  • func (t TagExpansion) OnMod(list *todotxt.List, event todotxt.ModEvent) error
  • func (t TagExpansion) OnValidate(list *todotxt.List, event todotxt.ValidationEvent) error
• type Tracker
• type Tracking
  • func NewTracking(tag string, tracker Tracker) *Tracking
  • func (t Tracking) OnMod(list *todotxt.List, event todotxt.ModEvent) error
  • func (Tracking) OnValidate(list *todotxt.List, event todotxt.ValidationEvent) error

Variables

var ErrNoActiveTracking = errors.New("No active tracking")

var ErrNoRecurrenceBase = errors.New("when the recurrence tag is set, either the due tag or the threshold tag (or both) must be set")

Functions

func NewRecurrence

func NewRecurrence(tags RecurrenceTags, opts ...func(Recurrence) Recurrence) todotxt.Hook

func NewTagExpansion

func NewTagExpansion(unknownTags bool, tags map[string]qselect.DType) todotxt.Hook

func NewTagExpansionWithNowFunc

func NewTagExpansionWithNowFunc(unknownTags bool, tags map[string]qselect.DType, now func() time.Time) todotxt.Hook

func WithNowFunc

func WithNowFunc(now func() time.Time) func(r Recurrence) Recurrence

func WithPreservePriority

func WithPreservePriority(preserve bool) func(r Recurrence) Recurrence

Types

type ClearOnDone

type ClearOnDone struct {
	Clear []string
}

func (ClearOnDone) OnMod

func (c ClearOnDone) OnMod(list *todotxt.List, event todotxt.ModEvent) error

func (ClearOnDone) OnValidate

func (c ClearOnDone) OnValidate(list *todotxt.List, event todotxt.ValidationEvent) error

type Recurrence

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

func (Recurrence) OnMod

func (r Recurrence) OnMod(list *todotxt.List, event todotxt.ModEvent) error

func (Recurrence) OnValidate

func (r Recurrence) OnValidate(list *todotxt.List, event todotxt.ValidationEvent) error

type RecurrenceTags

type RecurrenceTags struct {
	Rec       string
	Due       string
	Threshold string
}

type TagExpansion

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

func (TagExpansion) OnMod

func (t TagExpansion) OnMod(list *todotxt.List, event todotxt.ModEvent) error

func (TagExpansion) OnValidate

func (t TagExpansion) OnValidate(list *todotxt.List, event todotxt.ValidationEvent) error

type Tracker

type Tracker interface {
	Start(tags []string) error
	Stop() error
	ActiveTags() ([]string, error)
	SetTags(tags []string) error
}

type Tracking

type Tracking struct {
	Tracker           Tracker
	Tag               string
	TrimProjectPrefix bool
	TrimContextPrefix bool
	IncludeTags       []string
}

func NewTracking

func NewTracking(tag string, tracker Tracker) *Tracking

func (Tracking) OnMod

func (t Tracking) OnMod(list *todotxt.List, event todotxt.ModEvent) error

func (Tracking) OnValidate

func (Tracking) OnValidate(list *todotxt.List, event todotxt.ValidationEvent) error