pi-zentui 0.7.0 → 0.8.0

package/README.md

@@ -35,6 +35,7 @@ Zentui brings two popular aesthetics to Pi:
 - Configurable model, provider, and thinking-level indicator colors
 - Prompt-box-style user messages matching the ZentUI input chrome
 - Copy-friendly mode hides editor and previous-message rail glyphs so terminal selection copies less chrome
+- **Fixed editor** (experimental, opt-in): Pin the editor and footer at the bottom of the terminal while the transcript scrolls above
 
 ### Git Status Icons
 
@@ -143,6 +144,9 @@ Useful slash-command shortcuts:
 /zentui copy-friendly enable
 /zentui copy-friendly disable
 /zentui copy-friendly toggle
+/zentui fixed-editor enable
+/zentui fixed-editor disable
+/zentui fixed-editor toggle
 /zentui format "$cwd on branch $git_branch$git_status using $runtime $fill $context"
 /zentui format clear
 ```
@@ -256,6 +260,11 @@ Default config values — copy this and change any value you want:
 		"defaultPlacement": "right",
 		"placements": {},
 		"colorModes": {}
+	},
+	"fixedEditor": {
+		"enabled": false,
+		"mouseScroll": true,
+		"copyNotice": true
 	}
 }
 ```
@@ -342,9 +351,59 @@ Center the branch between directory and cost:
 - Unknown `$variables` render empty.
 - Set or clear at runtime: `/zentui format "<template>"` and `/zentui format clear`.
 
+## Fixed editor (experimental, opt-in)
+
+The fixed editor pins the Zentui editor and footer at the bottom of the terminal while the transcript scrolls above. This enables composing follow-up messages while referencing earlier conversation history.
+
+### How to enable
+
+```text
+/zentui fixed-editor enable
+```
+
+Or in `~/.pi/agent/zentui.json`:
+
+```json
+{
+	"fixedEditor": {
+		"enabled": true
+	}
+}
+```
+
+### Keyboard controls
+
+| Key | Action |
+| --- | ------ |
+| `PageUp` / `PageDown` | Scroll transcript one viewport up/down |
+| `Ctrl+Shift+↑` / `Ctrl+Shift+↓` | Scroll transcript up/down (Kitty protocol variants supported) |
+| `Enter` | Jump to bottom (and submit message) |
+
+### Mouse scroll (default on)
+
+Mouse wheel scrolling is enabled by default when the fixed editor is on. Disable it via `/zentui` Features or:
+
+```json
+{
+	"fixedEditor": {
+		"enabled": true,
+		"mouseScroll": true
+	}
+}
+```
+
+**Warning**: Mouse scroll enables SGR mouse reporting, which disables native terminal text selection, URL click-through, and tmux/Herdr scrollback for the Pi session. Toggle off if you need those features.
+
+### Conflicts and limitations
+
+- **Incompatible with** `pi-powerline-footer`, `@tifan/pi-fixed-editor`, and `pi-sticky-input`. These packages patch the same Pi TUI internals; only one rendering owner can be active at a time.
+- **Alternate screen**: Uses the terminal's alternate screen buffer. Native scrollback history is not accessible while the fixed editor is active.
+- **Pi version fragility**: Patches internal TUI methods (`doRender`, `render`, `terminal.write`, `terminal.rows`) that may change across Pi versions. If the TUI layout is unsupported, Zentui falls back to normal rendering with a console warning.
+- If your terminal is stuck after a crash, run `reset` or restart the terminal.
+
 ## Requirements
 
