todo

README

todo

To get the package

go get github.com/slashformotion/todo/pkg/todo

Documentation

Index

• Constants
• func CheckTodoFileName(path string) error
• func FinishedCharacters() []string
• func MarkTaskAsFinished(task *Task) error
• func MarkTaskAsUnfinished(task *Task) error
• func UnfinishedCharacters() []string
• type Task
  • func NewTask(name string, done bool) (*Task, error)
  • func Parse(s string) (tasks []*Task, err error)
  • func ProcessMatch(match []string) (*Task, error)
  • func (t *Task) Finished()
  • func (t *Task) IsFinished() bool
  • func (t *Task) Unfinished()
• type TodoFile
  • func NewTodoFile(path string) (*TodoFile, error)
  • func (t *TodoFile) Append(task *Task)
  • func (t *TodoFile) AppendMultiples(tasks []*Task)
  • func (t *TodoFile) MarkAsCompleted(index int) (*Task, error)
  • func (t *TodoFile) MarkAsUncompleted(index int) (*Task, error)
  • func (t *TodoFile) RemoveTask(index int) (*Task, error)
  • func (t *TodoFile) RenderToFile() (res string)
  • func (t *TodoFile) RenderToScreen() (res string)

Constants

const DefaultExtension string = ".todo"

Functions

func CheckTodoFileName

func CheckTodoFileName(path string) error

func FinishedCharacters

func FinishedCharacters() []string

CONSTANT: Return the caracter signaling that the task is done

Explaination here => https://qvault.io/golang/golang-constant-maps-slices/

func MarkTaskAsFinished

func MarkTaskAsFinished(task *Task) error

Mark the task as Finished

func MarkTaskAsUnfinished

func MarkTaskAsUnfinished(task *Task) error

Mark the task as Unfinished

func UnfinishedCharacters

func UnfinishedCharacters() []string

CONSTANT: Return the caracter signaling that the task is not done

Explaination here => https://qvault.io/golang/golang-constant-maps-slices/

Types

type Task

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

Task represents a Task in .todo files 'Name' is the name of the task 'Finished' is self-explainatory

func NewTask

func NewTask(name string, done bool) (*Task, error)

Create a new Task with a name and a state of completion (boolean)

func Parse

func Parse(s string) (tasks []*Task, err error)

func ProcessMatch

func ProcessMatch(match []string) (*Task, error)

func (*Task) Finished

func (t *Task) Finished()

Mark the task as Finished

func (*Task) IsFinished

func (t *Task) IsFinished() bool

return the true is the task is finished

func (*Task) Unfinished

func (t *Task) Unfinished()

Mark the task as Unfinished

type TodoFile

type TodoFile struct {
	Path string
	// contains filtered or unexported fields
}

func NewTodoFile

func NewTodoFile(path string) (*TodoFile, error)

func (*TodoFile) Append

func (t *TodoFile) Append(task *Task)

func (*TodoFile) AppendMultiples

func (t *TodoFile) AppendMultiples(tasks []*Task)

func (*TodoFile) MarkAsCompleted

func (t *TodoFile) MarkAsCompleted(index int) (*Task, error)

func (*TodoFile) MarkAsUncompleted

func (t *TodoFile) MarkAsUncompleted(index int) (*Task, error)

Mark the task at index as uncompleted

func (*TodoFile) RemoveTask

func (t *TodoFile) RemoveTask(index int) (*Task, error)

func (*TodoFile) RenderToFile

func (t *TodoFile) RenderToFile() (res string)

func (*TodoFile) RenderToScreen

func (t *TodoFile) RenderToScreen() (res string)