SuperAPI AI 工具集

honey-debt

通用与其它

查看项目

更新于 10-15 21:55

技能介绍

用途:Honey Debt 用于把代码库中所有 honey: 注释收集成一份债务台账。这类注释标记的是有意做出的简化,记录其已知上限以及需要重新审视的触发条件,避免这些取舍被遗忘。

主要能力:通过一条 grep 命令扫描代码库,每个命中即台账中的一行,按文件分组输出。输出格式为 <file>:<line> — <what was simplified>. ceiling: <the limit>. trigger: <when to revisit>.,其中 ceiling 和 trigger 直接取自 honey: <ceiling>, <trigger> 注释约定。没有 trigger 的标记会被标为 no-trigger,因为缺少复查条件的上限最容易腐化。结尾汇总为 <N> markers, <M> with no trigger.;若未找到则输出 No honey: debt. Clean ledger.。仅在用户询问归属时,才为每行附加 git blame -L<line>,<line> -- <file>。

使用方式:运行扫描命令 grep -rnE '(#|//|--|/\*) ?honey:' . --exclude-dir={node_modules,.git,dist,build,vendor},注释前缀用于排除仅提及该约定的普通文字。

适用场景:适用于采用 Lever 1 思路、以已知上限换取代码简化的项目,需要定期盘点这些有意取舍时。

限制:该工具只做报告,不修复、不重构、不删除标记,由用户决定偿还哪些债务,只提供建议而不采取行动。不得虚构债务,TODO/FIXME 不算 honey: 标记,最多在数量很大时单独提一次,不并入台账。不对每行做主观评价,台账是数据,判断只保留在结尾一行,且仅在确有警示意义时给出。