@jwilger/pi-development-system 0.59.0 → 0.60.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jwilger/pi-development-system",
-  "version": "0.59.0",
+  "version": "0.60.0",
   "description": "A pi extension package representing a seasoned approach to software development using a full AI SDLC.",
   "keywords": [
     "pi-package"

package/src/planning/task-record.ts

@@ -38,6 +38,19 @@ const PLACEHOLDER =
 
 const isSection = (name: string): name is Section => SECTIONS.some((s) => s === name);
 
+const FENCE = /^\s*(?:```|~~~)/;
+const HEADING = /^#{1,6}\s/;
+
+/** For each line, whether it sits inside (or on the edge of) a fenced code block. */
+const fencedFlags = (lines: readonly string[]): boolean[] => {
+  let open = false;
+  return lines.map((line) => {
+    if (!FENCE.test(line)) return open;
+    open = !open;
+    return true;
+  });
+};
+
 type Sections = { readonly text: Map<Section, string>; readonly duplicates: Section[] };
 
 /** Splits the body into section texts keyed by name; text may continue over several lines. */
@@ -45,8 +58,9 @@ function splitSections(lines: readonly string[]): Sections {
   const found = new Map<Section, string[]>();
   const duplicates: Section[] = [];
   let current: string[] | undefined;
-  for (const line of lines) {
-    const match = SECTION_LINE.exec(line);
+  const fenced = fencedFlags(lines);
+  for (const [at, line] of lines.entries()) {
+    const match = fenced[at] === true ? null : SECTION_LINE.exec(line);
     const name = match?.[1]?.trim();
     if (match !== null && name !== undefined && isSection(name)) {
       if (found.has(name)) duplicates.push(name);
@@ -60,12 +74,13 @@ function splitSections(lines: readonly string[]): Sections {
 
 type Located = { readonly id: string; readonly title: string; readonly lines: readonly string[] };
 
-/** Every `## <id> — <title>` block; any other `## ` heading ends the block before it. */
+/** Every `## <id> — <title>` block; any other heading (outside code fences) ends the block before it. */
 function recordsIn(lines: readonly string[]): Located[] {
   const records: { id: string; title: string; lines: string[] }[] = [];
   let open: { id: string; title: string; lines: string[] } | undefined;
-  for (const line of lines) {
-    if (line.startsWith("## ")) {
+  const fenced = fencedFlags(lines);
+  for (const [at, line] of lines.entries()) {
+    if (fenced[at] !== true && HEADING.test(line)) {
       const header = HEADER.exec(line);
       open =
         header === null
@@ -77,13 +92,25 @@ function recordsIn(lines: readonly string[]): Located[] {
   return records;
 }
 
-const stripTicks = (text: string): string => text.replace(/^`+|`+$/g, "").trim();
+/** A command or result without its backticks, or the body of a fenced block (its info string dropped). */
+const stripTicks = (text: string): string => {
+  const lines = text.split("\n");
+  if (FENCE.test(lines[0] ?? "")) {
+    const body = lines.slice(1);
+    if (FENCE.test(body.at(-1) ?? "")) body.pop();
+    return body.join("\n").trim();
+  }
+  return text.replace(/^`+|`+$/g, "").trim();
+};
 
-const stepsOf = (text: string): string[] =>
-  text.split("\n").flatMap((line) => {
-    const item = STEP.exec(line)?.[1]?.trim();
+const stepsOf = (text: string): string[] => {
+  const lines = text.split("\n");
+  const fenced = fencedFlags(lines);
+  return lines.flatMap((line, at) => {
+    const item = fenced[at] === true ? undefined : STEP.exec(line)?.[1]?.trim();
     return item === undefined || item === "" ? [] : [item];
   });
+};
 
 function concrete(name: "Run" | "Expected", text: string): string | undefined {
   const bare = stripTicks(text);

package/src/tracker/github.ts

@@ -1,6 +1,13 @@
 import type { Exec } from "../core/exec.ts";
 import { ok } from "../core/result.ts";
 import { unwritable } from "./item-format.ts";
+
+/** Our status marker is a label; a user label with that name would change the status as a side effect. */
+const unusable = (item: { title: string; labels: readonly string[] }): string | undefined =>
+  item.labels.includes("in-progress")
+    ? '"in-progress" is reserved for the in-progress status; set status instead'
+    : unwritable(item);
+
 import {
   type ItemFilter,
   type NewWorkItem,
@@ -142,7 +149,7 @@ const listIssues = async (gh: Gh, filter: ItemFilter): Promise<TrackerResult<Wor
 };
 
 const createIssue = async (gh: Gh, input: NewWorkItem): Promise<TrackerResult<WorkItem>> => {
-  const problem = unwritable({ title: input.title, labels: input.labels ?? [] });
+  const problem = unusable({ title: input.title, labels: input.labels ?? [] });
   if (problem !== undefined) return trackerError(problem);
   const labels = (input.labels ?? []).flatMap((l) => ["--label", l]);
   const out = await gh([
@@ -203,7 +210,7 @@ const updateIssue = async (
   id: string,
   patch: WorkItemPatch,
 ): Promise<TrackerResult<WorkItem>> => {
-  const problem = unwritable({ title: patch.title ?? "x", labels: patch.labels ?? [] });
+  const problem = unusable({ title: patch.title ?? "x", labels: patch.labels ?? [] });
   if (problem !== undefined) return trackerError(problem);
   const raw = await viewRaw(gh, id);
   if (!raw.ok) return raw;

package/src/tracker/item-format.ts

@@ -32,17 +32,13 @@ export const unwritable = (item: Pick<WorkItem, "title" | "labels">): string | u
     : `label ${JSON.stringify(bad)} is blank or holds a comma or line break`;
 };
 
+/** Written to pass our own markdownlint: no trailing space, no repeated heading text, no stacked blank lines. */
 export const renderItem = (item: WorkItem): string => {
-  const comments = item.comments.map((c) => `\n### Comment\n\n${quote(c)}\n`).join("");
-  return [
-    `# ${item.title}`,
-    "",
-    `Status: ${item.status}`,
-    `Labels: ${item.labels.join(", ")}`,
-    "",
-    item.body,
-    COMMENTS + comments,
-  ].join("\n");
+  const labels = item.labels.length === 0 ? "" : ` ${item.labels.join(", ")}`;
+  const top = `# ${item.title}\n\nStatus: ${item.status}\nLabels:${labels}`;
+  const body = item.body === "" ? [] : [item.body];
+  const comments = item.comments.map((c, n) => `\n### Comment ${n + 1}\n\n${quote(c)}\n`);
+  return `${[top, ...body, "## Comments"].join("\n\n")}\n${comments.join("")}`;
 };
 
 const isStatus = (value: string): value is WorkStatus =>
@@ -50,7 +46,7 @@ const isStatus = (value: string): value is WorkStatus =>
 
 const commentsOf = (section: string): string[] =>
   section
-    .split(/^### Comment\n\n/m)
+    .split(/^### Comment(?: \d+)?\n\n/m)
     .slice(1)
     .map((c) => unquote(c.replace(/\n+$/, "")));
 
@@ -59,7 +55,7 @@ export const parseItem = (id: string, raw: string): TrackerResult<WorkItem> => {
   const marker = text.lastIndexOf(COMMENTS);
   const main = marker < 0 ? text : text.slice(0, marker);
   const comments = marker < 0 ? [] : commentsOf(text.slice(marker + COMMENTS.length));
-  const head = /^# (.+)\n\nStatus: (.*)\nLabels: (.*)\n\n?/.exec(main);
+  const head = /^# (.+)\n\nStatus: (.*)\nLabels:[ ]?(.*)(?:\n\n|\n$|$)/.exec(main);
   if (head === null)
     return trackerError(`work item ${id}: expected "# title", Status and Labels lines`);
   const [whole, title = "", status = "", labels = ""] = head;