todocom (Todo Comments)

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". To create the TODO list, simply open terminal and run the following command:

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:

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

Or:

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

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

# Prints soon 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):

# Store results in a txt file![dummy](https://user-images.githubusercontent.com/73610201/211216021-a4859641-69a6-4e94-8f8c-2c0cafd0a455.png)

todo -o [path/to/sample.txt] [folder/file]

Setup

pip install todocom

Comments Format

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:

1. TODO:
2. TODo:
3. TOD0:
4. ToD0:
5. To-D0:
6. to-do:

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:

1. TO-DO soon:
2. tODo soon: 
3. ToD0 urgent:
4. T0-D0 urgent: