@pi-vault/pi-status 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Lanh Hoang
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,95 @@
+# @pi-vault/pi-status
+
+[![npm version](https://img.shields.io/npm/v/%40pi-vault%2Fpi-status)](https://www.npmjs.com/package/@pi-vault/pi-status)
+[![Quality](https://github.com/pi-vault/pi-status/actions/workflows/quality.yml/badge.svg?branch=master)](https://github.com/pi-vault/pi-status/actions/workflows/quality.yml)
+[![Node >= 22.12](https://img.shields.io/badge/node-%3E%3D22.12-339933?logo=node.js&logoColor=white)](https://nodejs.org/)
+[![License: MIT](https://img.shields.io/badge/license-MIT-yellow.svg)](LICENSE)
+
+Replace Pi's default footer with a cleaner Codex-style status line that stays out of the way but keeps the useful bits visible.
+
+Default status line:
+
+`model-with-reasoning · current-dir`
+
+> **Status:** Early-adopter release (`v0.1.0`). It is ready to use, but the available segments and configuration details may still change before `v1.0`.
+
+## Install
+
+```bash
+pi install npm:@pi-vault/pi-status
+```
+
+Then reload Pi:
+
+```bash
+/reload
+```
+
+## Use
+
+Once installed, the footer updates automatically.
+
+Use `/statusline` inside Pi to:
+
+- turn footer items on or off
+- reorder the items you want to see
+- preview the result before saving
+- control which extension status messages are shown
+
+Changes are saved and reused the next time Pi starts.
+
+## Available Status Items
+
+You can build your footer from these items:
+
+- `model`
+- `model-with-reasoning`
+- `project-name`
+- `current-dir`
+- `git-branch`
+- `run-state`
+- `context-remaining`
+- `context-used`
+- `context-window-size`
+- `used-tokens`
+- `total-input-tokens`
+- `total-output-tokens`
+- `session-id`
+- `five-hour-limit`
+- `weekly-limit`
+- `extension-statuses`
+
+`five-hour-limit` and `weekly-limit` come from [`@pi-vault/pi-usage`](https://www.npmjs.com/package/@pi-vault/pi-usage) and only appear when that usage data is available.
+
+## Common Setups
+
+Keep it minimal:
+
+```text
+model-with-reasoning · current-dir
+```
+
+Show more session detail:
+
+```text
+model · run-state · git-branch · context-used · context-remaining · session-id
+```
+
+## Compatibility
+
+- Node.js `>=22.12`
+- Pi host environment with `@earendil-works/pi-coding-agent` and `@earendil-works/pi-tui`
+- Tested in this repo against `@earendil-works/pi-coding-agent@0.78.x` and `@earendil-works/pi-tui@0.78.x`
+
+## Development Setup
+
+```bash
+pnpm install
+pnpm check
+pnpm pack --dry-run
+pi -e .
+```
+
+## License
+
+MIT

package/package.json

@@ -0,0 +1,58 @@
+{
+  "name": "@pi-vault/pi-status",
+  "version": "0.1.0",
+  "type": "module",
+  "description": "Pi extension that replaces the default status with a Codex-like status",
+  "author": "Lanh Hoang <lanhhoang@users.noreply.github.com>",
+  "license": "MIT",
+  "homepage": "https://github.com/pi-vault/pi-status#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/pi-vault/pi-status.git"
+  },
+  "bugs": {
+    "url": "https://github.com/pi-vault/pi-status/issues"
+  },
+  "keywords": [
+    "pi",
+    "pi-package",
+    "pi-extension",
+    "pi-status"
+  ],
+  "scripts": {
+    "format": "biome format --write .",
+    "lint": "biome lint .",
+    "typecheck": "tsc --noEmit",
+    "test": "vitest run",
+    "check": "biome lint . && tsc --noEmit && vitest run",
+    "pack:dry-run": "pnpm pack --dry-run"
+  },
+  "pi": {
+    "extensions": [
+      "./src/index.ts",
+      "node_modules/@pi-vault/pi-usage/src/index.ts"
+    ]
+  },
+  "engines": {
+    "node": ">=22.12"
+  },
+  "files": [
+    "src",
+    "README.md"
+  ],
+  "dependencies": {
+    "@pi-vault/pi-usage": "^0.1.1"
+  },
+  "peerDependencies": {
+    "@earendil-works/pi-coding-agent": "*",
+    "@earendil-works/pi-tui": "*"
+  },
+  "devDependencies": {
+    "@biomejs/biome": "^2.4.16",
+    "@earendil-works/pi-coding-agent": "^0.78.0",
+    "@earendil-works/pi-tui": "^0.78.0",
+    "@types/node": "^25.9.1",
+    "typescript": "^6.0.3",
+    "vitest": "^4.1.7"
+  }
+}

package/src/config.ts

@@ -0,0 +1,272 @@
+import {
+  mkdirSync,
+  mkdtempSync,
+  existsSync,
+  readFileSync,
+  renameSync,
+  rmSync,
+  writeFileSync,
+} from "node:fs";
+import { homedir } from "node:os";
+import { dirname, join, resolve } from "node:path";
+import {
+  DEFAULT_SEGMENTS,
+  type StatusFilter,
+  type StatusLineSegmentId,
+} from "./render.ts";
+
+export type PiStatusConfig = {
+  segments: StatusLineSegmentId[];
+  filter: StatusFilter;
+};
+
+export type ConfigLoadResult = {
+  config: PiStatusConfig;
+  source: "settings" | "default";
+};
+
+export const DEFAULT_CONFIG: PiStatusConfig = {
+  segments: [...DEFAULT_SEGMENTS],
+  filter: { mode: "all", hidden: [] },
+};
+
+const KNOWN_SEGMENTS = new Set<StatusLineSegmentId>([
+  "model",
+  "model-with-reasoning",
+  "project-name",
+  "current-dir",
+  "git-branch",
+  "run-state",
+  "context-remaining",
+  "context-used",
+  "context-window-size",
+  "used-tokens",
+  "total-input-tokens",
+  "total-output-tokens",
+  "session-id",
+  "five-hour-limit",
+  "weekly-limit",
+  "extension-statuses",
+]);
+
+function cloneDefaultConfig(): PiStatusConfig {
+  return {
+    segments: [...DEFAULT_CONFIG.segments],
+    filter:
+      DEFAULT_CONFIG.filter.mode === "all"
+        ? { mode: "all", hidden: [...DEFAULT_CONFIG.filter.hidden] }
+        : { mode: "only", shown: [...DEFAULT_CONFIG.filter.shown] },
+  };
+}
+
+export function getSettingsPaths(cwd = process.cwd()): {
+  global: string;
+  project: string;
+} {
+  return {
+    global: resolve(homedir(), ".pi/agent/settings.json"),
+    project: resolve(cwd, ".pi/settings.json"),
+  };
+}
+
+export function normalizeSegments(input: unknown): StatusLineSegmentId[] {
+  if (!Array.isArray(input)) return [...DEFAULT_SEGMENTS];
+  const out: StatusLineSegmentId[] = [];
+  const seen = new Set<StatusLineSegmentId>();
+
+  for (const value of input) {
+    if (typeof value !== "string") continue;
+    if (!KNOWN_SEGMENTS.has(value as StatusLineSegmentId)) continue;
+    const id = value as StatusLineSegmentId;
+    if (seen.has(id)) continue;
+    seen.add(id);
+    out.push(id);
+  }
+
+  return out;
+}
+
+function normalizeFilterValues(input: unknown): string[] {
+  if (!Array.isArray(input)) return [];
+  const out: string[] = [];
+  const seen = new Set<string>();
+
+  for (const value of input) {
+    if (typeof value !== "string") continue;
+    if (value.length === 0) continue;
+    if (seen.has(value)) continue;
+    seen.add(value);
+    out.push(value);
+  }
+
+  return out;
+}
+
+export function normalizeStatusFilter(input: unknown): StatusFilter {
+  if (!input || typeof input !== "object" || Array.isArray(input))
+    return { mode: "all", hidden: [] };
+  const mode = (input as { mode?: unknown }).mode;
+
+  if (mode === "all") {
+    return {
+      mode: "all",
+      hidden: normalizeFilterValues((input as { hidden?: unknown }).hidden),
+    };
+  }
+
+  if (mode === "only") {
+    return {
+      mode: "only",
+      shown: normalizeFilterValues((input as { shown?: unknown }).shown),
+    };
+  }
+
+  return { mode: "all", hidden: [] };
+}
+
+function readJsonObject(path: string): Record<string, unknown> | null {
+  try {
+    const parsed: unknown = JSON.parse(readFileSync(path, "utf8"));
+    if (!parsed || typeof parsed !== "object" || Array.isArray(parsed))
+      return null;
+    return parsed as Record<string, unknown>;
+  } catch {
+    return null;
+  }
+}
+
+type SettingsFileState =
+  | { exists: false; value: Record<string, never> }
+  | { exists: true; value: Record<string, unknown> }
+  | { exists: true; malformed: true };
+
+function readSettingsFileState(path: string): SettingsFileState {
+  if (!existsSync(path)) {
+    return { exists: false, value: {} };
+  }
+
+  const parsed = readJsonObject(path);
+  if (parsed) {
+    return { exists: true, value: parsed };
+  }
+
+  return { exists: true, malformed: true };
+}
+
+function normalizePiStatus(input: unknown): PiStatusConfig {
+  if (!input || typeof input !== "object" || Array.isArray(input))
+    return cloneDefaultConfig();
+  const segments = normalizeSegments(
+    (input as { segments?: unknown }).segments,
+  );
+  const filter = normalizeStatusFilter((input as { filter?: unknown }).filter);
+  return {
+    segments: segments.length > 0 ? segments : [...DEFAULT_SEGMENTS],
+    filter,
+  };
+}
+
+function mergePiStatus(globalValue: unknown, projectValue: unknown): unknown {
+  if (
+    !globalValue ||
+    typeof globalValue !== "object" ||
+    Array.isArray(globalValue)
+  )
+    return projectValue ?? globalValue;
+  if (
+    !projectValue ||
+    typeof projectValue !== "object" ||
+    Array.isArray(projectValue)
+  )
+    return globalValue;
+  const g = globalValue as Record<string, unknown>;
+  const p = projectValue as Record<string, unknown>;
+  const merged: Record<string, unknown> = { ...g, ...p };
+
+  const gFilter = g.filter;
+  const pFilter = p.filter;
+  if (
+    gFilter &&
+    typeof gFilter === "object" &&
+    !Array.isArray(gFilter) &&
+    pFilter &&
+    typeof pFilter === "object" &&
+    !Array.isArray(pFilter)
+  ) {
+    merged.filter = {
+      ...(gFilter as Record<string, unknown>),
+      ...(pFilter as Record<string, unknown>),
+    };
+  }
+
+  return merged;
+}
+
+export function loadConfig(options?: { cwd?: string }): ConfigLoadResult {
+  const cwd = options?.cwd ?? process.cwd();
+  const settingsPaths = getSettingsPaths(cwd);
+  const globalSettings = readJsonObject(settingsPaths.global);
+  const projectSettings = readJsonObject(settingsPaths.project);
+  const mergedPiStatus = mergePiStatus(
+    globalSettings?.statusLine,
+    projectSettings?.statusLine,
+  );
+  if (mergedPiStatus !== undefined) {
+    return { config: normalizePiStatus(mergedPiStatus), source: "settings" };
+  }
+
+  return { config: cloneDefaultConfig(), source: "default" };
+}
+
+export function saveConfigToSettings(
+  config: PiStatusConfig,
+  options?: { cwd?: string },
+): { target: "project" | "global"; path: string } {
+  const cwd = options?.cwd ?? process.cwd();
+  const paths = getSettingsPaths(cwd);
+
+  const projectState = readSettingsFileState(paths.project);
+  if ("malformed" in projectState) {
+    throw new Error(
+      `Refusing to select settings target because project settings are malformed or not a JSON object: ${paths.project}`,
+    );
+  }
+
+  const target: "project" | "global" =
+    projectState.exists && Object.hasOwn(projectState.value, "statusLine")
+      ? "project"
+      : "global";
+  const path = target === "project" ? paths.project : paths.global;
+
+  const targetState = readSettingsFileState(path);
+  if ("malformed" in targetState) {
+    throw new Error(
+      `Refusing to write malformed or non-object settings file: ${path}`,
+    );
+  }
+
+  const base = targetState.value;
+  const next = {
+    ...base,
+    statusLine: {
+      segments: [...config.segments],
+      filter:
+        config.filter.mode === "all"
+          ? { mode: "all", hidden: [...config.filter.hidden] }
+          : { mode: "only", shown: [...config.filter.shown] },
+    },
+  };
+
+  const parent = dirname(path);
+  mkdirSync(parent, { recursive: true });
+  const tempDir = mkdtempSync(join(parent, ".pi-status-"));
+  const tempFile = join(tempDir, "settings.json.tmp");
+  try {
+    writeFileSync(tempFile, `${JSON.stringify(next, null, 2)}\n`, "utf8");
+    renameSync(tempFile, path);
+  } finally {
+    rmSync(tempDir, { recursive: true, force: true });
+  }
+
+  return { target, path };
+}