-- [Pi](https://pi.dev) coding agent 0.79 or newer
+- [Pi](https://pi.dev) coding agent 0.80 or newer
 - A [Nerd Font](https://www.nerdfonts.com/) for icons (or set `icons.mode` to `"ascii"`)
 
 ## Development

package/extensions/zentui/config.ts

@@ -61,6 +61,12 @@ export type FooterSegmentsConfig = {
 	packageVersion: boolean;
 };
 
+export type FixedEditorConfig = {
+	enabled: boolean;
+	mouseScroll: boolean;
+	copyNotice: boolean;
+};
+
 export type ExtensionStatusPlacement = "off" | "left" | "middle" | "right";
 export type ExtensionStatusColorMode = "zentui" | "original";
 
@@ -139,6 +145,7 @@ export type PolishedTuiConfig = {
 	gitCommit: GitCommitConfig;
 	gitMetrics: GitMetricsConfig;
 	extensionStatuses: ExtensionStatusesConfig;
+	fixedEditor: FixedEditorConfig;
 };
 
 /**
@@ -257,6 +264,11 @@ export const defaultConfig: PolishedTuiConfig = {
 		placements: {},
 		colorModes: {},
 	},
+	fixedEditor: {
+		enabled: false,
+		mouseScroll: true,
+		copyNotice: true,
+	},
 };
 
 type ConfigRecord = Record<string, unknown>;
@@ -508,6 +520,21 @@ function normalizeExtensionStatuses(record: Record<string, unknown>): ExtensionS
 	};
 }
 
+function normalizeFixedEditorConfig(record: Record<string, unknown>): FixedEditorConfig {
+	return {
+		enabled:
+			typeof record.enabled === "boolean" ? record.enabled : defaultConfig.fixedEditor.enabled,
+		mouseScroll:
+			typeof record.mouseScroll === "boolean"
+				? record.mouseScroll
+				: defaultConfig.fixedEditor.mouseScroll,
+		copyNotice:
+			typeof record.copyNotice === "boolean"
+				? record.copyNotice
+				: defaultConfig.fixedEditor.copyNotice,
+	};
+}
+
 function isColorSourceKey(value: string): value is keyof ColorSourcesConfig {
 	return value === "starship" || value === "editor" || value === "userMessages";
 }
@@ -606,6 +633,9 @@ export function mergeConfig(parsed: unknown): PolishedTuiConfig {
 	const gitMetrics = isRecord(config.gitMetrics)
 		? normalizeGitMetricsConfig(config.gitMetrics as Record<string, unknown>)
 		: defaultConfig.gitMetrics;
+	const fixedEditor = isRecord(config.fixedEditor)
+		? normalizeFixedEditorConfig(config.fixedEditor as Record<string, unknown>)
+		: defaultConfig.fixedEditor;
 	return {
 		projectRefreshIntervalMs: parseProjectRefreshIntervalMs(config.projectRefreshIntervalMs),
 		footerFormat: stringValue(config, "footerFormat") ?? "",
@@ -627,6 +657,7 @@ export function mergeConfig(parsed: unknown): PolishedTuiConfig {
 			placements: { ...extensionStatuses.placements },
 			colorModes: { ...extensionStatuses.colorModes },
 		},
+		fixedEditor,
 	};
 }
 
@@ -812,3 +843,21 @@ export function saveExtensionStatusColorMode(
 	writeFileSync(path, `${JSON.stringify(record, null, 2)}\n`, "utf8");
 	return mergeConfig(record);
 }
+
+export function saveFixedEditorPatch(
+	patch: Partial<FixedEditorConfig>,
+	path = configPath,
+): PolishedTuiConfig {
+	const record = readConfigRecord(path);
+	const existing = isRecord(record.fixedEditor)
+		? { ...(record.fixedEditor as Record<string, unknown>) }
+		: {};
+	record.fixedEditor = {
+		...existing,
+		...(patch.enabled !== undefined ? { enabled: patch.enabled } : {}),
+		...(patch.mouseScroll !== undefined ? { mouseScroll: patch.mouseScroll } : {}),
+		...(patch.copyNotice !== undefined ? { copyNotice: patch.copyNotice } : {}),
+	};
+	writeFileSync(path, `${JSON.stringify(record, null, 2)}\n`, "utf8");
+	return mergeConfig(record);
+}

package/extensions/zentui/fixed-editor/cluster.ts

@@ -0,0 +1,194 @@
+/**
+ * Cluster discovery and rendering for the fixed editor.
+ *
+ * The "cluster" is the set of Pi TUI children around the editor that should be
+ * pinned at the bottom: status container, above-editor widget, editor,
+ * below-editor widget, and footer.
+ *
+ * @internal
+ */
+
+import { CURSOR_MARKER, truncateToWidth, visibleWidth } from "@earendil-works/pi-tui";
+
+import type { ClusterRender } from "./types";
+
+/** Minimal Component shape needed for rendering. */
+type Renderable = {
+	render(width: number): string[];
+	/** Saved original render when the compositor has patched render → [] */
+	__zentuiOriginalRender?: (width: number) => string[];
+};
+
+/** Minimal Container shape for child scanning. */
+type ContainerLike = Renderable & {
+	children: unknown[];
+};
+
+/** Check if a value is a container-like object (has children + render). */
+function isContainerLike(value: unknown): value is ContainerLike {
+	return (
+		typeof value === "object" &&
+		value !== null &&
+		Array.isArray(Reflect.get(value, "children")) &&
+		typeof Reflect.get(value, "render") === "function"
+	);
+}
+
+/** Check if a value looks like an editor component (duck-typed). */
+function isEditorLike(value: unknown): boolean {
+	return (
+		typeof value === "object" &&
+		value !== null &&
+		typeof Reflect.get(value, "getText") === "function" &&
+		typeof Reflect.get(value, "setText") === "function" &&
+		typeof Reflect.get(value, "handleInput") === "function"
+	);
+}
+
+/**
+ * Find the index in `children` of the container holding the editor.
+ * Prefers the focused component's parent; falls back to scanning for
+ * an editor-like grandchild.
+ */
+export function findEditorContainerIndex(
+	children: unknown[],
+	focusedComponent?: unknown,
+): number | undefined {
+	// Try focused component first.
+	if (focusedComponent && typeof focusedComponent === "object") {
+		const idx = children.findIndex(
+			(c) => isContainerLike(c) && c.children.includes(focusedComponent),
+		);
+		if (idx !== -1) return idx;
+	}
+
+	// Scan for a container with an editor-like child.
+	const idx = children.findIndex(
+		(c) => isContainerLike(c) && c.children.some((gc) => isEditorLike(gc)),
+	);
+	return idx === -1 ? undefined : idx;
+}
+
+/** The 5-component cluster pinned at the bottom. */
+export type FixedCluster = {
+	status: Renderable | null;
+	aboveWidget: Renderable | null;
+	editor: Renderable;
+	belowWidget: Renderable | null;
+	footer: Renderable | null;
+};
+
+/**
+ * Patch a cluster component's render to return [] (hide from transcript).
+ * Saves the original render for cluster painting.
+ */
+export function hideRenderable(component: Renderable | null): void {
+	if (!component || component.__zentuiOriginalRender) return;
+	component.__zentuiOriginalRender = component.render.bind(component);
+	component.render = () => [];
+}
+
+/** Restore a cluster component's original render. */
+export function restoreRenderable(component: Renderable | null): void {
+	if (!component?.__zentuiOriginalRender) return;
+	component.render = component.__zentuiOriginalRender;
+	delete component.__zentuiOriginalRender;
+}
+
+/** Build the cluster from children around the editor index. */
+export function buildCluster(children: unknown[], editorIdx: number): FixedCluster | null {
+	const editor = children[editorIdx];
+	if (!editor || typeof (editor as Renderable).render !== "function") return null;
+	return {
+		status: (children[editorIdx - 2] as Renderable | undefined) ?? null,
+		aboveWidget: (children[editorIdx - 1] as Renderable | undefined) ?? null,
+		editor: editor as Renderable,
+		belowWidget: (children[editorIdx + 1] as Renderable | undefined) ?? null,
+		footer: (children[editorIdx + 2] as Renderable | undefined) ?? null,
+	};
+}
+
+/** Render a component at `width`, using the saved original render if hidden. */
+function renderComponent(component: Renderable | null, width: number): string[] {
+	if (!component) return [];
+	const renderFn = component.__zentuiOriginalRender ?? component.render;
+	const lines = renderFn.call(component, width);
+	// Strip only trailing blank lines — internal blank lines (e.g. editor
+	// padding in copy-friendly mode) must be preserved.
+	let end = lines.length;
+	while (end > 0 && visibleWidth(lines[end - 1]) === 0) end--;
+	return lines.slice(0, Math.max(end, 1));
+}
+
+/**
+ * Cap editor lines to `maxLines`, keeping the cursor row visible.
+ * If the cursor marker is found, the window centers on it; otherwise
+ * the last `maxLines` are kept.
+ */
+export function capEditorLines(lines: string[], maxLines: number): string[] {
+	if (maxLines <= 0) return [];
+	if (lines.length <= maxLines) return lines;
+
+	const cursorRow = lines.findIndex((line) => line.includes(CURSOR_MARKER));
+	if (cursorRow !== -1) {
+		const start = Math.max(0, Math.min(cursorRow - maxLines + 1, lines.length - maxLines));
+		return lines.slice(start, start + maxLines);
+	}
+	return lines.slice(lines.length - maxLines);
+}
+
+function sanitizeLines(lines: string[], width: number): string[] {
+	return lines.map((line) =>
+		visibleWidth(line) > width ? truncateToWidth(line, width, "", true) : line,
+	);
+}
+
+/**
+ * Render the full cluster (status + widgets + editor + footer) and extract
+ * the cursor position from the CURSOR_MARKER.
+ */
+export function renderCluster(
+	cluster: FixedCluster,
+	width: number,
+	maxHeight: number,
+): ClusterRender {
+	const w = Math.max(1, width);
+	const maxRows = Math.max(1, maxHeight - 1);
+
+	const statusLines = sanitizeLines(renderComponent(cluster.status, w), w);
+	const aboveLines = sanitizeLines(renderComponent(cluster.aboveWidget, w), w);
+	const editorSource = sanitizeLines(renderComponent(cluster.editor, w), w);
+	const belowLines = sanitizeLines(renderComponent(cluster.belowWidget, w), w);
+	const footerLines = sanitizeLines(renderComponent(cluster.footer, w), w);
+
+	const editorLines = capEditorLines(editorSource, maxRows);
+	let remaining = maxRows - editorLines.length;
+
+	const footer = footerLines.slice(-remaining);
+	remaining -= footer.length;
+
+	const below = belowLines.slice(-remaining);
+	remaining -= below.length;
+
+	const above = aboveLines.slice(-remaining);
+	remaining -= above.length;
+
+	const status = statusLines.slice(-remaining);
+
+	let allLines = [...status, ...above, ...editorLines, ...below, ...footer];
+
+	// Strip leading blank lines (e.g. empty status line above the editor border).
+	let start = 0;
+	while (start < allLines.length - 1 && visibleWidth(allLines[start]) === 0) start++;
+	allLines = allLines.slice(start);
+
+	let cursor: { row: number; col: number } | null = null;
+	const cleaned = allLines.map((line, row) => {
+		const markerIndex = line.indexOf(CURSOR_MARKER);
+		if (markerIndex === -1) return line;
+		cursor ??= { row, col: visibleWidth(line.slice(0, markerIndex)) };
+		return line.slice(0, markerIndex) + line.slice(markerIndex + CURSOR_MARKER.length);
+	});
+
+	return { lines: cleaned, cursor };
+}