pi-extensions-tool-display 1.0.1 → 1.1.1

package/README.md

@@ -14,6 +14,8 @@ It is also a standalone Pi extension. Install or include this package in Pi's pa
 
 This package owns the display protocol and generic component composition only. Each feature extension continues to own its domain-specific audit extraction, copy, status, and layout.
 
+Built-in overrides only replace tools that Pi has already activated; `registerToolOverrides` does not enable inactive built-in tools.
+
 ## Upstream attribution
 
 The display integration is designed to work with the MIT-licensed [`MasuRii/pi-tool-display`](https://github.com/MasuRii/pi-tool-display), the original full-featured Pi tool-display project. We thank MasuRii for that work.

package/README.zh-CN.md

@@ -14,6 +14,8 @@
 
 这个包负责实际工具展示、展示协议和通用组件组合。具体业务的审计数据提取、文案、状态和布局仍由调用方维护，避免把不同扩展耦合在一起。
 
+内建工具覆盖只替换 Pi 当前已经激活的工具；`registerToolOverrides` 不会启用原本未激活的内建工具。
+
 ## 上游引用
 
 本包的展示集成设计用于兼容 MIT 许可的 [`MasuRii/pi-tool-display`](https://github.com/MasuRii/pi-tool-display)，这是 Pi 生态中原始的完整工具展示项目。感谢 MasuRii 的工作。

package/SKILL.md

@@ -0,0 +1,28 @@
+---
+name: configure-pi-extensions-tool-display
+description: "配置与排查 Pi 工具展示宿主、内建/自定义工具 override、输出模式和 diff 视图。Use when changing pi-extensions-tool-display rendering."
+---
+
+# 配置 pi-extensions-tool-display
+
+## 诊断
+
+读取实际 Pi agent 目录下的 `extensions/pi-tool-display/config.json`。注意目录名是 `pi-tool-display`，不是 npm 包名。以包内 `config.example.json` 和当前源码支持的字段为准。
+
+确认没有同时加载另一份工具展示宿主；`pi-distill` 与 `pi-tool-supervisor` 已会加载这个共享宿主，通常无需重复安装。
+
+## 修改
+
+优先运行 `/config:tool-display`；`/tool-display`、`/pi-tool-display` 是兼容别名。按目标最小修改：
+
+- `registerToolOverrides` 控制 `read/grep/find/ls/bash/edit/write` 的展示所有权；
+- `customToolOverrides.<tool>` 使用 `enabled`、`kind`、`outputMode`；
+- `readOutputMode`、`searchOutputMode`、`mcpOutputMode`、`bashOutputMode` 控制输出展示；
+- `diffViewMode`、`diffIndicatorMode`、折叠行数和换行字段只影响 diff UI；
+- `enabled: false` 关闭宿主展示。
+
+不要把展示开关解释为禁用工具，也不要让多个宿主同时注册同一内建 override。
+
+## 验证
+
+分别调用一个受影响的内建或自定义工具，观察折叠、预览、diff 或输出模式。若消费者审计卡片未出现，先确认宿主只加载一次，再确认消费者 middleware 已注册；不能用配置文件可解析代替真实 UI 证据。

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pi-extensions-tool-display",
-  "version": "1.0.1",
+  "version": "1.1.1",
   "description": "Pi tool display host and shared result-rendering protocol for extensions",
   "type": "module",
   "main": "./index.ts",
@@ -15,6 +15,7 @@
     "config.example.json",
     "README.md",
     "README.zh-CN.md",
+    "SKILL.md",
     "tsconfig.json"
   ],
   "scripts": {
@@ -53,6 +54,9 @@
   "pi": {
     "extensions": [
       "./index.ts"
+    ],
+    "skills": [
+      "./SKILL.md"
     ]
   },
   "devDependencies": {

package/src/config-modal.ts

@@ -104,7 +104,7 @@ export function buildInspectorSettings(
 			inspectorTitle: "Global Tool Display Switch",
 			inspectorSummary: [
 				"Enables or disables all pi-tool-display rendering and tool ownership behavior.",
-				"The /tool-display command remains available while disabled so the extension can be enabled again without editing Pi package settings.",
+				"The /config:tool-display command remains available while disabled so the extension can be enabled again without editing Pi package settings.",
 			],
 			inspectorOptions: [
 				"on — enable tool overrides and enhanced rendering",
@@ -500,7 +500,7 @@ export function handleToolDisplayArgs(args: string, ctx: ExtensionCommandContext
 		const candidate = normalized.slice("preset ".length).trim();
 		const preset = parseToolDisplayPreset(candidate);
 		if (!preset) {
-			ctx.ui.notify(`Unknown preset. Use: /tool-display preset ${PRESET_COMMAND_HINT}`, "warning");
+			ctx.ui.notify(`Unknown preset. Use: /config:tool-display preset ${PRESET_COMMAND_HINT}`, "warning");
 			return true;
 		}
 
@@ -509,7 +509,7 @@ export function handleToolDisplayArgs(args: string, ctx: ExtensionCommandContext
 		return true;
 	}
 
-	ctx.ui.notify(`Usage: /tool-display [show|reset|preset ${PRESET_COMMAND_HINT}]`, "warning");
+	ctx.ui.notify(`Usage: /config:tool-display [show|reset|preset ${PRESET_COMMAND_HINT}]`, "warning");
 	return true;
 }
 
@@ -523,7 +523,7 @@ export async function runToolDisplayCommandHandler(
 	}
 
 	if (!ctx.hasUI) {
-		ctx.ui.notify("/tool-display requires interactive TUI mode.", "warning");
+		ctx.ui.notify("/config:tool-display requires interactive TUI mode.", "warning");
 		return;
 	}
 
@@ -531,10 +531,13 @@ export async function runToolDisplayCommandHandler(
 }
 
 export function registerToolDisplayCommand(pi: ExtensionAPI, controller: ToolDisplayConfigController): void {
-	pi.registerCommand("tool-display", {
+	const command = {
 		description: "Configure tool output rendering (OpenCode-style)",
 		handler: async (args, ctx) => {
 			await runToolDisplayCommandHandler(args, ctx, controller);
 		},
-	});
+	};
+	for (const name of ["config:tool-display", "tool-display", "pi-tool-display"] as const) {
+		pi.registerCommand(name, command);
+	}
 }

package/src/index.ts

@@ -13,6 +13,7 @@ import {
   type ToolDisplayCapabilities,
 } from "./capabilities.js";
 import { registerToolDisplayOverrides } from "./tool-overrides.js";
+import { logToolDisplayDebug } from "./debug-logger.js";
 import { disposeAll, resetDisposed } from "./disposable.js";
 import { registerThinkingLabeling } from "./thinking-label.js";
 import registerNativeUserMessageBox from "./user-message-box-native.js";
@@ -24,6 +25,12 @@ import {
 
 export * from "./result-render-middleware.js";
 
+const TOOL_DISPLAY_RELOAD_ACTIVE_TOOLS_KEY = Symbol.for("pi-tool-display.reloadActiveTools.v1");
+const BUILT_IN_TOOL_OVERRIDE_NAME_SET = new Set<string>(BUILT_IN_TOOL_OVERRIDE_NAMES);
+type GlobalWithToolDisplayReloadState = typeof globalThis & {
+  [TOOL_DISPLAY_RELOAD_ACTIVE_TOOLS_KEY]?: string[];
+};
+
 function ownershipChanged(
   previous: ToolDisplayConfig,
   next: ToolDisplayConfig,
@@ -44,9 +51,9 @@ export function toolDisplayReloadRequired(
 
 const initializedHosts = new WeakSet<ExtensionAPI>();
 
-function hasRegisteredToolDisplayCommand(pi: ExtensionAPI): boolean {
+function hasRegisteredToolDisplayCommand(pi: ExtensionAPI, name: string): boolean {
   try {
-    return pi.getCommands().some((command) => command.name === "tool-display");
+    return pi.getCommands().some((command) => command.name === name);
   } catch {
     return false;
   }
@@ -65,10 +72,21 @@ export function ensureToolDisplayHost(
   if (initializedHosts.has(pi)) return;
   initializedHosts.add(pi);
 
+  const globalReloadState = globalThis as GlobalWithToolDisplayReloadState;
+  const activeBuiltInToolNamesBeforeReload = globalReloadState[TOOL_DISPLAY_RELOAD_ACTIVE_TOOLS_KEY];
+  delete globalReloadState[TOOL_DISPLAY_RELOAD_ACTIVE_TOOLS_KEY];
+
   resetDisposed();
 
   pi.on("session_shutdown", (event: { reason: string }) => {
     if (event.reason === "reload") {
+      try {
+        globalReloadState[TOOL_DISPLAY_RELOAD_ACTIVE_TOOLS_KEY] = pi
+          .getActiveTools()
+          .filter((toolName) => BUILT_IN_TOOL_OVERRIDE_NAME_SET.has(toolName));
+      } catch (error) {
+        logToolDisplayDebug("Failed to preserve active built-in tools for reload.", error);
+      }
       disposeAll();
       initializedHosts.delete(pi);
     }
@@ -112,22 +130,23 @@ export function ensureToolDisplayHost(
   };
 
   if (initial.config.enabled) {
-    registerToolDisplayOverrides(pi, getEffectiveConfig);
+    registerToolDisplayOverrides(pi, getEffectiveConfig, activeBuiltInToolNamesBeforeReload);
     registerNativeUserMessageBox(pi, getConfig);
     registerThinkingLabeling(pi);
   }
 
   // Each Pi extension has its own registration map, while getCommands() sees
   // the shared runtime. Check the latter so feature extensions do not expose
-  // duplicate /tool-display entries when they initialize this host separately.
-  if (!hasRegisteredToolDisplayCommand(pi)) {
-    pi.registerCommand("tool-display", {
-      description: "Configure tool output rendering (OpenCode-style)",
-      handler: async (args, ctx) => {
-        const { runToolDisplayCommandHandler } = await import("./config-modal.js");
-        await runToolDisplayCommandHandler(args, ctx, { getConfig, setConfig, getCapabilities });
-      },
-    });
+  // duplicate management commands when they initialize this host separately.
+  const command = {
+    description: "Configure tool output rendering (OpenCode-style)",
+    handler: async (args: string, ctx: ExtensionCommandContext) => {
+      const { runToolDisplayCommandHandler } = await import("./config-modal.js");
+      await runToolDisplayCommandHandler(args, ctx, { getConfig, setConfig, getCapabilities });
+    },
+  };
+  for (const name of ["config:tool-display", "tool-display", "pi-tool-display"] as const) {
+    if (!hasRegisteredToolDisplayCommand(pi, name)) pi.registerCommand(name, command);
   }
 
   pi.on("session_start", async (_event, ctx) => {

package/src/tool-overrides.ts

@@ -1668,9 +1668,20 @@ function tryGetAllTools(pi: ExtensionAPI, debugMessage: string): unknown[] | und
   }
 }
 
+// Return undefined until Pi binds the extension action methods.
+function tryGetActiveToolNames(pi: ExtensionAPI, debugMessage: string): string[] | undefined {
+  try {
+    return pi.getActiveTools();
+  } catch (error) {
+    logToolDisplayDebug(debugMessage, error);
+    return undefined;
+  }
+}
+
 export function registerToolDisplayOverrides(
   pi: ExtensionAPI,
   getConfig: ConfigGetter,
+  activeToolNamesDuringLoad?: readonly string[],
 ): void {
   clearBuiltInToolCache();
   const toolDisplayApi = installToolDisplayApi(getConfig);
@@ -1688,7 +1699,7 @@ export function registerToolDisplayOverrides(
   const registeredBuiltInToolOverrides = new Set<BuiltInToolOverrideName>();
 
   const isExternallyOwnedBuiltInTool = (toolName: BuiltInToolOverrideName): boolean => {
-    const allTools = tryGetAllTools(pi, "Built-in tool override ownership discovery unavailable during extension load; registering renderer for pre-bind history rendering.");
+    const allTools = tryGetAllTools(pi, "Built-in tool override ownership discovery unavailable; skipping conflicting owners.");
     if (!allTools) {
       return false;
     }
@@ -1780,7 +1791,37 @@ export function registerToolDisplayOverrides(
     return { scope: getSearchScope(args), limitSuffix: args.limit !== undefined ? ` (limit ${args.limit})` : "" };
   };
 
-  registerIfOwned("read", () => {
+  const builtInToolRegistrations = new Map<BuiltInToolOverrideName, () => void>();
+
+  // Record each built-in replacement until Pi exposes its active tool selection.
+  const recordBuiltInToolRegistration = (
+    toolName: BuiltInToolOverrideName,
+    register: () => void,
+  ): void => {
+    builtInToolRegistrations.set(toolName, register);
+  };
+
+  // Retry deferred replacements against Pi's current active tool selection.
+  const registerActiveBuiltInToolOverrides = (
+    knownActiveToolNames?: readonly string[],
+  ): void => {
+    const activeToolNames = knownActiveToolNames ?? tryGetActiveToolNames(
+      pi,
+      "Built-in tool activation discovery unavailable; skipping display overrides.",
+    );
+    if (!activeToolNames) {
+      return;
+    }
+
+    const activeTools = new Set(activeToolNames);
+    for (const [toolName, register] of builtInToolRegistrations) {
+      if (activeTools.has(toolName)) {
+        registerIfOwned(toolName, register);
+      }
+    }
+  };
+
+  recordBuiltInToolRegistration("read", () => {
     registerRuntimeTool(pi, {
       name: "read",
       label: "read",
@@ -1795,7 +1836,7 @@ export function registerToolDisplayOverrides(
     });
   });
 
-  registerIfOwned("grep", () => {
+  recordBuiltInToolRegistration("grep", () => {
     registerRuntimeTool(pi, {
       name: "grep",
     label: "grep",
@@ -1816,7 +1857,7 @@ export function registerToolDisplayOverrides(
     });
   });
 
-  registerIfOwned("find", () => {
+  recordBuiltInToolRegistration("find", () => {
     registerRuntimeTool(pi, {
       name: "find",
     label: "find",
@@ -1834,7 +1875,7 @@ export function registerToolDisplayOverrides(
     });
   });
 
-  registerIfOwned("ls", () => {
+  recordBuiltInToolRegistration("ls", () => {
     registerRuntimeTool(pi, {
       name: "ls",
     label: "ls",
@@ -1850,7 +1891,7 @@ export function registerToolDisplayOverrides(
     });
   });
 
-  registerIfOwned("edit", () => {
+  recordBuiltInToolRegistration("edit", () => {
     registerRuntimeTool(pi, {
       name: "edit",
     label: "edit",
@@ -1872,7 +1913,7 @@ export function registerToolDisplayOverrides(
     });
   });
 
-  registerIfOwned("write", () => {
+  recordBuiltInToolRegistration("write", () => {
     registerRuntimeTool(pi, {
       name: "write",
     label: "write",
@@ -1945,7 +1986,7 @@ export function registerToolDisplayOverrides(
     });
   });
 
-  registerIfOwned("bash", () => {
+  recordBuiltInToolRegistration("bash", () => {
     registerRuntimeTool(pi, {
       name: "bash",
     label: "bash",
@@ -2024,6 +2065,8 @@ export function registerToolDisplayOverrides(
     });
   });
 
+  registerActiveBuiltInToolOverrides(activeToolNamesDuringLoad);
+
   const wrappedCustomToolNames = new Set<string>();
   registerCleanup(() => wrappedCustomToolNames.clear());
 
@@ -2229,11 +2272,13 @@ export function registerToolDisplayOverrides(
 
   pi.on("session_start", async () => {
     clearWriteExecutionMeta(writeExecutionMetaByToolCallId);
+    registerActiveBuiltInToolOverrides();
     registerMcpToolOverrides();
     scheduleMcpToolOverrideDiscovery();
   });
   pi.on("before_agent_start", async () => {
     clearWriteExecutionMeta(writeExecutionMetaByToolCallId);
+    registerActiveBuiltInToolOverrides();
     registerMcpToolOverrides();
     scheduleMcpToolOverrideDiscovery();
   });