@pi-unipi/utility 0.2.7 → 0.2.9

package/README.md

@@ -1,94 +1,68 @@
 # @pi-unipi/utility
 
-Comprehensive utility suite for the Pi coding agent — part of the Unipi extension suite.
+Environment info, diagnostics, cleanup, name badge, and diff rendering. The grab-bag package for maintaining your development environment and making tool output readable.
 
-## Features
+The diff rendering is the standout feature — Shiki-powered syntax-highlighted diffs for `write` and `edit` tool output. Side-by-side view for edits, unified view for writes, with color presets and auto-fallback on narrow terminals.
 
-### Commands
+## Commands
 
 | Command | Description |
 |---------|-------------|
-| `/unipi:continue` | Continue agent without polluting context |
-| `/unipi:reload` | Explain how to reload extensions |
-| `/unipi:status` | Show status of all unipi modules |
-| `/unipi:cleanup` | Clean stale DBs, temp files, old sessions |
 | `/unipi:env` | Show environment info (Node, Pi, OS, paths) |
 | `/unipi:doctor` | Run diagnostics across all modules |
-| `/unipi:name-badge` | Toggle name badge overlay (shows session name) |
+| `/unipi:status` | Show status of all unipi modules |
+| `/unipi:cleanup` | Clean stale DBs, temp files, old sessions |
+| `/unipi:reload` | Explain how to reload extensions |
+| `/unipi:name-badge` | Toggle name badge overlay |
 | `/unipi:badge-gen` | Generate session name via LLM and enable badge |
-| `/unipi:util-settings` | **Unified settings** — badge + diff rendering config |
-| `/unipi:badge-settings` | Settings overlay (deprecated alias for `/unipi:util-settings`) |
+| `/unipi:util-settings` | Unified settings for badge and diff rendering |
 
-### Tools
+### Examples
 
-| Tool | Description |
-|------|-------------|
-| `ctx_batch` | Atomic batch execution with rollback support |
-| `ctx_env` | Environment inspection for debugging |
-| `write` | Write file with **syntax-highlighted diff** (when diff enabled) |
-| `edit` | Edit file with **split/unified diff view** (when diff enabled) |
+```
+/unipi:env                 # Show environment
+/unipi:doctor              # Run diagnostics
+/unipi:cleanup             # Clean stale files
+/unipi:cleanup --dry-run   # Preview what would be cleaned
+/unipi:name-badge          # Toggle the session name badge
+/unipi:badge-gen           # Generate a session name via LLM
+```
 
-### Modules (Programmatic API)
+## Special Triggers
 
-| Module | Path | Description |
-|--------|------|-------------|
-| **ProcessLifecycle** | `lifecycle/process` | Parent PID polling, orphan detection, signal handlers, cleanup registry |
-| **cleanupStale** | `lifecycle/cleanup` | Stale DB/temp/session/cache cleanup with dry-run support |
-| **TTLCache** | `cache/ttl-cache` | Memory or SQLite-backed TTL cache with auto-expiration |
-| **AnalyticsCollector** | `analytics/collector` | Privacy-respecting event collection with daily rollup |
-| **runDiagnostics** | `diagnostics/engine` | Cross-module health checks with plugin architecture |
-| **detectCapabilities** | `display/capabilities` | Terminal feature detection (color, Nerd Font, unicode) |
-| **Width Utilities** | `display/width` | ANSI-aware clamp, wrap, collapse, pad, center |
-| **SettingsInspector** | `tui/settings-inspector` | Reusable settings overlay data model |
-
-## Installation
-
-```bash
-pi install npm:@pi-unipi/utility
-```
+Utility registers with the info-screen dashboard, showing module status and diagnostic results. The footer subscribes to utility events for its extension status segment.
 
-Or install the full Unipi suite:
+The diff rendering feature wraps Pi's built-in `write` and `edit` tools. When enabled, these tools show syntax-highlighted diffs instead of plain output. This is a transparent replacement — the agent doesn't need to know about it.
 
