mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-10-23 00:53:38 +02: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>
338 lines
12 KiB
TypeScript
338 lines
12 KiB
TypeScript
import { useId, useState, type ReactNode } from "react";
|
|
import {
|
|
ChevronDown,
|
|
CircleAlert,
|
|
CircleCheck,
|
|
Info,
|
|
OctagonAlert,
|
|
TriangleAlert,
|
|
type LucideIcon,
|
|
} from "lucide-react";
|
|
import { cn } from "@/lib/utils";
|
|
|
|
export type SystemNoticeTone = "neutral" | "info" | "success" | "warning" | "danger";
|
|
|
|
export type SystemNoticeMetadataRow =
|
|
| { kind: "text"; label: string; value: string }
|
|
| { kind: "code"; label: string; value: string }
|
|
| { kind: "issue"; label: string; identifier: string; href?: string; title?: string }
|
|
| { kind: "agent"; label: string; name: string; href?: string }
|
|
| { kind: "run"; label: string; runId: string; href?: string; status?: string };
|
|
|
|
export type SystemNoticeMetadataSection = {
|
|
title?: string;
|
|
rows: SystemNoticeMetadataRow[];
|
|
};
|
|
|
|
export type SystemNoticeProps = {
|
|
tone?: SystemNoticeTone;
|
|
/** Short label that names the system actor + tone, e.g. "System warning". Required so tone is not color-only. */
|
|
label?: string;
|
|
/** Short visible body — one or two sentences from the system perspective. */
|
|
body: ReactNode;
|
|
/** Optional small chip for the originating run link. */
|
|
source?: { label: string; href?: string };
|
|
/** Hidden-by-default metadata. Renders the Details affordance only when present. */
|
|
metadata?: SystemNoticeMetadataSection[];
|
|
/** Force the details panel open initially. Defaults to false (collapsed). */
|
|
detailsDefaultOpen?: boolean;
|
|
/** Optional ISO timestamp shown next to the label. */
|
|
timestamp?: string;
|
|
className?: string;
|
|
};
|
|
|
|
type ToneTokens = {
|
|
container: string;
|
|
iconWrap: string;
|
|
icon: LucideIcon;
|
|
iconClass: string;
|
|
label: string;
|
|
divider: string;
|
|
};
|
|
|
|
const TONE_TOKENS: Record<SystemNoticeTone, ToneTokens> = {
|
|
neutral: {
|
|
container:
|
|
"border-border bg-muted/35 dark:bg-muted/20",
|
|
iconWrap: "bg-muted text-foreground/70",
|
|
icon: Info,
|
|
iconClass: "text-muted-foreground",
|
|
label: "text-muted-foreground",
|
|
divider: "border-border/70",
|
|
},
|
|
info: {
|
|
container:
|
|
"border-sky-300/70 bg-sky-50/70 dark:border-sky-500/30 dark:bg-sky-500/10",
|
|
iconWrap: "bg-sky-100 text-sky-700 dark:bg-sky-500/20 dark:text-sky-200",
|
|
icon: Info,
|
|
iconClass: "text-sky-700 dark:text-sky-300",
|
|
label: "text-sky-800 dark:text-sky-200",
|
|
divider: "border-sky-300/50 dark:border-sky-500/30",
|
|
},
|
|
success: {
|
|
container:
|
|
"border-emerald-300/70 bg-emerald-50/70 dark:border-emerald-500/30 dark:bg-emerald-500/10",
|
|
iconWrap: "bg-emerald-100 text-emerald-700 dark:bg-emerald-500/20 dark:text-emerald-200",
|
|
icon: CircleCheck,
|
|
iconClass: "text-emerald-700 dark:text-emerald-300",
|
|
label: "text-emerald-800 dark:text-emerald-200",
|
|
divider: "border-emerald-300/50 dark:border-emerald-500/30",
|
|
},
|
|
warning: {
|
|
container:
|
|
"border-amber-300/70 bg-amber-50/80 dark:border-amber-500/30 dark:bg-amber-500/10",
|
|
iconWrap: "bg-amber-100 text-amber-800 dark:bg-amber-500/20 dark:text-amber-200",
|
|
icon: TriangleAlert,
|
|
iconClass: "text-amber-700 dark:text-amber-300",
|
|
label: "text-amber-900 dark:text-amber-200",
|
|
divider: "border-amber-300/60 dark:border-amber-500/30",
|
|
},
|
|
danger: {
|
|
container:
|
|
"border-red-400/60 bg-red-50/80 dark:border-red-500/35 dark:bg-red-500/10",
|
|
iconWrap: "bg-red-100 text-red-700 dark:bg-red-500/20 dark:text-red-200",
|
|
icon: OctagonAlert,
|
|
iconClass: "text-red-700 dark:text-red-300",
|
|
label: "text-red-900 dark:text-red-200",
|
|
divider: "border-red-400/50 dark:border-red-500/30",
|
|
},
|
|
};
|
|
|
|
function formatTimestamp(ts: string) {
|
|
try {
|
|
return new Date(ts).toLocaleString(undefined, {
|
|
month: "short",
|
|
day: "numeric",
|
|
hour: "numeric",
|
|
minute: "2-digit",
|
|
});
|
|
} catch {
|
|
return ts;
|
|
}
|
|
}
|
|
|
|
function MetadataRow({ row, tone }: { row: SystemNoticeMetadataRow; tone: ToneTokens }) {
|
|
return (
|
|
<div className="grid grid-cols-(--gtc-8) gap-x-3 gap-y-0.5 px-3 py-1.5 text-xs">
|
|
<div className="truncate text-(length:--text-micro) font-medium uppercase tracking-(--tracking-label) text-muted-foreground">
|
|
{row.label}
|
|
</div>
|
|
<div className="min-w-0 break-words text-foreground/90">
|
|
{(() => {
|
|
switch (row.kind) {
|
|
case "text":
|
|
return <span>{row.value}</span>;
|
|
case "code":
|
|
return (
|
|
<code className="rounded bg-muted px-1.5 py-0.5 font-mono text-(length:--text-micro) text-foreground/80">
|
|
{row.value}
|
|
</code>
|
|
);
|
|
case "issue": {
|
|
const issueLabel = (
|
|
<>
|
|
<span>{row.identifier}</span>
|
|
{row.title ? (
|
|
<span className="text-muted-foreground">— {row.title}</span>
|
|
) : null}
|
|
</>
|
|
);
|
|
if (row.href) {
|
|
return (
|
|
<a
|
|
href={row.href}
|
|
className={cn(
|
|
"inline-flex items-center gap-1 rounded-sm font-medium underline-offset-2 hover:underline",
|
|
tone.label,
|
|
)}
|
|
>
|
|
{issueLabel}
|
|
</a>
|
|
);
|
|
}
|
|
return (
|
|
<span className={cn("inline-flex items-center gap-1 font-medium", tone.label)}>
|
|
{issueLabel}
|
|
</span>
|
|
);
|
|
}
|
|
case "agent":
|
|
if (row.href) {
|
|
return (
|
|
<a
|
|
href={row.href}
|
|
className={cn(
|
|
"inline-flex items-center gap-1 rounded-sm font-medium underline-offset-2 hover:underline",
|
|
tone.label,
|
|
)}
|
|
>
|
|
{row.name}
|
|
</a>
|
|
);
|
|
}
|
|
return (
|
|
<span className={cn("font-medium", tone.label)}>{row.name}</span>
|
|
);
|
|
case "run": {
|
|
const runShort = row.runId.length > 12 ? `${row.runId.slice(0, 8)}…` : row.runId;
|
|
const inner = (
|
|
<>
|
|
<code className="rounded bg-muted px-1.5 py-0.5 text-foreground/80">{runShort}</code>
|
|
{row.status ? (
|
|
<span className={cn("font-sans", tone.label)}>{row.status}</span>
|
|
) : null}
|
|
</>
|
|
);
|
|
if (row.href) {
|
|
return (
|
|
<a
|
|
href={row.href}
|
|
className="inline-flex items-center gap-2 rounded-sm font-mono text-(length:--text-micro) underline-offset-2 hover:underline"
|
|
>
|
|
{inner}
|
|
</a>
|
|
);
|
|
}
|
|
return (
|
|
<span className="inline-flex items-center gap-2 font-mono text-(length:--text-micro)">
|
|
{inner}
|
|
</span>
|
|
);
|
|
}
|
|
}
|
|
})()}
|
|
</div>
|
|
</div>
|
|
);
|
|
}
|
|
|
|
export function SystemNotice({
|
|
tone = "neutral",
|
|
label,
|
|
body,
|
|
source,
|
|
metadata,
|
|
detailsDefaultOpen = false,
|
|
timestamp,
|
|
className,
|
|
}: SystemNoticeProps) {
|
|
const tokens = TONE_TOKENS[tone];
|
|
const ToneIcon = tokens.icon;
|
|
const [open, setOpen] = useState(detailsDefaultOpen);
|
|
const detailsId = useId();
|
|
const hasDetails = Boolean(metadata && metadata.length > 0);
|
|
const resolvedLabel =
|
|
label ??
|
|
{
|
|
neutral: "System notice",
|
|
info: "System notice",
|
|
success: "System notice",
|
|
warning: "System warning",
|
|
danger: "System alert",
|
|
}[tone];
|
|
|
|
return (
|
|
<section
|
|
role="status"
|
|
aria-label={resolvedLabel}
|
|
className={cn(
|
|
"relative w-full overflow-hidden rounded-lg border text-sm shadow-(--shadow-extract-8)",
|
|
tokens.container,
|
|
className,
|
|
)}
|
|
>
|
|
<header className="flex items-start gap-3 px-3 py-2.5 sm:px-4">
|
|
<span
|
|
className={cn(
|
|
"mt-0.5 flex h-7 w-7 shrink-0 items-center justify-center rounded-md",
|
|
tokens.iconWrap,
|
|
)}
|
|
aria-hidden
|
|
>
|
|
<ToneIcon className={cn("h-4 w-4", tokens.iconClass)} />
|
|
</span>
|
|
<div className="min-w-0 flex-1">
|
|
<div className="flex flex-wrap items-center gap-x-2 gap-y-0.5 text-(length:--text-micro) font-semibold uppercase tracking-(--tracking-eyebrow)">
|
|
<span className={tokens.label}>{resolvedLabel}</span>
|
|
{source ? (
|
|
<>
|
|
<span className="text-muted-foreground/60" aria-hidden>·</span>
|
|
{source.href ? (
|
|
<a
|
|
href={source.href}
|
|
className="rounded-sm font-medium normal-case tracking-normal text-muted-foreground underline-offset-2 hover:text-foreground hover:underline"
|
|
>
|
|
{source.label}
|
|
</a>
|
|
) : (
|
|
<span className="font-medium normal-case tracking-normal text-muted-foreground">
|
|
{source.label}
|
|
</span>
|
|
)}
|
|
</>
|
|
) : null}
|
|
{timestamp ? (
|
|
<>
|
|
<span className="text-muted-foreground/60" aria-hidden>·</span>
|
|
<span className="font-medium normal-case tracking-normal text-muted-foreground">
|
|
{formatTimestamp(timestamp)}
|
|
</span>
|
|
</>
|
|
) : null}
|
|
</div>
|
|
<div className="mt-1 break-words text-sm leading-6 text-foreground">{body}</div>
|
|
</div>
|
|
{hasDetails ? (
|
|
<button
|
|
type="button"
|
|
onClick={() => setOpen((v) => !v)}
|
|
aria-expanded={open}
|
|
aria-controls={detailsId}
|
|
className={cn(
|
|
"ml-1 inline-flex h-7 shrink-0 items-center gap-1 rounded-md border border-transparent px-2 text-(length:--text-micro) font-medium uppercase tracking-(--tracking-eyebrow) text-muted-foreground transition-(--tp-background-color-border-color-color)",
|
|
"hover:border-border/70 hover:bg-background/70 hover:text-foreground",
|
|
"focus-visible:outline-none focus-visible:ring-2 focus-visible:ring-ring/50",
|
|
)}
|
|
>
|
|
<span>{open ? "Hide details" : "Details"}</span>
|
|
<ChevronDown
|
|
className={cn(
|
|
"h-3.5 w-3.5 transition-transform duration-150",
|
|
open && "rotate-180",
|
|
)}
|
|
/>
|
|
</button>
|
|
) : null}
|
|
</header>
|
|
{hasDetails && open ? (
|
|
<div
|
|
id={detailsId}
|
|
className={cn(
|
|
"border-t bg-background/50 dark:bg-background/30",
|
|
tokens.divider,
|
|
)}
|
|
>
|
|
<div className="divide-y divide-border/50 px-1 py-1">
|
|
{metadata!.map((section, sectionIdx) => (
|
|
<div key={sectionIdx} className="py-1.5 first:pt-2 last:pb-2">
|
|
{section.title ? (
|
|
<div className="px-3 pb-1 pt-0.5 text-(length:--text-nano) font-semibold uppercase tracking-(--tracking-caps) text-muted-foreground">
|
|
{section.title}
|
|
</div>
|
|
) : null}
|
|
<div>
|
|
{section.rows.map((row, rowIdx) => (
|
|
<MetadataRow key={rowIdx} row={row} tone={tokens} />
|
|
))}
|
|
</div>
|
|
</div>
|
|
))}
|
|
</div>
|
|
</div>
|
|
) : null}
|
|
</section>
|
|
);
|
|
}
|
|
|
|
export default SystemNotice;
|