@xynogen/pix-pretty 1.19.0 → 1.20.1

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@xynogen/pix-pretty",
-	"version": "1.19.0",
+	"version": "1.20.1",
 	"description": "Enhanced tool output rendering with syntax highlighting, file icons, tree views, diff rendering, and FFF search",
 	"type": "module",
 	"main": "src/index.ts",
@@ -25,13 +25,15 @@
 		"./resize": "./src/resize.ts",
 		"./context": "./src/tools/context.ts",
 		"./gate-overlay": "./src/gate-overlay.ts",
-		"./modal-frame": "./src/modal-frame.ts"
+		"./modal-frame": "./src/modal-frame.ts",
+		"./test-utils": "./src/test-utils.ts"
 	},
 	"scripts": {
 		"test": "bun test"
 	},
 	"files": [
 		"src",
+		"!src/**/*.test.*",
 		"README.md",
 		"LICENSE"
 	],
@@ -62,7 +64,7 @@
 		"@xynogen/pix-runtime": "^0.8.0",
 		"chalk": "^4.1.2",
 		"cli-highlight": "^2.1.11",
-		"@ff-labs/fff-node": "^0.5.2",
+		"@ff-labs/fff-node": "^0.10.6",
 		"diff": "^8.0.3"
 	},
 	"peerDependencies": {

package/src/test-utils.ts

@@ -0,0 +1,100 @@
+// Shared test harness for tool renderers. Test-only — every pix tool package
+// rebuilt these same mocks (MockTextComponent, capture-pi, theme, render ctx)
+// by hand; this collapses them to one import. Pure and Pi-host-agnostic.
+
+import type { CursorStore, FffState } from "./fff.js";
+import type { ToolContext } from "./tools/context.js";
+import type { PiPrettyApi, RenderContextLike, TextComponentCtor, ThemeLike } from "./types.js";
+
+/** In-memory TextComponent: stores text, splits on render. */
+export class MockTextComponent {
+	private text: string;
+	constructor(text = "") {
+		this.text = text;
+	}
+	setText(value: string): void {
+		this.text = value;
+	}
+	getText(): string {
+		return this.text;
+	}
+	render(_width?: number): string[] {
+		return this.text.split("\n");
+	}
+	invalidate(): void {}
+}
+
+/** The tool object a registrar hands to `registerTool`, with the render hooks tests poke. */
+export interface CapturedTool {
+	name?: string;
+	renderCall?: (...args: unknown[]) => MockTextComponent;
+	renderResult?: (...args: unknown[]) => MockTextComponent;
+	[key: string]: unknown;
+}
+
+/**
+ * A PiPrettyApi that captures every registered tool. `tool` is the last one
+ * registered (Object.assign'd so render hooks are directly callable); `names`
+ * lists all registered tool names in order.
+ */
+export function capturePi(): { pi: PiPrettyApi; tool: CapturedTool; names: string[] } {
+	const tool: CapturedTool = {};
+	const names: string[] = [];
+	const pi: PiPrettyApi = {
+		registerTool(t: unknown) {
+			const name = (t as { name?: string }).name;
+			if (name) names.push(name);
+			Object.assign(tool, t);
+		},
+		registerCommand() {},
+		on() {},
+	};
+	return { pi, tool, names };
+}
+
+/** Build the ToolContext every registrar expects; override any field. */
+export function makeToolContext(overrides: Partial<ToolContext> = {}): ToolContext {
+	return {
+		cwd: process.cwd(),
+		sp: (p: string) => p,
+		// SAFETY: MockTextComponent implements the setText/getText/render/invalidate surface
+		// TextComponentCtor requires; the ctor arity differs but callers only use `new C(text)`.
+		TextComponent: MockTextComponent as unknown as TextComponentCtor,
+		fffState: { module: null, finder: null, partialIndex: false, dbDir: null } as FffState,
+		// SAFETY: tool renderers only call store()/get() on the cursor store; this stub covers both.
+		cursorStore: { store: () => "", get: () => undefined } as unknown as CursorStore,
+		...overrides,
+	};
+}
+
+/**
+ * Theme mock. Default is passthrough (`fg`/`bold` return the raw value).
+ * Pass `tag: true` to wrap `dim`/`muted` foregrounds as `<key>value</key>`,
+ * which lets tests assert on visual-hierarchy roles.
+ */
+export function makeTheme({ tag = false }: { tag?: boolean } = {}): ThemeLike {
+	return {
+		fg: (key: string, value: string) =>
+			tag && (key === "dim" || key === "muted") ? `<${key}>${value}</${key}>` : value,
+		bold: (value: string) => value,
+	};
+}
+
+/**
+ * Build a RenderContextLike with sane defaults; override expanded/isError/state/etc.
+ * `state` is intentionally loose (`Record<string, unknown>`) because renderers stash
+ * booleans/numbers/timers there at runtime that the strict `state` type doesn't model.
+ */
+export function makeRenderCtx(
+	overrides: Partial<Omit<RenderContextLike, "state">> & { state?: Record<string, unknown> } = {},
+): RenderContextLike {
+	// SAFETY: loose state bag matches runtime renderer usage; the strict RenderContextLike
+	// state type only lists string keys, but renderers read/write timers and flags there.
+	return {
+		expanded: false,
+		isError: false,
+		invalidate: () => {},
+		state: {},
+		...overrides,
+	} as unknown as RenderContextLike;
+}

package/src/utils.ts

@@ -24,7 +24,7 @@ import type {
 } from "./types.js";
 
 export function renderToolError(error: string, theme: FgTheme): string {
-	return fillToolBackground(`\n${theme.fg("error", error)}`, BG_ERROR);
+	return fillToolBackground(theme.fg("error", error), BG_ERROR);
 }
 
 export function normalizeLineEndings(text: string): string {
@@ -324,8 +324,13 @@ export function renderCollapsedToolRow(
 	target: string,
 	meta = "",
 	status: CollapsedToolStatus = "success",
+	width?: number,
 ): string {
-	return fillToolBackground(formatCollapsedToolRow(theme, tool, target, meta, status));
+	return fillToolBackground(
+		formatCollapsedToolRow(theme, tool, target, meta, status),
+		BG_BASE,
+		width,
+	);
 }
 
 /** Hide renderCall after its paired result has auto-collapsed. */

package/src/ansi.test.ts

@@ -1,12 +0,0 @@
-import { describe, expect, test } from "bun:test";
-import * as ansi from "./ansi.ts";
-import { resolveBaseBackground } from "./ansi.ts";
-
-describe("tool surfaces", () => {
-	test("always preserves terminal background", () => {
-		resolveBaseBackground({ getBgAnsi: () => "\x1b[48;2;10;20;30m" });
-		expect(ansi.BG_BASE).toBe("\x1b[49m");
-		expect(ansi.BG_ERROR).toBe("\x1b[49m");
-		expect(ansi.RST).toBe("\x1b[0m");
-	});
-});

package/src/dependency-security.test.ts

@@ -1,32 +0,0 @@
-import { describe, expect, it } from "bun:test";
-import { readFileSync } from "node:fs";
-import { dirname, join } from "node:path";
-import { fileURLToPath } from "node:url";
-
-const packageRoot = dirname(dirname(fileURLToPath(import.meta.url)));
-const repoRoot = dirname(dirname(packageRoot));
-
-interface PackageManifest {
-	dependencies?: Record<string, string>;
-	overrides?: Record<string, string>;
-}
-
-function readManifest(path: string): PackageManifest {
-	try {
-		return JSON.parse(readFileSync(path, "utf8")) as PackageManifest;
-	} catch (cause) {
-		throw new Error(`Unable to read package manifest: ${path}`, { cause });
-	}
-}
-
-describe("dependency security floors", () => {
-	it("uses a jsdiff release without GHSA-73rr-hh4g-fpgx", () => {
-		const manifest = readManifest(join(packageRoot, "package.json"));
-		expect(manifest.dependencies?.diff).toBe("^8.0.3");
-	});
-
-	it("pins protobufjs above GHSA-j3f2-48v5-ccww", () => {
-		const manifest = readManifest(join(repoRoot, "package.json"));
-		expect(manifest.overrides?.protobufjs).toBe("7.6.5");
-	});
-});

package/src/diff.test.ts

@@ -1,117 +0,0 @@
-import { describe, expect, it } from "bun:test";
-import { parseDiff } from "./diff.js";
-import {
-	DEFAULT_DIFF_COLORS,
-	diffThemeCacheKey,
-	renderDiffSummary,
-	renderUnified,
-	resolveDiffColors,
-} from "./diff-render.js";
-
-const OLD = "line1\nline2\nline3";
-const NEW = "line1\nCHANGED\nline3";
-const ANSI_RE = /\x1b\[[0-9;]*m|<\/?syntax\w+>/g;
-
-describe("theme-derived diff rendering", () => {
-	const theme = {
-		fg: (key: string, text: string) => `<${key}>${text}</${key}>`,
-		getFgAnsi: (key: string) => {
-			if (key === "toolDiffAdded") return "\x1b[38;2;120;210;150m";
-			if (key === "toolDiffRemoved") return "\x1b[38;2;230;120;130m";
-			if (key === "toolDiffContext") return "\x1b[38;2;130;140;150m";
-			return "";
-		},
-	};
-
-	it("uses semantic foregrounds", () => {
-		const colors = resolveDiffColors(theme);
-		expect(colors.fgAdd).toBe("\x1b[38;2;120;210;150m");
-		expect(colors.fgDel).toBe("\x1b[38;2;230;120;130m");
-		expect(colors.fgCtx).toBe("\x1b[38;2;130;140;150m");
-	});
-
-	// Regression: these six slots were all set to BG_BASE (\x1b[49m), which
-	// dropped the faint green/red row tint and left only the gutter chips
-	// colored. A diff must read as add/remove bands at a glance.
-	it("gives changed rows a faint tint background", () => {
-		for (const colors of [DEFAULT_DIFF_COLORS, resolveDiffColors(theme)]) {
-			for (const key of [
-				"bgAdd",
-				"bgDel",
-				"bgAddHighlight",
-				"bgDelHighlight",
-				"bgGutterAdd",
-				"bgGutterDel",
-			] as const) {
-				expect(colors[key]).not.toBe("\x1b[49m");
-				expect(colors[key]).toMatch(/^\x1b\[48;2;\d+;\d+;\d+m$/);
-			}
-			// Word-diff emphasis must be distinguishable from the row tint.
-			expect(colors.bgAddHighlight).not.toBe(colors.bgAdd);
-			expect(colors.bgDelHighlight).not.toBe(colors.bgDel);
-			// Add and remove must never collide.
-			expect(colors.bgAdd).not.toBe(colors.bgDel);
-		}
-	});
-
-	it("includes semantic theme colors in cache identity", () => {
-		const changed = { ...theme, getFgAnsi: () => "\x1b[38;2;1;2;3m" };
-		expect(diffThemeCacheKey(theme)).not.toBe(diffThemeCacheKey(changed));
-	});
-
-	it("colors persisted plain summaries only at render time", () => {
-		expect(renderDiffSummary("+3 -2", theme)).toBe(
-			"<toolDiffAdded>+3</toolDiffAdded> <toolDiffRemoved>-2</toolDiffRemoved>",
-		);
-		expect(renderDiffSummary("no changes", theme)).toBe(
-			"<toolDiffContext>no changes</toolDiffContext>",
-		);
-	});
-
-	it("emits tint backgrounds on changed rows", async () => {
-		const rendered = await renderUnified(
-			parseDiff("const oldValue = 1;", "const newValue = 2;"),
-			"typescript",
-			80,
-			resolveDiffColors({ ...theme, fg: (_key, text) => text }),
-		);
-		const { bgAdd, bgDel } = resolveDiffColors(theme);
-		expect(rendered).toContain(bgDel);
-		expect(rendered).toContain(bgAdd);
-	});
-
-	it("keeps gutter numbering and rule layout intact", async () => {
-		const rendered = await renderUnified(
-			parseDiff("const oldValue = 1;", "const newValue = 2;"),
-			"typescript",
-			80,
-			resolveDiffColors({ ...theme, fg: (_key, text) => text }),
-		);
-		const lines = rendered.replace(ANSI_RE, "").split("\n");
-
-		expect(lines).toHaveLength(4);
-		expect(lines[0]).toMatch(/^─+$/);
-		expect(lines[1]).toMatch(/^▌\s+1- │ const oldValue = 1;\s*$/);
-		expect(lines[2]).toMatch(/^▌\s+1\+ │ const newValue = 2;\s*$/);
-		expect(lines[3]).toMatch(/^─+$/);
-		expect(rendered).toContain(theme.getFgAnsi("toolDiffRemoved"));
-		expect(rendered).toContain(theme.getFgAnsi("toolDiffAdded"));
-	});
-});
-
-describe("parseDiff baseLine", () => {
-	it("is snippet-relative when baseLine omitted (default 0)", () => {
-		const { lines } = parseDiff(OLD, NEW);
-		const del = lines.find((l) => l.type === "del");
-		expect(del?.oldNum).toBe(2); // line2 is the 2nd line of the snippet
-	});
-
-	it("shifts gutter numbers to absolute when baseLine given", () => {
-		// Snippet begins at file line 84 → snippet line 2 becomes file line 85.
-		const { lines } = parseDiff(OLD, NEW, 3, 84);
-		const del = lines.find((l) => l.type === "del");
-		const add = lines.find((l) => l.type === "add");
-		expect(del?.oldNum).toBe(85);
-		expect(add?.newNum).toBe(85);
-	});
-});