-```bash
-pi install npm:@pi-unipi/unipi
-```
+## Agent Tools
 
-## Usage
+| Tool | Description |
+|------|-------------|
+| `ctx_batch` | Atomic batch execution with rollback support |
+| `ctx_env` | Environment inspection for debugging |
+| `write` | Write file with syntax-highlighted diff (when diff enabled) |
+| `edit` | Edit file with split/unified diff view (when diff enabled) |
 
-### Commands
+### Batch Execution
 
-```
-/unipi:continue           # Resume agent cleanly
-/unipi:cleanup             # Clean stale files
-/unipi:cleanup --dry-run   # Preview what would be cleaned
-/unipi:env                 # Show environment
-/unipi:doctor              # Run diagnostics
-```
+```typescript
+import { BatchBuilder } from "@pi-unipi/utility/tools/batch";
 
-### Name Badge
+const report = await new BatchBuilder()
+  .addCommand("search", { query: "refactor" })
+  .addTool("memory_search", { query: "patterns" })
+  .withOptions({ failFast: true, commandTimeoutMs: 30000 })
+  .execute(myExecutor);
 
-```
-/unipi:name-badge          # Toggle the session name badge on/off
-/unipi:badge-gen           # Generate a session name via LLM
+if (!report.success) {
+  console.log("Failed:", report.results.find(r => !r.success)?.error);
+}
 ```
 
-The badge is a persistent HUD overlay in the top-right corner showing the current session name.
-It auto-restores visibility on session restart.
+## Configurables
 
 ### Diff Rendering
 
-Shiki-powered, syntax-highlighted diffs for `write` and `edit` tool output. When enabled, the default tools are replaced with enhanced versions that show side-by-side or stacked diffs with syntax highlighting.
-
-**Features:**
-- Split view (side-by-side) for `edit` tool, auto-falls back to unified on narrow terminals
-- Unified view (stacked single-column) for `write` tool overwrites
-- 4 color presets: default, midnight, subtle, neon
-- LRU cache (192 entries) for Shiki highlights
-- Large diff fallback (skip highlighting above 80k chars)
-- Environment variable color overrides (`DIFF_ADD_BG`, `DIFF_REM_BG`, etc.)
-
-**Configuration:**
-
 ```
 /unipi:util-settings        # Open unified settings TUI
 ```
@@ -106,26 +80,38 @@ Or edit `.unipi/config/util-settings.json` directly:
 }
 ```
 
-**Diff themes:** default, midnight, subtle, neon
-**Shiki themes:** github-dark, dracula, one-dark-pro, catppuccin-mocha, nord, tokyo-night, and more
+| Setting | Default | Options |
+|---------|---------|---------|
+| `enabled` | true | true/false |
+| `theme` | "default" | default, midnight, subtle, neon |
+| `shikiTheme` | "github-dark" | github-dark, dracula, one-dark-pro, catppuccin-mocha, nord, tokyo-night |
+| `splitMinWidth` | 150 | Minimum terminal width for split view |
 
-### Batch Execution (Code)
+Environment variable overrides: `DIFF_ADD_BG`, `DIFF_REM_BG`, etc.
 
-```typescript
-import { BatchBuilder } from "@pi-unipi/utility/tools/batch";
+Features:
+- Split view (side-by-side) for `edit`, auto-falls back to unified on narrow terminals
+- Unified view (stacked) for `write` overwrites
+- LRU cache (192 entries) for Shiki highlights
+- Large diff fallback (skip highlighting above 80k chars)
 
-const report = await new BatchBuilder()
-  .addCommand("search", { query: "refactor" })
-  .addTool("memory_search", { query: "patterns" })
-  .withOptions({ failFast: true, commandTimeoutMs: 30000 })
-  .execute(myExecutor);
+### Name Badge
 
-if (!report.success) {
-  console.log("Failed:", report.results.find(r => !r.success)?.error);
-}
-```
+The badge is a persistent HUD overlay in the top-right corner showing the current session name. It auto-restores visibility on session restart.
+
+## Programmatic API
+
+| Module | Path | Description |
+|--------|------|-------------|
+| ProcessLifecycle | `lifecycle/process` | Parent PID polling, orphan detection, signal handlers |
+| cleanupStale | `lifecycle/cleanup` | Stale DB/temp/session/cache cleanup with dry-run |
+| TTLCache | `cache/ttl-cache` | Memory or SQLite-backed TTL cache |
+| AnalyticsCollector | `analytics/collector` | Privacy-respecting event collection with daily rollup |
+| runDiagnostics | `diagnostics/engine` | Cross-module health checks with plugin architecture |
+| detectCapabilities | `display/capabilities` | Terminal feature detection (color, Nerd Font, unicode) |
+| Width Utilities | `display/width` | ANSI-aware clamp, wrap, collapse, pad, center |
 
