SuperAPI AI 工具集

sg-change-report

测试与质量

查看项目

更新于 10-15 20:05

技能介绍

用途:在视觉运行、截图采集、前端 PR 或干系人评审前,生成随 UI 变更一起提交的持久化前后对比报告,把视觉测试证据转化为 PR 评审材料。

主要能力:创建或更新源报告目录 visual-tests/_results/change-reports/<report-id>/(含 report.json 与 screenshots/),再运行 node visual-tests/build-review.mjs 生成面向不同受众的 HTML,输出到 visual-tests/_results/persona-reports/<report-id>/,包括 index.html、各受众页面(如 client.html、engineering.html)、client-invite-email.md、client-response-email.md、proposal-trace.md/json,并刷新顶层 persona-reports/index.html。report.json 是持久化事实来源,persona-reports 是其渲染视图;字段均可选,status 默认 draft。

使用方式:参数为稳定的 kebab-case <report-id>,可选摘要文本(写入 report.json.summary)和可选截图路径(复制到 screenshots/ 并作为 before/after 的 src)。工作流:复用 sg-visual-run、sg-visual-review 或 sg-visual-fix 的视觉证据;复制相关截图;编写 report.json;若缺少 build-review.mjs 或 _review-template.html 则从 $SHIPGUARD_PLUGIN_ROOT/skills/sg-visual-review/ 复制;运行构建脚本,可选 --serve --port=<free-port> 本地浏览,之后用 /sg-visual-review-stop 停止;验证 index.html 与至少一个受众页面存在;用 git add 提交持久化产物。

限制:不要提交 visual-tests/_results/review.html 和 .server.pid。宿主项目常忽略 _results/,若暂存后 git status 不显示,可用 git add -f 或调整忽略规则。SHIPGUARD_PLUGIN_ROOT 为本技能 SKILL.md 上两级目录,或由 $CLAUDE_PLUGIN_ROOT 指定。