mcpField
P
ponytail-debt

ponytail-debt

github.com/dietrichgebert开发179.1k45.0k 次安装2 周前更新
代码仓库

关于 ponytail-debt

ponytail-debt 是只读技能,可从代码库收集标记有意取舍的注释并整理成分组清单。它会指出缺少升级路径或触发条件的标记,便于跟踪延期工作。

主要功能

  1. 01扫描代码库注释标记
  2. 02按文件分组列出条目
  3. 03提取限制与升级路径
  4. 04标记缺少触发条件的项
  5. 05只读报告

适用场景

  1. 01审查延期的实现工作
  2. 02查找缺少升级路径的取舍项
  3. 03整理可跟踪的技术债清单

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/dietrichgebert/ponytail --skill ponytail-debt

安装后在 Claude Code 中输入/ponytail-debt确认已加载。

详细介绍

每个有意采用的 ponytail 快捷方案都用 shortcut: 注释标记,并注明其上限和升级路径(旧代码中可能写作 ponytail:)。这样可以将它们汇总到一份清单中,避免延期事项悄然变成永久方案。

扫描

在仓库中搜索注释标记,跳过 .git 以及 .gitignore 文件忽略的所有内容(适用于各种技术栈中的依赖项、构建产物和缓存):

git grep --no-index --exclude-standard -nE '(#|//|/[*]) ?(shortcut|ponytail):'(如果你的技术栈使用其他注释前缀,也请添加)

如果用户指定了自己的标记词(/ponytail-debt TODO),则改为搜索该词。

每处匹配对应一条清单记录。注释前缀可以排除那些只是在文字中提到这一约定的内容。跳过并非延期事项的匹配,例如关于键盘快捷键的备注。

输出

每个标记一条记录,按文件分组:

<文件>:<行号>, <简化了什么>。上限:<注明的上限>。升级条件:<重新审视的触发条件>。

约定格式为 shortcut: <上限>, <升级路径>,因此直接从注释中提取上限和触发条件。想为每条记录添加负责人?添加 git blame -L<line>,<line>。

标出腐化风险:凡是未注明升级路径或触发条件的标记注释,都加上 no-trigger 标签;这些事项最容易悄然腐化。

最后写上 <N> 个标记,其中 <M> 个没有触发条件。。如果没有找到任何内容,则写:没有快捷方案债务。清单干净。

范围

只读取并报告,不做任何更改。如需保存结果,请提出请求,届时会将清单写入文件(例如 PONYTAIL-DEBT.md)。仅运行一次。

评论

支持 Markdown