@riddledc/riddle-proof 0.8.37 → 0.8.39

package/README.md

@@ -968,6 +968,27 @@ way to a ready PR after proof and CI; `leave_draft: true` is only an explicit
 debug or user-request escape hatch. The notification adapter is where a host
 updates Discord, OpenClaw, GitHub, or another integration.
 
+## PR Proof Comments
+
+Use `pr-comment` when a project already has a PR and a Riddle Proof output
+directory, but is not using the full ship loop. It reads
+`riddle-run-response.json` and `result.json`, builds a managed GitHub comment,
+embeds the primary hosted screenshot when available, links structured artifacts,
+summarizes check counts, and updates the existing Riddle Proof comment on
+reruns.
+
+```sh
+riddle-proof-loop pr-comment \
+  --proof-dir test-results/riddle-proof-docs \
+  --pr 228 \
+  --repo davisdiehl/riddle-site
+```
+
+Use `--dry-run` to print the exact Markdown without touching GitHub, or
+`--body-file proof-comment.md` to save the generated body for another tool. The
+markdown builder is also exported from `@riddledc/riddle-proof/pr-comment` for
+host integrations that want to post comments themselves.
+
 ## Runtime Scratch Space
 
 The packaged proof-run setup uses isolated git worktrees for before and after

package/dist/chunk-6KYXX4OE.js

