pi-formatter 0.1.0

package/DOCUMENTATION.md

@@ -0,0 +1,120 @@
+# Runner API
+
+A *runner* wraps a single formatting tool (for example, `prettier` or `ruff`).
+This document describes how runners work and how to add new ones.
+
+## File layout
+
+| File | Purpose |
+| ---- | ------- |
+| `extensions/format/runners/*.ts` | One file per runner |
+| `extensions/format/runners/helpers.ts` | Helper constructors (`direct`, `pypi`, `goTool`, `defineRunner`) |
+| `extensions/format/runners/index.ts` | Runner registry |
+| `extensions/format/plan.ts` | File-kind → runner-group mapping |
+| `extensions/format/types.ts` | Shared types |
+
+## Add a new runner
+
+1. Create a file under `extensions/format/runners/`.
+2. Define the runner with the helper constructors from `helpers.ts`.
+3. Register it in `extensions/format/runners/index.ts`.
+4. Add its `id` to one or more groups in `extensions/format/plan.ts`.
+
+## Runner definition
+
+Every runner needs two things:
+
+- `id`: a unique identifier
+- `launcher`: how to locate and execute the tool
+
+### Launchers
+
+Use the helper constructors to create a launcher:
+
+| Constructor | Behavior |
+| ----------- | -------- |
+| `direct("prettier")` | Run the command directly |
+| `pypi("ruff")` | Run the tool natively, fall back to `uv tool run` |
+| `goTool("shfmt", "mvdan.cc/sh/v3/cmd/shfmt@v3.10.0")` | Run the tool natively, fall back to `go run` |
+
+All commands execute in the project working directory and respect the
+configured timeout.
+
+### Arguments
+
+There are two ways to supply arguments:
+
+- **Static** (preferred): Set `args: string[]`. The file path is appended
+  automatically unless you set `appendFile: false`.
+- **Dynamic**: Implement `buildArgs(ctx)` and return the argument array, or
+  `undefined` to skip the runner.
+
+### Optional predicates and requirements
+
+- `when(ctx)`: Return `false` to skip the runner based on an extra condition.
+- `requires.majorVersionFromConfig`: Gate execution on a major version match:
+  - `patterns`: Config-file globs to read the required major version from.
+  - `command` (optional): Command to inspect with `--version`.
+  - `onInvalid` / `onMismatch`: `"warn-skip"` (default) or `"skip"`.
+
+### Runner context
+
+The `ctx` object passed to `when` and `buildArgs` exposes:
+
+| Member | Description |
+| ------ | ----------- |
+| `filePath`, `cwd`, `sourceTool`, `kind` | Current invocation metadata |
+| `hasCommand(cmd)` | Check whether a command is available |
+| `hasConfig(patterns)`, `findConfigFile(patterns)` | Look up configuration files |
+| `hasEditorConfigInCwd()` | Check for an `.editorconfig` in the working directory |
+| `getChangedLines()` | Get the line ranges that changed |
+| `warn(msg)` | Emit a warning without failing the run |
+
+## Format plan
+
+`extensions/format/plan.ts` maps each file kind to an ordered list of runner
+groups. Each group has a mode:
+
+- **`"all"`**: Run every qualifying runner in order.
+- **`"fallback"`**: Run the first qualifying runner and stop.
+
+## Examples
+
+### Static runner
+
+```ts
+import { defineRunner, direct } from "./helpers.js";
+
+const myRunner = defineRunner({
+  id: "my-formatter",
+  launcher: direct("my-formatter"),
+  args: ["--write"],
+});
+
+export default myRunner;
+```
+
+### Dynamic runner with a version requirement
+
+```ts
+import { defineRunner, direct } from "./helpers.js";
+
+const clangFormatRunner = defineRunner({
+  id: "clang-format",
+  launcher: direct("clang-format"),
+  requires: {
+    majorVersionFromConfig: {
+      patterns: [".clang-format-version"],
+    },
+  },
+  async buildArgs(ctx) {
+    const lines = await ctx.getChangedLines();
+    if (lines.length > 0) {
+      return [...lines.map((line) => `--lines=${line}`), "-i", ctx.filePath];
+    }
+    return ["-i", ctx.filePath];
+  },
+});
+
+export default clangFormatRunner;
+```

package/LICENSE

