@henryqw/pi-footer 2.2.4 → 4.0.0

package/README.md

@@ -1,6 +1,6 @@
 # `@henryqw/pi-footer`
 
-Keep checkout identity, model usage, elapsed agent work, and extension status visible while you work in Pi. See repository, pull request, model, cost, and status details without separate commands.
+Keep checkout identity, model usage, elapsed agent work, and extension status visible while you work in Pi. Open the current Pi working directory with `/open`, using VS Code by default or another configured command. The footer and open commands can be enabled independently.
 
 ![Pi footer showing repository, pull request, quota, usage, model, and extension status](./example.png)
 
@@ -10,18 +10,50 @@ Keep checkout identity, model usage, elapsed agent work, and extension status vi
 pi install npm:@henryqw/pi-footer
 ```
 
+Version 3 replaces `@henryqw/pi-open-in`. If you have it installed, remove it before upgrading to prevent duplicate `/open` and `/set-open-in` commands:
+
+```bash
+pi remove npm:@henryqw/pi-open-in
+pi install npm:@henryqw/pi-footer
+```
+
+For project-local installs, use `--local` on both commands. Remove manually configured paths to the old package as well, then restart Pi. The existing open-command config stays at `config/pi-open-in/config.json`; do not move it.
+
+Both entry points load by default. To use `/open` without the custom footer, use Pi's native package resource filter in `settings.json`:
+
+```json
+{
+  "packages": [
+    {
+      "source": "npm:@henryqw/pi-footer",
+      "extensions": ["extensions/open.ts"]
+    }
+  ]
+}
+```
+
+Select `extensions/footer.ts` instead for only the footer, or use `pi config` to toggle either resource. No package activation config is needed.
+
 ## Works with
 
 | Package | Relationship | Purpose |
 | --- | --- | --- |
 | [`@henryqw/pi-codegraph`](https://pi.henry.wang/extensions/pi-codegraph) | Improves | Shows CodeGraph index status, quiet setup progress, and direct tool activity when loaded. |
+| [`@henryqw/pi-config-store`](https://pi.henry.wang/extensions/pi-config-store) | Required | Owns config-home resolution and storage. |
 | [`@henryqw/pi-multi-codex`](https://pi.henry.wang/extensions/pi-multi-codex) | Improves | Adds active Codex subscription quota and reset status. |
-| [`@henryqw/pi-open-in`](https://pi.henry.wang/extensions/pi-open-in) | Improves | Adds `/open` and `/set-open-in` commands for editor configuration. |
 | [`@henryqw/pi-pr`](https://pi.henry.wang/extensions/pi-pr) | Improves | Adds current-branch pull-request status. |
 
 ## Use
 
-After installing, start a Pi TUI session to see checkout, usage, model, thinking, and extension statuses.
+After installing, start a Pi TUI session to see checkout, usage, model, thinking, and extension statuses. Run `/open` to open the current working directory in VS Code by default; it also works while the agent is busy.
+
+| Surface | Type | Purpose |
+| --- | --- | --- |
+| Footer | ui | Shows checkout identity, usage, model, elapsed agent work, and extension statuses. |
+| `/open` | command | Opens the current working directory with the configured command. |
+| `/set-open-in <command>` | command | Sets the command used by `/open`. |
+
+Run `/set-open-in <command>` to choose another command, such as `cursor --reuse-window`. `/open` runs `<command> <current-working-directory>`.
 
 ```text
 pi-harness · clear-field-f8d2 [+2 ~3 ?1 ↑2] · PR #123 · approved    Codex #1 · 50% · 7d 1d 1h 22m
@@ -60,18 +92,47 @@ Only the non-empty `pi-multi-codex` quota status occupies the right side of the
 
 Statuses from other extensions, including Ponytail and `pi-rewind`, share the left side of the third line. They are sorted by key; colors, links, glyphs, and interior spacing are preserved. Leading and trailing whitespace is trimmed, line breaks become spaces, and long statuses may be clipped to fit the footer. Only direct `codegraph_explore` tool calls trigger the `● CG` badge; CodeGraph queries made from inside scripted tools are not shown.
 
