@diegopetrucci/pi-git-footer 0.1.0

package/.pi-fleet-tested-version

@@ -0,0 +1 @@
+0.78.0

package/README.md

@@ -0,0 +1,41 @@
+# git-footer
+
+A TLH-style git status footer for pi.
+
+This package is standalone-only and is not auto-loaded by the `@diegopetrucci/pi-extensions` collection package because only one custom footer should win.
+
+It replaces pi's built-in footer with a compact two-line layout whose first line mirrors how [`the-last-harness`](https://github.com/diegopetrucci/the-last-harness) summarizes repository state:
+
+```text
+<repo> • <branch> • <git-status> • PR #<number> • <session-name>
+ctx <percent>% • <model> <thinking> • <extension-statuses>
+```
+
+Git status indicators:
+
+- `!N`: conflicted paths
+- `+N`: staged paths
+- `~N`: unstaged paths
+- `?N`: untracked paths
+- `↑N`: commits ahead of upstream
+- `↓N`: commits behind upstream
+
+The extension polls git status in the background, caches the latest snapshot, and keeps footer rendering synchronous. It also performs a best-effort `gh pr view` lookup for the current branch; if `gh` is unavailable or the branch has no PR, the PR segment is omitted.
+
+## Install
+
+```bash
+pi install npm:@diegopetrucci/pi-git-footer
+```
+
+Then reload pi:
+
+```text
+/reload
+```
+
+## Notes
+
+- Replaces pi's built-in footer entirely.
+- Intended as a separate footer extension; do not enable it at the same time as another custom-footer extension such as `minimal-footer` unless you want the last-loaded footer to win.
+- `render()` never spawns subprocesses. Git and GitHub CLI lookups run on a short background interval with timeouts, and the footer reads only cached snapshots.

package/index.ts

