@staff0rd/assist 0.522.1 → 0.523.0

package/dist/index.js

@@ -6,7 +6,7 @@ import { Command } from "commander";
 // package.json
 var package_default = {
   name: "@staff0rd/assist",
-  version: "0.522.1",
+  version: "0.523.0",
   type: "module",
   main: "dist/index.js",
   bin: {
@@ -25218,6 +25218,11 @@ function gatherContext() {
 // src/commands/review/postReviewToPr.ts
 import { readFileSync as readFileSync41 } from "fs";
 
+// src/commands/review/carriedUnanchoredFindings.ts
+function carriedUnanchoredFindings(unanchored) {
+  return unanchored.filter((finding) => finding.source !== "already-raised");
+}
+
 // src/commands/review/chainAddressComments.ts
 function chainAddressComments(prNumber, announce) {
   const args = ["review-pr-comments", String(prNumber)];
@@ -25317,11 +25322,30 @@ function formatSynthesisSummary(summary) {
 }
 
 // src/commands/review/buildReviewSummary.ts
+var UNANCHOR_REASONS = {
+  "out-of-diff": "its line falls outside the PR diff",
+  unlocated: "it has no parseable file:line"
+};
 function formatFindingLine(finding) {
   const severity = finding.severity ?? "finding";
   return `- **${severity}: ${finding.title}**`;
 }
-function buildReviewSummary(markdown) {
+function formatLocation(finding) {
+  const location = finding.location.trim();
+  if (!location || location.toLowerCase() === "n/a") return "no location";
+  return `\`${location}\``;
+}
+function formatUnanchoredFinding(finding) {
+  const lines2 = [
+    `${formatFindingLine(finding)} \u2014 ${formatLocation(finding)}`,
+    `  - Not anchored: ${UNANCHOR_REASONS[finding.reason]}`
+  ];
+  if (finding.impact) lines2.push(`  - Impact: ${finding.impact}`);
+  if (finding.recommendation)
+    lines2.push(`  - Recommendation: ${finding.recommendation}`);
+  return lines2;
+}
+function buildReviewSummary(markdown, unanchored = []) {
   const summary = summariseSynthesis(markdown);
   const findings = parseFindings(markdown);
   const lines2 = ["## Code review summary", "", formatSynthesisSummary(summary)];
@@ -25329,6 +25353,18 @@ function buildReviewSummary(markdown) {
     lines2.push("", "### Findings", "");
     for (const finding of findings) lines2.push(formatFindingLine(finding));
   }
+  const carried = carriedUnanchoredFindings(unanchored);
+  if (carried.length > 0) {
+    lines2.push(
+      "",
+      "### Findings not anchored to the diff",
+      "",
+      "No line comment could be attached to these, so the detail is here instead.",
+      ""
+    );
+    for (const finding of carried)
+      lines2.push(...formatUnanchoredFinding(finding));
+  }
   return lines2.join("\n");
 }
 
@@ -25367,13 +25403,12 @@ function postFindings(findings) {
   return { posted, failed: failed2 };
 }
 
-// src/commands/review/submitPendingReview.ts
-var MUTATION = `mutation($prId: ID!, $body: String) { submitPullRequestReview(input: { pullRequestId: $prId, event: COMMENT, body: $body }) { pullRequestReview { id } } }`;
-function submitPendingReview(body) {
+// src/commands/review/runReviewSubmission.ts
+function runReviewSubmission(mutation, body) {
   try {
     const prId = getCurrentPrNodeId();
-    runGhGraphql(MUTATION, { prId, body });
-    console.log("Submitted pending review.");
+    runGhGraphql(mutation, { prId, body });
+    console.log("Submitted review.");
   } catch (error) {
     if (isGhNotInstalled(error)) {
       console.error("Error: GitHub CLI (gh) is not installed.");
@@ -25384,9 +25419,25 @@ function submitPendingReview(body) {
   }
 }
 
+// src/commands/review/submitBodyOnlyReview.ts
+var MUTATION = `mutation($prId: ID!, $body: String) { addPullRequestReview(input: { pullRequestId: $prId, event: COMMENT, body: $body }) { pullRequestReview { id } } }`;
+function submitBodyOnlyReview(body) {
+  runReviewSubmission(MUTATION, body);
+}
+
+// src/commands/review/submitPendingReview.ts
+var MUTATION2 = `mutation($prId: ID!, $body: String) { submitPullRequestReview(input: { pullRequestId: $prId, event: COMMENT, body: $body }) { pullRequestReview { id } } }`;
+function submitPendingReview(body) {
+  runReviewSubmission(MUTATION2, body);
+}
+
 // src/commands/review/postAndMaybeSubmit.ts
-function buildReviewBody(markdown) {
-  return sanitiseReviewerNames(buildReviewSummary(markdown));
+function buildReviewBody(markdown, unanchored) {
+  return sanitiseReviewerNames(buildReviewSummary(markdown, unanchored));
+}
+function submitReview(body, posted) {
+  if (posted > 0) submitPendingReview(body);
+  else submitBodyOnlyReview(body);
 }
 async function decideSubmit(options2) {
   if (!options2.prompt) return options2.submit;
@@ -25397,17 +25448,19 @@ async function decideSubmit(options2) {
     await setSessionStatus("running");
   }
 }
-async function postAndMaybeSubmit(lineBound, markdown, options2) {
+async function postAndMaybeSubmit(lineBound, unanchored, markdown, options2) {
   const result = postFindings(lineBound);
   const failedSuffix = result.failed > 0 ? `, ${result.failed} failed` : "";
   console.log(`Posted ${result.posted} comment(s)${failedSuffix}.`);
-  if (result.posted === 0) return { posted: 0, submitted: false };
+  const carried = carriedUnanchoredFindings(unanchored);
+  if (result.posted === 0 && carried.length === 0)
+    return { posted: 0, submitted: false };
   const shouldSubmit = await decideSubmit(options2);
   if (shouldSubmit) {
-    submitPendingReview(buildReviewBody(markdown));
+    submitReview(buildReviewBody(markdown, unanchored), result.posted);
     return { posted: result.posted, submitted: true };
   }
-  console.log("Leaving pending review unsubmitted.");
+  console.log("Leaving the review unsubmitted.");
   return { posted: result.posted, submitted: false };
 }
 
@@ -25503,7 +25556,7 @@ function warnOutOfDiff(outOfDiff) {
   if (outOfDiff.length === 0) return;
   console.warn(
     chalk196.yellow(
-      `Skipped ${outOfDiff.length} finding(s) whose lines fall outside the PR diff (GitHub would silently drop these):`
+      `Moved ${outOfDiff.length} finding(s) whose lines fall outside the PR diff into the review body (GitHub cannot anchor a comment on these):`
     )
   );
   for (const finding of outOfDiff) {
@@ -25524,7 +25577,12 @@ function selectInDiffFindings(lineBound, prDiff) {
     buildDiffLineIndex(diff3)
   );
   warnOutOfDiff(outOfDiff);
-  return inDiff;
+  return {
+    inDiff,
+    unanchored: outOfDiff.map(
+      (finding) => ({ ...finding, reason: "out-of-diff" })
+    )
+  };
 }
 
 // src/commands/review/warnUnlocated.ts
@@ -25533,7 +25591,7 @@ function warnUnlocated(unlocated) {
   if (unlocated.length === 0) return;
   console.warn(
     chalk197.yellow(
-      `Skipped ${unlocated.length} finding(s) without a parseable file:line:`
+      `Moved ${unlocated.length} finding(s) without a parseable file:line into the review body:`
     )
   );
   for (const finding of unlocated) {
@@ -25549,7 +25607,7 @@ function selectPostableFindings(markdown, prInfo) {
   const findings = parseFindings(markdown);
   if (findings.length === 0) {
     console.log("Synthesis contains no findings; nothing to post.");
-    return [];
+    return { inDiff: [], unanchored: [] };
   }
   const { lineBound, unlocated, alreadyRaised } = partitionFindings(findings);
   warnUnlocated(unlocated);
@@ -25558,14 +25616,19 @@ function selectPostableFindings(markdown, prInfo) {
       `Skipped ${alreadyRaised.length} finding(s) already raised by prior comments.`
     );
   }
+  const carriedUnlocated = unlocated.map(
+    (finding) => ({ ...finding, reason: "unlocated" })
+  );
   if (lineBound.length === 0) {
-    console.log("No line-bound findings to post.");
-    return [];
+    console.log("No line-bound findings to comment on.");
+    return { inDiff: [], unanchored: carriedUnlocated };
   }
-  const inDiff = selectInDiffFindings(lineBound, prInfo);
+  const { inDiff, unanchored } = selectInDiffFindings(lineBound, prInfo);
   if (inDiff.length === 0)
-    console.log("No findings fall within the PR diff; nothing to post.");
-  return inDiff;
+    console.log(
+      "No findings fall within the PR diff; no line comments to post."
+    );
+  return { inDiff, unanchored: [...carriedUnlocated, ...unanchored] };
 }
 
 // src/commands/review/stillOnReviewedPr.ts
@@ -25590,23 +25653,29 @@ function stillOnReviewedPr(prNumber) {
 
 // src/commands/review/postReviewToPr.ts
 var NOTHING_POSTED = { posted: 0, submitted: false };
-async function confirmPost(prNumber, count8, options2) {
+function describeWork(comments3, carried) {
+  const parts = [];
+  if (comments3 > 0) parts.push(`${comments3} line comment(s)`);
+  if (carried > 0) parts.push(`${carried} finding(s) in the review body`);
+  return parts.join(" and ");
+}
+async function confirmPost(prNumber, work, options2) {
   if (!options2.prompt) return true;
-  return promptConfirm(`Post ${count8} comment(s) to PR #${prNumber}?`, false);
+  return promptConfirm(`Post ${work} to PR #${prNumber}?`, false);
 }
 async function postFindingsToPr(prInfo, synthesisPath, options2) {
   const markdown = readFileSync41(synthesisPath, "utf8");
-  const inDiff = selectPostableFindings(markdown, prInfo);
-  if (inDiff.length === 0) return NOTHING_POSTED;
-  console.log(
-    `Found PR #${prInfo.prNumber} with ${inDiff.length} line-bound finding(s) in the diff.`
-  );
-  const confirmed = await confirmPost(prInfo.prNumber, inDiff.length, options2);
+  const { inDiff, unanchored } = selectPostableFindings(markdown, prInfo);
+  const carried = carriedUnanchoredFindings(unanchored);
+  if (inDiff.length === 0 && carried.length === 0) return NOTHING_POSTED;
+  const work = describeWork(inDiff.length, carried.length);
+  console.log(`Found PR #${prInfo.prNumber} with ${work} to post.`);
+  const confirmed = await confirmPost(prInfo.prNumber, work, options2);
   if (!confirmed) {
     console.log("Skipped posting.");
     return NOTHING_POSTED;
   }
-  return postAndMaybeSubmit(inDiff, markdown, options2);
+  return postAndMaybeSubmit(inDiff, unanchored, markdown, options2);
 }
 async function postReviewToPr(synthesisPath, prInfo, options2) {
   if (!stillOnReviewedPr(prInfo.prNumber)) return;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@staff0rd/assist",
-	"version": "0.522.1",
+	"version": "0.523.0",
 	"type": "module",
 	"main": "dist/index.js",
 	"bin": {