@xynogen/pix-hunk 0.1.2 → 0.2.1

package/README.md

@@ -1,4 +1,4 @@
-# @xynogen/pix-hunk
+# pix-hunk
 
 Pi tool for driving a live [Hunk](https://github.com/modem-dev/hunk) diff review.
 One `hunk` call accepts ordered `ops[]`, so an agent can inspect, navigate,
@@ -7,7 +7,10 @@ quoting.
 
 ## Requirements
 
-Install Hunk and launch its interactive TUI in another terminal. This extension
+Launch Hunk's interactive TUI in another terminal. If `hunk` isn't found
+(`~/.pi/agent/binary.json` → `~/.pi/agent/bin` → `PATH`), pix downloads the
+official `modem-dev/hunk` release on first use and verifies it against
+`SHA256SUMS`, with a visible status. This extension
 only calls `hunk session *`; it never starts `hunk diff`, `show`, `patch`, or
 another interactive command.
 
@@ -54,20 +57,33 @@ Model-facing output defaults to 10,000 characters. Set `maxCharacters` between
 quota, so a large patch cannot hide later results. Full structured results
 remain available in tool details for inspection.
 
+## Scope ceiling
+
+`comment apply`, STML markup, and comment clearing are intentionally omitted.
+Use Hunk's CLI directly until repeated demand justifies extending the schema.
+
 ## Install
 
 ```bash
 pi install npm:@xynogen/pix-hunk
 ```
 
-Standalone/opt-in: Hunk and a live local review session are required, so this
-package is not bundled by `@xynogen/pix-core`.
+> Standalone and opt-in. [`@xynogen/pix-core`](https://www.npmjs.com/package/@xynogen/pix-core) does not bundle it. It needs the external Hunk CLI and a live review session.
 
-## Scope ceiling
+## Full distro
 
-`comment apply`, STML markup, and comment clearing are intentionally omitted.
-Use Hunk's CLI directly until repeated demand justifies extending the schema.
+This package is part of [Pix](https://github.com/xynogen/pix-mono). The installer sets up Pi and the full distro. See [Install](https://github.com/xynogen/pix-mono#install) for the notes for each OS.
+
+```bash
+# Linux / macOS
+curl -fsSL https://raw.githubusercontent.com/xynogen/pix-mono/main/scripts/install.sh | sh
+```
+
+```powershell
+# Windows
+irm https://raw.githubusercontent.com/xynogen/pix-mono/main/scripts/install.ps1 | iex
+```
 
 ## License
 
-MIT
+MIT. See [LICENSE](LICENSE).

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@xynogen/pix-hunk",
-	"version": "0.1.2",
-	"description": "Pi tool — drive live Hunk diff reviews with ordered bulk operations",
+	"version": "0.2.1",
+	"description": "Pi tool \u2014 drive live Hunk diff reviews with ordered bulk operations",
 	"type": "module",
 	"main": "src/index.ts",
 	"exports": {
@@ -44,11 +44,11 @@
 		"access": "public"
 	},
 	"dependencies": {
-		"@xynogen/pix-pretty": "^1.25.0",
-		"@xynogen/pix-runtime": "^0.8.1",
-		"typebox": "^1.1.38"
+		"@xynogen/pix-pretty": "^1.30.0",
+		"@xynogen/pix-runtime": "^0.13.0"
 	},
 	"peerDependencies": {
+		"typebox": "*",
 		"@earendil-works/pi-coding-agent": "*",
 		"@earendil-works/pi-tui": "*"
 	}

package/src/index.ts

@@ -1,13 +1,16 @@
-import { execFile } from "node:child_process";
 import type { ExtensionAPI } from "@earendil-works/pi-coding-agent";
 import { Text } from "@earendil-works/pi-tui";
+import { reportToolStatus, type ToolStatusUI } from "@xynogen/pix-pretty/tool-status";
 import {
 	dotJoin,
 	formatCollapsedToolRow,
+	formatToolCallTitle,
 	frameToolResult,
+	getErrorMessage,
 	hideCollapsedToolCall,
 } from "@xynogen/pix-pretty/utils";
 import { type CollapseState, tickCollapse } from "@xynogen/pix-runtime/collapse";
+import { runTool } from "@xynogen/pix-runtime/exec";
 import { Type } from "typebox";
 import {
 	buildHunkArgs,
@@ -26,22 +29,29 @@ export interface HunkRunResult {
 	code: number;
 }
 
-export type HunkRunner = (args: string[], signal?: AbortSignal) => Promise<HunkRunResult>;
-
-export const runHunk: HunkRunner = (args, signal) =>
-	new Promise((resolve, reject) => {
-		execFile("hunk", args, { maxBuffer: MAX_OUTPUT_BYTES, signal }, (error, stdout, stderr) => {
-			if (error && signal?.aborted) {
-				reject(error);
-				return;
-			}
-			resolve({
-				stdout,
-				stderr: stderr || error?.message || "",
-				code: typeof error?.code === "number" ? error.code : error ? 1 : 0,
-			});
-		});
+export type HunkRunner = (
+	args: string[],
+	signal?: AbortSignal,
+	ui?: ToolStatusUI,
+) => Promise<HunkRunResult>;
+
+/**
+ * Default runner: resolve hunk via pix-runtime (binary.json → agent bin →
+ * PATH), downloading the official release on first use with a visible status.
+ * runTool also runs the npm `hunk.cmd` shim on Windows. A missing binary
+ * throws BinaryMissingError carrying the install hint.
+ */
+export const runHunk: HunkRunner = async (args, signal, ui) => {
+	const r = await runTool("hunk", args, {
+		signal,
+		onStatus: reportToolStatus(ui),
+		maxBuffer: MAX_OUTPUT_BYTES,
 	});
+	if (signal?.aborted) throw signal.reason ?? new Error("aborted");
+	if (r.truncated)
+		return { stdout: r.stdout, stderr: `hunk output exceeded ${MAX_OUTPUT_BYTES} bytes`, code: 1 };
+	return { stdout: r.stdout, stderr: r.stderr, code: r.code ?? 1 };
+};
 
 type JsonValue = null | boolean | number | string | JsonValue[] | { [key: string]: JsonValue };
 
@@ -361,10 +371,7 @@ function modelText(results: HunkOperationResult[], ops: ToolOp[], maxCharacters:
 }
 
 function executionError(run: HunkRunResult): string {
-	const raw = (run.stderr || run.stdout || `hunk exited ${run.code}`).trim();
-	return /(?:^|\s)(?:spawn\s+)?hunk\s+ENOENT(?:\s|$)/i.test(raw)
-		? "Hunk CLI not found. Install Hunk, launch a review session, then retry."
-		: raw;
+	return (run.stderr || run.stdout || `hunk exited ${run.code}`).trim();
 }
 
 function actionSummary(actions: HunkAction[]): string {
@@ -440,6 +447,7 @@ function renderExpanded(details: HunkResultDetails, theme: HunkTheme): string {
 export default function registerHunk(pi: ExtensionAPI, runner: HunkRunner = runHunk): void {
 	pi.registerTool({
 		name: "hunk",
+		...({ exposure: "deferred" } as const),
 		label: "Hunk",
 		renderShell: "self",
 		description:
@@ -472,7 +480,7 @@ export default function registerHunk(pi: ExtensionAPI, runner: HunkRunner = runH
 				return text;
 			const actions = ((args as { ops?: ToolOp[] }).ops ?? []).map((op) => op.action);
 			text.setText(
-				`${theme.fg("toolTitle", theme.bold("hunk"))} ${theme.fg("dim", actionSummary(actions))}`,
+				`${formatToolCallTitle(theme, "hunk", context)} ${theme.fg("dim", actionSummary(actions))}`,
 			);
 			return text;
 		},
@@ -483,14 +491,11 @@ export default function registerHunk(pi: ExtensionAPI, runner: HunkRunner = runH
 				text.setText(
 					result.content.flatMap((part) => (part.type === "text" ? [part.text] : [])).join("\n"),
 				);
-				return text;
+				return options.isPartial ? text : frameToolResult(text, theme, context.isError);
 			}
-			const collapsed = tickCollapse(
-				"hunk",
-				context.state as CollapseState,
-				context.invalidate,
-				options.expanded,
-			);
+			const collapsed =
+				!options.isPartial &&
+				tickCollapse("hunk", context.state as CollapseState, context.invalidate, options.expanded);
 			if (collapsed) {
 				text.setText(renderSummary(details, theme as HunkTheme));
 				return text;
@@ -505,7 +510,7 @@ export default function registerHunk(pi: ExtensionAPI, runner: HunkRunner = runH
 			const results: HunkOperationResult[] = [];
 			for (const op of ops) {
 				try {
-					const run = await runner(buildHunkArgs(op, ctx.cwd), signal);
+					const run = await runner(buildHunkArgs(op, ctx.cwd), signal, ctx.ui);
 					results.push(
 						run.code === 0
 							? { action: op.action, ok: true, data: parseOutput(run.stdout || run.stderr) }
@@ -516,7 +521,7 @@ export default function registerHunk(pi: ExtensionAPI, runner: HunkRunner = runH
 					results.push({
 						action: op.action,
 						ok: false,
-						error: error instanceof Error ? error.message : String(error),
+						error: getErrorMessage(error),
 					});
 				}
 			}