SuperAPI AI 工具集

create-review-guide

前端与建站

查看项目

更新于 10-15 19:58

技能介绍

用途:为当前代码变更生成一个自包含的 HTML 代码审查指南,让审查者在阅读 diff 之前和过程中,自上而下理解实现目的、架构、各部分位置及变更内容。

主要能力:解析输出目录(按插件级 config.json 的 outputDir、技能级 config.json 覆盖、否则参考 config.example.json 并询问用户绝对路径的顺序);确定审查范围(用户指定的分支/PR/提交范围、工作区未提交变更、特性分支相对 main 的差异,或默认分支干净时询问用户);收集真实内容(git log --oneline、git diff --stat,完整阅读每个变更文件,追踪入口与调用方,无法验证的内容标记为 unverified)。

生成的 HTML 包含:头部(仓库、分支/范围、日期、提交列表、--stat 摘要)、概览、内联 SVG 架构图(高亮变更节点、淡化未变节点、含图例)、文件与职责映射表、按推荐阅读顺序的逐文件变更讲解(可折叠、带注释 diff 片段)、审查清单。交互包括可折叠讲解、变更类型筛选、粘性目录。

使用方式:文件名格式为 <repo>-<branch-slug>-review-<yyyyMMdd-HHmm>.html,保存到解析出的输出目录;若 openAfterGenerate 为真则用 start <path>(回退 explorer.exe <path>)打开,并报告保存路径、审查范围和 2–3 行摘要。

限制:所选范围无变更或不在 git 仓库时停止并报告,不生成空指南;差异超过约 50 个文件时,将低影响文件(生成代码、锁文件、重命名)汇总到单个折叠表格并说明。输出为单个自包含 HTML,内联样式、脚本和 SVG,不使用 CDN 或外部资源。正文语言与用户对话语言一致,标识符、路径和代码保持原样。未提供具体收费、平台或效果信息。