🍠 Tospudo

A tool to manage TODOs in your project.

Installation

pnpm add -D tospudo

Add it to your package.json scripts:

{
  "scripts": {
    "todo": "tospudo"
  }
}

Usage

pnpm todo

Tospudo scans all files from the current directory, respecting .gitignore.

It reports every TODO and FIXME comment found in code, plus unchecked items (- [ ]) in a TODO.md file.

CLI options

• --max <number> — exit with code 1 if the TODO count exceeds this number (useful in CI)
• --help
• --version

Configuration

Configuration is optional. Use a tospudo.config.json file:

{
  "$schema": "./node_modules/tospudo/schema.json",
  "ignore": ["src/generated/**"],
  "max": 20
}

The $schema field enables autocomplete and inline documentation for all options in VS Code and other editors that support JSON Schema.

Or add a tospudo key to package.json:

{
  "tospudo": {
    "ignore": ["src/generated/**"],
    "max": 20
  }
}

Options:

• ignore — glob patterns to exclude from scanning, in addition to .gitignore rules
• max — exit with code 1 if TODO count exceeds this threshold; useful in CI. Can also be set with the --max CLI flag
• maxLength — truncate TODO text in scan output to this many characters (default: 80); does not affect TODO.md content
• sectionEmojis — show an emoji prefix in TODO.md section headings, e.g. 🐛 fix (default: true)