-### TTL Cache (Code)
+### TTL Cache
 
 ```typescript
 import { TTLCache } from "@pi-unipi/utility/cache/ttl-cache";
@@ -135,16 +121,7 @@ await cache.set("key", { data: "value" });
 const value = await cache.get("key");
 ```
 
-### Diagnostics (Code)
-
-```typescript
-import { runDiagnostics, formatDiagnosticsReport } from "@pi-unipi/utility/diagnostics/engine";
-
-const report = await runDiagnostics();
-console.log(formatDiagnosticsReport(report));
-```
-
-### Terminal Capabilities (Code)
+### Terminal Capabilities
 
 ```typescript
 import { detectCapabilities, getIcon } from "@pi-unipi/utility/display/capabilities";
@@ -154,64 +131,13 @@ console.log("Nerd Font:", caps.nerdFont);
 console.log(getIcon("󰘳", "[OK]")); // Uses Nerd Font if available
 ```
 
-## Architecture
-
-```
-packages/utility/src/
-├── index.ts              # Extension entry point
-├── commands.ts           # Command registration
-├── types.ts              # Shared types
-├── info-screen.ts        # Info-screen integration
-├── lifecycle/
-│   ├── process.ts        # Process lifecycle manager
-│   └── cleanup.ts        # Stale cleanup utility
-├── cache/
-│   └── ttl-cache.ts      # TTL cache (memory + SQLite)
-├── analytics/
-│   └── collector.ts      # Event collection + rollup
-├── diagnostics/
-│   └── engine.ts         # Health check engine
-├── display/
-│   ├── capabilities.ts   # Terminal detection
-│   └── width.ts          # Width utilities
-├── diff/
-│   ├── settings.ts       # Unified settings (badge + diff) read/write + migration
-│   ├── theme.ts          # Diff color presets, resolution chain, hex ↔ ANSI
-│   ├── parser.ts         # Diff parsing (structuredPatch, word diff analysis)
-│   ├── highlighter.ts    # Shiki singleton, LRU cache, language detection
-│   ├── renderer.ts       # Split/unified renderers, ANSI utilities
-│   └── wrapper.ts        # write/edit tool wrapping with diff output
-├── tui/
-│   ├── settings-inspector.ts  # Settings overlay model
-│   ├── name-badge.ts          # Name badge overlay component
-│   ├── name-badge-state.ts    # Name badge state manager
-│   ├── badge-settings.ts      # Badge settings (thin wrapper over diff/settings)
-│   └── util-settings-tui.ts  # Unified settings TUI (badge + diff)
-└── tools/
-    ├── batch.ts          # Batch execution
-    └── env.ts            # Environment info
-```
-
 ## Privacy
 
-The analytics collector is **privacy-respecting** by design:
-- No file contents are recorded
+The analytics collector is privacy-respecting:
+- No file contents recorded
 - No sensitive data (API keys, tokens, passwords) — redacted automatically
 - Strings truncated to 500 characters