@@ -0,0 +1,191 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to the Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by the Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding any notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2025 Tenzir GmbH
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,41 @@
+# 🎨 pi-formatter
+
+A [pi](https://github.com/badlogic/pi-mono/tree/main/packages/coding-agent)
+extension that auto-formats files after every `write` and `edit` tool call.
+
+The extension hooks into successful tool results, detects the file type, and
+runs the appropriate formatter. Failures never block the tool result, so
+formatting is always best-effort.
+
+## 📦 Install
+
+```bash
+pi install npm:pi-formatter
+```
+
+## ⚙️ What it does
+
+`pi-formatter` listens to successful `write` and `edit` tool calls and applies
+best-effort formatting. Formatter failures never block tool results.
+
+Supported file types:
+
+- C/C++
+- CMake
+- Markdown
+- JSON
+- Shell
+- Python
+- JavaScript/TypeScript
+
+## 🔧 Configuration
+
+- `PI_FORMAT_COMMAND_TIMEOUT_MS`: timeout (ms) per formatter command (default: `10000`)
+
+## 🧩 Contributor docs
+
+See the [runner API contract](DOCUMENTATION.md) for how to add new formatters.
+
+## 📄 License
+
+[Apache-2.0](LICENSE)

package/extensions/format/config.ts

@@ -0,0 +1,11 @@
+const DEFAULT_COMMAND_TIMEOUT_MS = 10_000;
+
+const configuredTimeoutMs = Number.parseInt(
+  process.env.PI_FORMAT_COMMAND_TIMEOUT_MS ?? "",
+  10,
+);
+
+export const commandTimeoutMs =
+  Number.isFinite(configuredTimeoutMs) && configuredTimeoutMs > 0
+    ? configuredTimeoutMs
+    : DEFAULT_COMMAND_TIMEOUT_MS;

package/extensions/format/context.ts

@@ -0,0 +1,277 @@
+import { readdir, readFile } from "node:fs/promises";
+import { dirname, join, resolve } from "node:path";
+import type { ExtensionAPI } from "@mariozechner/pi-coding-agent";
+import { getPathForGit, isWithinDirectory, pathExists } from "./path.js";
+import { hasCommand } from "./system.js";
+import type { FileKind, RequiredMajorVersion, RunnerContext, SourceTool } from "./types.js";
+
+const globRegexCache = new Map<string, RegExp>();
+
+function getPatternRegex(pattern: string): RegExp {
+  const cached = globRegexCache.get(pattern);
+  if (cached) {
+    return cached;
+  }
+
+  const escaped = pattern
+    .split("*")
+    .map((part) => part.replace(/[-/\\^$+?.()|[\]{}]/g, "\\$&"))
+    .join(".*");
+
+  const regex = new RegExp(`^${escaped}$`);
+  globRegexCache.set(pattern, regex);
+  return regex;
+}
+
+async function findConfigFileFromPath(
+  filePath: string,
+  patterns: readonly string[],
+  rootDirectory: string,
+): Promise<string | undefined> {
+  const root = resolve(rootDirectory);
+  let dir = resolve(dirname(filePath));
+
+  if (!isWithinDirectory(dir, root)) {
+    return undefined;
+  }
+
+  while (isWithinDirectory(dir, root)) {
+    let entries: string[];
+    try {
+      entries = await readdir(dir);
+    } catch {
+      entries = [];
+    }
+
+    for (const pattern of patterns) {
+      const regex = getPatternRegex(pattern);
+      const matchingEntry = entries.find((entry) => regex.test(entry));
+      if (matchingEntry) {
+        return join(dir, matchingEntry);
+      }
+    }
+
+    if (dir === root) {
+      break;
+    }
+
+    const parent = dirname(dir);
+    if (parent === dir) {
+      break;
+    }
+
+    dir = parent;
+  }
+
+  return undefined;
+}
+
+export class FormatRunContext implements RunnerContext {
+  readonly filePath: string;
+  readonly cwd: string;
+  readonly sourceTool: SourceTool;
+  readonly kind: FileKind;
+
+  private readonly pi: ExtensionAPI;
+  private readonly timeoutMs: number;
+
+  private readonly configLookupCache = new Map<
+    string,
+    Promise<string | undefined>
+  >();
+  private readonly requiredMajorVersionCache = new Map<
+    string,
+    Promise<RequiredMajorVersion>
+  >();
+  private readonly installedMajorVersionCache = new Map<
+    string,
+    Promise<string | undefined>
+  >();
+
+  private changedLinesPromise?: Promise<string[]>;
+  private editorConfigInCwdPromise?: Promise<boolean>;
+
+  constructor(
+    pi: ExtensionAPI,
+    cwd: string,
+    filePath: string,
+    sourceTool: SourceTool,
+    kind: FileKind,
+    timeoutMs: number,
+  ) {
+    this.pi = pi;
+    this.cwd = cwd;
+    this.filePath = filePath;
+    this.sourceTool = sourceTool;
+    this.kind = kind;
+    this.timeoutMs = timeoutMs;
+  }
+
+  async hasCommand(command: string): Promise<boolean> {
+    return hasCommand(command);
+  }
+
+  async findConfigFile(patterns: readonly string[]): Promise<string | undefined> {
+    const key = patterns.join("\u0000");
+    let cached = this.configLookupCache.get(key);
+
+    if (!cached) {
+      cached = findConfigFileFromPath(this.filePath, patterns, this.cwd);
+      this.configLookupCache.set(key, cached);
+    }
+
+    return cached;
+  }
+
+  async hasConfig(patterns: readonly string[]): Promise<boolean> {
+    return (await this.findConfigFile(patterns)) !== undefined;
+  }
+
+  async hasEditorConfigInCwd(): Promise<boolean> {
+    if (!this.editorConfigInCwdPromise) {
+      this.editorConfigInCwdPromise = this.resolveEditorConfigInCwd();
+    }
+
+    return this.editorConfigInCwdPromise;
+  }
+
+  async exec(command: string, args: string[]) {
+    try {
+      return await this.pi.exec(command, args, {
+        cwd: this.cwd,
+        timeout: this.timeoutMs,
+      });
+    } catch {
+      return undefined;
+    }
+  }
+
+  async getChangedLines(): Promise<string[]> {
+    if (!this.changedLinesPromise) {
+      this.changedLinesPromise = this.resolveChangedLines();
+    }
+
+    return this.changedLinesPromise;
+  }
+
+  async getRequiredMajorVersionFromConfig(
+    patterns: readonly string[],
+  ): Promise<RequiredMajorVersion> {
+    const key = patterns.join("\u0000");
+    let cached = this.requiredMajorVersionCache.get(key);
+
+    if (!cached) {
+      cached = this.resolveRequiredMajorVersionFromConfig(patterns);
+      this.requiredMajorVersionCache.set(key, cached);
+    }
+
+    return cached;
+  }
+
+  async getInstalledToolMajorVersion(
+    command: string,
+  ): Promise<string | undefined> {
+    let cached = this.installedMajorVersionCache.get(command);
+
+    if (!cached) {
+      cached = this.resolveInstalledToolMajorVersion(command);
+      this.installedMajorVersionCache.set(command, cached);
+    }
+
+    return cached;
+  }
+
+  warn(message: string): void {
+    console.warn(message);
+  }
+
+  private async resolveEditorConfigInCwd(): Promise<boolean> {
+    const root = resolve(this.cwd);
+    let dir = dirname(this.filePath);
+
+    while (isWithinDirectory(dir, root)) {
+      if (await pathExists(join(dir, ".editorconfig"))) {
+        return true;
+      }
+
+      const parent = dirname(dir);
+      if (parent === dir) {
+        break;
+      }
+
+      dir = parent;
+    }
+
+    return false;
+  }
+
+  private async resolveChangedLines(): Promise<string[]> {
+    const gitPath = getPathForGit(this.filePath, this.cwd);
+    const diffResult = await this.exec("git", [
+      "diff",
+      "--cached",
+      "--unified=0",
+      "--",
+      gitPath,
+    ]);
+
+    if (!diffResult || diffResult.code !== 0) {
+      return [];
+    }
+
+    const ranges: string[] = [];
+
+    for (const line of diffResult.stdout.split(/\r?\n/)) {
+      const match = line.match(/^@@ .* \+([0-9]+)(?:,([0-9]+))? @@/);
+      if (!match) {
+        continue;
+      }
+
+      const start = Number.parseInt(match[1], 10);
+      const count = match[2] ? Number.parseInt(match[2], 10) : 1;
+
+      if (!Number.isFinite(start) || !Number.isFinite(count) || count <= 0) {
+        continue;
+      }
+
+      ranges.push(`${start}:${start + count - 1}`);
+    }
+
+    return ranges;
+  }
+
+  private async resolveRequiredMajorVersionFromConfig(
+    patterns: readonly string[],
+  ): Promise<RequiredMajorVersion> {
+    const versionFile = await this.findConfigFile(patterns);
+    if (!versionFile) {
+      return undefined;
+    }
+
+    try {
+      const content = await readFile(versionFile, "utf8");
+      const firstLine = content.split(/\r?\n/, 1)[0]?.trim() ?? "";
+      if (!firstLine) {
+        return "invalid";
+      }
+
+      const match = firstLine.match(/[0-9]+/);
+      return match ? match[0] : "invalid";
+    } catch {
+      return "invalid";
+    }
+  }
+
+  private async resolveInstalledToolMajorVersion(
+    command: string,
+  ): Promise<string | undefined> {
+    const result = await this.exec(command, ["--version"]);
+    if (!result || result.code !== 0) {
+      return undefined;
+    }
+
+    const output = `${result.stdout}\n${result.stderr}`;
+    const match = output.match(/version\s+([0-9]+)/i);
+    return match?.[1];
+  }
+}