The easy way to find TODO and FINDME annotations in your project!
- files allows to find todo/fixme in one or more files specified by user
- catalog allows to find todo/fixme in catalog specified by user
- Clone repository using
git clone https://github.com/miloszhoc/TodoFinder.git
command. - cd into todo_finder folder.
- Type
python setup.py install
orpython3 setup.py install
in order to install program.
To see all commands - type ftfinder -h
The usage is simple and requires to specify the file or catalog which will be used to search for "todo" or "fixme" annotations.
-
ftfinder files <file(s) name>
- search for "todo" or "fixme" annotations in given file(s). -
ftfinder catalog <catalog name> <ext>
- search for "todo" or "fixme" annotations for given extension in the catalog. In this mode you can also specify if you want to exclude some directories or files.
You can also specify if you want o see only Todo or Fixme annotations by passing appropriate flag (see section below). The default mode shows both fixme and todo.
-
files
positional arguments:
file_name
file or files to open
optional arguments:
-h, --help
help message
-f, --fixme
show only FIXME
-t, --todo
show only TODO -
catalog
positional arguments:
path
path to catalog
ext
file extension
optional arguments:
-h, --help
help message
-f, --fixme
show only FIXME
-t, --todo
show only TODO
-e [EXCLUDE [EXCLUDE ...]], --exclude [EXCLUDE [EXCLUDE ...]]
excluded files and folders