Todoctor

VersionGitHub starsDownloads per weekLicense

Todoctor grew out of a work project. Lots of TODO comments had piled up in our codebase, and we wanted to understand what was happening with them: how many there were, how long they had been there, and whether their number was growing. Comments like these rarely make it into an issue tracker and can sit in the code for years.

Todoctor finds comments with TODO, FIXME, and similar tags in JavaScript and TypeScript files. Then it walks through the Git history and uses git blame to find out who left each comment and when.

The result is an HTML report that opens in your browser automatically. It includes:

You can see what the report looks like in this example.

How to start using it?

Run Todoctor in the root of your repository:

Bash
npx todoctor

The --months flag sets how many months of history to analyze. To get the report in JSON or CSV, use the --output-format flag.