-## Limits and recovery
+## Config
 
-When the configured executable is `code` and Pi reports hyperlink support, the accent-colored checkout name links to the current path. The link opens a new window for `code -n` or `code --new-window`. A missing config silently uses `code`. Other executables and terminals with hyperlinks disabled render plain text.
+Package-owned: `~/.pi/agent/config/pi-open-in/config.json` (under `getAgentDir()` when overridden). The retained `pi-open-in` home belongs to the open commands now shipped here.
 
-Pi handles the custom URI in its fullscreen TUI, which is the default since Pi 1.0. Then use normal primary click. On older supported Pi versions (before 1.0), enable it:
+| Name | Description | Values | Default |
+| --- | --- | --- | --- |
+| `command` | Command run by `/open`; required when the file exists. | Non-empty string. | `"code"` |
 
-```json
-{
-  "tuiMode": "fullscreen"
-}
+A missing file silently uses the default command, `code`. An invalid existing file makes `/open` fail visibly and remains unchanged; see Limits and recovery. `/open` reads the config on every run. Only `/set-open-in` writes the file, atomically. Reads do not create or write the config home.
+
+## API
+
+Consumers should use the owner API instead of reading the config file directly. Replace imports from `@henryqw/pi-open-in/open-uri` with `@henryqw/pi-footer/open-uri`:
+
+```ts
+import { loadOpenInConfig } from "@henryqw/pi-footer/open-uri";
+
+const { source, value } = loadOpenInConfig();
 ```
 
-Set this through `/settings`, or launch with `--tui-mode fullscreen`. Regular TUI (`"tuiMode": "regular"` or `--tui-mode regular`) delegates OSC 8 activation to the terminal, so the link works only where the terminal opens custom URI schemes.
+These exports serve package consumers; the commands in Use are the Pi interfaces.
+
+| Surface | Type | Purpose |
+| --- | --- | --- |
+| `default` (`openInExtension(pi)`) | function | Registers the open commands with Pi, without the footer. |
+| `OpenInConfig` | type | Describes the configured command. |
+| `loadOpenInConfig(agentDir?)` | function | Reads and validates the owner config. |
+| `configuredOpenUri(path)` | function | Returns a safe VS Code URI for a supported command. |
+
+`loadOpenInConfig` returns `source` as `"missing"` or `"file"`; `value.command` is validated. Pass an agent directory when needed.
+
+`configuredOpenUri(path)` works when the executable is `code`. With `code -n` or `code --new-window`, it adds `windowId=_blank` so the link opens in a new window. It returns `undefined` for other commands or invalid config. `@henryqw/pi-config-store` owns the config home and storage.
+
+## Limits and recovery
+
+The open command splits on whitespace into an executable and arguments. Tokens cannot contain spaces, and quoting is unsupported. Use a wrapper script for executables in spaced paths.
+
+An existing config file must be a JSON object with exactly one non-empty string `command` property. Otherwise `/open` fails with a visible error, offers no open URI, and leaves the malformed file unchanged. If the configured command exits unsuccessfully, Pi reports its error output or exit code; fix the command and run `/open` again.
+
+When the configured executable is `code` and Pi reports hyperlink support, the accent-colored checkout name links to the current path. The link opens a new window for `code -n` or `code --new-window`. A missing config silently uses `code`. Other executables and terminals with hyperlinks disabled render plain text.
+
+Pi handles the custom URI in its default fullscreen TUI. Use normal primary click. Regular TUI (`"tuiMode": "regular"` or `--tui-mode regular`) delegates OSC 8 activation to the terminal, so the link works only where the terminal opens custom URI schemes.
 
 Ghostty uses `Cmd+click` but may not open custom URI schemes.

package/extensions/footer.ts

@@ -1,8 +1,8 @@
 import { readFile } from "node:fs/promises";
 import { basename, dirname, join } from "node:path";
-import type { ExtensionAPI, ExtensionContext } from "@earendil-works/pi-coding-agent";
+import type { ExtensionAPI, ExtensionContext, SessionEntry } from "@earendil-works/pi-coding-agent";
 import { getCapabilities, hyperlink, truncateToWidth, visibleWidth } from "@earendil-works/pi-tui";
-import { configuredOpenUri } from "@henryqw/pi-open-in/open-uri";
+import { configuredOpenUri } from "./open.ts";
 
 const THINKING_COLORS = {
 	minimal: 46,
@@ -12,7 +12,7 @@ const THINKING_COLORS = {
 	xhigh: 208,
 	max: 196,
 } as const;
-const HENRY_STATUS_KEY = "pi-multi-codex";
+const QUOTA_STATUS_KEY = "pi-multi-codex";
 const AGENT_TIME_ENTRY = "pi-footer:agent-work";
 const SUBAGENT_BACKGROUND_RESULT = "subagent-background-result";
 /** Pi's VIRTUAL_MODEL_API: catalog entries that route each request to a physical model. */
@@ -219,9 +219,7 @@ export default function footerExtension(pi: ExtensionAPI): void {
 	const resumeActive = () => {
 		if (!promptPaused) return;
 		promptPaused = false;
-		activeStartedAt = performance.now();
-		if (requestRuntimeRender) runtimeTimer = setInterval(requestRuntimeRender, 1_000);
-		requestRuntimeRender?.();
+		startActive();
 	};
 	const finalizeActive = (): boolean => {
 		if (activeStartedAt === undefined && !promptPaused) return false;
@@ -233,15 +231,9 @@ export default function footerExtension(pi: ExtensionAPI): void {
 		return true;
 	};
 
-	pi.on("agent_start", (_event) => {
-		startActive();
-	});
-	pi.on("ui_prompt_start", () => {
-		pauseActive();
-	});
-	pi.on("ui_prompt_end", () => {
-		resumeActive();
-	});
+	pi.on("agent_start", startActive);
+	pi.on("ui_prompt_start", pauseActive);
+	pi.on("ui_prompt_end", resumeActive);
 	pi.on("agent_settled", async (_event, ctx) => {
 		if (!ctx.isIdle()) return;
 		if (finalizeActive()) pi.appendEntry(AGENT_TIME_ENTRY, activeMilliseconds);
@@ -301,12 +293,12 @@ export default function footerExtension(pi: ExtensionAPI): void {
 		// and some (Claude bridge) emit message_end only after post-stream teardown.
 		let assistantStartedAt: number | undefined;
 		let assistantLastUpdateAt: number | undefined;
-		pi.on("message_update", async (event) => {
+		pi.on("message_update", (event) => {
 			if (event.message.role !== "assistant") return;
 			assistantLastUpdateAt = performance.now();
 			assistantStartedAt ??= assistantLastUpdateAt;
 		});
-		pi.on("message_end", async (event) => {
+		pi.on("message_end", (event) => {
 			if (event.message.role !== "assistant") return;
 			const output = event.message.usage?.output ?? 0;
 			const seconds = assistantStartedAt === undefined ? 0 : (assistantLastUpdateAt! - assistantStartedAt) / 1000;
@@ -314,14 +306,14 @@ export default function footerExtension(pi: ExtensionAPI): void {
 			tps = seconds > 0 ? output / seconds : undefined;
 		});
 
-		// ponytail: keyed on length + last entry (sessions are append-only) + leaf (tree navigation); revisit if entries ever mutate in place.
+		// Session entries are append-only; the leaf also changes on tree navigation.
 		let usageKey: string | undefined;
 		let routed: ReturnType<typeof latestResponse>;
 		let input = 0;
 		let output = 0;
 		let cost = 0;
 		let cacheRate: number | undefined;
-		const computeUsage = () => {
+		const computeUsage = (entries: SessionEntry[]) => {
 			input = 0;
 			output = 0;
 			cost = 0;
@@ -333,7 +325,7 @@ export default function footerExtension(pi: ExtensionAPI): void {
 				cost += usage.cost.total;
 			};
 
-			for (const entry of ctx.sessionManager.getEntries()) {
+			for (const entry of entries) {
 				if (entry.type === "message" && entry.message.role === "assistant") {
 					const usage = entry.message.usage;
 					const prompt = usage.input + usage.cacheRead + usage.cacheWrite;
@@ -364,10 +356,10 @@ export default function footerExtension(pi: ExtensionAPI): void {
 				invalidate() { },
 				render(width: number): string[] {
 					const entries = ctx.sessionManager.getEntries();
-					const key = `${entries.length}:${entries.at(-1)?.type}:${ctx.sessionManager.getLeafId()}`;
+					const key = `${entries.length}:${ctx.sessionManager.getLeafId()}`;
 					if (key !== usageKey) {
 						usageKey = key;
-						computeUsage();
+						computeUsage(entries);
 						routed = latestResponse(ctx);
 					}
 
@@ -380,13 +372,12 @@ export default function footerExtension(pi: ExtensionAPI): void {
 					const codegraph = activeCodegraphCalls.size > 0
 						? `${theme.fg("accent", "●")} CG`
 						: sanitizeStatus(extensionStatuses.get("pi-codegraph") ?? "");
-					const henryStatuses: string[] = [];
+					const quotaStatus = sanitizeStatus(extensionStatuses.get(QUOTA_STATUS_KEY) ?? "");
 					const externalStatuses: string[] = [];
 					for (const [key, value] of [...extensionStatuses].sort(([a], [b]) => a.localeCompare(b))) {
-						if (key === "pi-pr" || key === "pi-codegraph") continue;
+						if (key === "pi-pr" || key === "pi-codegraph" || key === QUOTA_STATUS_KEY) continue;
 						const text = sanitizeStatus(value);
-						if (!text) continue;
-						(key === HENRY_STATUS_KEY ? henryStatuses : externalStatuses).push(text);
+						if (text) externalStatuses.push(text);
 					}
 					const ellipsis = theme.fg("dim", "…");
 					const usage = theme.fg("dim", [
@@ -415,7 +406,7 @@ export default function footerExtension(pi: ExtensionAPI): void {
 						: theme.fg("dim", checkout);
 					const checkoutStatus = gitSummary.badges ? `${checkoutLink} ${theme.fg("dim", gitSummary.badges)}` : checkoutLink;
 					const identityLine = prStatus ? `${identity}${checkoutStatus} · ${prStatus}` : `${identity}${checkoutStatus}`;
-					const firstLine = henryStatuses.length ? align(identityLine, henryStatuses.join(" "), width, ellipsis) : identityLine;
+					const firstLine = quotaStatus ? align(identityLine, quotaStatus, width, ellipsis) : identityLine;
 					const lines = [
 						firstLine,
 						align(usage, model, width, ellipsis),

package/extensions/open.ts

@@ -0,0 +1,77 @@
+import { pathToFileURL } from "node:url";
+import { type ExtensionAPI } from "@earendil-works/pi-coding-agent";
+import { createConfigStore } from "@henryqw/pi-config-store";
+
+const DEFAULT_COMMAND = "code";
+
+export type OpenInConfig = { command: string };
+
+function parseOpenInConfig(value: unknown): OpenInConfig {
+	if (!value || typeof value !== "object" || Array.isArray(value)) {
+		throw new Error('Invalid open-in config: expected exactly one non-empty string "command" property');
+	}
+	const config = value as Record<string, unknown>;
+	if (Object.keys(config).length !== 1 || typeof config.command !== "string" || !config.command.trim()) {
+		throw new Error('Invalid open-in config: expected exactly one non-empty string "command" property');
+	}
+	return { command: config.command.trim() };
+}
+
+function createOpenInConfigStore(agentDir?: string) {
+	return createConfigStore<OpenInConfig>({
+		extensionId: "pi-open-in",
+		agentDir,
+		defaults: () => ({ command: DEFAULT_COMMAND }),
+		parse: parseOpenInConfig,
+	});
+}
+
+export function loadOpenInConfig(agentDir?: string): { source: "file" | "missing"; value: OpenInConfig } {
+	return createOpenInConfigStore(agentDir).loadSync();
+}
+
+export function configuredOpenUri(path: string): string | undefined {
+	let args: string[];
+	try {
+		const [executable, ...commandArgs] = loadOpenInConfig().value.command.split(/\s+/);
+		if (executable !== "code") return undefined;
+		args = commandArgs;
+	} catch {
+		// Invalid config must not break footer render; just omit the URI.
+		return undefined;
+	}
+	const query = args.includes("-n") || args.includes("--new-window") ? "?windowId=_blank" : "";
+	if (path.startsWith("\\\\")) {
+		const [host, ...parts] = path.slice(2).split("\\");
+		const uri = new URL(`file://${host}`);
+		uri.pathname = `/${parts.join("/")}`;
+		return `vscode://file//${uri.host}${uri.pathname}${query}`;
+	}
+	return `vscode://file${pathToFileURL(path).pathname}${query}`;
+}
+
+export default function openInExtension(pi: ExtensionAPI): void {
+	const configStore = createOpenInConfigStore();
+
+	// Reload config on each call; split the command on whitespace (no quoted tokens).
+	pi.registerCommand("open", {
+		description: "Open the current path with the configured command",
+		handler: async (_args, ctx) => {
+			const [executable, ...args] = configStore.loadSync().value.command.split(/\s+/);
+			const result = await pi.exec(executable, [...args, ctx.cwd]);
+			if (result.code !== 0) {
+				throw new Error(`Open command failed: ${result.stderr.trim() || `exit code ${result.code}`}`);
+			}
+		},
+	});
+
+	pi.registerCommand("set-open-in", {
+		description: "Set command used by /open",
+		handler: async (args, ctx) => {
+			const command = args.trim();
+			if (!command) throw new Error("Usage: /set-open-in <command>");
+			await configStore.save({ command });
+			ctx.ui.notify(`Saved open-in command: ${command}`, "info");
+		},
+	});
+}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@henryqw/pi-footer",
-  "version": "2.2.4",
-  "description": "Show concise repository, branch, and usage details in the Pi footer.",
+  "version": "4.0.0",
+  "description": "Show repository and usage details in the Pi footer and open the current working directory.",
   "keywords": [
     "pi-package",
     "pi",
@@ -19,14 +19,17 @@
     "README.md",
     "example.png"
   ],
