Files
pipdock/docs/UI-SPEC.md
T
poli0981andClaude Opus 5 3fc529f42b feat(ui): the preview, the conflict control, the console and the summary
The mutation spine on screen — DATA-FLOW §3 from `Resolving` to `Summary`, and PRD G1's
promise that every mutating operation is previewed before it runs. `usePlanStore` tracks
which step is showing and nothing more: which step is *allowed* next is the flow's business,
in Rust, because two implementations of that state machine is what `core::flow` exists to
prevent.

**`Will downgrade` is its own section.** `ChangeKind` has four variants and UI-SPEC §4 named
three groups, so `Downgrade` had nowhere to go — and it is not rare: a *compatible* resolve
routinely moves a package down to satisfy something else. Folding it in with the upgrades
would put `2.0 → 1.9` under a heading reading "Will upgrade", which is misleading about
exactly the change most likely to surprise. §4 amended.

**`Keep compatible` is disabled on impossible rows.** UI-SPEC said every needs-decision row
hosts the full 3-way control, but `default_decision(is_impossible = true, …)` returns `Skip`
because an impossible package has no compatible version to keep. The UI mirrors the core
rather than offering a choice it would refuse to honour; §4 now says so too.

**The round counter is visible.** `MAX_CONFLICT_ROUNDS` has been in core since M1 with
nothing surfacing it, so a user could hit the cap unwarned. The preview says how many rounds
remain, and the exhausted state keeps the preview on screen with a warning rather than
dead-ending.

**The cancelled summary has copy now** — the third Stage 1 deferral. It says the run stopped
part-way, that a package may have been left half-written, and points at the snapshot, which
is the only complete answer to that.

Two smaller things worth their comments: the console buffer is capped at 2000 lines, because
a source build is tens of thousands and each would otherwise be a React state update holding
a string alive — the full log is the log file, which is what "Copy full log" reads. And
answers are cleared with the round they belonged to, since the next preview may name a
different set and a stale answer would be sent to a flow that has moved on.

"Update selected" is live, so UI-SPEC §5's budget is now real: Updates → Select all →
Update → Confirm.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
2026-08-04 18:47:15 +07:00

10 KiB
Raw Blame History

PipDock — UI Specification

Version 0.1 · 2026-07-17 · Direction: dark terminal-tech (owner decision 2026-07)

1. Design intent

PipDock should feel like a precision instrument docked over a terminal — the calm confidence of a good TUI with the affordances of a native app. Not a neon cyberpunk cliché, not a generic admin dashboard: restrained phosphor-green on near-black, monospace where data lives, one accent doing real work. Signature moves: a terminal-style status line pinned to the bottom, a live execution console that streams real engine output, and (P1) a Ctrl+K command palette.

Anti-goals: gradients-everywhere SaaS look, rounded-blob cards, decorative glow. Any glow is functional (focus rings, live-activity pulse) and subtle.

2. Design tokens (Tailwind 4 @theme)

Token Value Use
--color-bg #0A0E0C app background
--color-surface #101612 panels, rows
--color-surface-2 #161E18 hover, elevated
--color-border #1F2B23 hairlines
--color-accent #4ADE80 primary actions, focus, live pulse
--color-accent-dim #22935B secondary accents, links
--color-text #E7F0EA primary text
--color-text-dim #8AA394 secondary text, dimmed up-to-date rows
--color-warn #F5B94A held-back, warnings
--color-danger #F0574F impossible, failures, force actions
--color-info #5BC0DE pinned, informational chips

Type: Inter (UI), JetBrains Mono (package names, versions, console, status line — both OFL-licensed, bundled). Base 14 px, mono data 13 px. Radius 6 px; borders 1 px; shadows minimal. Motion: 120–160 ms ease-out; live-activity pulse on the status-line engine badge during execution; prefers-reduced-motion respected.

3. Layout

┌──────────────────────────────────────────────────────────────┐
│ ⌂ PipDock      [env: .venv (Py 3.12) ▾]        [engine: uv]  │  top bar
├───────────┬──────────────────────────────────────────────────┤
│ Environments        │                                        │
│ Installed           │                                        │
│ Updates (7)         │              content area              │
│ Search              │                                        │
│ Pins                │                                        │
│ Health              │                                        │
│ Security (P1)       │                                        │
│ Settings            │                                        │
├───────────┴──────────────────────────────────────────────────┤
│ ▸ .venv · Py 3.12.4 · uv 0.9.x · idle            log ⌄  ⚠ 0  │  status line
└──────────────────────────────────────────────────────────────┘

Sidebar is icon+label, collapsible to icons. Status line (mono) always shows env · python · engine · state, plus a log-drawer toggle. The console drawer slides up over the status line during execution, streaming plan-progress lines with per-package section markers; collapsible, never modal.

4. Screens

Environments. Auto-discovered list (source chip: registry / py launcher / uv / manual) with python version and package count; PEP 668 envs carry a red MANAGED chip and a disabled state explaining PD-ENV-002. Actions: Browse…, Rescan, star-as-default.

Installed. Virtualized table: name (mono) · version · latest · size · chips. When the env's hidden_user_site is non-null (non-venv system Pythons only — see SECURITY §2), an inline --color-info note above the table says user-account packages are not listed and names the path; it is informational, never a block, and never appears for a venv. Up-to-date rows use --color-text-dim (owner's "dimmed" requirement); outdated rows show an UPDATE badge; pinned rows a 🔒 --color-info chip. Row actions: pin/unpin, uninstall, details. Multi-select via checkboxes; bulk action bar appears on selection.

