mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-11-08 01:57:31 +01:00
## Thinking Path > - Paperclip is the open source app people use to manage AI agents for work > - Its UI is the operator's daily surface: task lists, boards, budgets, agent status — all built on shadcn components and Tailwind > - Visual values (colors, spacing, type sizes, radii) were hardcoded at ~1,600 call sites: the same "small gray label" was 9/10/11px depending on the file, charts disagreed with chips about status colors, two toggle-switch implementations coexisted in two greens, and there was no visual regression coverage > - This made the UI drift-prone and made any restyle a hundreds-of-files project, which discourages design iteration > - This pull request extracts visual values into a single token layer in `ui/src/index.css`, adds a Storybook visual regression suite backed by external immutable baseline archives, and then applies a deliberate retune reviewed change-by-change on screenshot diffs > - The benefit is that Paperclip's look becomes a config surface: retheming is a token edit reviewed as a snapshot diff, drift is blocked by a token gate, and future UI PRs can prove exactly what changed visually without committing hundreds of PNGs ## Linked Issues or Issue Description No existing public issue covers this work (searched "design tokens", "visual regression", "design system" across issues and PRs). Related in spirit: Refs #8982 (theming a hardcoded panel — a one-off instance of the same problem class this PR addresses systematically). **Problem (feature-request form):** UI visual values are hardcoded per call site with no source of truth and no regression coverage; consistency depends on reviewer memory, and restyling requires mass file edits. **Proposed solution (this PR):** a single token layer + enforcement gate + externally stored visual snapshot suite, then an intentional restyle on top of that foundation. ## What Changed - **Token extraction (zero visual change, machine-verified during development):** committed codemods (`scripts/codemod-*.mjs`) moved ~1,600 hardcoded color/type/spacing/radius/shadow/misc values into named tokens in a non-inline `:root` block of `ui/src/index.css`. - **Visual regression suite:** `pnpm test:storybook-visual` covers 255 stories × light/dark = 510 Playwright screenshots at `maxDiffPixels: 0`, plus new primitive-coverage stories and deterministic-render fixes. - **External visual baselines:** committed PNG snapshots were removed. `tests/storybook-visual/baseline-manifest.json` pins an immutable archive URL/hash/size/count, and `scripts/storybook-visual-baseline.mjs` handles `download`, `verify`, `pack`, and trusted maintainer `upload` flows. - **Opt-in visual CI artifacts:** added a `Storybook Visual` workflow that runs on manual dispatch or PRs labeled `storybook-visual`, downloads/verifies the baseline, runs Playwright, and uploads Playwright report/test-result artifacts for review. Normal PR runs do not mutate baseline objects. - **Token gate:** `pnpm check:token-gates` — zero hex literals, zero arbitrary bracket values, zero raw font-sizes in `ui/src/components/**` and `ui/src/pages/**`, with a documented inline allowlist for legitimate opt-outs. - **Theme retune (intentional, snapshot-reviewed):** new base theme values; radius ladder derived from a single `--radius` knob; micro-type cluster collapsed to a named ladder (`--text-nano/micro/compact` + Tailwind `text-xs`/`text-sm`); letter-spacing collapsed to named steps. - **One status-color vocabulary:** charts, quota/budget bar fills, RUNNING/live chips, and liveness indicators all use the canonical `--status-*` hues. Light-mode legibility fixes for red alert surfaces that used dark-tuned text classes. - **One switch:** `ToggleSwitch` restyled to the registry capsule form, second hand-rolled implementation removed, and all call sites unified. - **Docs:** `DESIGN.md` is the design contract; `doc/design/` holds audit reports, decision logs, and updated guidance for external baseline review/update workflows. - Dead code removed (`agentStatusBadge` duplicate map), byte-identical contrast constants consolidated, semantic renames (`--project-seed`/`--project-none`, `--liveness-blue`). ## Verification - `pnpm check:token-gates` — 3/3 gates CLEAN during the design-system run - `pnpm typecheck` && `pnpm --filter @paperclipai/ui build` — green during the design-system run - `node --test scripts/__tests__/storybook-visual-baseline.test.mjs` — pass after external-baseline rework - `pnpm exec tsc --noEmit --pretty false --module NodeNext --moduleResolution NodeNext --target ES2022 --types node,@playwright/test tests/storybook-visual/playwright.config.ts tests/storybook-visual/storybook-visual.spec.ts` — pass after external-baseline rework - `git diff --check origin/pr/9134..HEAD` — pass after external-baseline rework - `find tests/storybook-visual -type f -name '*.png' -print | wc -l` — `0` - `node scripts/storybook-visual-baseline.mjs verify` — intentionally fails closed until the first trusted maintainer publishes the baseline archive and updates `baseline-manifest.json` ## Risks - **Large but shallow:** the PR still touches many UI files due to mechanical token extraction and retune work, but committed PNG snapshot churn has been removed from the branch. - **Baseline publication required before the visual suite can pass in clean clones:** the manifest currently has placeholder archive metadata. A trusted maintainer must publish the first immutable archive, then update `baseline-manifest.json`. - **Rendering platform variance:** the external baseline should be captured in the documented Linux/Chromium environment. Future CI runs verify against the pinned archive and fail closed on checksum/count mismatch. - **Visual CI is opt-in while stabilizing:** add the `storybook-visual` label or dispatch the workflow manually to produce downloadable Playwright report/test-result artifacts. - **Scheduled follow-ups, deliberately out of scope:** Tailwind palette classes map to semantic tokens in a dedicated pass; card/pill component consolidation; ESLint ratchet. Tracked in `doc/design/DECISION-SHEET.md`. ## Model Used Claude Fable 5 (Anthropic, `claude-fable-5`, Mythos-class tier) with extended thinking, running in Claude Code with tool use; mechanical phases delegated to Claude Sonnet subagents. Follow-up external-baseline rework assisted by OpenAI Codex (`gpt-5` coding agent with repository, terminal, and GitHub tool use). All bulk rewrites executed via deterministic, idempotent scripts committed in `scripts/`; intentional visual changes were human-reviewed on screenshot contact sheets. ## Checklist - [x] I have included a thinking path that traces from project context to this change - [x] I have specified the model used (with version and capability details) - [x] I have checked ROADMAP.md and confirmed this PR does not duplicate planned core work - [x] I have searched GitHub for duplicate or related PRs and linked them above - [x] I have either (a) linked existing issues with `Fixes: #` / `Closes #` / `Refs #` OR (b) described the issue in-PR following the relevant issue template - [x] I have not referenced internal/instance-local Paperclip issues or links (only public GitHub `#NNN` / `github.com/paperclipai/paperclip` URLs) - [x] My branch name describes the change (e.g. `docs/...`, `fix/...`) and contains no internal Paperclip ticket id or instance-derived details - [x] I have run targeted local verification and documented the intentional baseline-publication failure above - [x] I have added or updated tests where applicable - [x] I have updated relevant documentation to reflect my changes - [x] I have considered and documented any risks above - [ ] All Paperclip CI gates are green *(pending new CI run after this rework)* - [ ] Greptile is 5/5 with no open P2s, recommendations, or follow-ups *(pending review)* - [x] I will address all Greptile and reviewer comments before requesting merge 🤖 Generated with [Claude Code](https://claude.com/claude-code) and OpenAI Codex --------- Co-authored-by: Claude Fable 5 <noreply@anthropic.com> Co-authored-by: Dotta <bippadotta@protonmail.com> Co-authored-by: Paperclip <noreply@paperclip.ing>
349 lines
11 KiB
TypeScript
349 lines
11 KiB
TypeScript
import { useEffect, useRef } from "react";
|
|
|
|
const CHARS = [" ", ".", "·", "▪", "▫", "○"] as const;
|
|
const TARGET_FPS = 24;
|
|
const FRAME_INTERVAL_MS = 1000 / TARGET_FPS;
|
|
|
|
const PAPERCLIP_SPRITES = [
|
|
[
|
|
" ╭────╮ ",
|
|
" ╭╯╭──╮│ ",
|
|
" │ │ ││ ",
|
|
" │ │ ││ ",
|
|
" │ │ ││ ",
|
|
" │ │ ││ ",
|
|
" │ ╰──╯│ ",
|
|
" ╰─────╯ ",
|
|
],
|
|
[
|
|
" ╭─────╮ ",
|
|
" │╭──╮╰╮ ",
|
|
" ││ │ │ ",
|
|
" ││ │ │ ",
|
|
" ││ │ │ ",
|
|
" ││ │ │ ",
|
|
" │╰──╯ │ ",
|
|
" ╰────╯ ",
|
|
],
|
|
] as const;
|
|
|
|
type PaperclipSprite = (typeof PAPERCLIP_SPRITES)[number];
|
|
|
|
interface Clip {
|
|
x: number;
|
|
y: number;
|
|
vx: number;
|
|
vy: number;
|
|
life: number;
|
|
maxLife: number;
|
|
drift: number;
|
|
sprite: PaperclipSprite;
|
|
width: number;
|
|
height: number;
|
|
}
|
|
|
|
function measureChar(container: HTMLElement): { w: number; h: number } {
|
|
const span = document.createElement("span");
|
|
span.textContent = "M";
|
|
span.style.cssText =
|
|
"position:absolute;visibility:hidden;white-space:pre;font-size:11px;font-family:monospace;line-height:1;";
|
|
container.appendChild(span);
|
|
const rect = span.getBoundingClientRect();
|
|
container.removeChild(span);
|
|
return { w: rect.width, h: rect.height };
|
|
}
|
|
|
|
function spriteSize(sprite: PaperclipSprite): { width: number; height: number } {
|
|
let width = 0;
|
|
for (const row of sprite) width = Math.max(width, row.length);
|
|
return { width, height: sprite.length };
|
|
}
|
|
|
|
export function AsciiArtAnimation() {
|
|
const preRef = useRef<HTMLPreElement>(null);
|
|
const frameRef = useRef<number | null>(null);
|
|
|
|
useEffect(() => {
|
|
if (!preRef.current) return;
|
|
const preEl: HTMLPreElement = preRef.current;
|
|
const motionMedia = window.matchMedia("(prefers-reduced-motion: reduce)");
|
|
let isVisible = document.visibilityState !== "hidden";
|
|
let loopActive = false;
|
|
let lastRenderAt = 0;
|
|
let tick = 0;
|
|
let cols = 0;
|
|
let rows = 0;
|
|
let charW = 7;
|
|
let charH = 11;
|
|
let trail = new Float32Array(0);
|
|
let colWave = new Float32Array(0);
|
|
let rowWave = new Float32Array(0);
|
|
let clipMask = new Uint16Array(0);
|
|
let clips: Clip[] = [];
|
|
let lastOutput = "";
|
|
|
|
function toGlyph(value: number): string {
|
|
const clamped = Math.max(0, Math.min(0.999, value));
|
|
const idx = Math.floor(clamped * CHARS.length);
|
|
return CHARS[idx] ?? " ";
|
|
}
|
|
|
|
function rebuildGrid() {
|
|
const nextCols = Math.max(0, Math.ceil(preEl.clientWidth / Math.max(1, charW)));
|
|
const nextRows = Math.max(0, Math.ceil(preEl.clientHeight / Math.max(1, charH)));
|
|
if (nextCols === cols && nextRows === rows) return;
|
|
|
|
cols = nextCols;
|
|
rows = nextRows;
|
|
const cellCount = cols * rows;
|
|
trail = new Float32Array(cellCount);
|
|
colWave = new Float32Array(cols);
|
|
rowWave = new Float32Array(rows);
|
|
clipMask = new Uint16Array(cellCount);
|
|
clips = clips.filter((clip) => {
|
|
return (
|
|
clip.x > -clip.width - 2 &&
|
|
clip.x < cols + 2 &&
|
|
clip.y > -clip.height - 2 &&
|
|
clip.y < rows + 2
|
|
);
|
|
});
|
|
lastOutput = "";
|
|
}
|
|
|
|
function drawStaticFrame() {
|
|
if (cols <= 0 || rows <= 0) {
|
|
preEl.textContent = "";
|
|
return;
|
|
}
|
|
|
|
const grid = Array.from({ length: rows }, () => Array.from({ length: cols }, () => " "));
|
|
for (let r = 0; r < rows; r++) {
|
|
for (let c = 0; c < cols; c++) {
|
|
const ambient = (Math.sin(c * 0.11 + r * 0.04) + Math.cos(r * 0.08 - c * 0.02)) * 0.18 + 0.22;
|
|
grid[r][c] = toGlyph(ambient);
|
|
}
|
|
}
|
|
|
|
const gapX = 18;
|
|
const gapY = 13;
|
|
for (let baseRow = 1; baseRow < rows - 9; baseRow += gapY) {
|
|
const startX = Math.floor(baseRow / gapY) % 2 === 0 ? 2 : 10;
|
|
for (let baseCol = startX; baseCol < cols - 10; baseCol += gapX) {
|
|
const sprite = PAPERCLIP_SPRITES[(baseCol + baseRow) % PAPERCLIP_SPRITES.length]!;
|
|
for (let sr = 0; sr < sprite.length; sr++) {
|
|
const line = sprite[sr]!;
|
|
for (let sc = 0; sc < line.length; sc++) {
|
|
const ch = line[sc] ?? " ";
|
|
if (ch === " ") continue;
|
|
const row = baseRow + sr;
|
|
const col = baseCol + sc;
|
|
if (row < 0 || row >= rows || col < 0 || col >= cols) continue;
|
|
grid[row]![col] = ch;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
const output = grid.map((line) => line.join("")).join("\n");
|
|
preEl.textContent = output;
|
|
lastOutput = output;
|
|
}
|
|
|
|
function spawnClip() {
|
|
const sprite = PAPERCLIP_SPRITES[Math.floor(Math.random() * PAPERCLIP_SPRITES.length)]!;
|
|
const size = spriteSize(sprite);
|
|
const edge = Math.random();
|
|
let x = 0;
|
|
let y = 0;
|
|
let vx = 0;
|
|
let vy = 0;
|
|
|
|
if (edge < 0.68) {
|
|
x = Math.random() < 0.5 ? -size.width - 1 : cols + 1;
|
|
y = Math.random() * Math.max(1, rows - size.height);
|
|
vx = x < 0 ? 0.04 + Math.random() * 0.05 : -(0.04 + Math.random() * 0.05);
|
|
vy = (Math.random() - 0.5) * 0.014;
|
|
} else {
|
|
x = Math.random() * Math.max(1, cols - size.width);
|
|
y = Math.random() < 0.5 ? -size.height - 1 : rows + 1;
|
|
vx = (Math.random() - 0.5) * 0.014;
|
|
vy = y < 0 ? 0.028 + Math.random() * 0.034 : -(0.028 + Math.random() * 0.034);
|
|
}
|
|
|
|
clips.push({
|
|
x,
|
|
y,
|
|
vx,
|
|
vy,
|
|
life: 0,
|
|
maxLife: 260 + Math.random() * 220,
|
|
drift: (Math.random() - 0.5) * 1.2,
|
|
sprite,
|
|
width: size.width,
|
|
height: size.height,
|
|
});
|
|
}
|
|
|
|
function stampClip(clip: Clip, alpha: number) {
|
|
const baseCol = Math.round(clip.x);
|
|
const baseRow = Math.round(clip.y);
|
|
for (let sr = 0; sr < clip.sprite.length; sr++) {
|
|
const line = clip.sprite[sr]!;
|
|
const row = baseRow + sr;
|
|
if (row < 0 || row >= rows) continue;
|
|
for (let sc = 0; sc < line.length; sc++) {
|
|
const ch = line[sc] ?? " ";
|
|
if (ch === " ") continue;
|
|
const col = baseCol + sc;
|
|
if (col < 0 || col >= cols) continue;
|
|
const idx = row * cols + col;
|
|
const stroke = ch === "│" || ch === "─" ? 0.8 : 0.92;
|
|
trail[idx] = Math.max(trail[idx] ?? 0, alpha * stroke);
|
|
clipMask[idx] = ch.charCodeAt(0);
|
|
}
|
|
}
|
|
}
|
|
|
|
function step(time: number) {
|
|
if (!loopActive) return;
|
|
frameRef.current = requestAnimationFrame(step);
|
|
if (time - lastRenderAt < FRAME_INTERVAL_MS || cols <= 0 || rows <= 0) return;
|
|
|
|
const delta = Math.min(2, lastRenderAt === 0 ? 1 : (time - lastRenderAt) / 16.6667);
|
|
lastRenderAt = time;
|
|
tick += delta;
|
|
|
|
const cellCount = cols * rows;
|
|
const targetCount = Math.max(3, Math.floor(cellCount / 2200));
|
|
while (clips.length < targetCount) spawnClip();
|
|
|
|
for (let i = 0; i < trail.length; i++) trail[i] *= 0.92;
|
|
clipMask.fill(0);
|
|
|
|
for (let i = clips.length - 1; i >= 0; i--) {
|
|
const clip = clips[i]!;
|
|
clip.life += delta;
|
|
|
|
const wobbleX = Math.sin((clip.y + clip.drift + tick * 0.12) * 0.09) * 0.0018;
|
|
const wobbleY = Math.cos((clip.x - clip.drift - tick * 0.09) * 0.08) * 0.0014;
|
|
clip.vx = (clip.vx + wobbleX) * 0.998;
|
|
clip.vy = (clip.vy + wobbleY) * 0.998;
|
|
|
|
clip.x += clip.vx * delta;
|
|
clip.y += clip.vy * delta;
|
|
|
|
if (
|
|
clip.life >= clip.maxLife ||
|
|
clip.x < -clip.width - 2 ||
|
|
clip.x > cols + 2 ||
|
|
clip.y < -clip.height - 2 ||
|
|
clip.y > rows + 2
|
|
) {
|
|
clips.splice(i, 1);
|
|
continue;
|
|
}
|
|
|
|
const life = clip.life / clip.maxLife;
|
|
const alpha = life < 0.12 ? life / 0.12 : life > 0.88 ? (1 - life) / 0.12 : 1;
|
|
stampClip(clip, alpha);
|
|
}
|
|
|
|
for (let c = 0; c < cols; c++) colWave[c] = Math.sin(c * 0.08 + tick * 0.06);
|
|
for (let r = 0; r < rows; r++) rowWave[r] = Math.cos(r * 0.1 - tick * 0.05);
|
|
|
|
let output = "";
|
|
for (let r = 0; r < rows; r++) {
|
|
for (let c = 0; c < cols; c++) {
|
|
const idx = r * cols + c;
|
|
const clipChar = clipMask[idx];
|
|
if (clipChar > 0) {
|
|
output += String.fromCharCode(clipChar);
|
|
continue;
|
|
}
|
|
const ambient = (colWave[c] + rowWave[r]) * 0.08 + 0.1;
|
|
const intensity = Math.max(trail[idx] ?? 0, ambient * 0.45);
|
|
output += toGlyph(intensity);
|
|
}
|
|
if (r < rows - 1) output += "\n";
|
|
}
|
|
|
|
if (output !== lastOutput) {
|
|
preEl.textContent = output;
|
|
lastOutput = output;
|
|
}
|
|
}
|
|
|
|
function syncLoop() {
|
|
const canRender = cols > 0 && rows > 0;
|
|
if (motionMedia.matches) {
|
|
if (loopActive) {
|
|
loopActive = false;
|
|
if (frameRef.current !== null) cancelAnimationFrame(frameRef.current);
|
|
frameRef.current = null;
|
|
}
|
|
if (canRender) drawStaticFrame();
|
|
return;
|
|
}
|
|
|
|
if (!isVisible || !canRender) {
|
|
if (loopActive) {
|
|
loopActive = false;
|
|
if (frameRef.current !== null) cancelAnimationFrame(frameRef.current);
|
|
frameRef.current = null;
|
|
}
|
|
return;
|
|
}
|
|
|
|
if (!loopActive) {
|
|
loopActive = true;
|
|
lastRenderAt = 0;
|
|
frameRef.current = requestAnimationFrame(step);
|
|
}
|
|
}
|
|
|
|
const observer = new ResizeObserver(() => {
|
|
const size = measureChar(preEl);
|
|
charW = size.w;
|
|
charH = size.h;
|
|
rebuildGrid();
|
|
syncLoop();
|
|
});
|
|
observer.observe(preEl);
|
|
|
|
const onVisibilityChange = () => {
|
|
isVisible = document.visibilityState !== "hidden";
|
|
syncLoop();
|
|
};
|
|
document.addEventListener("visibilitychange", onVisibilityChange);
|
|
|
|
const onMotionChange = () => {
|
|
syncLoop();
|
|
};
|
|
motionMedia.addEventListener("change", onMotionChange);
|
|
|
|
const charSize = measureChar(preEl);
|
|
charW = charSize.w;
|
|
charH = charSize.h;
|
|
rebuildGrid();
|
|
syncLoop();
|
|
|
|
return () => {
|
|
loopActive = false;
|
|
if (frameRef.current !== null) cancelAnimationFrame(frameRef.current);
|
|
observer.disconnect();
|
|
document.removeEventListener("visibilitychange", onVisibilityChange);
|
|
motionMedia.removeEventListener("change", onMotionChange);
|
|
};
|
|
}, []);
|
|
|
|
return (
|
|
<pre
|
|
ref={preRef}
|
|
className="w-full h-full m-0 p-0 overflow-hidden text-muted-foreground/60 select-none leading-none"
|
|
style={{ fontSize: "var(--text-micro)", fontFamily: "monospace" }}
|
|
aria-hidden="true"
|
|
/>
|
|
);
|
|
}
|