@@ -0,0 +1,533 @@
+import { spawn } from "node:child_process";
+import { basename } from "node:path";
+import type { ExtensionAPI } from "@earendil-works/pi-coding-agent";
+import { truncateToWidth } from "@earendil-works/pi-tui";
+
+type GitStatusSnapshot = {
+	branch?: string;
+	staged: number;
+	unstaged: number;
+	untracked: number;
+	conflict: number;
+	ahead: number;
+	behind: number;
+};
+
+type PullRequestSnapshot = {
+	number?: number | string;
+	state?: string;
+	isDraft?: boolean;
+	url?: string;
+	title?: string;
+};
+
+type CommandResult = {
+	stdout: string;
+	stderr: string;
+	exitCode: number | null;
+};
+
+type CommandRunner = (
+	command: string,
+	args: readonly string[],
+	options: { cwd: string; signal: AbortSignal },
+) => Promise<CommandResult>;
+
+type TimerHandle = unknown;
+
+type Clock = {
+	setInterval(callback: () => void, ms: number): TimerHandle;
+	clearInterval(handle: TimerHandle): void;
+};
+
+type GitFooterCacheOptions = {
+	cwd: () => string;
+	runner?: CommandRunner;
+	clock?: Clock;
+	refreshIntervalMs?: number;
+	gitTimeoutMs?: number;
+	ghTimeoutMs?: number;
+	onChange?: () => void;
+	onBranchChangeSource?: (callback: () => void) => () => void;
+};
+
+const BRANCH_HEAD_PREFIX = "# branch.head ";
+const BRANCH_AB_PREFIX = "# branch.ab ";
+const FOOTER_SEPARATOR = " • ";
+const DEFAULT_REFRESH_INTERVAL_MS = 8_000;
+const DEFAULT_GIT_TIMEOUT_MS = 1_500;
+const DEFAULT_GH_TIMEOUT_MS = 3_000;
+const GIT_STATUS_ARGS = ["--no-optional-locks", "status", "--porcelain=v2", "--branch"] as const;
+const GH_PR_VIEW_ARGS = ["pr", "view", "--json", "number,state,isDraft,url,title"] as const;
+
+function createEmptyGitStatus(): GitStatusSnapshot {
+	return {
+		branch: undefined,
+		staged: 0,
+		unstaged: 0,
+		untracked: 0,
+		conflict: 0,
+		ahead: 0,
+		behind: 0,
+	};
+}
+
+function positiveCount(value: number): number {
+	return Number.isFinite(value) && value > 0 ? Math.trunc(value) : 0;
+}
+
+function addTrackedStatusCounts(status: GitStatusSnapshot, xy: string): void {
+	if (xy.length !== 2) return;
+	if (xy[0] !== ".") status.staged += 1;
+	if (xy[1] !== ".") status.unstaged += 1;
+}
+
+function parseBranchAheadBehind(line: string, status: GitStatusSnapshot): void {
+	const match = /^# branch\.ab \+(\d+) -(\d+)$/.exec(line);
+	if (!match) return;
+	status.ahead = Number.parseInt(match[1]!, 10);
+	status.behind = Number.parseInt(match[2]!, 10);
+}
+
+function normalizeBranchHead(value: string): string {
+	const branch = value.trim();
+	return branch === "(detached)" ? "detached" : branch;
+}
+
+function parseGitStatusPorcelainV2(output: string): GitStatusSnapshot {
+	const status = createEmptyGitStatus();
+
+	for (const rawLine of output.split("\n")) {
+		const line = rawLine.endsWith("\r") ? rawLine.slice(0, -1) : rawLine;
+		if (!line) continue;
+
+		if (line.startsWith(BRANCH_HEAD_PREFIX)) {
+			status.branch = normalizeBranchHead(line.slice(BRANCH_HEAD_PREFIX.length)) || undefined;
+			continue;
+		}
+
+		if (line.startsWith(BRANCH_AB_PREFIX)) {
+			parseBranchAheadBehind(line, status);
+			continue;
+		}
+
+		if (line.startsWith("1 ") || line.startsWith("2 ")) {
+			addTrackedStatusCounts(status, line.slice(2, 4));
+			continue;
+		}
+
+		if (line.startsWith("u ")) {
+			status.conflict += 1;
+			continue;
+		}
+
+		if (line.startsWith("? ")) status.untracked += 1;
+	}
+
+	return status;
+}
+
+function formatGitStatusFooterSegment(status: GitStatusSnapshot | undefined): string | undefined {
+	if (!status) return undefined;
+
+	const parts: string[] = [];
+	const indicators: Array<[string, number]> = [
+		["!", positiveCount(status.conflict)],
+		["+", positiveCount(status.staged)],
+		["~", positiveCount(status.unstaged)],
+		["?", positiveCount(status.untracked)],
+		["↑", positiveCount(status.ahead)],
+		["↓", positiveCount(status.behind)],
+	];
+
+	for (const [prefix, count] of indicators) {
+		if (count > 0) parts.push(`${prefix}${count}`);
+	}
+
+	return parts.length > 0 ? parts.join(" ") : undefined;
+}
+
+function formatPullRequestFooterSegment(pullRequest: PullRequestSnapshot | undefined): string | undefined {
+	const value = pullRequest?.number;
+	if (Number.isSafeInteger(value) && Number(value) > 0) return `PR #${value}`;
+	if (typeof value === "string") {
+		const trimmed = value.trim();
+		if (/^[1-9]\d*$/.test(trimmed)) return `PR #${trimmed}`;
+	}
+	return undefined;
+}
+
+function formatGitFooterSegments(
+	status: GitStatusSnapshot | undefined,
+	pullRequest: PullRequestSnapshot | undefined,
+): string[] {
+	const segments: string[] = [];
+	const branch = typeof status?.branch === "string" ? status.branch.trim() : "";
+	if (branch) segments.push(branch);
+
+	const statusSegment = formatGitStatusFooterSegment(status);
+	if (statusSegment) segments.push(statusSegment);
+
+	const pullRequestSegment = formatPullRequestFooterSegment(pullRequest);
+	if (pullRequestSegment) segments.push(pullRequestSegment);
+
+	return segments;
+}
+
+function parsePullRequestJson(stdout: string): PullRequestSnapshot | undefined {
+	const trimmed = stdout.trim();
+	if (!trimmed) return undefined;
+	let parsed: unknown;
+	try {
+		parsed = JSON.parse(trimmed);
+	} catch {
+		return undefined;
+	}
+	if (!parsed || typeof parsed !== "object" || Array.isArray(parsed)) return undefined;
+
+	const record = parsed as Record<string, unknown>;
+	const snapshot: PullRequestSnapshot = {};
+	if (typeof record.number === "number" || typeof record.number === "string") {
+		snapshot.number = record.number;
+	}
+	if (typeof record.state === "string") snapshot.state = record.state;
+	if (typeof record.isDraft === "boolean") snapshot.isDraft = record.isDraft;
+	if (typeof record.url === "string") snapshot.url = record.url;
+	if (typeof record.title === "string") snapshot.title = record.title;
+	return snapshot;
+}
+
+function gitStatusSnapshotsEqual(
+	left: GitStatusSnapshot | undefined,
+	right: GitStatusSnapshot | undefined,
+): boolean {
+	return (
+		left?.branch === right?.branch
+		&& left?.staged === right?.staged
+		&& left?.unstaged === right?.unstaged
+		&& left?.untracked === right?.untracked
+		&& left?.conflict === right?.conflict
+		&& left?.ahead === right?.ahead
+		&& left?.behind === right?.behind
+	);
+}
+
+function pullRequestSnapshotsEqual(
+	left: PullRequestSnapshot | undefined,
+	right: PullRequestSnapshot | undefined,
+): boolean {
+	return (
+		left?.number === right?.number
+		&& left?.state === right?.state
+		&& left?.isDraft === right?.isDraft
+		&& left?.url === right?.url
+		&& left?.title === right?.title
+	);
+}
+
+function defaultRunner(
+	command: string,
+	args: readonly string[],
+	options: { cwd: string; signal: AbortSignal },
+): Promise<CommandResult> {
+	return new Promise((resolve, reject) => {
+		let child;
+		try {
+			child = spawn(command, [...args], {
+				cwd: options.cwd,
+				stdio: ["ignore", "pipe", "pipe"],
+				windowsHide: true,
+			});
+		} catch (error) {
+			reject(error);
+			return;
+		}
+
+		let stdout = "";
+		let stderr = "";
+		let settled = false;
+
+		const finish = (result: CommandResult | Error) => {
+			if (settled) return;
+			settled = true;
+			options.signal.removeEventListener("abort", onAbort);
+			if (result instanceof Error) reject(result);
+			else resolve(result);
+		};
+
+		const onAbort = () => {
+			try {
+				child.kill("SIGTERM");
+			} catch {
+				// Ignore: process may already be gone.
+			}
+			finish(new Error("aborted"));
+		};
+
+		child.stdout?.on("data", (chunk: Buffer | string) => {
+			stdout += typeof chunk === "string" ? chunk : chunk.toString("utf8");
+		});
+		child.stderr?.on("data", (chunk: Buffer | string) => {
+			stderr += typeof chunk === "string" ? chunk : chunk.toString("utf8");
+		});
+		child.on("error", finish);
+		child.on("close", (code) => finish({ stdout, stderr, exitCode: code }));
+
+		if (options.signal.aborted) {
+			onAbort();
+			return;
+		}
+		options.signal.addEventListener("abort", onAbort, { once: true });
+	});
+}
+
+function defaultClock(): Clock {
+	return {
+		setInterval(callback, ms) {
+			const handle = setInterval(callback, ms);
+			(handle as { unref?: () => void }).unref?.();
+			return handle;
+		},
+		clearInterval(handle) {
+			clearInterval(handle as ReturnType<typeof setInterval>);
+		},
+	};
+}
+
+class GitFooterCache {
+	private readonly cwd: () => string;
+	private readonly runner: CommandRunner;
+	private readonly clock: Clock;
+	private readonly refreshIntervalMs: number;
+	private readonly gitTimeoutMs: number;
+	private readonly ghTimeoutMs: number;
+	private readonly onChange: (() => void) | undefined;
+
+	private intervalHandle: TimerHandle | undefined;
+	private readonly inflightControllers = new Set<AbortController>();
+	private disposed = false;
+	private refreshInFlight: Promise<void> | undefined;
+	private branchChangeUnsubscribe: (() => void) | undefined;
+	private statusSnapshot: GitStatusSnapshot | undefined;
+	private pullRequestSnapshot: PullRequestSnapshot | undefined;
+	private lastSeenBranch: string | undefined;
+
+	constructor(options: GitFooterCacheOptions) {
+		this.cwd = options.cwd;
+		this.runner = options.runner ?? defaultRunner;
+		this.clock = options.clock ?? defaultClock();
+		this.refreshIntervalMs = options.refreshIntervalMs ?? DEFAULT_REFRESH_INTERVAL_MS;
+		this.gitTimeoutMs = options.gitTimeoutMs ?? DEFAULT_GIT_TIMEOUT_MS;
+		this.ghTimeoutMs = options.ghTimeoutMs ?? DEFAULT_GH_TIMEOUT_MS;
+		this.onChange = options.onChange;
+
+		this.intervalHandle = this.clock.setInterval(() => {
+			void this.refresh();
+		}, this.refreshIntervalMs);
+		void this.refresh();
+
+		if (options.onBranchChangeSource) {
+			this.branchChangeUnsubscribe = options.onBranchChangeSource(() => {
+				void this.refresh();
+			});
+		}
+	}
+
+	getStatusSnapshot(): GitStatusSnapshot | undefined {
+		return this.statusSnapshot;
+	}
+
+	getPullRequestSnapshot(): PullRequestSnapshot | undefined {
+		return this.pullRequestSnapshot;
+	}
+
+	refresh(): Promise<void> {
+		if (this.disposed) return Promise.resolve();
+		if (this.refreshInFlight) return this.refreshInFlight;
+		const run = this.runRefresh()
+			.finally(() => {
+				this.refreshInFlight = undefined;
+			})
+			.catch(() => undefined);
+		this.refreshInFlight = run;
+		return run;
+	}
+
+	private async runRefresh(): Promise<void> {
+		const previousStatusSnapshot = this.statusSnapshot;
+		const previousPullRequestSnapshot = this.pullRequestSnapshot;
+
+		const result = await this.fetchGitStatus();
+		if (this.disposed) return;
+		if (result.kind === "transient") return;
+		if (result.kind === "not-a-repo") {
+			this.statusSnapshot = undefined;
+			this.pullRequestSnapshot = undefined;
+			this.lastSeenBranch = undefined;
+			this.emitChangeIfSnapshotsChanged(previousStatusSnapshot, previousPullRequestSnapshot);
+			return;
+		}
+
+		const status = result.status;
+		this.statusSnapshot = status;
+
+		const branch = typeof status.branch === "string" ? status.branch : undefined;
+		const isValidBranch = !!branch && branch !== "detached";
+		const branchChanged = branch !== this.lastSeenBranch;
+
+		if (branchChanged) this.pullRequestSnapshot = undefined;
+		this.lastSeenBranch = branch;
+
+		if (!isValidBranch) {
+			this.pullRequestSnapshot = undefined;
+			this.emitChangeIfSnapshotsChanged(previousStatusSnapshot, previousPullRequestSnapshot);
+			return;
+		}
+
+		const pr = await this.fetchPullRequest();
+		if (this.disposed) return;
+		if (pr !== undefined) this.pullRequestSnapshot = pr;
+		else if (branchChanged) this.pullRequestSnapshot = undefined;
+
+		this.emitChangeIfSnapshotsChanged(previousStatusSnapshot, previousPullRequestSnapshot);
+	}
+
+	private emitChangeIfSnapshotsChanged(
+		previousStatusSnapshot: GitStatusSnapshot | undefined,
+		previousPullRequestSnapshot: PullRequestSnapshot | undefined,
+	): void {
+		if (this.disposed) return;
+		if (
+			gitStatusSnapshotsEqual(previousStatusSnapshot, this.statusSnapshot)
+			&& pullRequestSnapshotsEqual(previousPullRequestSnapshot, this.pullRequestSnapshot)
+		) {
+			return;
+		}
+		try {
+			this.onChange?.();
+		} catch {
+			// Rendering hooks should not break refreshes.
+		}
+	}
+
+	private async fetchGitStatus(): Promise<
+		| { kind: "ok"; status: GitStatusSnapshot }
+		| { kind: "not-a-repo" }
+		| { kind: "transient" }
+	> {
+		const result = await this.runCommandSafely("git", GIT_STATUS_ARGS, this.gitTimeoutMs);
+		if (!result) return { kind: "transient" };
+		if (result.exitCode !== 0) return { kind: "not-a-repo" };
+		return { kind: "ok", status: parseGitStatusPorcelainV2(result.stdout) };
+	}
+
+	private async fetchPullRequest(): Promise<PullRequestSnapshot | undefined> {
+		const result = await this.runCommandSafely("gh", GH_PR_VIEW_ARGS, this.ghTimeoutMs);
+		if (!result || result.exitCode !== 0) return undefined;
+		return parsePullRequestJson(result.stdout);
+	}
+
+	private async runCommandSafely(
+		command: string,
+		args: readonly string[],
+		timeoutMs: number,
+	): Promise<CommandResult | undefined> {
+		if (this.disposed) return undefined;
+		const controller = new AbortController();
+		this.inflightControllers.add(controller);
+		const timeoutId = setTimeout(() => controller.abort(), timeoutMs);
+		try {
+			return await this.runner(command, args, { cwd: this.cwd(), signal: controller.signal });
+		} catch {
+			return undefined;
+		} finally {
+			clearTimeout(timeoutId);
+			this.inflightControllers.delete(controller);
+		}
+	}
+
+	dispose(): void {
+		if (this.disposed) return;
+		this.disposed = true;
+		if (this.intervalHandle !== undefined) {
+			this.clock.clearInterval(this.intervalHandle);
+			this.intervalHandle = undefined;
+		}
+		if (this.branchChangeUnsubscribe) {
+			try {
+				this.branchChangeUnsubscribe();
+			} catch {
+				// Ignore misbehaving notifier.
+			}
+			this.branchChangeUnsubscribe = undefined;
+		}
+		for (const controller of this.inflightControllers) controller.abort();
+		this.inflightControllers.clear();
+	}
+}
+
+function composeFooterFirstLine(input: {
+	cwd: string;
+	sessionName?: string | null;
+	status?: GitStatusSnapshot;
+	pullRequest?: PullRequestSnapshot;
+}): string {
+	const segments = [input.cwd];
+	if (input.status !== undefined) {
+		segments.push(...formatGitFooterSegments(input.status, input.pullRequest));
+	}
+	if (input.sessionName) segments.push(input.sessionName);
+	return segments.join(FOOTER_SEPARATOR);
+}
+
+function sanitizeFooterSegment(value: string): string {
+	return value.replace(/[\r\n\t]+/g, " ").trim();
+}
+
+export default function (pi: ExtensionAPI) {
+	pi.on("session_start", (_event, ctx) => {
+		let cache: GitFooterCache | undefined;
+
+		ctx.ui.setFooter((tui, theme, footerData) => {
+			cache = new GitFooterCache({
+				cwd: () => ctx.cwd,
+				onChange: () => tui.requestRender(),
+				onBranchChangeSource: (callback) => footerData.onBranchChange(callback),
+			});
+
+			return {
+				dispose() {
+					cache?.dispose();
+					cache = undefined;
+				},
+				invalidate() {},
+				render(width: number): string[] {
+					const status = cache?.getStatusSnapshot();
+					const pullRequest = cache?.getPullRequestSnapshot();
+					const firstLine = composeFooterFirstLine({
+						cwd: basename(ctx.cwd),
+						status,
+						pullRequest,
+						sessionName: pi.getSessionName(),
+					});
+
+					const usage = ctx.getContextUsage();
+					const context = usage?.percent == null ? "ctx ?" : `ctx ${usage.percent.toFixed(1)}%`;
+					const thinking = pi.getThinkingLevel();
+					const model = ctx.model?.id ?? "no-model";
+					const modelText = thinking === "off" ? model : `${model} ${thinking}`;
+					const statuses = [...footerData.getExtensionStatuses().values()]
+						.map(sanitizeFooterSegment)
+						.filter(Boolean);
+					const secondLine = [theme.fg("dim", context), theme.fg("dim", modelText), ...statuses]
+						.join(theme.fg("dim", FOOTER_SEPARATOR));
+
+					return [
+						truncateToWidth(theme.fg("dim", firstLine), width),
+						truncateToWidth(secondLine, width),
+					];
+				},
+			};
+		});
+	});
+}

package/package.json

@@ -0,0 +1,35 @@
+{
+  "name": "@diegopetrucci/pi-git-footer",
+  "version": "0.1.0",
+  "description": "A TLH-style git status footer for pi.",
+  "keywords": [
+    "pi-package",
+    "pi",
+    "terminal",
+    "footer",
+    "git"
+  ],
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/diegopetrucci/pi-extensions.git",
+    "directory": "extensions/git-footer"
+  },
+  "files": [
+    "index.ts",
+    "README.md",
+    ".pi-fleet-tested-version"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "pi": {
+    "extensions": [
+      "index.ts"
+    ]
+  },
+  "peerDependencies": {
+    "@earendil-works/pi-coding-agent": "*",
+    "@earendil-works/pi-tui": "*"
+  }
+}