SuperAPI AI 工具集

ponytail-debt

通用与其它

查看项目

更新于 10-15 21:10

技能介绍

用途:ponytail-debt 用于盘点代码中刻意留下的简化标记。每个有意的 ponytail 捷径都以 shortcut: 注释标注其天花板(ceiling)与升级路径(upgrade path),旧代码可能写作 ponytail:。该技能把这些注释汇成一份账本,避免临时性的推迟悄悄固化为永久债务。

主要能力:扫描仓库中的注释标记,跳过 .git 以及 .gitignore 忽略的内容(依赖、构建产物、缓存等,适用于任何技术栈);每个命中记为一行,按文件分组输出;可识别并标记缺少升级路径或触发条件的条目(no-trigger);结尾汇总标记总数与无触发条件的数量,无结果时输出“No shortcut debt. Clean ledger.”。

使用方式:默认扫描命令为 git grep --no-index --exclude-standard -nE '(#|//|/[*]) ?(shortcut|ponytail):' (可用你的技术栈所用的其他注释前缀补充)。若用户指定了自己的标记词(如 /ponytail-debt TODO),则改用该词进行 grep。输出格式为:<file>:<line>, <what was simplified>. ceiling: <the limit named>. upgrade: <the trigger to revisit>.。需要每行的负责人信息时,可追加 git blame -L<line>,<line>。

适用场景:适合在提交前、代码审查或阶段性清理时,快速了解项目中存在哪些被推迟的简化及其后续升级条件;也可用于判断哪些标记因缺少触发条件而有“腐化”风险。

限制:仅读取和报告,不更改任何内容;属于一次性操作。如需持久化,需用户明确要求后才会把账本写入文件(例如 PONYTAIL-DEBT.md)。使用“stop ponytail-debt”或“normal mode”可退出该模式。除上述标记注释外,仅提及该约定或讨论键盘快捷键的注释会被跳过。