fix: unify harness plan readiness display

Author: kamilio

package-lock.json

@@ -1,5 +1,6 @@
 export { discoverWorkflowDocs, resolveWorkflowPath, type DiscoverDocsOptions } from "./paths.js";
 export { archivePlan, discoverPlans, openPlanList, parsePlanReadiness } from "./plans.js";
+export { comparePlanReadiness, formatPlanReadinessLabel } from "./plan-readiness.js";
 export type {
   ArchivePlanOptions,
   DiscoverPlansOptions,

packages/agent-harness-tools/src/index.ts

@@ -0,0 +1,19 @@
+import { describe, expect, it } from "vitest";
+import { comparePlanReadiness, formatPlanReadinessLabel } from "./plan-readiness.js";
+
+describe("plan readiness presentation", () => {
+  it("adds the plan-viewer checkmark only to ready plans", () => {
+    expect(formatPlanReadinessLabel("docs/plans/ready.md", "ready")).toBe(
+      "docs/plans/ready.md ✓"
+    );
+    expect(formatPlanReadinessLabel("docs/plans/draft.md", "draft")).toBe(
+      "docs/plans/draft.md"
+    );
+  });
+
+  it("sorts ready plans ahead of drafts", () => {
+    expect(comparePlanReadiness({ readiness: "ready" }, { readiness: "draft" })).toBeLessThan(0);
+    expect(comparePlanReadiness({ readiness: "draft" }, { readiness: "ready" })).toBeGreaterThan(0);
+    expect(comparePlanReadiness({ readiness: "ready" }, { readiness: "ready" })).toBe(0);
+  });
+});

packages/agent-harness-tools/src/plan-readiness.test.ts

@@ -0,0 +1,12 @@
+import type { PlanReadiness } from "./plans.js";
+
+export function formatPlanReadinessLabel(label: string, readiness: PlanReadiness): string {
+  return `${label}${readiness === "ready" ? " ✓" : ""}`;
+}
+
+export function comparePlanReadiness(
+  left: { readiness: PlanReadiness },
+  right: { readiness: PlanReadiness }
+): number {
+  return Number(right.readiness === "ready") - Number(left.readiness === "ready");
+}

packages/agent-harness-tools/src/plan-readiness.ts

@@ -3,6 +3,7 @@ import path from "node:path";
 import { openTaskList, type TaskList, type TaskListFs } from "@poe-code/task-list";
 import { hasOwnErrorCode } from "./error-codes.js";
 import { resolveWorkflowPath } from "./paths.js";
+import { comparePlanReadiness } from "./plan-readiness.js";
 
 const PLAN_LIST_NAME = "plans";
 const MARKDOWN_EXTENSION = ".md";
@@ -171,7 +172,7 @@ export async function discoverPlans(options: DiscoverPlansOptions): Promise<Plan
       ...plan,
       displayPath: displayPlanPath(plan.absolutePath, options.cwd, options.homeDir)
     }))
-    .sort((left, right) => Number(right.readiness === "ready") - Number(left.readiness === "ready"));
+    .sort(comparePlanReadiness);
 }
 
 export const archivePlan = async (options: ArchivePlanOptions): Promise<void> => {

packages/agent-harness-tools/src/plans.ts

@@ -1,5 +1,5 @@
 import * as fsPromises from "node:fs/promises";
-import { discoverPlans } from "@poe-code/agent-harness-tools";
+import { discoverPlans, formatPlanReadinessLabel } from "@poe-code/agent-harness-tools";
 
 type DiscoveryFileStat = {
   isFile(): boolean;
@@ -37,6 +37,6 @@ export const discoverExperimentDocs = async (
 
   return plans.map((plan) => ({
     path: plan.displayPath,
-    displayPath: `${plan.displayPath}${plan.readiness === "ready" ? " ✓" : ""}`
+    displayPath: formatPlanReadinessLabel(plan.displayPath, plan.readiness)
   }));
 };

packages/experiment-loop/src/discovery/discovery.ts

@@ -1,6 +1,10 @@
 import path from "node:path";
 import * as fsPromises from "node:fs/promises";
-import { discoverPlans } from "@poe-code/agent-harness-tools";
+import {
+  comparePlanReadiness,
+  discoverPlans,
+  formatPlanReadinessLabel
+} from "@poe-code/agent-harness-tools";
 import { UserError } from "@poe-code/user-error";
 import { parsePlan } from "./parser.js";
 import type { PipelineFileStat, PipelineFileSystem } from "../types.js";
@@ -92,7 +96,13 @@ async function listPlanCandidates(
       return countCompletedTasks(plan.displayPath, content, plan.readiness === "ready");
     })
   );
