6.3 KiB

Raw Blame History

Changing Paperclip's UI — a field guide

How to make visual changes now that the design system exists. Written for everyone: designers, engineers, and AI agents (AGENTS.md points here via DESIGN.md).

The one-minute mental model

Paperclip's look lives in three layers, and you almost always work in the first one:

Tokens — every color, text size, spacing, radius, and shadow is a named value in ui/src/index.css. Change a token, and every surface using it follows.
Components — consume tokens, never raw values. One component per job (one Button, one Card, one ToggleSwitch).
Screenshots — 510 baseline images (255 stories × light/dark) downloaded into tests/storybook-visual/.snapshots/ from the pinned external archive in tests/storybook-visual/baseline-manifest.json. They are the proof of what the UI looks like. Any visual change shows up as a screenshot diff; no visual change proves itself the same way.

The rules live in DESIGN.md (repo root). The reasoning behind past decisions lives in DECISION-SHEET.md. If you disagree with a rule, change DESIGN.md first (with review) — don't quietly diverge in code.

The three commands

pnpm check:token-gates        # am I allowed to write this? (no hardcoded values)
pnpm test:storybook-visual    # what does my change look like? (diff vs baseline)
pnpm test:storybook-visual:update   # accept my intentional changes as the new baseline

Recipe 1 — change how something looks everywhere

"Make the corners rounder." "That amber is too loud." "Bump the smallest text size."

Find the token in ui/src/index.css (they're named and commented: --radius, --status-task-todo, --text-micro, …).
Change the value.
pnpm test:storybook-visual — it will "fail" on every affected story. That's the point: each failure writes a before/actual/diff image triplet into tests/storybook-visual/test-results/. Review them (or npx playwright show-report from tests/storybook-visual/ for a browsable version).
Happy? pnpm test:storybook-visual:update, review the generated bundle under tests/storybook-visual/baseline-review/, publish it from a trusted maintainer environment, then commit the token edit and the updated manifest metadata together.

Notable single-knob tokens: --radius drives the entire corner ladder (sm→4xl are derived); the --status-task-* / --status-agent-* family is the app-wide status vocabulary (chips, charts, bars, live dots all follow it).

Recipe 2 — retheme the whole app

The core palette follows the shadcn token names, so a theme built at ui.shadcn.com/create applies as token values:

cd ui && pnpm dlx shadcn@latest init --preset <CODE> --force --no-reinstall

Then review the git diff and keep only the CSS-variable value changes — the CLI also tries to rewrite components.json, lib/utils.ts, and add dependencies; revert those (it once deleted 240 lines of our utils). Never use shadcn apply --preset (it overwrites component files). After the token diff is clean: Recipe 1 steps 3–4, plus a sanity pass on the Paperclip-specific tiers (agent gradients, WCAG-tuned status hues) for clashes.

Recipe 3 — build or style a component

Values: tokens only. No hex, no text-[11px], no p-[13px]. If no token fits, add a token — that's a feature, not a workaround.
Type: use the named ladder — --text-nano (10px) / --text-micro (11px) / Tailwind text-xs (12) / --text-compact (13) / text-sm (14). Letter-spacing: --tracking-label / --tracking-eyebrow / --tracking-caps.
Status: anything that means running/idle/paused/error/todo/done/blocked uses the status system (ui/src/lib/status-colors.ts helpers or --status-* tokens). Liveness is always blue.
Primitives: check ui/src/components/ui/ and doc/design/COMPONENT-INVENTORY.md before writing a new component. Switches are ToggleSwitch; badges/chips route through brandChipBadge.
Give it a story. New visual surface = new Storybook story = automatic screenshot coverage forever.
pnpm check:token-gates before you push. If a value genuinely can't be a token (third-party config, canvas fills, intentional one-off decoration on demo pages), it goes on the allowlist with an inline comment saying why.

Recipe 4 — you changed something and snapshots failed

That's the system working. Two cases:

You meant it → review the diffs (they're your design review), then pnpm test:storybook-visual:update, publish the packed baseline archive, and commit the manifest update with the change. A PR with visual changes but no baseline-manifest update is incomplete; baseline changes with no explanation are a red flag.
You didn't mean it → you broke something. The diff images show you exactly where. Do not update the baseline to make it green.

Three stories are known to flake under full parallel load (they pass in isolation — see DECISION-SHEET). Re-run a single story with npx playwright test --config tests/storybook-visual/playwright.config.ts -g "<story name>" before assuming a real failure.

For AI-agent sessions

(Running a session as the human? See AGENT-SESSIONS.md — this section is instructions for the agent itself.)

This system was built to be steered by instruction. "Make all running indicators blue" or "collapse these three grays into one" should land as a token edit or a small codemod plus a snapshot diff — not a manual hunt. If a change is mechanical and touches many files, write an idempotent script in scripts/ (see codemod-*.mjs for the pattern) instead of hand-editing. DESIGN.md is loaded via AGENTS.md; follow it exactly, and record consequential choices in DECISION-SHEET.md.

What's deliberately not done yet (don't fix ad hoc)

Tailwind palette classes (bg-red-500, ~3,100 sites) — scheduled for a dedicated cluster-by-cluster conversion pass; piecemeal fixes will collide with it.
Hand-rolled cards/pills → Card/Badge, sidebar agents-section unification — queued as a component-convergence pass with per-site snapshot verification.
ESLint ratchet — will eventually enforce the token rules at lint time; until then check:token-gates is the gate.

See DECISION-SHEET.md for the full ledger.

6.3 KiB Raw Blame History Unescape Escape