@@ -0,0 +1,209 @@
+// src/pr-comment.ts
+var RIDDLE_PROOF_PR_COMMENT_MARKER = "<!-- riddle-proof:pr-comment:v1 -->";
+function asRecord(value) {
+  return value && typeof value === "object" && !Array.isArray(value) ? value : {};
+}
+function asArray(value) {
+  return Array.isArray(value) ? value : [];
+}
+function stringValue(value) {
+  return typeof value === "string" && value.trim() ? value.trim() : void 0;
+}
+function numberValue(value) {
+  return typeof value === "number" && Number.isFinite(value) ? value : void 0;
+}
+function booleanValue(value) {
+  return typeof value === "boolean" ? value : void 0;
+}
+function artifactKind(name, url) {
+  const target = `${name} ${url}`.toLowerCase();
+  if (/\.(png|jpe?g|gif|webp|avif|svg)(\?|#|$)/.test(target)) return "image";
+  if (/\.(json|har|txt|md|html|log)(\?|#|$)/.test(target)) return "data";
+  return "artifact";
+}
+function artifactDisplayName(value, fallback) {
+  const raw = stringValue(value);
+  if (raw) return raw;
+  return fallback;
+}
+function collectArtifacts(runResponse) {
+  const proofResult = asRecord(runResponse.proofResult);
+  const outputs = asArray(proofResult.outputs);
+  const artifacts = [];
+  const seen = /* @__PURE__ */ new Set();
+  for (const [index, item] of outputs.entries()) {
+    const artifact = asRecord(item);
+    const url = stringValue(artifact.url);
+    if (!url || seen.has(url)) continue;
+    seen.add(url);
+    const name = artifactDisplayName(artifact.name, `artifact-${index + 1}`);
+    artifacts.push({
+      name,
+      url,
+      kind: artifactKind(name, url),
+      size_bytes: numberValue(artifact.size)
+    });
+  }
+  return artifacts;
+}
+function pageSummaries(result) {
+  const pages = [];
+  for (const page of asArray(result.pages)) {
+    const record = asRecord(page);
+    const route = stringValue(record.route) || stringValue(record.url) || "page";
+    const checks = asRecord(record.checks);
+    let passed = 0;
+    let failed = 0;
+    for (const value of Object.values(checks)) {
+      if (value === true) passed += 1;
+      if (value === false) failed += 1;
+    }
+    pages.push({ route, passed, failed });
+  }
+  return pages;
+}
+function summarizeExplicitChecks(value) {
+  let passed = 0;
+  let failed = 0;
+  const visit = (current, inChecks = false) => {
+    if (current === true && inChecks) {
+      passed += 1;
+      return;
+    }
+    if (current === false && inChecks) {
+      failed += 1;
+      return;
+    }
+    if (Array.isArray(current)) {
+      for (const item of current) visit(item, inChecks);
+      return;
+    }
+    if (current && typeof current === "object") {
+      for (const [key, item] of Object.entries(current)) {
+        visit(item, inChecks || key === "checks");
+      }
+    }
+  };
+  visit(value);
+  return { passed, failed };
+}
+function selectPrimaryImage(artifacts) {
+  const images = artifacts.filter((artifact) => artifact.kind === "image");
+  return images.find((artifact) => /after|proof|screenshot/i.test(artifact.name)) || images[0];
+}
+function summarizeRiddleProofPrComment(input) {
+  const runResponse = asRecord(input.runResponse);
+  const result = asRecord(input.result);
+  const proofResult = asRecord(runResponse.proofResult);
+  const preview = asRecord(runResponse.preview);
+  const artifacts = collectArtifacts(runResponse);
+  const pages = pageSummaries(result);
+  const checkSource = { ...result };
+  delete checkSource.ok;
+  const nestedChecks = summarizeExplicitChecks(checkSource);
+  const ok = booleanValue(result.ok) ?? booleanValue(runResponse.ok) ?? null;
+  return {
+    ok,
+    status: stringValue(proofResult.status),
+    job_id: stringValue(proofResult.job_id),
+    duration_ms: numberValue(proofResult.duration_ms),
+    proof_url: stringValue(runResponse.proofUrl),
+    preview_id: stringValue(preview.id),
+    preview_url: stringValue(preview.preview_url) || stringValue(preview.url),
+    preview_publish_recovered: booleanValue(preview.publish_recovered),
+    preview_publish_error: stringValue(preview.publish_error),
+    passed_checks: nestedChecks.passed,
+    failed_checks: nestedChecks.failed,
+    pages,
+    artifacts,
+    primary_image: selectPrimaryImage(artifacts)
+  };
+}
+function formatDuration(ms) {
+  if (typeof ms !== "number" || !Number.isFinite(ms)) return "";
+  const seconds = Math.max(0, Math.round(ms / 1e3));
+  const minutes = Math.floor(seconds / 60);
+  const remainder = seconds % 60;
+  return minutes > 0 ? `${minutes}m${String(remainder).padStart(2, "0")}s` : `${seconds}s`;
+}
+function markdownLink(label, url) {
+  return `[${label.replace(/\]/g, "\\]")}](${url})`;
+}
+function resultLabel(summary) {
+  if (summary.ok === true) return "passed";
+  if (summary.ok === false) return "failed";
+  return summary.status || "recorded";
+}
+function artifactRank(artifact) {
+  const name = artifact.name.toLowerCase();
+  if (name === "proof.json") return 0;
+  if (name === "result.json") return 1;
+  if (name.includes("proof") && name.endsWith(".json") && !name.includes("layout")) return 2;
+  if (name === "console.json") return 3;
+  if (artifact.kind === "data") return 10;
+  if (artifact.kind === "image") return 20;
+  return 30;
+}
+function buildRiddleProofPrCommentMarkdown(input) {
+  const summary = summarizeRiddleProofPrComment(input);
+  const title = input.title?.trim() || "Riddle Proof Evidence";
+  const lines = [
+    RIDDLE_PROOF_PR_COMMENT_MARKER,
+    `## ${title}`,
+    "",
+    `**Result:** ${resultLabel(summary)}`
+  ];
+  if (input.goal?.trim()) lines.push(`**Goal:** ${input.goal.trim()}`);
+  if (input.successCriteria?.trim()) lines.push(`**Success criteria:** ${input.successCriteria.trim()}`);
+  if (summary.status) lines.push(`**Riddle job status:** ${summary.status}`);
+  if (summary.job_id) lines.push(`**Riddle job:** \`${summary.job_id}\``);
+  if (summary.duration_ms) lines.push(`**Duration:** ${formatDuration(summary.duration_ms)}`);
+  if (summary.proof_url) lines.push(`**Proof URL:** ${markdownLink(summary.proof_url, summary.proof_url)}`);
+  if (summary.preview_id || summary.preview_url) {
+    const previewLabel = summary.preview_id ? `\`${summary.preview_id}\`` : "preview";
+    lines.push(`**Preview:** ${summary.preview_url ? markdownLink(previewLabel, summary.preview_url) : previewLabel}`);
+  }
+  if (summary.preview_publish_recovered) {
+    const detail = summary.preview_publish_error ? `: ${summary.preview_publish_error}` : "";
+    lines.push(`**Preview publish recovery:** recovered after publish error${detail}`);
+  }
+  lines.push(`**Checks:** ${summary.passed_checks} passed / ${summary.failed_checks} failed`);
+  lines.push("");
+  if (summary.primary_image) {
+    lines.push("### Screenshot");
+    lines.push(`![${summary.primary_image.name}](${summary.primary_image.url})`);
+    lines.push("");
+  }
+  if (summary.pages.length) {
+    lines.push("### Page Checks");
+    for (const page of summary.pages.slice(0, 12)) {
+      lines.push(`- \`${page.route}\`: ${page.passed} passed / ${page.failed} failed`);
+    }
+    if (summary.pages.length > 12) lines.push(`- ${summary.pages.length - 12} more page(s) omitted`);
+    lines.push("");
+  }
+  const linkedArtifacts = summary.artifacts.filter((artifact) => artifact.url !== summary.primary_image?.url).sort((left, right) => artifactRank(left) - artifactRank(right) || left.name.localeCompare(right.name)).slice(0, 20);
+  if (linkedArtifacts.length) {
+    lines.push("### Artifacts");
+    for (const artifact of linkedArtifacts) {
+      lines.push(`- ${markdownLink(artifact.name, artifact.url)}`);
+    }
+    if (summary.artifacts.length - (summary.primary_image ? 1 : 0) > linkedArtifacts.length) {
+      lines.push(`- ${summary.artifacts.length - (summary.primary_image ? 1 : 0) - linkedArtifacts.length} more artifact(s) omitted`);
+    }
+    lines.push("");
+  }
+  if (input.source?.trim()) {
+    lines.push(`_Source: ${input.source.trim()}_`);
+  } else {
+    lines.push("_Updated by `riddle-proof-loop pr-comment`._");
+  }
+  return `${lines.join("\n").trim()}
+`;
+}
+
+export {
+  RIDDLE_PROOF_PR_COMMENT_MARKER,
+  summarizeRiddleProofPrComment,
+  buildRiddleProofPrCommentMarkdown
+};

package/dist/{chunk-F4HKK2YH.js → chunk-MVJBPCZ4.js}

@@ -1,3 +1,13 @@
+import {
+  createRiddleApiClient,
+  isTerminalRiddleJobStatus,
+  parseRiddleViewport
+} from "./chunk-DI2XNGEZ.js";
+import {
+  RIDDLE_PROOF_PR_COMMENT_MARKER,
+  buildRiddleProofPrCommentMarkdown,
+  summarizeRiddleProofPrComment
+} from "./chunk-6KYXX4OE.js";
 import {
   RIDDLE_PROOF_PROFILE_EVIDENCE_VERSION,
   assessRiddleProofProfileEvidence,
@@ -13,11 +23,6 @@ import {
   resolveRiddleProofProfileTargetUrl,
   resolveRiddleProofProfileTimeoutSec
 } from "./chunk-Z2LCVROU.js";
-import {
-  createRiddleApiClient,
-  isTerminalRiddleJobStatus,
-  parseRiddleViewport
-} from "./chunk-DI2XNGEZ.js";
 import {
   createDisabledRiddleProofAgentAdapter,
   readRiddleProofRunStatus,
@@ -56,11 +61,14 @@ var KNOWN_CLI_OPTIONS = /* @__PURE__ */ new Set([
   "codexSandbox",
   "codexTimeoutMs",
   "command",
+  "commentMode",
   "continueWithStage",
   "createdAt",
   "decision",
   "defaultReviewer",
   "defaultShipMode",
+  "bodyFile",
+  "dryRun",
   "exclude",
   "format",
   "framework",
@@ -88,20 +96,25 @@ var KNOWN_CLI_OPTIONS = /* @__PURE__ */ new Set([
   "pack",
   "packFile",
   "profile",
+  "proofDir",
+  "pr",
   "progressEveryMs",
   "quiet",
   "readinessPath",
   "readinessTimeout",
   "reasonsJson",
+  "repo",
   "requestJson",
   "requiredJson",
   "responseJson",
   "resultFormat",
+  "resultJson",
   "resultsDir",
   "riddleEngineModuleUrl",
   "riddleProofDir",
   "route",
   "runDir",
+  "runResponse",
   "runner",
   "scriptFile",
   "sourceKind",
@@ -112,8 +125,10 @@ var KNOWN_CLI_OPTIONS = /* @__PURE__ */ new Set([
   "submitRetries",
   "submitTimeoutMs",
   "summary",
+  "successCriteria",
   "sync",
   "timeout",
+  "title",
   "url",
   "unsubmittedJobRetries",
   "unsubmittedJobTimeoutMs",
@@ -138,6 +153,7 @@ function usage() {
     "  riddle-proof-loop run-profile aggregate --profile <file|json|-> --url <base-url> [--base-url <base-url>] --input-dir <dir>|--inputs <path[,path...]> [--output <dir>|--output-dir <dir>] [--result-format json|compact-json|summary|none; default json]",
     "  riddle-proof-loop run-profile recover --profile <file|json|-> --url <base-url> [--base-url <base-url>] --job <job-id> [--viewport-name <name[,name...]>] [--output <dir>|--output-dir <dir>] [--result-format json|compact-json|summary|none; default json]",
     "  riddle-proof-loop regression-pack run [--pack oc-flow-regression|--pack-file <file>] [--local-core true|false; default true] [--hosted-riddle true|false; default false] [--format json|markdown|compact-json; default json] [--output <dir>|--output-dir <dir>]",
+    "  riddle-proof-loop pr-comment --proof-dir <dir>|--run-response <file> [--result-json <file>] --pr <number|url> [--repo owner/name] [--dry-run] [--body-file <file>] [--comment-mode update|append]",
     "  riddle-proof-loop profile-body-assertions --artifact <file|url|-> --candidates-json <file|json|-> [--required-json <file|json|->] [--format json|body-contains]",
     "  riddle-proof-loop profile-http-status-preflight --profile <file|json|-> --url <base-url> [--format json|summary]",
     "  riddle-proof-loop riddle-preview-deploy <build-dir> <label> [--framework spa|static] [--quiet]",
@@ -946,6 +962,81 @@ function riddlePreviewProgressLine(snapshot) {
   const messagePart = snapshot.message ? ` ${snapshot.message}` : "";
   return `[riddle-preview] ${snapshot.stage}${idPart}${statusPart}${attemptPart} elapsed=${formatPollDuration(snapshot.elapsed_ms)} label=${snapshot.label} framework=${snapshot.framework}${filePart}${totalPart}${archivePart}${previewPart}${recoveryPart}${messagePart}`;
 }
+function readJsonFileIfExists(filePath) {
+  if (!filePath || !existsSync(filePath)) return void 0;
+  return readJsonValue(filePath, filePath);
+}
+function defaultProofDirJsonPath(proofDir, filename) {
+  return proofDir ? path.join(proofDir, filename) : void 0;
+}
+function prNumberFromValue(value) {
+  const text = value?.trim();
+  if (!text) return "";
+  const match = text.match(/\/pull\/(\d+)(?:\/|$)/) || text.match(/^#?(\d+)$/);
+  return match ? match[1] : text;
+}
+function ghJson(args, input) {
+  const result = spawnSync("gh", args, {
+    input: typeof input === "undefined" ? void 0 : `${JSON.stringify(input)}
+`,
+    encoding: "utf-8",
+    timeout: 9e4
+  });
+  if (result.error) throw result.error;
+  if (result.status !== 0) {
+    const detail = (result.stderr || result.stdout || "").trim();
+    throw new Error(`gh ${args.join(" ")} failed${detail ? `: ${detail}` : ""}`);
+  }
+  const stdout = (result.stdout || "").trim();
+  return stdout ? JSON.parse(stdout) : {};
+}
+function resolveGhRepoName(repoOption) {
+  if (repoOption?.trim()) return repoOption.trim();
+  const result = spawnSync("gh", ["repo", "view", "--json", "nameWithOwner", "--jq", ".nameWithOwner"], {
+    encoding: "utf-8",
+    timeout: 3e4
+  });
+  if (result.error) throw result.error;
+  if (result.status !== 0 || !result.stdout.trim()) {
+    const detail = (result.stderr || result.stdout || "").trim();
+    throw new Error(`Could not resolve GitHub repository. Pass --repo owner/name.${detail ? ` gh said: ${detail}` : ""}`);
+  }
+  return result.stdout.trim();
+}
+function findManagedPrComment(repo, prNumber) {
+  const comments = ghJson(["api", `repos/${repo}/issues/${prNumber}/comments`, "--paginate"]);
+  return comments.find((comment) => typeof comment.body === "string" && comment.body.includes(RIDDLE_PROOF_PR_COMMENT_MARKER));
+}
+function upsertPrComment(input) {
+  const payload = { body: input.body };
+  if (input.mode !== "append") {
+    const existing = findManagedPrComment(input.repo, input.prNumber);
+    if (existing?.id) {
+      return {
+        action: "updated",
+        comment: ghJson([
+          "api",
+          `repos/${input.repo}/issues/comments/${existing.id}`,
+          "-X",
+          "PATCH",
+          "--input",
+          "-"
+        ], payload)
+      };
+    }
+  }
+  return {
+    action: "created",
+    comment: ghJson([
+      "api",
+      `repos/${input.repo}/issues/${input.prNumber}/comments`,
+      "-X",
+      "POST",
+      "--input",
+      "-"
+    ], payload)
+  };
+}
 function readJsonValue(value, label) {
   if (!value) throw new Error(`${label} is required.`);
   const raw = value === "-" ? readStdin() : existsSync(value) ? readFileSync(value, "utf-8") : value;
@@ -4578,6 +4669,47 @@ async function main() {
     process.exitCode = result.ok ? 0 : 1;
     return;
   }
+  if (command === "pr-comment") {
+    const proofDir = optionString(options, "proofDir") || optionString(options, "outputDir") || positional[1];
+    const runResponsePath = optionString(options, "runResponse") || defaultProofDirJsonPath(proofDir, "riddle-run-response.json");
+    const resultJsonPath = optionString(options, "resultJson") || defaultProofDirJsonPath(proofDir, "result.json");
+    const runResponse = readJsonFileIfExists(runResponsePath);
+    const result = readJsonFileIfExists(resultJsonPath);
+    if (!runResponse && !result) {
+      throw new Error("pr-comment requires --proof-dir with riddle-run-response.json/result.json or explicit --run-response/--result-json.");
+    }
+    const body = buildRiddleProofPrCommentMarkdown({
+      title: optionString(options, "title"),
+      goal: optionString(options, "summary"),
+      successCriteria: optionString(options, "successCriteria"),
+      runResponse,
+      result
+    });
+    const bodyFile = optionString(options, "bodyFile");
+    if (bodyFile) writeFileSync(bodyFile, body);
+    if (optionBoolean(options, "dryRun")) {
+      process.stdout.write(body);
+      return;
+    }
+    const prNumber = prNumberFromValue(optionString(options, "pr"));
+    if (!prNumber) throw new Error("pr-comment requires --pr <number|url> unless --dry-run is used.");
+    const commentMode = optionString(options, "commentMode") || "update";
+    if (!["update", "append"].includes(commentMode)) throw new Error("--comment-mode must be update or append.");
+    const repo = resolveGhRepoName(optionString(options, "repo"));
+    const resultPayload = upsertPrComment({ repo, prNumber, body, mode: commentMode });
+    const comment = resultPayload.comment;
+    process.stdout.write(`${JSON.stringify({
+      ok: true,
+      action: resultPayload.action,
+      repo,
+      pr: prNumber,
+      comment_url: cliString(comment.html_url) || null,
+      summary: summarizeRiddleProofPrComment({ runResponse, result }),
+      body_file: bodyFile || null
+    }, null, 2)}
+`);
+    return;
+  }
   if (command === "profile-http-status-preflight") {
     const profile = normalizeProfileForCli(options);
     const result = await preflightRiddleProofProfileHttpStatusChecks(profile);

package/dist/cli/index.js

@@ -1,6 +1,7 @@
-import "../chunk-F4HKK2YH.js";
-import "../chunk-Z2LCVROU.js";
+import "../chunk-MVJBPCZ4.js";
 import "../chunk-DI2XNGEZ.js";
+import "../chunk-6KYXX4OE.js";
+import "../chunk-Z2LCVROU.js";
 import "../chunk-ZREWMTFA.js";
 import "../chunk-ZQWVXQKJ.js";
 import "../chunk-RDPG554T.js";