SuperAPI AI 工具集

ponytail-debt

编程与开发

查看项目

更新于 11-12 06:46

技能介绍

ponytail-debt 用于把代码库中刻意留下的 ponytail: 注释汇总成一份技术债台账,避免暂时性的简化或推迟被悄悄遗忘、最终变成永久问题。按照约定,每一处刻意的 ponytail 简化都应带有 ponytail: 注释,写明其能力上限和升级路径。

用途:收集散布在代码注释中的 ponytail: 标记,形成统一台账,便于团队追踪技术债。

主要能力:扫描仓库中的注释标记,默认跳过 node_modules、.git 和构建输出;每处命中生成一条台账记录,按文件分组,记录被简化的内容、声明的 ceiling 上限以及建议重新审视的 upgrade 触发条件;对未写明升级路径或触发条件的注释标记为 no-trigger,提示其存在静默腐化风险;最后汇总标记总数及无触发条件的数量,若未发现则报告无 ponytail 债务。

使用方式:可用 grep 扫描,例如 grep -rnE '(#|//) ?ponytail:' . ,如技术栈使用其他注释前缀可自行补充。每条命中即一行台账,格式为 <file>:<line> - <what was simplified>. ceiling: <the limit named>. upgrade: <the trigger to revisit>.;ceiling 与触发条件直接从注释中提取。若需要为每行标注负责人,可使用 git blame -L<line>,<line>。工具仅读取和报告,不修改代码;如需持久化,可要求其将台账写入文件(例如 PONYTAIL-DEBT.md)。这是一次性操作,使用“stop ponytail-debt”或“normal mode”可恢复。

适用场景:采用 ponytail 注释约定的项目;代码评审或技术债盘点时清点刻意的简化与推迟项。

限制:仅读取和报告,不自动修复或修改代码;依赖代码中的 ponytail: 注释约定;注释前缀需与实际技术栈匹配;资料未提供其他平台、收费或集成信息。