pi-all-tools 1.0.7 → 1.1.0

package/README.md

@@ -1,6 +1,6 @@
 # pi-all-tools
 
-Ensure 3 additional Pi tools are always available: `find`, `grep`, `ls`
+Ensure 3 additional Pi tools are always available: `find`, `grep`, `ls`.
 
 ## Install
 
@@ -10,4 +10,20 @@ pi install npm:pi-all-tools
 
 ## What it does
 
-Pi 默认自带 4 个工具 (read, bash, edit, write)。此扩展在每次 agent 启动时自动追加 `find`, `grep`, `ls`，共 7 个工具可用，不覆盖其他扩展注册的工具。
+Pi 默认自带 4 个工具 (read, bash, edit, write)。此扩展在每次 agent 启动时补齐 `find`, `grep`, `ls`，共 7 个工具可用，不覆盖其他扩展注册的工具。
+
+## Pi 1.1+：改用原生 defaultTools
+
+Pi 1.1 给 `defaultTools` 和 `--tools` 加了 `+name` / `-name` 增量语法，这件事可以不再依赖扩展：
+
+```json
+{
+  "defaultTools": ["+find", "+grep", "+ls"]
+}
+```
+
+**本扩展在 Pi 1.1+ 上会让位给这个设置**：某个工具如果被 `defaultTools` 明确写成 `-find`，扩展不会再把它加回来（`-name` 的移除按官方语义应当保持）；没有被提到的工具仍然照旧补齐。所以：
+
+- 已经装了本扩展的用户，升级 Pi 后行为不变，无需改配置。
+- 想单独禁用某个工具，写 `{"defaultTools": ["-find"]}` 即可，扩展不会覆盖。
+- 全新环境建议直接用上面的原生配置，本扩展可以不安。

package/extensions/default-tools.ts

