SuperAPI AI 工具集

review-structure

编程与开发

查看项目

更新于 10-16 02:22

技能介绍

用途

review-structure 是一个用于代码库整体结构可维护性审查的技能,来源为 existential-birds/beagle。它适用于对当前分支改动进行异常严格的审查,重点不在功能正确性,而在实现质量、可维护性、抽象质量和代码库健康度。该技能要求审查者不局限于发现局部清理机会,而是主动寻找“代码柔道”式重构:在保持行为不变的前提下,让实现显著更简单、更小、更直接、更优雅。

主要能力

该技能以仓库全局为结构视角,可读取和搜索代码库中任意文件,用于判断规范辅助函数是否已存在、文件大小预算是否被遵守、改动是否让代码库更易或更难维护。它内置一套硬性门与规则:

  • 反虚构门(gate 0):在给出任何结论前,必须引用本轮实际读取的代码(文件:行号加代码)或搜索/行数证据(搜索模式加结果,或 wc -l/读取计数)。没有同轮证据的结论无效。
  • 硬性门序列:G1 变更文件列表(git diff --name-only 等返回非空列表或明确退出);G2 完整文件读取(记录每个文件路径与行数);G3 规范辅助函数与 1000 行声明验证(必须引用搜索或行数证据)。
  • 核心规则:对结构简化保持雄心;阻止文件从 1000 行以下涨到 1000 行以上;禁止随意面条式分支增长;保持逻辑在规范层并复用现有辅助函数;关注类型与边界清晰度;避免不必要的串行编排和非原子更新。

使用方式

该技能以提示词和审查流程的形式使用。首先通过 git 命令确定变更文件集合,例如:

BASE=$(for ref in main origin/main master origin/master; do git rev-parse --verify "$ref" >/dev/null 2>&1 && { echo "$ref"; break; } done) if [ -z "$BASE" ]; then echo "error: no main/master ref found (checked main, origin/main, master, origin/master)." >&2 exit 1 fi MERGE_BASE=$(git merge-base HEAD "$BASE") || { echo "error: git merge-base HEAD $BASE failed." >&2 exit 1 } git diff --name-only "$MERGE_BASE..HEAD"

若列表为空,需明确说明,不得编造结构性问题。随后按硬性门逐步推进,完整读取范围内文件并记录行数,再依据证据提出发现。输出格式包含 Review Summary、Issues(Critical/Major/Minor/Informational)、Good Patterns 和 Verdict。每个问题需包含 FILE:LINE、Issue、Why、Fix,并按实际严重程度分类。Verdict 只考虑 Critical 和 Major,Minor 与 Informational 不阻塞批准。

适用场景

该技能适用于对代码改动进行深度结构审查,尤其是当改动可能引入面条式分支、文件膨胀、抽象泄漏、类型边界模糊或重复辅助函数时。它适合在代码评审流程中作为严格的质量门,推动作者进行结构性简化而非仅接受“能运行”的实现。

限制

该技能要求审查者具备仓库全局读取与搜索能力,并严格依赖同轮证据。它不评估功能正确性本身,也不替代测试。若变更文件列表为空,则不应输出结构性发现。该技能未提供具体的收费、价格或平台信息,这些事实暂未提供。