-  candidates.sort((left, right) => Number(right.ready) - Number(left.ready) || left.path.localeCompare(right.path));
+  candidates.sort(
+    (left, right) =>
+      comparePlanReadiness(
+        { readiness: left.ready ? "ready" : "draft" },
+        { readiness: right.ready ? "ready" : "draft" }
+      ) || left.path.localeCompare(right.path)
+  );
   return candidates;
 }
 
@@ -209,7 +219,10 @@ export async function resolvePlanPaths(options: {
       return options.selectPlans({
         message: "Select pipeline plans to run",
         options: candidates.map((candidate) => ({
-          label: `${candidate.path}${candidate.ready ? " ✓" : ""} (${candidate.done}/${candidate.total})`,
+          label: `${formatPlanReadinessLabel(
+            candidate.path,
+            candidate.ready ? "ready" : "draft"
+          )} (${candidate.done}/${candidate.total})`,
           value: candidate.path
         })),
         required: true
@@ -221,7 +234,10 @@ export async function resolvePlanPaths(options: {
     const selectedPlan = await options.selectPlan({
       message: "Select a pipeline plan to run",
       options: candidates.map((candidate) => ({
-        label: `${candidate.path}${candidate.ready ? " ✓" : ""} (${candidate.done}/${candidate.total})`,
+        label: `${formatPlanReadinessLabel(
+          candidate.path,
+          candidate.ready ? "ready" : "draft"
+        )} (${candidate.done}/${candidate.total})`,
         value: candidate.path
       }))
     });

packages/pipeline/src/plan/discovery.ts

@@ -18,6 +18,7 @@
     "dist"
   ],
   "dependencies": {
+    "@poe-code/agent-harness-tools": "*",
     "toolcraft-design": "*",
     "@poe-code/experiment-loop": "*",
     "@poe-code/pipeline": "*",

packages/plan-browser/package.json

@@ -1,6 +1,7 @@
 import path from "node:path";
 import * as fsPromises from "node:fs/promises";
 import { parsePlan } from "@poe-code/pipeline";
+import { comparePlanReadiness } from "@poe-code/agent-harness-tools";
 import {
   planConfigScope,
   readMergedDocumentReadonly,
@@ -315,7 +316,7 @@ export async function discoverAllPlans(options: {
     if (leftSaved !== rightSaved) {
       return leftSaved - rightSaved;
     }
-    const readinessOrder = Number(right.readiness === "ready") - Number(left.readiness === "ready");
+    const readinessOrder = comparePlanReadiness(left, right);
     if (readinessOrder !== 0) return readinessOrder;
     if (right.updatedAt !== left.updatedAt) {
       return right.updatedAt - left.updatedAt;

packages/plan-browser/src/discovery.ts

@@ -1,4 +1,5 @@
 import path from "node:path";
+import { formatPlanReadinessLabel } from "@poe-code/agent-harness-tools";
 import type { Action, ExplorerConfig, Row } from "toolcraft-design";
 import { normalizeExplorerConfig } from "toolcraft-design";
 import {
@@ -221,7 +222,7 @@ function toRows(plans: PlanEntry[]): Row[] {
   const rowIds = createRowIds(plans);
   return plans.map((entry, index) => ({
     id: rowIds[index]!,
-    title: `${path.basename(entry.path)}${entry.readiness === "ready" ? " ✓" : ""}`,
+    title: formatPlanReadinessLabel(path.basename(entry.path), entry.readiness),
     subtitle: formatSubtitle(entry),
     badge: { text: entry.typeLabel },
     group: isSavedForLaterEntry(entry) ? "Saved for later" : "Active"