todo-audit
A zero-dependency Python CLI tool that recursively scans a directory tree for source files containing TODO, FIXME, HACK, TEMP, XXX, BUG, or NOTE comments, then prints a grouped report by file.
Supported file extensions:
.py .js .ts .jsx .tsx .java .go .rs
.c .cpp .h .hpp .rb .php
Install
pip install todo-audit
Usage
todo-audit [options]
| Option | Description | Default |
|---|---|---|
--dir <path> |
Root directory to scan | Current dir |
--ignore <pat> |
Comma-separated sub-string patterns to skip | (none) |
--json |
Output results as JSON | false |
--help |
Show help |
Examples
# Scan the current directory
todo-audit
# Scan a specific project, ignoring node_modules and vendor
todo-audit --dir /path/to/project --ignore node_modules,vendor,.git
# Get JSON output for programmatic consumption
todo-audit --dir ./src --ignore __pycache__ --json
Example output
/home/user/project/src/main.py
-------------------------------
12: PORT = 3000 # TODO: make configurable
45: def legacy(): # FIXME: remove in v3
/home/user/project/src/utils.ts
--------------------------------
8: // HACK: workaround for Chrome bug #1234
With --json:
{
"/home/user/project/src/main.py": [
{ "line": 12, "content": "PORT = 3000 # TODO: make configurable" },
{ "line": 45, "content": "def legacy(): # FIXME: remove in v3" }
]
}
License
MIT
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
todo_audit-1.0.0.tar.gz
(4.1 kB
view details)
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file todo_audit-1.0.0.tar.gz.
File metadata
- Download URL: todo_audit-1.0.0.tar.gz
- Upload date:
- Size: 4.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/6.2.0 CPython/3.11.15
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
07af7cf64295a75ae20b721284635d33946781a30884db5b6dac0525d07807dd
|
|
| MD5 |
5eb76a6292f08994dcd7253c1c865e94
|
|
| BLAKE2b-256 |
448de66518b7352d29e7089fa2c404e11f98659cbf8d5e2d134e1d47dad55c57
|
File details
Details for the file todo_audit-1.0.0-py3-none-any.whl.
File metadata
- Download URL: todo_audit-1.0.0-py3-none-any.whl
- Upload date:
- Size: 4.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/6.2.0 CPython/3.11.15
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
db6d1cc5ae447296f0865d4c740fc9621d8bd8111f5e24867e856fcaed33fe4a
|
|
| MD5 |
73a0004e31a014379745367c8dd1a334
|
|
| BLAKE2b-256 |
552124002465794f4aa85cbfcbbf44ee794d5735a944e24653c262d9d294a542
|
