Does it support structured data output?

Yes, todo-scan supports a --format json flag for all commands, making it easy to parse results with tools like jq or integrate into other automated workflows.

How does the priority system work?

todo-scan recognizes priority levels based on suffix markers: 'normal' is the default, 'high' is marked with (!), and 'urgent' is marked with (!!).

Can I use this to block Pull Requests?

Yes, by using the 'check' command with the --max-new or --block-tags flags in your CI pipeline, you can fail builds that introduce unwanted technical debt.

Can I exclude certain directories like node_modules?

Absolutely. You can configure excluded directories and regex patterns in the .todo-scan.toml configuration file to ignore vendor or generated files.

Which comment tags does todo-scan support?

It scans for TODO, FIXME, HACK, XXX, BUG, and NOTE comments by default. You can also customize these tags in your .todo-scan.toml configuration file.

TODO Scan & Hygiene

Name: TODO Scan & Hygiene
Author: sotayamashita

bysotayamashita

•

デプロイメントとDevOps

Scans, tracks, and enforces code quality gates for TODO, FIXME, and BUG comments across your codebase.

todo-scan is a specialized utility designed to manage technical debt by scanning and analyzing comment tags like TODO, FIXME, HACK, and BUG. It allows developers to list annotated tasks with priority filtering, compare changes between git branches to prevent debt accumulation, and implement automated CI/CD quality gates that block merges if specific comment thresholds or critical tags are found. By integrating directly into development workflows, it ensures code hygiene remains a priority throughout the software lifecycle.

主な機能

01Structured JSON output for easy integration with tools like jq or custom scripts

02Comprehensive scanning for TODO, FIXME, HACK, BUG, and custom tags

03Priority-based sorting and filtering (Normal, High, Urgent) for task management

04Git-integrated diffing to track newly added technical debt between refs

05Automated CI/CD quality gates with configurable thresholds and blocked tags

064 GitHub stars

ユースケース

01Identifying and prioritizing high-urgency BUG or FIXME comments before a release

02Generating structured reports of technical debt for team sprint planning

03Enforcing a 'zero-new-TODOs' policy during Pull Request reviews

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add sotayamashita/todo-scan todo-scan

For use in Claude.ai and ChatGPT

Download Skill