todo-audit-cli

A zero-dependency Node.js 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

npm install -g todo-audit-cli

Or run directly without installing:

npx todo-audit-cli --dir . --ignore node_modules

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.js
-------------------------------
  12: const PORT = 3000; // TODO: make configurable
  45: function 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.js": [
    { "line": 12, "content": "const PORT = 3000; // TODO: make configurable" },
    { "line": 45, "content": "function legacy() {   // FIXME: remove in v3" }
  ]
}

License

MIT