Updates. Same table filtered to outdated, badge count in sidebar. Header: Select all (excludes pinned; shows "3 pinned excluded"), Update selected. After resolve → Preview panel replaces the table: grouped sections — Will upgrade (A 1.2 → 2.0), Will downgrade, Will install, New dependencies, Needs decision (held-back in --color-warn with one-line blocker sentence; impossible in --color-danger). Each needs-decision row hosts a segmented control: Keep compatible · Skip · Force latest (Force opens an inline confirm naming what breaks). Footer: Confirm (n changes) / Back.

Will downgrade was added in S3. ChangeKind has always had four variants and this section named three, leaving Downgrade with nowhere to go — and it is not a rare case: a compatible resolve routinely moves a package down to satisfy something else's constraint. Folding it in with the upgrades would have been the worst outcome, since a row reading 2.0 → 1.9 under a heading that says "Will upgrade" is actively misleading about the one change most likely to surprise. It carries --color-warn for the same reason.

On impossible rows, Keep compatible is disabled. UI-SPEC once said every needs-decision row hosts the full 3-way control, but default_decision(is_impossible = true, …) returns Skip, because an impossible package has no compatible version to keep — there is nothing for the control to select. The UI mirrors the core rather than offering a choice that cannot be honoured.

The round counter is visible. MAX_CONFLICT_ROUNDS is 3; when a decision round is applied the preview says how many remain, and the exhausted state keeps the preview on screen with the controls disabled rather than dead-ending. Without it a user hits the cap unwarned.

Search. Search field autofocused; results stream under 50 ms per keystroke from the local index. Result row: name · summary (from cached metadata) · latest · INSTALLED ✓/UPDATE chip when applicable · [Add]. Right detail panel: description, requires-python, license, links. Queue ("dock bay") docks along the right edge as a slim column of added packages with editable version fields and Install (n).

Pins. Pin list with reason field; (P1) auto-suggest section: "urllib3 — 12 packages depend on it. Pin?".

Snapshots (surfaced under Environments → env detail): timeline of snapshots with trigger label, diff viewer (added/removed/changed in mono), Rollback… with its own preview per DATA-FLOW §8.

Health. Project-folder picker (persisted per env) → run panel with three result tabs (deptry / vulture / ruff) per CODE-HEALTH-SPEC; Fix with ruff gated behind explicit confirm listing file count.

Settings. Engine (pip/uv radio + detected versions), locale (EN/VI), thresholds (pin auto-suggest count, snapshot retention), index refresh, PEP 668 override (off by default, scary copy), Open logs folder, Legal & About (links to GitHub legal docs + re-open legal gate).

Legal gate (first run). Modal listing the five documents with GitHub links and a summarized disclaimer sentence; single checkbox "I have read and accept" → Continue. Decline exits the app. Consent stored with docs-version hash; hash bump re-triggers the gate.

5. Click budgets (owner ceiling: 5)

Flow Clicks Path
Update everything 4 Updates → Select all → Update → Confirm (app auto-scans on env open)
Update everything, 1 conflict kept compatible 4 default choice needs no extra click
Install one package 4 + typing Search (autofocus) → result [Add] → Install → Confirm
Uninstall one package 3 Installed row ⋮ → Uninstall → Confirm
Rollback last snapshot 4 Env detail → snapshot → Rollback → Confirm
Switch engine 3 Settings → engine radio → (auto-saved) back
Run Code Health 3 Health → Run (folder persisted) → view

6. Component inventory (prefix Pd)

PdSidebar, PdStatusLine, PdEnvSwitcher, PdPackageTable (virtualized), PdPackageRow, PdBadge, PdPreviewDiff, PdConflictRow (segmented 3-way), PdDockBay (queue), PdConsoleDrawer, PdSummarySheet, PdSnapshotTimeline, PdHealthReport, PdLegalGate, PdEmptyState, PdOfflineBanner.

7. States & feedback

  • Loading: skeleton rows in surface-2, never spinners longer than 300 ms without text.
  • Empty states: one mono glyph + one sentence + one action (e.g. Updates empty: ▸ all packages up to date).
  • Offline: banner chip in top bar; search works (local index), metadata panel shows cached-at timestamp.
  • Errors: inline with catalog code, human message (localized), and Details expanding stderr tail. Toasts only for background completions.
  • Destructive confirms (Force latest, uninstall with breakage, PEP 668 override) use --color-danger primary buttons and require the dialog's default focus to be Cancel.

8. Keyboard & accessibility

Full keyboard traversal: Ctrl+1..8 sidebar tabs, / focuses search, Space toggles row selection, Ctrl+A select-all-visible, Enter primary action, Esc closes drawers.

"Select-all-visible" means the current filtered set, not the rendered window. Resolved in S2: the package table is virtualized, so only ~25 of a 200-package environment are in the DOM at any moment and "visible" would otherwise mean whatever the scroll position happens to be. Ctrl+A selects every selectable row in the set the screen is showing — so on Updates that is the outdated rows, and pinned rows are excluded there as they are from the Select all button. The row, not its checkbox, is the tab stop and the target of Space; tabbing through two controls per row is not traversal at 200 rows. Contrast: all text tokens meet WCAG AA on their surfaces (verified in the design-token test); focus ring 2 px accent, never removed. Screen-reader labels on all icon buttons; live region announces execution progress summaries ("13 of 15 complete"). Windows high-contrast mode: tokens fall back to system colors.