SuperAPI AI 工具集

codebase-readiness

编程与开发

查看项目

更新于 10-19 19:24

技能介绍

用途

codebase-readiness 是一个用于运行“Agent-Ready Codebase Assessment”的技能,即对代码库支持自主 AI 智能体工作的程度做打分评估。评估以每周 1000+ AI 生成拉取请求的 Stripe 基准为参照框架,按阶段依次推进。

主要能力

技能将评估拆分为 8 个维度,由 4 个并行智能体分工完成:

  • 测试与 CI 代理:Test Foundation、Feedback Loops(反馈回路切片:可操作性、可复现性、门禁测试)
  • 文档代理:Documentation & Context
  • 代码质量代理:Code Clarity、Consistency & Conventions
  • 架构代理:Type Safety、Architecture Clarity、Change Safety(变更安全切片:阻断语义与基线治理)

各维度按 0-100 评分带打分,并可应用分数修正。质量门参考文件 references/quality-gates.md 分发给测试与 CI、代码质量、架构三个代理,每个代理只对自己负责的切片计分,通过信用归属表避免重复计分。

使用方式

阶段 1:代码库侦察。直接运行 bash scripts/recon.sh 收集项目元数据(无需代理),然后整理代码库快照,包含主要语言/框架、语言层级(静态类型 / 动态类型 / 渐进类型)、提交数、贡献者、源文件数、测试文件数及比例、CI/CD 平台、智能体指令(AGENTS.md / CLAUDE.md 及规范路径与符号链接状态)、领域上下文(CONTEXT.md / CONTEXT-MAP.md / docs/DOMAIN.md、ADR 位置与数量)、lint 配置、质量门(须抄录侦察输出中的 Suggested Gate Maturity Level: Lx -- ... 行,并对照 references/quality-gates.md 校验,仅在证据与启发式矛盾时修改并说明原因)、README。缺少质量门行时不得启动评估代理,否则各代理会各自重新推导等级,导致维度漂移。

随后确定 PRIMARY_LANGUAGE 与 LANGUAGE_TIER。支持语言:ruby、python、php、typescript、javascript、go、java、scala、rust。若主要语言不在支持列表,应告知用户支持的语言,并在用户同意时改用最接近的语言文件,或在不使用语言特定标准的情况下通用评估。

阶段 2:并行启动 4 个评估代理。每个代理提示词由角色前言 + 代码库快照 + 维度内容 + quality-gates 内容 + 语言内容 + 输出说明组合而成;用 Read 工具加载参考文件并以内联方式写入提示词,并要求代理仅引用与其维度相关的语言文件章节。通过一次消息中的 4 个 Agent 调用(subagent_type: general-purpose)同时启动,等待全部完成后继续。

阶段 3:分数计算。权重随语言层级自适应:动态类型语言(Ruby、Python、JavaScript、PHP)中 Test Foundation 权重 25%,Type Safety 仅 10%(反映契约与接口清晰度,而非类型检查器);静态类型语言(TypeScript、Go、Java、Scala、Rust)中 Type Safety 权重 20%,Test Foundation 为 15%。总分 = 各维度得分 × 权重之和。评分等级:85-100 Agent-Ready;70-84 Agent-Assisted;50-69 Agent-Supervised;30-49 Agent-Caution;0-29 Not Agent-Ready。

阶段 4:报告组装。读取 assets/report-template.md,用代理结果和对应语言层级的权重表填充;报告中的代码库快照须与提供给代理的完全一致(含质量门行),并在 Quality Gate Maturity 章节逐字重复该行,二者不得相悖。须使用阶段 3 对应表格中的确切权重,不得硬编码。

阶段 5:询问用户是否将评估保存为项目根目录的 AGENT_READY_ASSESSMENT.md,作为后续改进的基线与团队分享材料;用户确认后写入当前目录。

阶段 6:CI 集成建议。保存后(或用户拒绝后),若质量门等级为 L0-L2,提示可用 agent-ready 插件的 quality-gates 模式,基于项目原生工具安装回归感知门禁(report / check / baseline 命令、merge-base 感知 CI、经审阅的基线及测试),可在不先清理历史债务的前提下阻断新增或恶化的复杂度、重复与死代码。随后提示可用 btar 做持续跟踪:

npm install -g btar
btar analyze .          # Quick score: types + lint + coverage
btar context generate agents-md  # Auto-generates AGENTS.md with your build/test commands

btar 提供对验证基础设施(类型错误、lint 违规、测试覆盖率)的快速确定性度量,可在分数回退时门禁 PR;本评估提供战略性基线,btar 提供关键指标的日常 CI 执行。

适用场景

用于评估一个代码库对自主 AI 智能体工作的支持程度,形成可追踪的基线报告,并据此决定是否引入质量门禁与 CI 持续跟踪。

限制

语言文件仅覆盖 ruby、python、php、typescript、javascript、go、java、scala、rust;其它语言需用户同意后采用最接近的语言文件或通用评估。质量门等级为启发式建议,需对照详细证据校验。关于其它功能、收费、价格与平台支持,资料暂未提供。