mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-10-26 18:31:34 +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>
201 lines
6.9 KiB
TypeScript
201 lines
6.9 KiB
TypeScript
import type { ReactNode } from "react";
|
||
import type {
|
||
ExternalObjectLivenessState,
|
||
ExternalObjectStatusCategory,
|
||
} from "@paperclipai/shared";
|
||
import { ExternalObjectStatusIcon } from "./ExternalObjectStatusIcon";
|
||
import {
|
||
externalObjectStatusIcon,
|
||
externalObjectStatusIconDefault,
|
||
externalObjectLivenessOverlay,
|
||
} from "../lib/status-colors";
|
||
import {
|
||
externalObjectCategoryLabel,
|
||
externalObjectDisplayLabel,
|
||
externalObjectLivenessLabel,
|
||
externalObjectIconForKey,
|
||
externalObjectProviderLabel,
|
||
externalObjectTypeLabel,
|
||
} from "../lib/external-objects";
|
||
import { cn } from "../lib/utils";
|
||
|
||
export interface ExternalObjectPillData {
|
||
providerKey: string | null;
|
||
objectType: string | null;
|
||
displayKey?: string | null;
|
||
iconKey?: string | null;
|
||
statusCategory: ExternalObjectStatusCategory;
|
||
liveness: ExternalObjectLivenessState;
|
||
displayTitle?: string | null;
|
||
statusLabel?: string | null;
|
||
statusIconKey?: string | null;
|
||
url?: string | null;
|
||
}
|
||
|
||
function githubObjectLabel(url: string | null | undefined): string | null {
|
||
if (!url) return null;
|
||
try {
|
||
const parsed = new URL(url);
|
||
if (parsed.hostname !== "github.com") return null;
|
||
const [, owner, repo, kind, number] = parsed.pathname.split("/");
|
||
if (!owner || !repo || !number) return null;
|
||
if (kind === "pull") return `PR ${number}`;
|
||
if (kind === "issues") return `Issue ${number}`;
|
||
return null;
|
||
} catch {
|
||
return null;
|
||
}
|
||
}
|
||
|
||
function externalObjectValueLabel(
|
||
object: ExternalObjectPillData,
|
||
fallback: string,
|
||
statusLabel: string,
|
||
): string {
|
||
const githubLabel = object.providerKey === "github" ? githubObjectLabel(object.url) : null;
|
||
const base = githubLabel ?? object.displayTitle?.trim() ?? fallback;
|
||
return statusLabel ? `${base} - ${statusLabel}` : base;
|
||
}
|
||
|
||
function isMergedExternalObject(object: ExternalObjectPillData, statusLabel: string): boolean {
|
||
return object.statusIconKey === "git-merge" || statusLabel.toLowerCase() === "merged";
|
||
}
|
||
|
||
function externalObjectPillTone(object: ExternalObjectPillData, statusLabel: string): string {
|
||
if (isMergedExternalObject(object, statusLabel)) {
|
||
return "text-violet-600 border-violet-600 dark:text-violet-400 dark:border-violet-400";
|
||
}
|
||
return externalObjectStatusIcon[object.statusCategory] ?? externalObjectStatusIconDefault;
|
||
}
|
||
|
||
function externalObjectStatusIconKey(
|
||
object: ExternalObjectPillData,
|
||
statusLabel: string,
|
||
): string | null | undefined {
|
||
if (isMergedExternalObject(object, statusLabel)) return object.statusIconKey ?? "git-merge";
|
||
return object.statusIconKey;
|
||
}
|
||
|
||
interface ExternalObjectPillProps {
|
||
object: ExternalObjectPillData;
|
||
/** Optional external mention count (renders as `×N` superscript when > 1). */
|
||
sourceCount?: number;
|
||
/** Optional source-mention summary used as the pill's `title` attribute. */
|
||
sourceSummary?: string | null;
|
||
className?: string;
|
||
/** Optional rendered label override. Defaults to `provider object-type`. */
|
||
children?: ReactNode;
|
||
/**
|
||
* If true the pill renders without a hover treatment (used inside
|
||
* non-interactive contexts like the property panel). Defaults to false.
|
||
*/
|
||
inert?: boolean;
|
||
/**
|
||
* Hide the provider icon when the surrounding UI already names the provider.
|
||
* The status icon still renders as the single state glyph inside the pill.
|
||
*/
|
||
showProviderIcon?: boolean;
|
||
}
|
||
|
||
/**
|
||
* External-object equivalent of `IssueReferencePill`. Same `paperclip-mention-chip`
|
||
* base so external references feel native to readers (Jakob's Law).
|
||
*/
|
||
export function ExternalObjectPill({
|
||
object,
|
||
sourceCount,
|
||
sourceSummary,
|
||
className,
|
||
children,
|
||
inert,
|
||
showProviderIcon = true,
|
||
}: ExternalObjectPillProps) {
|
||
const overlay = externalObjectLivenessOverlay[object.liveness] ?? "";
|
||
const providerLabel = externalObjectProviderLabel(object.providerKey);
|
||
const typeLabel = externalObjectTypeLabel(object.objectType);
|
||
const displayKey = externalObjectDisplayLabel(object.providerKey, object.objectType, object.displayKey);
|
||
const statusLabel = object.statusLabel ?? externalObjectCategoryLabel(object.statusCategory);
|
||
const tone = externalObjectPillTone(object, statusLabel);
|
||
const valueLabel = externalObjectValueLabel(object, displayKey, statusLabel);
|
||
const statusIconKey = externalObjectStatusIconKey(object, statusLabel);
|
||
const livenessLabel = externalObjectLivenessLabel(object.liveness);
|
||
const ProviderIcon = externalObjectIconForKey(object.iconKey);
|
||
const ariaKey = displayKey;
|
||
const ariaLabel = `${ariaKey} — ${statusLabel}${
|
||
object.liveness === "fresh" || object.liveness === "unknown" ? "" : ` (${livenessLabel})`
|
||
}${object.displayTitle ? `: ${object.displayTitle}` : ""}`;
|
||
|
||
const interactive = !inert && Boolean(object.url);
|
||
const classNames = cn(
|
||
"paperclip-mention-chip paperclip-mention-chip--external-object",
|
||
"inline-flex max-w-full items-center gap-1 rounded-full border border-border px-2 py-0.5 text-xs no-underline",
|
||
// Tone is applied as text classes only — the border style comes from the
|
||
// overlay (dashed for stale/auth/unreachable).
|
||
tone.split(" ").filter((c) => c.startsWith("text-")).join(" "),
|
||
overlay,
|
||
interactive
|
||
&& "hover:bg-accent/50 focus-visible:outline-none focus-visible:ring-(length:--rad-3) focus-visible:ring-ring",
|
||
className,
|
||
);
|
||
const titleAttr = sourceSummary
|
||
? `${object.displayTitle ?? displayKey} — ${sourceSummary}`
|
||
: object.displayTitle ?? displayKey;
|
||
const labelText = children ?? (
|
||
<>
|
||
<ExternalObjectStatusIcon
|
||
category={object.statusCategory}
|
||
liveness={object.liveness}
|
||
statusIconKey={statusIconKey}
|
||
sizeClassName="h-3 w-3"
|
||
label={`${providerLabel}: ${statusLabel}`}
|
||
/>
|
||
<span className="max-w-(--sz-16rem) truncate font-medium">{valueLabel}</span>
|
||
</>
|
||
);
|
||
const countSuffix = typeof sourceCount === "number" && sourceCount > 1 ? (
|
||
<span className="tabular-nums text-(length:--text-nano) font-medium opacity-80">×{sourceCount}</span>
|
||
) : null;
|
||
const innerContent = (
|
||
<>
|
||
{showProviderIcon && ProviderIcon ? (
|
||
<ProviderIcon aria-hidden="true" className="h-3 w-3 shrink-0" />
|
||
) : null}
|
||
<span className="inline-flex min-w-0 items-center gap-1">
|
||
{labelText}
|
||
</span>
|
||
{countSuffix}
|
||
</>
|
||
);
|
||
|
||
if (interactive && object.url) {
|
||
return (
|
||
<a
|
||
href={object.url}
|
||
target="_blank"
|
||
rel="noopener noreferrer"
|
||
data-mention-kind="external-object"
|
||
data-external-status={object.statusCategory}
|
||
data-external-liveness={object.liveness}
|
||
className={classNames}
|
||
title={titleAttr}
|
||
aria-label={ariaLabel}
|
||
>
|
||
{innerContent}
|
||
</a>
|
||
);
|
||
}
|
||
|
||
return (
|
||
<span
|
||
data-mention-kind="external-object"
|
||
data-external-status={object.statusCategory}
|
||
data-external-liveness={object.liveness}
|
||
className={classNames}
|
||
title={titleAttr}
|
||
aria-label={ariaLabel}
|
||
>
|
||
{innerContent}
|
||
</span>
|
||
);
|
||
}
|