@@ -1,9 +1,93 @@
-// Ponytail: local typed interface keeps zero deps
-export default function (pi: { on: (event: string, cb: () => void | Promise<void>) => void; getActiveTools: () => string[]; setActiveTools: (tools: string[]) => void }) {
+/**
+ * pi-all-tools — keep find, grep and ls available.
+ *
+ * Pi 1.1 added `+name`/`-name` entries to `defaultTools` and `--tools`, so the
+ * tool set can be adjusted in configuration without an extension:
+ *
+ *   { "defaultTools": ["+find", "+grep", "+ls"] }
+ *
+ * This package predates that. It still ensures the three tools, but on Pi that
+ * reads those increments it defers to what the setting says about each one:
+ *
+ *   { "defaultTools": ["-find"] }
+ *
+ * now means find stays off, instead of being re-added on the next agent start.
+ * A tool the setting never mentions is added exactly as it always was, so an
+ * existing install keeps its 7-tool set with no configuration change.
+ *
+ * Ponytail: local typed interface keeps zero deps.
+ */
+
+/** The tools this package has always ensured are present. */
+const WANTED = ["find", "grep", "ls"];
+
+interface PiLike {
+  on: (event: string, cb: () => void | Promise<void>) => void;
+  getActiveTools?: () => string[] | undefined;
+  setActiveTools?: (tools: string[]) => void;
+  getSettings?: () => { defaultTools?: string[] } | undefined;
+}
+
+/**
+ * What `defaultTools` says about one tool, once the `+name`/`-name` grammar is
+ * understood:
+ *
+ * - `added` — named plainly or with `+`; the person wants it on.
+ * - `removed` — named with `-`; this extension must not put it back, because a
+ *   `-name` removal is documented to stick across reloads.
+ * - `unset` — not named; the extension may add it as before.
+ *
+ * A plain allowlist that simply omits the tool is not read as a removal: that
+ * is the older replace-the-defaults form this package never honoured anyway.
+ */
+export function statedIntent(defaultTools: string[] | undefined, tool: string): "added" | "removed" | "unset" {
+  if (!Array.isArray(defaultTools)) return "unset";
+  for (const entry of defaultTools) {
+    if (typeof entry !== "string") continue;
+    if (entry === tool || entry === `+${tool}`) return "added";
+    if (entry === `-${tool}`) return "removed";
+  }
+  return "unset";
+}
+
+/**
+ * Whether Pi reads `+name`/`-name` increments in `defaultTools`.
+ *
+ * `getSettings` exposes the resolved settings; only Pi 1.1+ pairs it with the
+ * increment grammar. Asking also covers the case where settings exist but carry
+ * no `defaultTools` key at all, which reads as `unset` either way.
+ */
+function supportsIncrements(pi: PiLike): boolean {
+  try {
+    return typeof pi.getSettings === "function" && pi.getSettings() !== undefined;
+  } catch {
+    return false;
+  }
+}
+
+export default function (pi: PiLike) {
+  // Resolved once: a session cannot change which Pi grammar it runs.
+  const respectsIncrements = supportsIncrements(pi);
+
   pi.on("before_agent_start", async () => {
     try {
+      if (typeof pi.getActiveTools !== "function" || typeof pi.setActiveTools !== "function") return;
       const current = pi.getActiveTools() ?? [];
-      const missing = ["find", "grep", "ls"].filter(t => !current.includes(t));
+
+      let defaultTools: string[] | undefined;
+      if (respectsIncrements) {
+        try {
+          defaultTools = pi.getSettings?.()?.defaultTools;
+        } catch {
+          defaultTools = undefined;
+        }
+      }
+
+      const missing = WANTED.filter((tool) => {
+        if (current.includes(tool)) return false;
+        // A natively-removed tool stays removed; anything else is added.
+        return statedIntent(defaultTools, tool) !== "removed";
+      });
       if (missing.length > 0) pi.setActiveTools([...current, ...missing]);
     } catch {
       // Extension should never crash Pi — silent no-op on failure

package/package.json

@@ -1,9 +1,14 @@
 {
   "name": "pi-all-tools",
-  "version": "1.0.7",
+  "version": "1.1.0",
   "description": "Enable all 7 built-in Pi tools by default (read, bash, edit, write, grep, find, ls)",
+  "type": "module",
   "license": "MIT",
-  "repository": "github:RealAlexandreAI/pi-all-tools",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/RetiredPhysicist/pi-plugins.git",
+    "directory": "packages/pi-all-tools"
+  },
   "keywords": [
     "pi-package",
     "pi",
@@ -14,5 +19,14 @@
     "extensions": [
       "./extensions"
     ]
+  },
+  "scripts": {
+    "test": "node --import tsx --test test/*.test.ts"
+  },
+  "devDependencies": {
+    "tsx": "^4.23.15"
+  },
+  "peerDependencies": {
+    "@earendil-works/pi-coding-agent": "^1.1.0"
   }
 }

package/test/default-tools.test.ts

@@ -0,0 +1,100 @@
+import { describe, it } from "node:test";
+import assert from "node:assert/strict";
+import register, { statedIntent } from "../extensions/default-tools.ts";
+
+/** A minimal stand-in for the Pi extension API. */
+function harness(options: {
+  active?: string[];
+  defaultTools?: string[];
+  hasSettings?: boolean;
+} = {}) {
+  const handlers = new Map<string, () => void | Promise<void>>();
+  const pi = {
+    on(event: string, cb: () => void | Promise<void>) {
+      handlers.set(event, cb);
+    },
+    getActiveTools: () => options.active ?? [],
+    setActiveTools(tools: string[]) {
+      options.active = tools;
+    },
+    ...(options.hasSettings === false
+      ? {}
+      : { getSettings: () => (options.defaultTools ? { defaultTools: options.defaultTools } : {}) }),
+  };
+  register(pi as never);
+  return {
+    active: () => options.active ?? [],
+    async start() {
+      const handler = handlers.get("before_agent_start");
+      if (handler) await handler();
+    },
+  };
+}
+
+describe("statedIntent", () => {
+  it("reads a plain name and +name as added", () => {
+    assert.equal(statedIntent(["find"], "find"), "added");
+    assert.equal(statedIntent(["+find"], "find"), "added");
+  });
+
+  it("reads -name as removed", () => {
+    assert.equal(statedIntent(["-find"], "find"), "removed");
+  });
+
+  it("treats an absent or unnamed tool as unset", () => {
+    assert.equal(statedIntent(undefined, "find"), "unset");
+    assert.equal(statedIntent([], "find"), "unset");
+    assert.equal(statedIntent(["+grep"], "find"), "unset");
+  });
+
+  it("ignores non-string entries", () => {
+    assert.equal(statedIntent([1 as never, "-find"], "find"), "removed");
+  });
+});
+
+describe("pi-all-tools extension", () => {
+  it("adds the missing tools on an unconfigured install", async () => {
+    const pi = harness({ active: ["read", "bash", "edit", "write"] });
+    await pi.start();
+    assert.deepEqual(pi.active(), ["read", "bash", "edit", "write", "find", "grep", "ls"]);
+  });
+
+  it("leaves the active set alone when nothing is missing", async () => {
+    const pi = harness({ active: ["read", "find", "grep", "ls"] });
+    await pi.start();
+    assert.deepEqual(pi.active(), ["read", "find", "grep", "ls"]);
+  });
+
+  it("respects a native removal instead of re-adding the tool", async () => {
+    const pi = harness({ active: ["read", "grep"], defaultTools: ["-find"] });
+    await pi.start();
+    // find stays removed; grep and ls are still filled in.
+    assert.deepEqual(pi.active(), ["read", "grep", "ls"]);
+  });
+
+  it("still adds a tool the setting never mentions", async () => {
+    const pi = harness({ active: ["read"], defaultTools: ["+grep"] });
+    await pi.start();
+    assert.deepEqual(pi.active(), ["read", "find", "grep", "ls"]);
+  });
+
+  it("falls back to the legacy behavior when settings are unavailable", async () => {
+    const pi = harness({ active: ["read"], hasSettings: false });
+    await pi.start();
+    assert.deepEqual(pi.active(), ["read", "find", "grep", "ls"]);
+  });
+
+  it("never throws when the active-tool API is missing", async () => {
+    const handlers = new Map<string, () => void | Promise<void>>();
+    const pi = {
+      on(event: string, cb: () => void | Promise<void>) {
+        handlers.set(event, cb);
+      },
+      getSettings: () => ({}),
+    };
+    register(pi as never);
+    const handler = handlers.get("before_agent_start");
+    assert.ok(handler);
+    await handler();
+  });
+});