-- All data stays local (in-memory by default, optional SQLite)
-
-## Dependencies
-
-- `@pi-unipi/core` — Shared constants, events, utilities
-- `@mariozechner/pi-coding-agent` — Pi extension API
-- `@sinclair/typebox` — Schema validation (peer dependency)
-- `diff` — Unified diff generation (for diff rendering)
-- `@shikijs/cli` — Shiki syntax highlighting (for diff rendering)
-- `sqlite3` — Optional, for persistent cache/analytics
-
-### Dev Dependencies
-
-- `@types/diff` — TypeScript types for the diff library
+- All data stays local
 
 ## License
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pi-unipi/utility",
-  "version": "0.2.7",
+  "version": "0.2.9",
   "description": "Utility commands and tools for Pi coding agent — lifecycle, diagnostics, cache, analytics, display, batch execution",
   "type": "module",
   "license": "MIT",

package/src/diff/highlighter.ts

@@ -273,9 +273,8 @@ export async function getShikiHighlighter(): Promise<any> {
         ],
       });
       return shikiHighlighter;
-    } catch (err) {
+    } catch {
       // If Shiki fails to load, return null — we'll use plain text
-      console.warn("[pi-diff] Shiki highlighter failed to load:", err);
       shikiInitPromise = null;
       return null;
     }

package/src/diff/renderer.ts

@@ -3,12 +3,17 @@
  *
  * ANSI diff rendering: split (side-by-side) and unified (stacked) views.
  * Includes ANSI utilities, background injection, and adaptive wrapping.
+ *
+ * IMPORTANT: All output lines must be truncated to terminal width
+ * to prevent TUI crashes. Use fit() or truncateToTermWidth()
+ * before pushing lines.
  */
 
 import type { ParsedDiff, DiffLine } from "./parser.js";
 import type { DiffColors } from "./theme.js";
 import { hexToBgAnsi, hexToFgAnsi } from "./theme.js";
 import { hlBlock, detectLanguage } from "./highlighter.js";
+import { truncateToWidth as piTruncateToWidth, visibleWidth as piVisibleWidth } from "@mariozechner/pi-tui";
 
 // ─── Constants ──────────────────────────────────────────────────────────────────
 