+  "exports": {
+    "./open-uri": "./extensions/open.ts"
+  },
   "scripts": {
     "test": "node --test test/*.test.ts",
     "typecheck": "tsc --noEmit --allowImportingTsExtensions --target ES2022 --module NodeNext --moduleResolution NodeNext --skipLibCheck extensions/*.ts test/*.test.ts",
     "pack:check": "npm pack --dry-run"
   },
   "peerDependencies": {
-    "@earendil-works/pi-coding-agent": ">=0.86.0 <0.100.0 || ^1.0.0",
-    "@earendil-works/pi-tui": ">=0.86.0 <0.100.0 || ^1.0.0"
+    "@earendil-works/pi-coding-agent": "^1.0.0",
+    "@earendil-works/pi-tui": "^1.0.0"
   },
   "repository": {
     "type": "git",
@@ -41,12 +44,13 @@
   },
   "pi": {
     "extensions": [
-      "./extensions/footer.ts"
+      "./extensions/footer.ts",
+      "./extensions/open.ts"
     ],
     "image": "https://raw.githubusercontent.com/HenryQW/pi-harness/main/extensions/pi-footer/example.png"
   },
   "dependencies": {
-    "@henryqw/pi-open-in": "^3.0.0"
+    "@henryqw/pi-config-store": "^3.0.0"
   },
   "devDependencies": {
     "@earendil-works/pi-coding-agent": "1.0.0",