@zhushanwen/pi-plan 0.2.3 → 0.3.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zhushanwen/pi-plan",
-  "version": "0.2.3",
+  "version": "0.3.1",
   "description": "Lightweight plan mode for Pi coding agent",
   "type": "module",
   "main": "index.ts",
@@ -16,8 +16,9 @@
   "license": "MIT",
   "peerDependencies": {
     "@earendil-works/pi-coding-agent": ">=0.73.0",
-    "@sinclair/typebox": "*",
-    "@earendil-works/pi-ai": "*"
+    "typebox": "*",
+    "@earendil-works/pi-ai": "*",
+    "@zhushanwen/pi-goal": "0.7.0"
   },
   "peerDependenciesMeta": {
     "@earendil-works/pi-ai": {

package/src/__tests__/compact-handler.test.ts

@@ -78,6 +78,8 @@ describe("handlePlanComplete", () => {
       expect.any(String),
       undefined,
       ctx,
+      "plan",
+      "All 2 steps of plan.md executed and verified: Step one; Step two",
     );
   });
 
@@ -108,6 +110,8 @@ describe("handlePlanComplete", () => {
       expect.any(String),
       undefined,
       ctx,
+      "plan",
+      "All 2 steps of plan.md executed and verified: Step one; Step two",
     );
   });
 });

package/src/command.ts

