pi-tool-display 0.1.4 → 0.1.6

package/CHANGELOG.md

@@ -7,6 +7,21 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.1.6] - 2026-03-04
+
+### Fixed
+- Use absolute GitHub raw URL for README image to fix npm display
+
+## [0.1.5] - 2026-03-04
+
+### Added
+- Thinking labels feature that prefixes AI reasoning blocks with themed "Thinking:" labels for better readability
+
+### Changed
+- Rewrote README.md with professional documentation standards
+- Added comprehensive feature documentation, configuration reference, and usage examples
+- Simplified settings modal by removing less-used advanced options (expandedPreviewMaxLines, diffSplitMinWidth, diffCollapsedLines, tool ownership toggles)
+
 ## [0.1.4] - 2026-03-02
 
 ### Added

package/README.md

@@ -1,41 +1,43 @@
 # pi-tool-display
 
-OpenCode-style tool rendering for the Pi coding agent.
+OpenCode-style tool rendering for the [Pi coding agent](https://github.com/mariozechner/pi).
 
-`pi-tool-display` overrides built-in tool renderers so tool calls/results stay compact by default, with optional previews and richer diffs when you need detail.
+`pi-tool-display` provides compact, expandable tool call/result rendering that keeps your terminal clean while preserving access to full details when needed.
 
-![Screenshot](assets/pi-tool-display.png)
+![Screenshot](https://raw.githubusercontent.com/MasuRii/pi-tool-display/main/assets/pi-tool-display.png)
 
 ## Features
 
-- Compact rendering for `read`, `grep`, `find`, `ls`, `bash`, `edit`, and `write`
-- Optional per-tool override ownership toggles (`read`, `grep`, `find`, `ls`, `bash`, `edit`, `write`) for extension compatibility
-- MCP and RTK-specific settings auto-hide/auto-disable when those capabilities are not available
-- Presets for output verbosity: `opencode`, `balanced`, `verbose`
-- Interactive settings modal via `/tool-display`
-- Command-based controls (`show`, `reset`, `preset ...`)
-- Diff renderer with adaptive split/unified mode and inline highlights
-- Optional truncation and RTK compaction hints
-- Native bordered user message box styling (configurable on/off)
+- **Compact Tool Rendering** — Overrides built-in `read`, `grep`, `find`, `ls`, `bash`, `edit`, and `write` tools with collapsed-by-default output
+- **MCP Tool Support** — Custom rendering for MCP gateway tool calls with configurable verbosity
+- **Rich Diff Display** — Adaptive split/unified diff views with syntax highlighting and inline change emphasis for `edit` and `write` operations
+- **Three Presets** — Quick verbosity profiles: `opencode` (minimal), `balanced` (summaries), `verbose` (previews)
+- **Thinking Labels** — Prefixes AI thinking blocks with themed labels for better readability
+- **Native User Message Box** — Bordered user prompt styling (optional)
+- **Extension Compatibility** — Per-tool ownership toggles to avoid conflicts with other extensions
+- **Capability Detection** — Auto-hides MCP/RTK settings when those features aren't available
 
 ## Installation
 
-### Local extension folder
+### Local Extension Folder
 
-Place this folder in:
+Place this folder in one of Pi's auto-discovery locations:
 
-- Global: `~/.pi/agent/extensions/pi-tool-display`
-- Project: `.pi/extensions/pi-tool-display`
+```text
+# Global (all projects)
+~/.pi/agent/extensions/pi-tool-display
 
-Pi auto-discovers this location. If you keep it elsewhere, add the path to your settings `extensions` array.
+# Project-specific
+.pi/extensions/pi-tool-display
+```
 
-### As an npm package
+### npm Package
 
 ```bash
 pi install npm:pi-tool-display
 ```
 
-Or from git:
+### Git Repository
 
 ```bash
 pi install git:github.com/MasuRii/pi-tool-display
@@ -43,39 +45,88 @@ pi install git:github.com/MasuRii/pi-tool-display
 
 ## Usage
 
-Command:
+### Interactive Settings
+
+Open the settings modal:
 
 ```text
 /tool-display
 ```
 
-Direct args:
+### Direct Commands
 
 ```text
-/tool-display show
-/tool-display reset
-/tool-display preset opencode
-/tool-display preset balanced
-/tool-display preset verbose
+/tool-display show                    # Display current configuration
+/tool-display reset                   # Reset to default settings
+/tool-display preset opencode         # Apply opencode preset
+/tool-display preset balanced         # Apply balanced preset
+/tool-display preset verbose          # Apply verbose preset
 ```
 
 ## Presets
 
-- `opencode` (default): hides most tool output in collapsed view
-- `balanced`: summary/count style output
-- `verbose`: preview mode with larger collapsed output
+| Preset | Read Output | Search Output | MCP Output | Preview Lines | Bash Lines |
+|--------|-------------|---------------|------------|---------------|------------|
+| `opencode` | hidden | hidden | hidden | 8 | 10 |
+| `balanced` | summary | count | summary | 8 | 10 |
+| `verbose` | preview | preview | preview | 12 | 20 |
+
+**opencode** (default) — Minimal inline-only display; tool results stay collapsed  
+**balanced** — Compact summaries showing line counts and match totals  
+**verbose** — Expanded previews with more visible content by default
 
 ## Configuration
 
-Runtime config is stored at:
+Runtime configuration is stored at:
 
 ```text
 ~/.pi/agent/extensions/pi-tool-display/config.json
 ```
 
-A starter file is included as `config/config.example.json`.
+A starter template is available at `config/config.example.json`.
+
+### Configuration Options
 
-Important compatibility config:
+| Option | Type | Default | Description |
+|--------|------|---------|-------------|
+| `registerToolOverrides` | object | all `true` | Per-tool ownership flags (see below) |
+| `enableNativeUserMessageBox` | boolean | `true` | Enable bordered user message styling |
+| `readOutputMode` | string | `"hidden"` | `hidden`, `summary`, or `preview` |
+| `searchOutputMode` | string | `"hidden"` | `hidden`, `count`, or `preview` |
+| `mcpOutputMode` | string | `"hidden"` | `hidden`, `summary`, or `preview` |
+| `previewLines` | number | `8` | Lines shown in collapsed preview |
+| `expandedPreviewMaxLines` | number | `4000` | Max lines when expanded |
+| `bashCollapsedLines` | number | `10` | Lines shown for bash output |
+| `diffViewMode` | string | `"auto"` | `auto`, `split`, or `unified` |
+| `diffSplitMinWidth` | number | `120` | Minimum terminal width for split view |
+| `diffCollapsedLines` | number | `24` | Lines shown in collapsed diff |
+| `diffWordWrap` | boolean | `true` | Wrap long lines in diff view |
+| `showTruncationHints` | boolean | `true` | Show truncation indicators |
+| `showRtkCompactionHints` | boolean | `true` | Show RTK compaction hints |
+
+### Tool Override Ownership
+
+Control which tools this extension overrides:
+
+```json
+{
+  "registerToolOverrides": {
+    "read": true,
+    "grep": true,
+    "find": true,
+    "ls": true,
+    "bash": true,
+    "edit": true,
+    "write": true
+  }
+}
+```
+
+Set any tool to `false` to leave rendering ownership to another extension.
+
+> **Note:** Changes to tool ownership require `/reload` to take effect.
+
+### Example Configuration
 
 ```json
 {
@@ -88,57 +139,93 @@ Important compatibility config:
     "edit": true,
     "write": true
   },
-  "enableNativeUserMessageBox": true
+  "enableNativeUserMessageBox": true,
+  "readOutputMode": "summary",
+  "searchOutputMode": "count",
+  "mcpOutputMode": "summary",
+  "previewLines": 12,
+  "expandedPreviewMaxLines": 4000,
+  "bashCollapsedLines": 15,
+  "diffViewMode": "auto",
+  "diffSplitMinWidth": 120,
+  "diffCollapsedLines": 24,
+  "diffWordWrap": true,
+  "showTruncationHints": true,
+  "showRtkCompactionHints": true
 }
 ```
 
-- Each flag controls whether `pi-tool-display` registers that built-in tool override.
-- Set any tool to `false` to leave ownership to another extension.
-- `enableNativeUserMessageBox` controls whether bordered user prompt rendering is enabled.
-- Changing ownership values requires `/reload` to apply.
-- Legacy `registerReadToolOverride` is still accepted for backward compatibility and maps to `registerToolOverrides.read`.
-- If MCP tooling is unavailable, MCP output controls are hidden and MCP output mode is forced to `hidden`.
-- If RTK optimizer is unavailable, RTK compaction hint controls are hidden and RTK hint rendering is forced off.
+## Capability Detection
 
-Values are normalized and clamped on load/save to avoid invalid settings.
+The extension automatically detects available capabilities:
+
+- **MCP Tooling** — When no MCP tools are available, MCP-related settings are hidden and MCP output mode is forced to `hidden`
+- **RTK Optimizer** — When [pi-rtk-optimizer](https://github.com/MasuRii/pi-rtk-optimizer) isn't installed, RTK compaction hint settings are hidden and hints are disabled
+
+This prevents confusion from settings that have no effect in your environment.
 
 ## Troubleshooting
 
-If another extension owns one of these tools (`read`, `grep`, `find`, `ls`, `bash`, `edit`, `write`) and you see conflicts:
+### Tool Ownership Conflicts
+
+If another extension owns a tool and you see rendering conflicts:
+
+1. Set the corresponding `registerToolOverrides.<tool>` to `false` in your config
+2. Run `/reload` in Pi
+3. Verify with `/tool-display show` that the ownership reflects expected `off` values
 
-1. Set the corresponding `registerToolOverrides.<tool>` value to `false` in your config.
-2. Run `/reload` in Pi.
-3. Verify with `/tool-display show` that `owners={...}` reflects the expected `off` values.
+### Configuration Not Loading
 
-## Related Extension
+If settings aren't applying:
 
-- RTK optimizer: [pi-rtk-optimizer](https://github.com/MasuRii/pi-rtk-optimizer)
+1. Check the config file exists at `~/.pi/agent/extensions/pi-tool-display/config.json`
+2. Verify JSON syntax is valid
+3. Run `/tool-display show` to see current effective configuration
+
+## Project Structure
+
+```text
+pi-tool-display/
+├── index.ts                    # Extension entrypoint (Pi auto-discovery)
+├── src/
+│   ├── index.ts                # Extension bootstrap and registration
+│   ├── tool-overrides.ts       # Built-in and MCP renderer overrides
+│   ├── diff-renderer.ts        # Edit/write diff rendering engine
+│   ├── config-modal.ts         # /tool-display settings UI
+│   ├── capabilities.ts         # MCP/RTK capability detection
+│   ├── config-store.ts         # Config load/save and normalization
+│   ├── presets.ts              # Preset definitions and matching
+│   ├── render-utils.ts         # Shared rendering helpers
+│   ├── thinking-label.ts       # Thinking block label formatting
+│   ├── user-message-box-native.ts  # User message border styling
+│   ├── types.ts                # TypeScript type definitions
+│   └── zellij-modal.ts         # Modal UI primitives
+├── config/
+│   └── config.example.json     # Starter config template
+└── assets/
+    └── pi-tool-display.png     # README screenshot
+```
 
 ## Development
 
 ```bash
+# Type check
 npm run build
+
+# Lint (same as build)
 npm run lint
+
+# Run tests
 npm run test
+
+# Full check
 npm run check
 ```
 
-## Project Layout
-
-- `index.ts` - root extension entrypoint (kept for Pi auto-discovery)
-- `src/index.ts` - extension bootstrap and registration
-- `src/tool-overrides.ts` - built-in and MCP renderer overrides
-- `src/diff-renderer.ts` - edit/write diff rendering engine
-- `src/config-modal.ts` - `/tool-display` settings UI
-- `src/capabilities.ts` - MCP/RTK capability detection and runtime config guards
-- `src/config-store.ts` - config load/save and normalization
-- `src/presets.ts` - preset definitions and matching
-- `src/render-utils.ts` - shared rendering helpers
-- `src/user-message-box-native.ts` - user message border patch
-- `src/zellij-modal.ts` - vendored modal UI primitives used by settings UI
-- `config/config.example.json` - starter config template
-- `assets/pi-tool-display.png` - README screenshot asset
+## Related Extensions
+
+- [pi-rtk-optimizer](https://github.com/MasuRii/pi-rtk-optimizer) — RTK optimizer for token-efficient source output
 
 ## License
 
-MIT
+[MIT](LICENSE)

package/config/config.example.json

@@ -1,24 +1,24 @@
-{
-  "registerToolOverrides": {
-    "read": true,
-    "grep": true,
-    "find": true,
-    "ls": true,
-    "bash": true,
-    "edit": true,
-    "write": true
-  },
-  "enableNativeUserMessageBox": true,
-  "readOutputMode": "hidden",
-  "searchOutputMode": "hidden",
-  "mcpOutputMode": "hidden",
-  "previewLines": 8,
-  "expandedPreviewMaxLines": 4000,
-  "bashCollapsedLines": 10,
-  "diffViewMode": "auto",
-  "diffSplitMinWidth": 120,
-  "diffCollapsedLines": 24,
-  "diffWordWrap": true,
-  "showTruncationHints": true,
-  "showRtkCompactionHints": true
-}
+{
+  "registerToolOverrides": {
+    "read": true,
+    "grep": true,
+    "find": true,
+    "ls": true,
+    "bash": true,
+    "edit": true,
+    "write": true
+  },
+  "enableNativeUserMessageBox": true,
+  "readOutputMode": "hidden",
+  "searchOutputMode": "hidden",
+  "mcpOutputMode": "hidden",
+  "previewLines": 8,
+  "expandedPreviewMaxLines": 4000,
+  "bashCollapsedLines": 10,
+  "diffViewMode": "auto",
+  "diffSplitMinWidth": 120,
+  "diffCollapsedLines": 24,
+  "diffWordWrap": true,
+  "showTruncationHints": true,
+  "showRtkCompactionHints": true
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pi-tool-display",
-  "version": "0.1.4",
+  "version": "0.1.6",
   "description": "OpenCode-style tool call/result rendering extension for Pi coding agent.",
   "type": "module",
   "main": "./index.ts",

package/src/capabilities.ts

@@ -1,94 +1,94 @@
-import type { ExtensionAPI } from "@mariozechner/pi-coding-agent";
-import { existsSync } from "node:fs";
-import { homedir } from "node:os";
-import { join } from "node:path";
-import type { ToolDisplayConfig } from "./types.js";
-
-export interface ToolDisplayCapabilities {
-	hasMcpTooling: boolean;
-	hasRtkOptimizer: boolean;
-}
-
-function toRecord(value: unknown): Record<string, unknown> {
-	if (!value || typeof value !== "object" || Array.isArray(value)) {
-		return {};
-	}
-	return value as Record<string, unknown>;
-}
-
-function getTextField(value: unknown, field: string): string | undefined {
-	const record = toRecord(value);
-	const raw = record[field];
-	return typeof raw === "string" && raw.trim().length > 0 ? raw.trim() : undefined;
-}
-
-function isMcpToolCandidate(tool: unknown): boolean {
-	const name = getTextField(tool, "name");
-	if (name === "mcp") {
-		return true;
-	}
-
-	const label = getTextField(tool, "label");
-	if (label?.startsWith("MCP ")) {
-		return true;
-	}
-
-	const description = getTextField(tool, "description");
-	return typeof description === "string" && /\bmcp\b/i.test(description);
-}
-
-function hasMcpTooling(pi: ExtensionAPI): boolean {
-	try {
-		const allTools = pi.getAllTools();
-		return allTools.some((tool) => isMcpToolCandidate(tool));
-	} catch {
-		return false;
-	}
-}
-
-function hasRtkCommand(pi: ExtensionAPI): boolean {
-	try {
-		const commands = pi.getCommands();
-		return commands.some((command) => command.name === "rtk" || command.name.startsWith("rtk-"));
-	} catch {
-		return false;
-	}
-}
-
-function hasRtkExtensionPath(cwd: string): boolean {
-	const candidates = [
-		join(homedir(), ".pi", "agent", "extensions", "pi-rtk-optimizer"),
-		join(cwd, ".pi", "extensions", "pi-rtk-optimizer"),
-	];
-
-	for (const candidate of candidates) {
-		try {
-			if (existsSync(candidate)) {
-				return true;
-			}
-		} catch {
-			// Ignore filesystem errors and continue probing other candidates.
-		}
-	}
-
-	return false;
-}
-
-export function detectToolDisplayCapabilities(pi: ExtensionAPI, cwd: string): ToolDisplayCapabilities {
-	return {
-		hasMcpTooling: hasMcpTooling(pi),
-		hasRtkOptimizer: hasRtkCommand(pi) || hasRtkExtensionPath(cwd),
-	};
-}
-
-export function applyCapabilityConfigGuards(
-	config: ToolDisplayConfig,
-	capabilities: ToolDisplayCapabilities,
-): ToolDisplayConfig {
-	return {
-		...config,
-		registerToolOverrides: { ...config.registerToolOverrides },
-		mcpOutputMode: capabilities.hasMcpTooling ? config.mcpOutputMode : "hidden",
-		showRtkCompactionHints: capabilities.hasRtkOptimizer ? config.showRtkCompactionHints : false,
-	};
-}
+import type { ExtensionAPI } from "@mariozechner/pi-coding-agent";
+import { existsSync } from "node:fs";
+import { homedir } from "node:os";
+import { join } from "node:path";
+import type { ToolDisplayConfig } from "./types.js";
+
+export interface ToolDisplayCapabilities {
+	hasMcpTooling: boolean;
+	hasRtkOptimizer: boolean;
+}
+
+function toRecord(value: unknown): Record<string, unknown> {
+	if (!value || typeof value !== "object" || Array.isArray(value)) {
+		return {};
+	}
+	return value as Record<string, unknown>;
+}
+
+function getTextField(value: unknown, field: string): string | undefined {
+	const record = toRecord(value);
+	const raw = record[field];
+	return typeof raw === "string" && raw.trim().length > 0 ? raw.trim() : undefined;
+}
+
+function isMcpToolCandidate(tool: unknown): boolean {
+	const name = getTextField(tool, "name");
+	if (name === "mcp") {
+		return true;
+	}
+
+	const label = getTextField(tool, "label");
+	if (label?.startsWith("MCP ")) {
+		return true;
+	}
+
+	const description = getTextField(tool, "description");
+	return typeof description === "string" && /\bmcp\b/i.test(description);
+}
+
+function hasMcpTooling(pi: ExtensionAPI): boolean {
+	try {
+		const allTools = pi.getAllTools();
+		return allTools.some((tool) => isMcpToolCandidate(tool));
+	} catch {
+		return false;
+	}
+}
+
+function hasRtkCommand(pi: ExtensionAPI): boolean {
+	try {
+		const commands = pi.getCommands();
+		return commands.some((command) => command.name === "rtk" || command.name.startsWith("rtk-"));
+	} catch {
+		return false;
+	}
+}
+
+function hasRtkExtensionPath(cwd: string): boolean {
+	const candidates = [
+		join(homedir(), ".pi", "agent", "extensions", "pi-rtk-optimizer"),
+		join(cwd, ".pi", "extensions", "pi-rtk-optimizer"),
+	];
+
+	for (const candidate of candidates) {
+		try {
+			if (existsSync(candidate)) {
+				return true;
+			}
+		} catch {
+			// Ignore filesystem errors and continue probing other candidates.
+		}
+	}
+
+	return false;
+}
+
+export function detectToolDisplayCapabilities(pi: ExtensionAPI, cwd: string): ToolDisplayCapabilities {
+	return {
+		hasMcpTooling: hasMcpTooling(pi),
+		hasRtkOptimizer: hasRtkCommand(pi) || hasRtkExtensionPath(cwd),
+	};
+}
+
+export function applyCapabilityConfigGuards(
+	config: ToolDisplayConfig,
+	capabilities: ToolDisplayCapabilities,
+): ToolDisplayConfig {
+	return {
+		...config,
+		registerToolOverrides: { ...config.registerToolOverrides },
+		mcpOutputMode: capabilities.hasMcpTooling ? config.mcpOutputMode : "hidden",
+		showRtkCompactionHints: capabilities.hasRtkOptimizer ? config.showRtkCompactionHints : false,
+	};
+}