TODO 注释扫描器
将以下提示词粘贴到你的 AI 对话框中:
请根据 https://skillhub.cn/install/skillhub.md,安装 @user_5aa6b640/todo-scanner。
技能介绍
问题背景
长期维护的代码库里,TODO 和 FIXME 往往散落在各文件与分支中,靠 IDE 全局搜索只能得到扁平列表,难以按标签、优先级或文件维度做盘点。发版前或接手遗留项目时,你需要一份可归档、可分享的汇总,而不是反复手动 grep。
工作方式
本技能对指定目录做递归扫描,用正则匹配常见注释形态,识别 TODO、FIXME、HACK、XXX、NOTE、OPTIMIZE(不区分大小写),并解析 TODO[high] 这类优先级标记。支持 JavaScript/TypeScript、Python、Go、Rust、Java、HTML/CSS、Shell、SQL、YAML、C/C++、Swift、Kotlin 等语言的典型注释语法。
报告按四层组织:摘要(总数与各标签/优先级分布)、按文件、按标签、按优先级;每条记录包含路径、行号、标签、优先级与注释正文,以 Markdown 表格呈现。默认跳过 node_modules、.git、dist、build、.next、venv 等目录及二进制文件;可按路径、排除目录、标签类型或文件后缀收窄扫描范围。
若结果中存在 FIXME 或 high 优先级项,会额外高亮提醒,便于优先处理风险点。
适用边界
- 只能识别符合约定格式的行内/块注释,自定义标记或写在字符串里的「伪 TODO」可能被误报或漏报。
- 超大 monorepo 全量扫描耗时取决于文件数量;建议用路径与后缀过滤缩小范围。
- 优先级语法需写成
[high]/[medium]/[low]等形式,否则归入无优先级统计。
使用场景
- 发版前对指定分支目录递归扫描,把 FIXME 与 `TODO[high]` 汇总成评审用的 Markdown 清单
- 接手遗留仓库时按文件分组列出 HACK、XXX,便于评估临时方案与风险点
- 只扫描某子目录下的 `.py` 文件,统计 OPTIMIZE 注释作为性能优化 backlog
- 排除 `dist`、`venv` 后对前端源码路径扫描,生成可归档的按标签分组报告
适合人员
- 负责发版门禁的后端 Tech Lead,合并前需核对全库 FIXME 与高优先级 TODO
- 刚接入大型 monorepo 的工程师,要按标签区分 TODO 与 HACK 在各模块的分布
- 组织技术债冲刺的维护者,需按 high/medium/low 统计 NOTE、OPTIMIZE 并拆分任务
- 主持跨语言仓库 code review 的工程师,需要 JS/Python/Go 注释统一表格便于会议讨论