@@ -18,6 +18,17 @@ export function registerPlanCommand(
       "Enter plan mode: /plan [description]. " +
       "Subcommands: /plan abort, /plan status. " +
       "With no args, show status or detect existing plan.",
+    getArgumentCompletions(prefix: string) {
+      const parts = prefix.trimStart().split(/\s+/).filter(Boolean);
+      // More than 1 token means the user is typing a free-text requirement, no completion.
+      if (parts.length > 1) return null;
+      const trimmed = (parts[0] ?? "").toLowerCase();
+      const opts = [
+        { label: "abort", value: "abort", description: "取消活跃的 plan mode" },
+        { label: "status", value: "status", description: "查看 plan mode 状态" },
+      ];
+      return trimmed === "" ? opts : opts.filter((o) => o.label.startsWith(trimmed));
+    },
     handler: async (args: string, ctx: ExtensionContext) => {
       const trimmed = args.trim();
       const sessionId = ctx.sessionManager.getSessionId();

package/src/compact.ts

@@ -1,6 +1,8 @@
 import * as fs from "node:fs";
+import { basename } from "node:path";
 
 import type { ExtensionAPI, ExtensionContext, SessionBeforeCompactEvent, SessionBeforeTreeEvent } from "@earendil-works/pi-coding-agent";
+import type { GoalInitFn } from "@zhushanwen/pi-goal";
 
 import type { PlanSessionMap, PlanState } from "./state.js";
 import { getPlanState } from "./state.js";
@@ -67,26 +69,45 @@ function readPlanFileSafe(planFilePath: string): string {
 /** Detect whether goal extension is available via its programming interface */
 export function detectGoalCapability(pi: ExtensionAPI): boolean {
   try {
-    const api = pi as unknown as Record<string, unknown>;
+    // 交叉类型单步断言（ExtensionAPI 可赋给 ExtensionAPI & { __goalInit? }）
+    const api = pi as ExtensionAPI & { __goalInit?: GoalInitFn };
     return typeof api.__goalInit === "function";
   } catch {
     return false;
   }
 }
 
+/**
+ * 从 plan 文件路径推导 goal slug（kebab-case；无有效字符时 fallback）。
+ * 仅 widget 标题 + history 展示用，不注入 prompt。
+ */
+function buildPlanSlug(planFilePath: string): string {
+  const stem = basename(planFilePath)
+    .replace(/\.md$/i, "")
+    .toLowerCase()
+    .replace(/[^a-z0-9]+/g, "-")
+    .replace(/^-+|-+$/g, "");
+  return stem || "plan-execution";
+}
+
+/** successCriteria 步骤预览条数上限 */
+const STEP_PREVIEW_LIMIT = 3;
+
+/**
+ * 从 plan 步骤构造可检查的 successCriteria（plan 完成 = 所有步骤执行并验证）。
+ * goal 的 complete 判定会对照本字段做证据审计。
+ */
+function buildPlanSuccessCriteria(planFilePath: string, tasks: string[]): string {
+  const preview = tasks.slice(0, STEP_PREVIEW_LIMIT).join("; ");
+  const ellipsis = tasks.length > STEP_PREVIEW_LIMIT ? "; …" : "";
+  return `All ${tasks.length} steps of ${basename(planFilePath)} executed and verified: ${preview}${ellipsis}`;
+}
+
 /** Try to initialize goal via programming interface */
 function tryGoalInit(pi: ExtensionAPI, planFilePath: string, ctx: ExtensionContext): boolean {
-  // Inline alias mirrors @zhushanwen/pi-goal's GoalInitFn (exported from goal/src/index.ts).
-  // Kept inline due to optional duck-typed coupling (pi.__goalInit) — update both if signature changes.
-  type GoalInitFn = (
-    objective: string,
-    budget: { tokenBudget?: number; timeBudgetMinutes?: number } | undefined,
-    ctx: ExtensionContext,
-  ) => boolean;
-
   try {
-    const api = pi as unknown as Record<string, unknown>;
-    const goalInit = api.__goalInit as GoalInitFn | undefined;
+    const api = pi as ExtensionAPI & { __goalInit?: GoalInitFn };
+    const goalInit = api.__goalInit;
     if (typeof goalInit !== "function") return false;
 
     const planContent = readPlanFileSafe(planFilePath);
@@ -96,7 +117,13 @@ function tryGoalInit(pi: ExtensionAPI, planFilePath: string, ctx: ExtensionConte
     const tasks = extractPlanSteps(planContent);
     if (tasks.length === 0) return false;
 
-    return goalInit(objective, undefined, ctx);
+    return goalInit(
+      objective,
+      undefined,
+      ctx,
+      buildPlanSlug(planFilePath),
+      buildPlanSuccessCriteria(planFilePath, tasks),
+    );
   } catch {
     return false;
   }

package/src/index.ts

@@ -14,7 +14,8 @@ export default function planExtension(pi: ExtensionAPI) {
   registerPlanCommand(pi, sessions);
 
   // External API: __planStart（allow other extensions to start plan mode programmatically, #9）
-  const api = pi as unknown as Record<string, unknown>;
+  // 交叉类型单步断言（ExtensionAPI 可赋给 ExtensionAPI & { __planStart? }，无需 unknown 中转）
+  const api = pi as ExtensionAPI & { __planStart?: (requirement: string, ctx: ExtensionContext) => boolean };
   api.__planStart = (requirement: string, ctx: ExtensionContext): boolean => {
     return startPlanMode(pi, sessions, ctx, requirement);
   };

package/src/state.ts

@@ -67,8 +67,13 @@ export function resetPlanState(
 }
 
 function isPlanStateEntry(entry: SessionEntry): entry is CustomEntry<Partial<PlanState>> & { customType: "plan-state" } {
-  const e = entry as unknown as Record<string, unknown>;
-  return e.type === "custom" && e.customType === "plan-state" && typeof e.data === "object" && e.data !== null;
+  // 判别式收窄（type === "custom"）后可直接访问 customType/data，无需 cast
+  return (
+    entry.type === "custom" &&
+    entry.customType === "plan-state" &&
+    typeof entry.data === "object" &&
+    entry.data !== null
+  );
 }
 
 export function reconstructPlanState(ctx: ExtensionContext): PlanState {
@@ -76,15 +81,16 @@ export function reconstructPlanState(ctx: ExtensionContext): PlanState {
   const entries = ctx.sessionManager.getEntries();
 
   for (let i = entries.length - 1; i >= 0; i--) {
-    if (isPlanStateEntry(entries[i])) {
-      const data = (entries[i] as unknown as { data: Partial<PlanState> }).data;
-      state.isActive = data.isActive ?? false;
-      state.phase = data.phase ?? "idle";
-      state.planFilePath = data.planFilePath ?? "";
-      state.requirement = data.requirement ?? "";
-      state.templateName = data.templateName ?? "";
-      break;
-    }
+    // entries[i] 是复杂表达式（TS 不收窄），守卫移到 const 变量上
+    const entry = entries[i];
+    if (!isPlanStateEntry(entry)) continue;
+    const data = entry.data;
+    state.isActive = data?.isActive ?? false;
+    state.phase = data?.phase ?? "idle";
+    state.planFilePath = data?.planFilePath ?? "";
+    state.requirement = data?.requirement ?? "";
+    state.templateName = data?.templateName ?? "";
+    break;
   }
 
   return state;