evan/pi-statusline
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: update AGENTS.md with accurate file layout and current conventions

Browse Source
This commit is contained in:
Evan Reichard
2026-05-03 21:22:26 -04:00
parent 35f8276a16
commit 7906519eeb
1 changed files with 10 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
AGENTS.md
View File

@@ -6,14 +6,17 @@
## Layout ## Layout
- `index.ts` — Extension entrypoint, footer registration, refresh timers, slash command, auth lookup. - `index.ts` — Extension entrypoint, footer registration, refresh timers, debounced rendering, slash command, auth lookup.
- `config.ts` — User-facing layout/config. Prefer changing this for layout tweaks. - `config.ts` — User-facing layout/config. Prefer changing this for layout tweaks.
- `types.ts` — Shared config/module/state types. - `types.ts` — Shared config/module/state types.
- `render.ts` — Width allocation, ANSI-aware truncation, dim text rendering. - `render.ts` — Width allocation, ANSI-aware truncation, dim text rendering.
- `utils.ts` — Shared utility helpers (`isRecord`, `toNumber`).
- `usage.ts` — Provider-agnostic usage type definitions (report, limit, credential, etc.).
- `modules/basic.ts` — Directory, context, model, thinking, and cost modules. - `modules/basic.ts` — Directory, context, model, thinking, and cost modules.
- `modules/usage.ts` — Usage bars/text modules and color gradient rendering. - `modules/usage.ts` — Usage bars/text modules and color gradient rendering.
- `usage/` — Provider usage fetchers adapted from `oh-my-pi`: https://github.com/can1357/oh-my-pi/tree/main/packages/ai/src/usage - `usage/` — Provider usage fetchers adapted from `oh-my-pi`: https://github.com/can1357/oh-my-pi/tree/main/packages/ai/src/usage
- `providers/openai-codex/constants.ts`, `usage.ts`, `utils.ts` — Local shims/support for copied usage code. - `usage/shared.ts` — Shared helpers for usage fetchers.
- `providers/openai-codex/constants.ts` — OpenAI Codex base URL constant.
## Conventions ## Conventions
@@ -26,14 +29,15 @@
{ type: "usage", window: "week", style: "text", parts: ["percent", "time"], separator: " | " } { type: "usage", window: "week", style: "text", parts: ["percent", "time"], separator: " | " }
``` ```
- Usage fallback behavior should be stable/no-pop-in: - Usage data is preserved during refresh (no clearing before fetch) to prevent pop-in:
- unknown/loading line bars render like 0% usage - Old data stays visible until new data arrives.
- unknown/loading percent renders `0%` - When no data exists yet: line bars render like 0% usage, percent renders `0%`, time renders `∞`.
- unknown/loading time renders `∞`
- Usage bar colors are a continuous green → yellow → red gradient derived from usage percentage, not hard thresholds. - Usage bar colors are a continuous green → yellow → red gradient derived from usage percentage, not hard thresholds.
- Rendering must remain ANSI-aware. If adding colors, update `visibleWidth`/`truncate` behavior as needed. - Rendering must remain ANSI-aware. If adding colors, update `visibleWidth`/`truncate` behavior as needed.
- Text modules and separators should remain dim; filled usage bars may use gradient color. - Text modules and separators should remain dim; filled usage bars may use gradient color.
- Thinking level comes from `pi.getThinkingLevel()` and `thinking_level_select`, not `ctx.thinkingLevel`. - Thinking level comes from `pi.getThinkingLevel()` and `thinking_level_select`, not `ctx.thinkingLevel`.
- `rerender()` is debounced via `queueMicrotask` — multiple rapid calls coalesce into a single render pass.
- All providers use the same refresh interval (`REFRESH_MS`).
## Testing ## Testing