@@ -36,64 +41,21 @@ export function strip(s: string): string {
 
 /**
  * Get the visible width of a string (excluding ANSI escapes).
- * Handles CJK characters (width 2) and emoji.
+ * Delegates to pi-tui's ANSI-aware implementation for correctness.
  */
 export function visibleWidth(s: string): number {
-  const stripped = strip(s);
-  let width = 0;
-  for (const char of stripped) {
-    const code = char.codePointAt(0)!;
-    // CJK Unified Ideographs, CJK Compatibility, etc.
-    if (
-      (code >= 0x4e00 && code <= 0x9fff) ||
-      (code >= 0x3000 && code <= 0x30ff) ||
-      (code >= 0xff00 && code <= 0xffef) ||
-      (code >= 0xf900 && code <= 0xfaff) ||
-      (code >= 0x2e80 && code <= 0x2eff) ||
-      (code >= 0x3400 && code <= 0x4dbf) ||
-      (code >= 0x20000 && code <= 0x2a6df)
-    ) {
-      width += 2;
-    } else if (code > 0xffff) {
-      // Surrogate pairs / emoji — typically width 2
-      width += 2;
-    } else {
-      width += 1;
-    }
-  }
-  return width;
+  return piVisibleWidth(s);
 }
 
 /**
  * Fit a string to a target width, padding or truncating as needed.
- * Preserves ANSI state across truncation.
+ * Uses pi-tui's ANSI-aware truncation for correctness.
  */
 export function fit(s: string, targetWidth: number): string {
   const vw = visibleWidth(s);
   if (vw === targetWidth) return s;
   if (vw > targetWidth) {
-    // Truncate — find the cut point
-    let width = 0;
-    let i = 0;
-    const stripped = strip(s);
-    for (; i < stripped.length && width < targetWidth; i++) {
-      const code = stripped.codePointAt(i)!;
-      width += (code >= 0x4e00 && code <= 0x9fff) || code > 0xffff ? 2 : 1;
-    }
-    // Find the corresponding position in the original (with ANSI) string
-    let strippedIdx = 0;
-    let origIdx = 0;
-    while (origIdx < s.length && strippedIdx < i) {
-      if (s[origIdx] === "\x1b") {
-        // Skip ANSI sequence
-        while (origIdx < s.length && s[origIdx] !== "m") origIdx++;
-        origIdx++;
-      } else {
-        strippedIdx++;
-        origIdx++;
-      }
-    }
-    return s.substring(0, origIdx) + "\x1b[0m";
+    return piTruncateToWidth(s, targetWidth, "");
   }
   // Pad
   return s + " ".repeat(targetWidth - vw);
@@ -198,6 +160,17 @@ export function termW(): number {
   }
 }
 
+/**
+ * Truncate a line to terminal width using pi-tui's ANSI-aware truncation.
+ * Prevents TUI crash when rendered lines exceed terminal width.
+ * Accounts for rendering overhead from Box nesting (~6 chars).
+ */
+export function truncateToTermWidth(line: string): string {
+  const maxW = Math.max(20, termW() - 6);
+  if (piVisibleWidth(line) <= maxW) return line;
+  return piTruncateToWidth(line, maxW, "…");
+}
+
 // ─── Background Injection ───────────────────────────────────────────────────────
 
 /**
@@ -313,16 +286,16 @@ export function renderUnified(
 
     switch (line.type) {
       case "hunk":
-        lines.push(`${hunkFg}${line.content}${reset}`);
+        lines.push(truncateToTermWidth(`${hunkFg}${line.content}${reset}`));
         break;
       case "add":
-        lines.push(`${addBg}${addFg}+${reset}${addBg} ${lnum(null, 4)} ${lnum(line.newLine, 4)} │ ${line.content}${reset}`);
+        lines.push(truncateToTermWidth(`${addBg}${addFg}+${reset}${addBg} ${lnum(null, 4)} ${lnum(line.newLine, 4)} │ ${line.content}${reset}`));
         break;
       case "remove":
-        lines.push(`${remBg}${remFg}-${reset}${remBg} ${lnum(line.oldLine, 4)} ${lnum(null, 4)} │ ${line.content}${reset}`);
+        lines.push(truncateToTermWidth(`${remBg}${remFg}-${reset}${remBg} ${lnum(line.oldLine, 4)} ${lnum(null, 4)} │ ${line.content}${reset}`));
         break;
       case "context":
-        lines.push(` ${headerFg}${lnum(line.oldLine, 4)} ${lnum(line.newLine, 4)}${reset} │ ${line.content}`);
+        lines.push(truncateToTermWidth(` ${headerFg}${lnum(line.oldLine, 4)} ${lnum(line.newLine, 4)}${reset} │ ${line.content}`));
         break;
     }
   }
@@ -411,7 +384,7 @@ export function renderSplit(
   for (let i = 0; i < leftLines.length; i++) {
     const left = leftLines[i];
     const right = rightLines[i];
-    lines.push(`${left} │ ${right}`);
+    lines.push(truncateToTermWidth(`${left} │ ${right}`));
   }
 
   if (truncated) {

package/src/diff/wrapper.ts

@@ -12,10 +12,11 @@
 import * as fs from "node:fs";
 import * as path from "node:path";
 import type { ExtensionAPI, ToolDefinition, AgentToolResult } from "@mariozechner/pi-coding-agent";
+import { visibleWidth as piVisibleWidth, truncateToWidth as piTruncateToWidth } from "@mariozechner/pi-tui";
 import { readDiffSettings } from "./settings.js";
 import { parseDiff } from "./parser.js";
 import { resolveDiffColors, applyDiffPalette } from "./theme.js";
-import { renderSplit, renderUnified, termW, SPLIT_MIN_WIDTH } from "./renderer.js";
+import { renderSplit, renderUnified, termW, SPLIT_MIN_WIDTH, truncateToTermWidth } from "./renderer.js";
 import { detectLanguageFromPath, hlBlock, MAX_HL_CHARS } from "./highlighter.js";
 
 // ─── Types ──────────────────────────────────────────────────────────────────────
@@ -157,7 +158,15 @@ export function registerEnhancedWriteTool(pi: ExtensionAPI, cwd: string): void {
     renderResult(result: any, _options: any, theme: any): any {
       const details = result?.details as DiffToolDetails | undefined;
       if (!details || !details.diff || !details.diff.lines || details.diff.lines.length === 0) {
-        return null as any;
+        // Error or empty-diff case: render the message from result.content so the
+        // user sees "Could not find text to replace..." etc. Never return null here
+        // because Container.render() will crash on null child.
+        const msg = result?.content?.[0]?.text ?? "";
+        return {
+          setText: () => {},
+          text: msg,
+          render: (width: number) => (width > 0 ? [msg.slice(0, width)] : [msg]),
+        } as any;
       }
 
       try {
@@ -169,14 +178,34 @@ export function registerEnhancedWriteTool(pi: ExtensionAPI, cwd: string): void {
           ? renderSplit(details.diff, details.language, max, dc)
           : renderUnified(details.diff, details.language, max, dc);
 
-        // Return a simple component-like object with text
+        // Split into lines and cache for width-aware rendering.
+        // Each line is already truncated to terminal width by
+        // truncateToTermWidth() in the renderer, but we also
+        // respect the width parameter from Box.render().
+        const cachedLines = rendered.split("\n");
+
         return {
           setText: () => {},
           text: rendered,
-          render: () => rendered.split("\n"),
+          render: (width: number) => {
+            // If width is provided, re-truncate lines that
+            // still exceed it (e.g., inside nested Boxes)
+            const maxW = width > 0 ? width : tw;
+            return cachedLines.map((line: string) => {
+              if (piVisibleWidth(line) > maxW) {
+                return piTruncateToWidth(line, maxW, "…");
+              }
+              return line;
+            });
+          },
         } as any;
       } catch {
-        return null as any;
+        const fallback = "(diff rendering failed)";
+        return {
+          setText: () => {},
+          text: fallback,
+          render: (width: number) => (width > 0 ? [fallback.slice(0, width)] : [fallback]),
+        } as any;
       }
     },
   });
@@ -262,7 +291,15 @@ export function registerEnhancedEditTool(pi: ExtensionAPI, cwd: string): void {
     renderResult(result: any, _options: any, theme: any): any {
       const details = result?.details as DiffToolDetails | undefined;
       if (!details || !details.diff || !details.diff.lines || details.diff.lines.length === 0) {
-        return null as any;
+        // Error or empty-diff case: render the message from result.content so the
+        // user sees "Could not find text to replace..." etc. Never return null here
+        // because Container.render() will crash on null child.
+        const msg = result?.content?.[0]?.text ?? "";
+        return {
+          setText: () => {},
+          text: msg,
+          render: (width: number) => (width > 0 ? [msg.slice(0, width)] : [msg]),
+        } as any;
       }
 
       try {
@@ -274,13 +311,28 @@ export function registerEnhancedEditTool(pi: ExtensionAPI, cwd: string): void {
           ? renderSplit(details.diff, details.language, max, dc)
           : renderUnified(details.diff, details.language, max, dc);
 
+        const cachedLines = rendered.split("\n");
+
         return {
           setText: () => {},
           text: rendered,
-          render: () => rendered.split("\n"),
+          render: (width: number) => {
+            const maxW = width > 0 ? width : tw;
+            return cachedLines.map((line: string) => {
+              if (piVisibleWidth(line) > maxW) {
+                return piTruncateToWidth(line, maxW, "…");
+              }
+              return line;
+            });
+          },
         } as any;
       } catch {
-        return null as any;
+        const fallback = "(diff rendering failed)";
+        return {
+          setText: () => {},
+          text: fallback,
+          render: (width: number) => (width > 0 ? [fallback.slice(0, width)] : [fallback]),
+        } as any;
       }
     },
   });