@@ -8,10 +8,17 @@ A GitHub Action that scans your codebase for inline TODOs, FIXMEs, and BUG comme
88
99- ✅ Detects ` TODO ` , ` FIXME ` , ` BUG ` , and ` HACK ` comments
1010- ✅ Supports multiple languages: ` .ts ` , ` .js ` , ` .py ` , ` .go ` , ` .html ` , etc.
11+ - ✅ Skips common directories like ` node_modules ` , ` dist ` , and ` coverage `
1112- ✅ Extracts metadata like ` priority ` , ` due ` , etc.
13+ - ✅ Parses structured tags (` @assignee ` , ` #module ` , ` key=value ` )
14+ - ✅ Warns about overdue TODOs
1215- ✅ Automatically labels issues based on type and metadata
1316- ✅ Creates labels on the fly if they don't exist
1417- ✅ Supports custom label colors and descriptions via JSON config
18+ - ✅ Custom templates for issue titles and bodies
19+ - ✅ LLM-powered issue title and body generation
20+ - ✅ Command-line interface for local usage
21+ - ✅ Optional Jira synchronization
1522
1623---
1724
5057 limit : 5
5158` ` `
5259
60+ ### 2. Run the CLI locally
61+
62+ Use the bundled command-line interface to scan a directory on your machine and
63+ optionally generate a markdown report:
64+
65+ ` ` ` bash
66+ npx todo-action --dir src --report
67+ ```
68+
69+ Flags:
70+
71+ - ` --dir ` , ` -d ` – Directory to scan (defaults to the current directory)
72+ - ` --report ` , ` -r ` – Write a ` TODO_REPORT.md ` file with all results
73+
5374## 📝 Example TODOs
5475
5576``` ts
@@ -75,16 +96,15 @@ If a label like `priority:high` or `due:2025-06-01` doesn't exist, it will be au
7596
7697## 📌 Notes
7798
78- - Max **5 issues** are created per run to avoid rate limiting (configurable via the `limit` input)
79- - **Duplicate detection** is not yet implemented _(coming soon)_
80- - All labels are **auto-created with default colors** if missing
81- - Provide a JSON file via `label-config` to override colors and descriptions
99+ - Max ** 5 issues** are created per run to avoid rate limiting (configurable via the ` limit ` input)
100+ - ** Duplicate detection** prevents reopening the same TODO multiple times
101+ - All labels are ** auto-created with default colors** if missing
102+ - Provide a JSON file via ` label-config ` to override colors and descriptions
82103
83104---
84105
85106## 📤 Coming Soon
86107
87- - ✅ Issue deduplication
88108- ✅ Custom templates for issue bodies
89109- ✅ CLI usage outside GitHub
90110- ✅ LLM-powered summarization and classification
0 commit comments