pi-formatter 1.0.0 → 1.0.2

package/README.md

@@ -3,11 +3,11 @@
 A [pi](https://pi.dev) extension that auto-formats files after `write` and
 `edit` tool calls.
 
-By default, formatting runs once per turn. You can also format after each tool
-call or defer formatting until the current session shuts down.
+By default, formatting runs once per prompt — after the agent finishes all its
+work and yields control back to you. You can also format after each individual
+tool call or defer formatting until the session shuts down.
 
-This default changed from the previous immediate-per-tool behavior. If you want
-the old default, set `"formatMode": "tool"`.
+To format after every individual edit instead, set `"formatMode": "tool"`.
 
 ## 📦 Install
 
@@ -22,19 +22,17 @@ best-effort post-processing. Formatter failures never block tool results.
 
 Formatting modes:
 
-- `tool`: format immediately after each successful `write` or `edit` tool
-  result.
-  Use this mode when you want the file on disk to stay formatted after every
-  edit, even while the agent is still working.
-- `turn`: collect files touched during the current turn and format them once at
-  `turn_end`. This is the default.
-  Use this mode when you want to avoid mid-turn formatter drift while still
-  keeping files formatted throughout the run.
+- `tool`: format immediately after each successful `write` or `edit` tool call.
+  Use this mode when you want files on disk to stay formatted after every edit,
+  even while the agent is still working.
+- `prompt`: collect all files touched during the agent run and format them once
+  when the agent finishes and yields control back to you. This is the default.
+  Use this mode to avoid mid-run formatter interruptions while still getting
+  clean files after each response.
 - `session`: collect files touched during the current session and format them
-  once at `session_shutdown`.
-  Use this mode when you want the fewest formatter interruptions and are okay
-  with formatting only when the session exits, reloads, or switches. Interrupted
-  runs stay pending until the session ends or changes.
+  once at session shutdown, reload, or switch.
+  Use this mode when you want the fewest interruptions and are okay with
+  formatting only when the session ends.
 
 Supported file types:
 
@@ -61,14 +59,14 @@ folder (default: `~/.pi/agent`, overridable via `PI_CODING_AGENT_DIR`):
 
 ```json
 {
-  "formatMode": "turn",
+  "formatMode": "prompt",
   "commandTimeoutMs": 10000,
   "hideCallSummariesInTui": false
 }
 ```
 
-- `formatMode`: formatting strategy (`"tool"` | `"turn"` | `"session"`,
-  default: `"turn"`). Use `"tool"` to restore the old immediate default.
+- `formatMode`: formatting strategy (`"tool"` | `"prompt"` | `"session"`,
+  default: `"prompt"`). Use `"tool"` to format after every individual edit.
 - `commandTimeoutMs`: timeout (ms) per formatter command (default: `10000`)
 - `hideCallSummariesInTui`: hide formatter pass/fail summaries in the TUI
   (default: `false`)

package/extensions/formatter/config.ts

@@ -2,11 +2,11 @@ import { existsSync, mkdirSync, readFileSync, writeFileSync } from "node:fs";
 import { join } from "node:path";
 import { getAgentDir } from "@mariozechner/pi-coding-agent";
 
-export type FormatMode = "tool" | "turn" | "session";
+export type FormatMode = "tool" | "prompt" | "session";
 
 const DEFAULT_COMMAND_TIMEOUT_MS = 10_000;
 const DEFAULT_HIDE_CALL_SUMMARIES_IN_TUI = false;
-const DEFAULT_FORMAT_MODE: FormatMode = "turn";
+export const DEFAULT_FORMAT_MODE: FormatMode = "prompt";
 const FORMATTER_CONFIG_FILE = "formatter.json";
 
 export type FormatterConfigSnapshot = {
@@ -65,7 +65,7 @@ function parseBooleanValue(value: unknown, defaultValue: boolean): boolean {
 }
 
 function parseFormatMode(value: unknown, defaultValue: FormatMode): FormatMode {
-  if (value === "tool" || value === "turn" || value === "session") {
+  if (value === "tool" || value === "prompt" || value === "session") {
     return value;
   }
 

package/extensions/index.ts

@@ -79,9 +79,9 @@ function getFormatterSettingItems(
       id: "formatMode",
       label: "Format mode",
       description:
-        "Choose whether formatting runs after each successful write/edit tool call, once after each turn, or once when the session shuts down.",
+        "Choose whether formatting runs after each successful write/edit tool call, once after each prompt completes, or once when the session shuts down.",
       currentValue: config.formatMode,
-      values: ["tool", "turn", "session"],
+      values: ["tool", "prompt", "session"],
     },
     {
       id: "commandTimeoutMs",
@@ -112,7 +112,7 @@ type FormatterContext = {
 export default function (pi: ExtensionAPI) {
   let formatterConfig = loadFormatterConfig();
   const formatQueueByPath = new Map<string, Promise<void>>();
-  const pendingTurnPaths = new Set<string>();
+  const pendingPromptPaths = new Set<string>();
   const pendingSessionPaths = new Set<string>();
 
   const enqueueFormat = async (
@@ -135,12 +135,27 @@ export default function (pi: ExtensionAPI) {
     await next;
   };
 
+  const emitSummaryMessages = (
+    messages: string[],
+    ctx: FormatterContext,
+  ): void => {
+    if (
+      !ctx.hasUI ||
+      formatterConfig.hideCallSummariesInTui ||
+      messages.length === 0
+    ) {
+      return;
+    }
+
+    ctx.ui.notify(messages.join("\n"), "info");
+  };
+
   const formatResolvedPath = async (
     filePath: string,
     ctx: FormatterContext,
-  ): Promise<void> => {
+  ): Promise<string[]> => {
     if (!(await pathExists(filePath))) {
-      return;
+      return [];
     }
 
     const showSummaries = !formatterConfig.hideCallSummariesInTui && ctx.hasUI;
@@ -155,6 +170,8 @@ export default function (pi: ExtensionAPI) {
       console.warn(normalizedMessage);
     };
 
+    let summaryMessages: string[] = [];
+
     await enqueueFormat(filePath, async () => {
       const summaries: FormatCallSummary[] = [];
       const summaryReporter = showSummaries
@@ -188,28 +205,37 @@ export default function (pi: ExtensionAPI) {
       }
 
       const fileLabel = getRelativePathOrAbsolute(filePath, ctx.cwd);
-
-      for (const summary of summaries) {
-        ctx.ui.notify(formatCallSummary(summary, fileLabel), "info");
-      }
+      summaryMessages = summaries.map((summary) =>
+        formatCallSummary(summary, fileLabel),
+      );
     });
+
+    return summaryMessages;
   };
 
   const flushPaths = async (
     paths: Set<string>,
     ctx: FormatterContext,
-  ): Promise<void> => {
+  ): Promise<string[]> => {
     const batch = [...paths];
     paths.clear();
 
+    const summaryMessages: string[] = [];
+
     for (const filePath of batch) {
-      await formatResolvedPath(filePath, ctx);
+      summaryMessages.push(...(await formatResolvedPath(filePath, ctx)));
     }
+
+    return summaryMessages;
   };
 
   const flushPendingPaths = async (ctx: FormatterContext): Promise<void> => {
-    await flushPaths(pendingTurnPaths, ctx);
-    await flushPaths(pendingSessionPaths, ctx);
+    const summaryMessages = [
+      ...(await flushPaths(pendingPromptPaths, ctx)),
+      ...(await flushPaths(pendingSessionPaths, ctx)),
+    ];
+
+    emitSummaryMessages(summaryMessages, ctx);
   };
 
   const reloadFormatterConfig = () => {
@@ -231,36 +257,28 @@ export default function (pi: ExtensionAPI) {
     }
 
     if (formatterConfig.formatMode === "tool") {
-      await formatResolvedPath(filePath, ctx);
+      emitSummaryMessages(await formatResolvedPath(filePath, ctx), ctx);
       return;
     }
 
-    if (formatterConfig.formatMode === "turn") {
-      pendingTurnPaths.add(filePath);
+    if (formatterConfig.formatMode === "prompt") {
+      pendingPromptPaths.add(filePath);
       return;
     }
 
     pendingSessionPaths.add(filePath);
   });
 
-  pi.on("turn_end", async (_event, ctx) => {
-    if (pendingTurnPaths.size === 0) {
-      return;
-    }
-
-    await flushPaths(pendingTurnPaths, ctx);
-  });
-
   pi.on("agent_end", async (_event, ctx) => {
-    if (pendingTurnPaths.size === 0) {
+    if (pendingPromptPaths.size === 0) {
       return;
     }
 
-    await flushPaths(pendingTurnPaths, ctx);
+    emitSummaryMessages(await flushPaths(pendingPromptPaths, ctx), ctx);
   });
 
   pi.on("session_switch", async (_event, ctx) => {
-    if (pendingTurnPaths.size === 0 && pendingSessionPaths.size === 0) {
+    if (pendingPromptPaths.size === 0 && pendingSessionPaths.size === 0) {
       return;
     }
 
@@ -268,7 +286,7 @@ export default function (pi: ExtensionAPI) {
   });
 
   pi.on("session_shutdown", async (_event, ctx) => {
-    if (pendingTurnPaths.size === 0 && pendingSessionPaths.size === 0) {
+    if (pendingPromptPaths.size === 0 && pendingSessionPaths.size === 0) {
       return;
     }
 

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "pi-formatter",
-  "version": "1.0.0",
-  "description": "Pi extension that auto-formats files after write/edit tool calls.",
+  "version": "1.0.2",
+  "description": "Pi extension that auto-formats files.",
   "type": "module",
   "files": [
     "extensions",