pi-formatter 0.1.0

package/extensions/format/types.ts

@@ -0,0 +1,112 @@
+import type { ExecResult } from "@mariozechner/pi-coding-agent";
+
+export type SourceTool = "write" | "edit";
+
+export type FileKind =
+  | "cxx"
+  | "cmake"
+  | "markdown"
+  | "json"
+  | "shell"
+  | "python"
+  | "jsts";
+
+export type RunnerMode = "all" | "fallback";
+export type RequiredMajorVersion = "invalid" | string | undefined;
+
+export interface DirectLauncher {
+  type: "direct";
+  command: string;
+}
+
+export interface PypiLauncher {
+  type: "pypi";
+  tool: string;
+}
+
+export interface GoLauncher {
+  type: "go";
+  tool: string;
+  module: string;
+}
+
+export type RunnerLauncher = DirectLauncher | PypiLauncher | GoLauncher;
+
+export interface ResolvedLauncher {
+  command: string;
+  argsPrefix: string[];
+}
+
+export interface RunnerContext {
+  readonly filePath: string;
+  readonly cwd: string;
+  readonly sourceTool: SourceTool;
+  readonly kind: FileKind;
+
+  hasCommand(command: string): Promise<boolean>;
+  hasConfig(patterns: readonly string[]): Promise<boolean>;
+  findConfigFile(patterns: readonly string[]): Promise<string | undefined>;
+  hasEditorConfigInCwd(): Promise<boolean>;
+
+  exec(command: string, args: string[]): Promise<ExecResult | undefined>;
+  getChangedLines(): Promise<string[]>;
+  getRequiredMajorVersionFromConfig(
+    patterns: readonly string[],
+  ): Promise<RequiredMajorVersion>;
+  getInstalledToolMajorVersion(command: string): Promise<string | undefined>;
+
+  warn(message: string): void;
+}
+
+export type RunnerPredicate =
+  | ((ctx: RunnerContext) => Promise<boolean> | boolean)
+  | undefined;
+
+export interface MajorVersionFromConfigRequirement {
+  patterns: readonly string[];
+  /**
+   * Optional command used for <cmd> --version lookup.
+   * Defaults to the command/tool declared in launcher.
+   */
+  command?: string;
+  onInvalid?: "warn-skip" | "skip";
+  onMismatch?: "warn-skip" | "skip";
+}
+
+export interface RunnerRequirements {
+  majorVersionFromConfig?: MajorVersionFromConfigRequirement;
+}
+
+interface RunnerBase {
+  id: string;
+  launcher: RunnerLauncher;
+  when?: RunnerPredicate;
+  requires?: RunnerRequirements;
+}
+
+export interface StaticRunnerDefinition extends RunnerBase {
+  args: string[];
+  /**
+   * Whether to append the target file path as the final argument.
+   * Defaults to true.
+   */
+  appendFile?: boolean;
+}
+
+export interface DynamicRunnerDefinition extends RunnerBase {
+  buildArgs:
+    (ctx: RunnerContext) => Promise<string[] | undefined> | string[] | undefined;
+}
+
+export type RunnerDefinition = StaticRunnerDefinition | DynamicRunnerDefinition;
+
+export interface RunnerGroup {
+  mode: RunnerMode;
+  runnerIds: string[];
+}
+
+export function isDynamicRunner(
+  runner: RunnerDefinition,
+): runner is DynamicRunnerDefinition {
+  return "buildArgs" in runner;
+}

package/extensions/index.ts

@@ -0,0 +1,65 @@
+import type { ExtensionAPI } from "@mariozechner/pi-coding-agent";
+import { commandTimeoutMs } from "./format/config.js";
+import { formatFile } from "./format/dispatch.js";
+import { pathExists, resolveToolPath } from "./format/path.js";
+import type { SourceTool } from "./format/types.js";
+
+function formatError(error: unknown): string {
+  return error instanceof Error ? error.message : String(error);
+}
+
+export default function (pi: ExtensionAPI) {
+  const formatQueueByPath = new Map<string, Promise<void>>();
+
+  const enqueueFormat = async (
+    filePath: string,
+    run: () => Promise<void>,
+  ): Promise<void> => {
+    const previous = formatQueueByPath.get(filePath) ?? Promise.resolve();
+    const next = previous
+      .catch(() => {
+        // Keep the queue alive after a failure.
+      })
+      .then(run)
+      .finally(() => {
+        if (formatQueueByPath.get(filePath) === next) {
+          formatQueueByPath.delete(filePath);
+        }
+      });
+
+    formatQueueByPath.set(filePath, next);
+    await next;
+  };
+
+  pi.on("tool_result", async (event, ctx) => {
+    if (event.isError) {
+      return;
+    }
+
+    if (event.toolName !== "write" && event.toolName !== "edit") {
+      return;
+    }
+
+    const rawPath = (event.input as { path?: unknown }).path;
+    if (typeof rawPath !== "string" || rawPath.length === 0) {
+      return;
+    }
+
+    const sourceTool = event.toolName as SourceTool;
+    const filePath = resolveToolPath(rawPath, ctx.cwd);
+
+    if (!(await pathExists(filePath))) {
+      return;
+    }
+
+    await enqueueFormat(filePath, async () => {
+      try {
+        await formatFile(pi, ctx.cwd, sourceTool, filePath, commandTimeoutMs);
+      } catch (error) {
+        console.warn(
+          `[pi-formatter] Failed to format ${filePath}: ${formatError(error)}`,
+        );
+      }
+    });
+  });
+}

package/package.json

@@ -0,0 +1,40 @@
+{
+  "name": "pi-formatter",
+  "version": "0.1.0",
+  "description": "Pi extension that auto-formats files after write/edit tool calls.",
+  "type": "module",
+  "files": [
+    "extensions",
+    "DOCUMENTATION.md",
+    "README.md",
+    "LICENSE"
+  ],
+  "keywords": [
+    "pi-package",
+    "pi-extension",
+    "coding-agent",
+    "formatter",
+    "formatting"
+  ],
+  "author": "Tenzir",
+  "license": "Apache-2.0",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/tenzir/pi-formatter.git"
+  },
+  "homepage": "https://github.com/tenzir/pi-formatter#readme",
+  "bugs": {
+    "url": "https://github.com/tenzir/pi-formatter/issues"
+  },
+  "engines": {
+    "node": ">=20.0.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "pi": {
+    "extensions": [
+      "./extensions/index.ts"
+    ]
+  }
+}