-
Notifications
You must be signed in to change notification settings - Fork 5
Quick Start
Get started by installing todoon with pip! Once you have todoon installed, you can run it "right out of the box" but it's strongly recommended that you initialize a .todo-ignore file as there can be a lot of files in your project directory that you might not be interested in maintaining (at least ignore '.git' please!)
Currently, any instance of the words "todo" or "fixme" (case-insensitive) on a line triggers a Hit (follow this issue to see updates to the Hit detection grammar). To ignore a line that contains a known TODO/FIXME string, add the following anywhere on the line:
todoon
For example, the following code:
def add_to_todo_list(x): # todoon
list.append(x) # TODO Add additional validation
will result in only one Hit: list.append(x) # TODO Add additional validation
. Notice that the string 'todo' is in the function's signature, but it did not trigger a Hit.
The command todoignore-util
with the -p (arguments are paths) and -c (create a new file if one doesn't exist) used below with a function that collects all the hidden files and folders in the working directory should be a good start for your .todo-ignore file.
TODO untested
pip install --upgrade todo-or-not
todoignore-util -pc $( ls -a | grep "^\.[^.]" )
todoon
This mode is not usually recommended! Use this if you are sure you don't have a large amount of files in the directory, because it will scan everything!
pip install --upgrade todo-or-not
todoon --force
Generate all the issues found in the project that haven't already been generated ( assumes issues environment is set up correctly and a .todo-ignore is in place)
gh auth login
todoon --silent --issue