SuperAPI AI 工具集

visual-review

前端与建站

查看项目

更新于 10-15 22:12

技能介绍

用途:把 GitHub PR 的 diff 转成可在浏览器中浏览的注释型 HTML 页面,每个改动块旁给出说明——涉及的设计原则以及如何简化,帮助你自己判断该在 PR 上评论什么。只读,不会向 PR 发帖,也不改动分支。

主要能力:聚焦设计与简化视角,包括可读性与简化、SOLID 与设计原则、可测试性、可复用性和可维护性,即如何让每个改动块更清晰、更可复用、更易测试。缺陷、安全、范围/声明不符(diff 是否做了 PR 描述所说的事)不在范围内,需改用 code-review。它是 code-review(文本反馈)和 visual-validate(浏览器 UI)的同类技能,特点是可视化产物与教学性,发现会链接到 references/principles.md。

使用方式:分四个阶段。阶段一解析 PR:若传入 PR URL 或编号则使用,否则检测当前分支的 PR,命令为 gh pr view --json number,title,author,url,baseRefName,headRefName;无 PR 且无参数则停止并询问。阶段二获取 diff:gh pr diff <number> 与 gh pr view <number> --json files,并读取每个改动文件在 head 的完整上下文(删除的文件跳过并标注为已移除)。阶段三逐块注释:对照 references/principles.md 评估每个有意义的改动块,仅在确有观察时提出发现(必须修复、值得考虑或赞赏),每条记录 file:line、严重程度、原则标签、原因(推理才是重点)以及可操作时的具体 before → after 改写。阶段四渲染 HTML:克隆 assets/report-template.html,填入标题、编号、作者、PR 链接、汇总计数,以及按文件分组、文件内按严重程度排序的发现卡片;保持自包含(内联 CSS/JS,无 CDN),可离线通过 file:// 打开,写入仓库根目录的 visual-review-pr-<number>.html,然后打开并报告路径:open visual-review-pr-<number>.html(macOS;Linux 用 xdg-open)。

规则与限制:对 PR 只读,页面只是审查界面,之后由你在 GitHub 上评论;注释要说明原因而非只给结论;仅自包含 HTML,无外部字体/脚本/样式。错误处理:gh pr view 失败时运行 gh auth status 检查认证,不在 PR 分支时询问 PR 编号;当前分支无 PR 且无参数时询问 URL 或编号;PR 中删除的文件跳过读取并在报告中标注;diff 过大时优先处理高风险文件(认证、支付、数据变更、共享模块),并在汇总中说明哪些文件被截断。其他收费、平台等信息暂未提供。