CLI program that retrieves all TODO comments from file(s) and prints them in terminal/shell. It was created in order to automatically update a list of TODO tasks by simply adding "TODO:" comments in the code Comments Format It also enables prioritization of tasks by using "TODO soon:" or "TODO urgent" and assign tasks to a specific teammate.

Add TODO comments according to the format, open terminal and run the following command:

CopyShow Line Numbers
todo [folder/file]

This command will print out all TODO comments that were found in the code, sorted by their prioritization: urgent, soon and regular. Urgent tasks will be printed in RED, soon in CYAN and regular comments in WHITE to make it easier to read. There is also an option to filter comments by their priotization:

CopyShow Line Numbers
# Prints urgent TODOs
todo -u [folder/file]

or:

CopyShow Line Numbers
# Prints soon TODOs
todo -s [folder/file]

Comments can also be assigned to a user by adding "Todo @username" comment:

CopyShow Line Numbers
# Prints Assigned TODOs
todo -a [USERNAME] [folder/file]

Finally, there is an option to save the list in a text file (stores as regular text without colors):

CopyShow Line Numbers
# Store results in a txt file
todo -o [path/to/sample.txt] [folder/file]

CopyShow Line Numbers
pip install todocom

There are two types of comments: single line and multi-line. Currently, multi-line comments (docstrings) are only supported in Python, but single line should work for most programming languages.

Format is flexible and can be lower-case, upper-case or a combination of both. Below are several examples:

CopyShow Line Numbers
                        - TODO:       - ToD0:
                        - To-D0:      - to-do:
                        - TODo:       - TOD0:

In Urgent and soon comments the TODO part is flexible as shown above, but must be followed by either urgent or soon in lower-case:

CopyShow Line Numbers
                    - TO-DO soon:       - tODo soon:
                    - ToD0 urgent:      - T0-D0 urgent: