Define requirements and design functions

[nakachan-ing]

Explanation

• For this issue, I need to define requirements and design functions.
• Functionality will follow the grammar and specifications of todo.txt.
• Requirements will be divided into the minimum required functions and extended functions as todo.txt.
• Comment on the above research findings and decisions.

[nakachan-ing]

todo.txt format

Why plain text?

• Plain text is software and operating system agonostic.
• It's unstructured.
• There's no databases or tags or flags or stars or prioritizing or insert company name here-induced rules on what we can and can't do with it.

The 3 axes of an effective todo list

1. Priority
2. Project
3. Context

todo.txt format rules

• Incomplete Tasks 　- If priority exists, it always appears first. 　- A task's creation date may optionally appear directly after priority and a space. 　- Context and Projects may appear anywhere in the line after priority/prepended date.
• Completed Tasks 　- A completed tast starts with an lowercase x character(x). 　- The date of completion appears directly after the x, separated by a space.

References https://github.com/todotxt/todo.txt

[nakachan-ing]

Image of how to add a task using todo.txt CLI

There are already many todo.txt CLI tools available, but I'll focus on two.

• todo.sh 　- https://github.com/todotxt/todo.txt-cli 　- https://zenn.dev/zakkie/articles/e050332ca490a8
• todo-cli (made with Go) 　- https://github.com/dondakeshimo/todo-cli 　- https://qiita.com/dondakeshimo/items/08805945c5b968ce955e

Specifications to refer to with todo.sh

• t list should display in a faithful manner to the todo.txt specifications.
• I would like the list display to be in the todo.txt format as much as possible, so I'll refer to this.

Specifications to refer to with todo-cli

• Priority and context can be specified or changed using command options. (add, modify)
• For information on commands and options, refer to this.

[nakachan-ing]

Functional requirements

At the very least, if the three axes of an effective ToDo list and the formatting rules for todo.txt are covered, the minimum necessary functionality will be met.

Functions

Tasks

• Add a task
• Edit a task
• Delete a task
• Complete a task
• Archive a task

The following are command options for adding and editing a task.

Tags

Priority

• Add a priority tag
• Delete a priority tag

Projects

• Add a project tag
• Delete a project tag

Context

• Add a context tag
• Delete a context tag

Rules

• A creation date will be assigned when a task is added.
• Tasks will always be sorted and displayed in order of priority.
• A completion date will be assigned when a task is completed.
• Priority will be removed from completed tasks.