/** * audit-report —— 对 UI 走查报告(evidence/UI-Audit-Report.md)做小块修改,一次改一处。 * * 为什么:agent 以前每改一次报告都把整份 Markdown 读出来、拼字符串、整段写回(00889383 写了 122 次, * 其前的思考共 34 分钟),越往后报告越长、每次改写越贵,还常把表格改坏。格式由 * shared/src/audit_report_edit.ts 保证,和平台的解析器是同一份契约。 * * 报告路径:--report ,缺省 $STREAMLINE_WORKSPACE_DIR/evidence/UI-Audit-Report.md。 * 作为卫星 bundle 的 `audit-report` 子命令运行(satellite/src/entry.ts),也可 `bun bin/audit-report.ts`。 */ import { existsSync, readFileSync, writeFileSync, renameSync, mkdirSync } from "node:fs"; import path from "node:path"; import { addIssue, addPage, doneScene, initReport, recountSummary, setConstructed, setCoverage, setRecipe, setRoute, setScene, type CovMark, } from "../shared/src/audit_report_edit"; const USAGE = `audit-report —— 小块修改 UI 走查报告(一次改一处,格式由平台保证) init --title '<标题>' [--langs en,de] [--meta '截图所用包=…' --meta '设备=…'] 新建报告(已存在则拒绝) page --page --title '<中文页面名>' --surface '面 3 · 设置' 加一页(第 4 节标题) issue --page --sev P2 --cat 热区 --langs 'en de' --text '<一句话现象>' [--repro '<复现条件>'] [--cause '<原因>'] [--detail '<取证>'] [--code '<文件:行>'] [--title …] [--surface …] 加一条问题,覆盖格自动设 ⚠,打印编号 cov --page --lang en --mark ok|issue|missing 设覆盖矩阵一格(页面行 / 语言列不存在会补) scene --scope '<场景>' --status '待走|BLOCKED(环境)|部分覆盖|…' --why '<已做到哪一步>' 第 3 节加 / 改一行 done --scope '<场景>' 场景走完:从第 3 节删掉 construct --page --how '<怎么造的>' [--script hooks/x.js] 第 5 节登记构造态 route --page --title '<中文名>' --how '<怎么进>' 第 6 节路由 recipe --scene '<场景>' --how '<管用的做法>' 第 6 节做法 summary 按第 4 节重算第 1 节两张汇总表 通用:--report (缺省 $STREAMLINE_WORKSPACE_DIR/evidence/UI-Audit-Report.md) 同一个键(页面 id / 场景名)再写一次是覆盖,不会重复加行。`; function parseArgs(argv: string[]): { op: string; flags: Record; multi: Record } { const flags: Record = {}; const multi: Record = {}; let op = ""; for (let i = 0; i < argv.length; i++) { const a = argv[i]; if (!a.startsWith("--")) { if (!op) op = a; continue; } const k = a.slice(2); const v = argv[i + 1] != null && !argv[i + 1].startsWith("--") ? argv[++i] : "true"; flags[k] = v; (multi[k] ??= []).push(v); } return { op, flags, multi }; } function die(code: number, msg: string): never { process.stderr.write(msg.endsWith("\n") ? msg : msg + "\n"); process.exit(code); } function need(f: Record, ...keys: string[]): void { const miss = keys.filter((k) => !f[k] || f[k] === "true"); if (miss.length) die(2, `缺少 ${miss.map((k) => `--${k}`).join(" ")}\n\n${USAGE}`); } export async function runAuditReport(argv: string[]): Promise { const { op, flags: f, multi } = parseArgs(argv); if (!op || op === "help" || f.help) { process.stdout.write(USAGE + "\n"); process.exit(op ? 0 : 2); } const ws = process.env.STREAMLINE_WORKSPACE_DIR; const file = f.report ?? (ws ? path.join(ws, "evidence", "UI-Audit-Report.md") : ""); if (!file) die(2, "不知道报告在哪:传 --report (或在任务环境里运行,会自动用工作区的 evidence/UI-Audit-Report.md)"); if (op === "init") { need(f, "title"); if (existsSync(file)) die(2, `${file} 已存在 —— 不覆盖。要改用其它子命令。`); const meta = (multi.meta ?? []).map((kv) => { const i = kv.indexOf("="); return [kv.slice(0, i), kv.slice(i + 1)] as [string, string]; }); mkdirSync(path.dirname(file), { recursive: true }); writeFileSync(file, initReport({ title: f.title, langs: f.langs?.split(/[,\s]+/).filter(Boolean), meta })); process.stdout.write(`✓ 已新建 ${file}\n`); process.exit(0); } if (!existsSync(file)) die(2, `${file} 不存在 —— 先 \`audit-report init --title …\``); let md = readFileSync(file, "utf8"); let msg = ""; switch (op) { case "page": need(f, "page"); md = addPage(md, f.page, { title: f.title, surface: f.surface }); msg = `页面 ${f.page}`; break; case "issue": { need(f, "page", "sev", "cat", "langs", "text"); const r = addIssue(md, { page: f.page, sev: f.sev, cat: f.cat, langs: f.langs.split(/[,\s]+/).filter(Boolean), text: f.text, repro: f.repro, cause: f.cause, detail: f.detail, code: f.code, title: f.title, surface: f.surface, }); md = r.md; msg = `${f.page} #${r.n}`; break; } case "cov": { need(f, "page", "lang", "mark"); if (!["ok", "issue", "missing"].includes(f.mark)) die(2, "--mark 只能是 ok / issue / missing"); md = setCoverage(md, f.page, f.lang, f.mark as CovMark); msg = `${f.page} @ ${f.lang} = ${f.mark}`; break; } case "scene": need(f, "scope", "status", "why"); md = setScene(md, f.scope, f.status, f.why); msg = `第 3 节「${f.scope}」`; break; case "done": { need(f, "scope"); const r = doneScene(md, f.scope); if (!r.removed) die(1, `第 3 节里没有「${f.scope}」(按第一列精确匹配)`); md = r.md; msg = `第 3 节删掉「${f.scope}」`; break; } case "construct": need(f, "page", "how"); md = setConstructed(md, f.page, f.how, f.script ?? "—"); msg = `第 5 节 ${f.page}`; break; case "route": need(f, "page", "title", "how"); md = setRoute(md, f.page, f.title, f.how); msg = `第 6 节路由 ${f.page}`; break; case "recipe": need(f, "scene", "how"); md = setRecipe(md, f.scene, f.how); msg = `第 6 节做法「${f.scene}」`; break; case "summary": md = recountSummary(md); msg = "第 1 节已按第 4 节重算"; break; default: die(2, `不认识的子命令 ${op}\n\n${USAGE}`); } // 先写临时文件再改名:写到一半被打断(会话被截断 / 交棒)也不会留下半份报告。 const tmp = `${file}.tmp-${process.pid}`; writeFileSync(tmp, md); renameSync(tmp, file); process.stdout.write(`✓ ${msg}\n`); process.exit(0); } if (import.meta.main) await runAuditReport(process.argv.slice(2));