extract-todo's Introduction

extract-todo

extract-todo is a simple commandline tool for the extraction of TODOs. It can extract TODOs from single-line-comments like:

    # TODO something todo

It prints the file, line number and the TODO text.

Installation

You need python3+ to run this tool. It can be installed from pypi with

pip install extract-todo

Usage

You can use this tool with the command

python -m extract_todo /path/to/file

extract-todo /path/to/file

It prints the filename, line number and the TODO text. Example output:

.\tests\files\test.py
  LINE 1:       test
  LINE 5:       test 2

Running on all relevant files in a directory

Note that if you want to run this tool on all the supported files in your git-managed project, you can run extract-todo with no file arguments:

extract-todo

If you want to limit it to searching certain files, you could do something like this:

extract-todo --filename-pattern='*.py' --filename-pattern='*.rb'

Author and License

extract_todo.py is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

extract_todo.py is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with extract_todo.py.  If not, see <http://www.gnu.org/licenses/>.

extract-todo's People

Contributors

Stargazers

Watchers

extract-todo's Issues

Comment delimiter size != 2 not correctly supported

extract-todo version: 0.3.1
Python version: 3.7.9
Operating System: Win 10

Description

When a filetype has only one comment char and we try to extract the todo with no space, it will not be noticed. This is probably also a problem with comments which have more than 2 comment chars