mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-10-29 04:25:52 +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>
189 lines
6.3 KiB
TypeScript
189 lines
6.3 KiB
TypeScript
import type { Meta, StoryObj } from "@storybook/react-vite";
|
|
import { useState } from "react";
|
|
import { QueryClient, QueryClientProvider } from "@tanstack/react-query";
|
|
import type {
|
|
DocumentAnnotationThreadWithComments,
|
|
DocumentAnnotationThreadStatus,
|
|
DocumentAnnotationAnchorState,
|
|
} from "@paperclipai/shared";
|
|
import { DocumentAnnotationPanel } from "@/components/DocumentAnnotationPanel";
|
|
import type { PendingAnchor } from "@/components/DocumentAnnotationLayer";
|
|
import type { CompanyUserProfile } from "@/lib/company-members";
|
|
import { queryKeys } from "@/lib/queryKeys";
|
|
|
|
const issueId = "issue-doc-comments";
|
|
const documentKey = "plan";
|
|
const currentUserId = "user-board";
|
|
|
|
const userProfileMap = new Map<string, CompanyUserProfile>([
|
|
[currentUserId, { label: "Dotta", image: null }],
|
|
["user-pm", { label: "Mara Product", image: null }],
|
|
]);
|
|
|
|
function makeThread(
|
|
overrides: Partial<DocumentAnnotationThreadWithComments> = {},
|
|
): DocumentAnnotationThreadWithComments {
|
|
const id = overrides.id ?? "thread-1";
|
|
const status: DocumentAnnotationThreadStatus = overrides.status ?? "open";
|
|
const anchorState: DocumentAnnotationAnchorState = overrides.anchorState ?? "active";
|
|
return {
|
|
id,
|
|
companyId: "co-1",
|
|
issueId,
|
|
documentId: "doc-1",
|
|
documentKey,
|
|
status,
|
|
anchorState,
|
|
anchorConfidence: "exact",
|
|
originalRevisionId: "rev-4",
|
|
originalRevisionNumber: 4,
|
|
currentRevisionId: "rev-4",
|
|
currentRevisionNumber: 4,
|
|
selectedText:
|
|
"the assistant should keep the existing editor selection highlighted while the comment composer is open",
|
|
prefixText: "We agreed ",
|
|
suffixText: ".",
|
|
normalizedStart: 0,
|
|
normalizedEnd: 22,
|
|
markdownStart: 0,
|
|
markdownEnd: 22,
|
|
anchorSelector: {
|
|
quote: { exact: "selection", prefix: "We ", suffix: "." },
|
|
position: { normalizedStart: 0, normalizedEnd: 22, markdownStart: 0, markdownEnd: 22 },
|
|
},
|
|
createdByAgentId: null,
|
|
createdByUserId: currentUserId,
|
|
resolvedByAgentId: null,
|
|
resolvedByUserId: null,
|
|
resolvedAt: null,
|
|
createdAt: new Date("2026-06-12T00:01:00Z"),
|
|
updatedAt: new Date("2026-06-12T00:02:00Z"),
|
|
comments: [
|
|
{
|
|
id: `${id}-c1`,
|
|
companyId: "co-1",
|
|
threadId: id,
|
|
issueId,
|
|
documentId: "doc-1",
|
|
body: "Please confirm this is still the behaviour we want.",
|
|
authorType: "user",
|
|
authorAgentId: null,
|
|
authorUserId: "user-pm",
|
|
createdByRunId: null,
|
|
createdAt: new Date("2026-06-12T00:01:00Z"),
|
|
updatedAt: new Date("2026-06-12T00:01:00Z"),
|
|
},
|
|
],
|
|
...overrides,
|
|
};
|
|
}
|
|
|
|
const pendingAnchor: PendingAnchor = {
|
|
selector: {
|
|
quote: { exact: "extremely snappy", prefix: "feels ", suffix: "." },
|
|
position: { normalizedStart: 0, normalizedEnd: 16, markdownStart: 0, markdownEnd: 16 },
|
|
},
|
|
selectedText:
|
|
"submission of comments should be optimistic so the whole interaction feels extremely snappy",
|
|
};
|
|
|
|
function PanelFrame({
|
|
label,
|
|
threads,
|
|
focusedThreadId = null,
|
|
pending = null,
|
|
}: {
|
|
label: string;
|
|
threads: DocumentAnnotationThreadWithComments[];
|
|
focusedThreadId?: string | null;
|
|
pending?: PendingAnchor | null;
|
|
}) {
|
|
const [client] = useState(() => {
|
|
const qc = new QueryClient({ defaultOptions: { queries: { retry: false } } });
|
|
qc.setQueryData(queryKeys.auth.session, {
|
|
session: { id: "sess-1", userId: currentUserId },
|
|
user: { id: currentUserId, email: "dotta@example.local", name: "Dotta", image: null },
|
|
});
|
|
return qc;
|
|
});
|
|
const [focused, setFocused] = useState<string | null>(focusedThreadId);
|
|
|
|
return (
|
|
<div className="flex flex-col gap-2">
|
|
<div className="paperclip-story__label">{label}</div>
|
|
<QueryClientProvider client={client}>
|
|
<div className="h-[460px]">
|
|
<DocumentAnnotationPanel
|
|
open
|
|
onOpenChange={() => undefined}
|
|
issueId={issueId}
|
|
documentKey={documentKey}
|
|
documentRevisionNumber={4}
|
|
baseRevisionId="rev-4"
|
|
baseRevisionNumber={4}
|
|
threads={threads}
|
|
focusedThreadId={focused}
|
|
onFocusThread={setFocused}
|
|
focusedCommentId={null}
|
|
pendingAnchor={pending}
|
|
onClearPendingAnchor={() => undefined}
|
|
desktopWidth={360}
|
|
userProfileMap={userProfileMap}
|
|
/>
|
|
</div>
|
|
</QueryClientProvider>
|
|
</div>
|
|
);
|
|
}
|
|
|
|
function DocumentCommentsMatrix() {
|
|
return (
|
|
<div className="paperclip-story">
|
|
<main className="paperclip-story__inner">
|
|
<section className="paperclip-story__frame overflow-hidden">
|
|
<div className="border-b border-border px-5 py-4">
|
|
<div className="paperclip-story__label">Document comments · PAP-10960</div>
|
|
<h2 className="mt-1 text-xl font-semibold">Simplified annotation panel</h2>
|
|
<p className="mt-1 text-sm text-muted-foreground">
|
|
No header, no filter chips, no empty-state copy. Revision indicator sits top-right.
|
|
The composer shows the author avatar + name, two-line clamped quote, and a plain
|
|
"Reply" affordance.
|
|
</p>
|
|
</div>
|
|
<div className="flex flex-wrap items-start gap-6 p-5">
|
|
<PanelFrame label="No comments yet" threads={[]} />
|
|
<PanelFrame
|
|
label="With comments (one expanded)"
|
|
threads={[
|
|
makeThread({ id: "thread-1" }),
|
|
makeThread({ id: "thread-2", status: "resolved", selectedText: "a resolved thread stays in the same list" }),
|
|
]}
|
|
focusedThreadId="thread-1"
|
|
/>
|
|
<PanelFrame label="Composing a new comment" threads={[makeThread({ id: "thread-1" })]} pending={pendingAnchor} />
|
|
</div>
|
|
</section>
|
|
</main>
|
|
</div>
|
|
);
|
|
}
|
|
|
|
const meta = {
|
|
title: "Product/Document Comments",
|
|
component: DocumentCommentsMatrix,
|
|
parameters: {
|
|
docs: {
|
|
description: {
|
|
component:
|
|
"Inline document comment panel (PAP-10960): simplified to drop the header, filter chips, and empty-state, surface the author identity in the composer, and clamp quotes to two lines.",
|
|
},
|
|
},
|
|
},
|
|
} satisfies Meta<typeof DocumentCommentsMatrix>;
|
|
|
|
export default meta;
|
|
|
|
type Story = StoryObj<typeof meta>;
|
|
|
|
export const Panel: Story = {};
|