mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-10-30 13:20:54 +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>
402 lines
14 KiB
TypeScript
402 lines
14 KiB
TypeScript
import { useState, useEffect, useMemo } from "react";
|
|
import { useLocation, useNavigate } from "@/lib/router";
|
|
import { useQuery } from "@tanstack/react-query";
|
|
import { useCompany } from "../context/CompanyContext";
|
|
import { useDialogActions } from "../context/DialogContext";
|
|
import { useSidebar } from "../context/SidebarContext";
|
|
import { issuesApi } from "../api/issues";
|
|
import { agentsApi } from "../api/agents";
|
|
import { projectsApi } from "../api/projects";
|
|
import { instanceSettingsApi } from "../api/instanceSettings";
|
|
import { queryKeys } from "../lib/queryKeys";
|
|
import {
|
|
CommandDialog,
|
|
CommandEmpty,
|
|
CommandGroup,
|
|
CommandInput,
|
|
CommandItem,
|
|
CommandList,
|
|
CommandSeparator,
|
|
} from "@/components/ui/command";
|
|
import {
|
|
CircleDot,
|
|
Bot,
|
|
Hexagon,
|
|
Target,
|
|
LayoutDashboard,
|
|
Inbox,
|
|
DollarSign,
|
|
History,
|
|
SquarePen,
|
|
FileCode2,
|
|
Plus,
|
|
Search,
|
|
} from "lucide-react";
|
|
import { Identity } from "./Identity";
|
|
import { agentUrl, projectUrl } from "../lib/utils";
|
|
|
|
const SEARCH_ALL_VALUE = "__paperclip-search-all__";
|
|
|
|
export function buildFullSearchPath(query: string) {
|
|
const trimmed = query.trim();
|
|
return trimmed.length === 0 ? "/search" : `/search?q=${encodeURIComponent(trimmed)}`;
|
|
}
|
|
|
|
const ISSUE_DETAIL_PATH_RE = /\/issues\/[^/?#]+(?:$|\?|#|\/)/;
|
|
|
|
function isOnIssueDetail(pathname: string): boolean {
|
|
return ISSUE_DETAIL_PATH_RE.test(pathname);
|
|
}
|
|
|
|
/** Max promoted project matches kept when typing in the palette. */
|
|
const MAX_MATCHED_PROJECTS = 5;
|
|
/** Task cap when projects are also promoted, so Tasks can't crowd them out. */
|
|
const TASK_LIMIT_WITH_PROJECTS = 6;
|
|
const TASK_LIMIT = 10;
|
|
|
|
/** True when every char of `needle` appears in `haystack` in order (fuzzy). */
|
|
function isSubsequence(needle: string, haystack: string): boolean {
|
|
let i = 0;
|
|
for (let j = 0; j < haystack.length && i < needle.length; j += 1) {
|
|
if (haystack[j] === needle[i]) i += 1;
|
|
}
|
|
return i === needle.length;
|
|
}
|
|
|
|
/**
|
|
* Score a project against a lowercased query. Higher is a better match;
|
|
* `null` means no match. Prefers name hits (exact > prefix > substring) over
|
|
* description hits, with fuzzy subsequence as a last resort.
|
|
*/
|
|
function scoreProjectMatch(name: string, description: string, q: string): number | null {
|
|
if (name === q) return 1000;
|
|
// Shorter names rank first, but clamp the length penalty so a prefix match can
|
|
// never sink below the substring band (max 699) for unusually long names —
|
|
// keeps the prefix > substring > description > fuzzy ordering invariant.
|
|
if (name.startsWith(q)) return Math.max(700, 900 - name.length);
|
|
const nameIdx = name.indexOf(q);
|
|
if (nameIdx >= 0) return 700 - nameIdx;
|
|
if (description.includes(q)) return 400;
|
|
if (isSubsequence(q, name)) return 200;
|
|
return null;
|
|
}
|
|
|
|
export function CommandPalette() {
|
|
const [open, setOpen] = useState(false);
|
|
const [query, setQuery] = useState("");
|
|
const navigate = useNavigate();
|
|
const location = useLocation();
|
|
const { selectedCompanyId } = useCompany();
|
|
const { openNewIssue, openNewAgent } = useDialogActions();
|
|
const { isMobile, setSidebarOpen } = useSidebar();
|
|
const searchQuery = query.trim();
|
|
const onIssueDetail = isOnIssueDetail(location.pathname);
|
|
const { data: experimentalSettings } = useQuery({
|
|
queryKey: queryKeys.instance.experimentalSettings,
|
|
queryFn: () => instanceSettingsApi.getExperimental(),
|
|
retry: false,
|
|
});
|
|
const fileViewerEnabled = experimentalSettings?.enableExperimentalFileViewer === true;
|
|
|
|
useEffect(() => {
|
|
function handleKeyDown(e: KeyboardEvent) {
|
|
if (e.key === "k" && (e.metaKey || e.ctrlKey)) {
|
|
e.preventDefault();
|
|
setOpen(true);
|
|
if (isMobile) setSidebarOpen(false);
|
|
}
|
|
}
|
|
document.addEventListener("keydown", handleKeyDown);
|
|
return () => document.removeEventListener("keydown", handleKeyDown);
|
|
}, [isMobile, setSidebarOpen]);
|
|
|
|
useEffect(() => {
|
|
if (!open) setQuery("");
|
|
}, [open]);
|
|
|
|
const { data: issues = [] } = useQuery({
|
|
queryKey: queryKeys.issues.list(selectedCompanyId!),
|
|
queryFn: () => issuesApi.list(selectedCompanyId!),
|
|
enabled: !!selectedCompanyId && open && searchQuery.length === 0,
|
|
});
|
|
|
|
const { data: searchedIssues = [] } = useQuery({
|
|
queryKey: queryKeys.issues.search(selectedCompanyId!, searchQuery, undefined, 10),
|
|
queryFn: () => issuesApi.list(selectedCompanyId!, { q: searchQuery, limit: 10, includeRoutineExecutions: true }),
|
|
enabled: !!selectedCompanyId && open && searchQuery.length > 0,
|
|
});
|
|
|
|
const { data: agents = [] } = useQuery({
|
|
queryKey: queryKeys.agents.list(selectedCompanyId!),
|
|
queryFn: () => agentsApi.list(selectedCompanyId!),
|
|
enabled: !!selectedCompanyId && open,
|
|
});
|
|
|
|
const { data: allProjects = [] } = useQuery({
|
|
queryKey: queryKeys.projects.list(selectedCompanyId!),
|
|
queryFn: () => projectsApi.list(selectedCompanyId!),
|
|
enabled: !!selectedCompanyId && open,
|
|
});
|
|
const projects = useMemo(
|
|
() => allProjects.filter((p) => !p.archivedAt),
|
|
[allProjects],
|
|
);
|
|
|
|
function go(path: string) {
|
|
setOpen(false);
|
|
navigate(path);
|
|
}
|
|
|
|
function goFullSearch() {
|
|
go(buildFullSearchPath(searchQuery));
|
|
}
|
|
|
|
const agentName = (id: string | null) => {
|
|
if (!id) return null;
|
|
return agents.find((a) => a.id === id)?.name ?? null;
|
|
};
|
|
|
|
const visibleIssues = useMemo(
|
|
() => (searchQuery.length > 0 ? searchedIssues : issues),
|
|
[issues, searchedIssues, searchQuery],
|
|
);
|
|
|
|
// Client-side typeahead ranking over the already-loaded projects. cmdk ranks
|
|
// items by their `value` (which defaults to the rendered name) and would bury
|
|
// or drop description-only matches, so we rank in JS and force-match below.
|
|
const matchedProjects = useMemo(() => {
|
|
if (searchQuery.length === 0) return [];
|
|
const q = searchQuery.toLowerCase();
|
|
return projects
|
|
.map((project) => ({
|
|
project,
|
|
score: scoreProjectMatch(
|
|
project.name.toLowerCase(),
|
|
(project.description ?? "").toLowerCase(),
|
|
q,
|
|
),
|
|
}))
|
|
.filter((entry): entry is { project: (typeof projects)[number]; score: number } => entry.score !== null)
|
|
.sort((a, b) => b.score - a.score)
|
|
.slice(0, MAX_MATCHED_PROJECTS)
|
|
.map((entry) => entry.project);
|
|
}, [projects, searchQuery]);
|
|
|
|
const showSearchAll = searchQuery.length > 0;
|
|
const showPromotedProjects = showSearchAll && matchedProjects.length > 0;
|
|
const taskLimit = showPromotedProjects ? TASK_LIMIT_WITH_PROJECTS : TASK_LIMIT;
|
|
const showEmptyHint =
|
|
showSearchAll && visibleIssues.length === 0 && matchedProjects.length === 0;
|
|
|
|
return (
|
|
<CommandDialog open={open} onOpenChange={(v) => {
|
|
setOpen(v);
|
|
if (v && isMobile) setSidebarOpen(false);
|
|
}}>
|
|
<CommandInput
|
|
placeholder="Search tasks, agents, projects..."
|
|
value={query}
|
|
onValueChange={setQuery}
|
|
onKeyDown={(event) => {
|
|
if (event.key === "Enter" && showEmptyHint) {
|
|
event.preventDefault();
|
|
goFullSearch();
|
|
}
|
|
}}
|
|
/>
|
|
<CommandList>
|
|
<CommandEmpty>
|
|
{showSearchAll ? (
|
|
<span>
|
|
No quick task matches. Press{" "}
|
|
<kbd className="rounded border border-border bg-muted px-1 py-0.5 text-(length:--text-nano)">↵</kbd>{" "}
|
|
to <span className="font-medium">search all</span> or keep typing to refine.
|
|
</span>
|
|
) : (
|
|
"No results found."
|
|
)}
|
|
</CommandEmpty>
|
|
|
|
{showSearchAll ? (
|
|
<CommandGroup heading="Search">
|
|
<CommandItem
|
|
value={`${SEARCH_ALL_VALUE} ${searchQuery}`}
|
|
onSelect={goFullSearch}
|
|
className="bg-accent/40 border border-accent data-[selected=true]:bg-accent/60"
|
|
data-testid="command-search-all"
|
|
>
|
|
<Search className="mr-2 h-4 w-4" />
|
|
<span className="flex-1 truncate">
|
|
Search all for <span className="font-semibold">“{searchQuery}”</span>
|
|
</span>
|
|
<span className="ml-auto inline-flex items-center gap-1 text-xs text-muted-foreground">
|
|
<span>open full search</span>
|
|
<kbd className="rounded border border-border bg-background px-1 py-0.5 text-(length:--text-nano)">↵</kbd>
|
|
</span>
|
|
</CommandItem>
|
|
</CommandGroup>
|
|
) : null}
|
|
|
|
{showSearchAll ? <CommandSeparator /> : null}
|
|
|
|
{showPromotedProjects && (
|
|
<>
|
|
<CommandGroup heading="Projects">
|
|
{matchedProjects.map((project) => (
|
|
<CommandItem
|
|
key={project.id}
|
|
value={`${searchQuery} ${project.name}`}
|
|
onSelect={() => go(projectUrl(project))}
|
|
data-testid="command-project-match"
|
|
>
|
|
<Hexagon className="mr-2 h-4 w-4 shrink-0" />
|
|
<span className="min-w-0 truncate">{project.name}</span>
|
|
{project.description ? (
|
|
<span className="ml-2 hidden min-w-0 flex-1 truncate text-xs text-muted-foreground sm:inline">
|
|
{project.description}
|
|
</span>
|
|
) : null}
|
|
</CommandItem>
|
|
))}
|
|
</CommandGroup>
|
|
<CommandSeparator />
|
|
</>
|
|
)}
|
|
|
|
<CommandGroup heading="Actions">
|
|
<CommandItem
|
|
onSelect={() => {
|
|
setOpen(false);
|
|
openNewIssue();
|
|
}}
|
|
>
|
|
<SquarePen className="mr-2 h-4 w-4" />
|
|
Create new task
|
|
<span className="ml-auto text-xs text-muted-foreground">C</span>
|
|
</CommandItem>
|
|
{onIssueDetail && fileViewerEnabled && (
|
|
<CommandItem
|
|
onSelect={() => {
|
|
setOpen(false);
|
|
window.dispatchEvent(new CustomEvent("paperclip:open-file-viewer"));
|
|
}}
|
|
>
|
|
<FileCode2 className="mr-2 h-4 w-4" />
|
|
Open file in this issue...
|
|
<span className="ml-auto text-xs text-muted-foreground">g f</span>
|
|
</CommandItem>
|
|
)}
|
|
<CommandItem
|
|
onSelect={() => {
|
|
setOpen(false);
|
|
openNewAgent();
|
|
}}
|
|
>
|
|
<Plus className="mr-2 h-4 w-4" />
|
|
Create new agent
|
|
</CommandItem>
|
|
<CommandItem onSelect={() => go("/projects")}>
|
|
<Plus className="mr-2 h-4 w-4" />
|
|
Create new project
|
|
</CommandItem>
|
|
</CommandGroup>
|
|
|
|
<CommandSeparator />
|
|
|
|
<CommandGroup heading="Pages">
|
|
<CommandItem onSelect={() => go("/dashboard")}>
|
|
<LayoutDashboard className="mr-2 h-4 w-4" />
|
|
Dashboard
|
|
</CommandItem>
|
|
<CommandItem onSelect={() => go("/inbox")}>
|
|
<Inbox className="mr-2 h-4 w-4" />
|
|
Inbox
|
|
</CommandItem>
|
|
<CommandItem onSelect={() => go("/issues")}>
|
|
<CircleDot className="mr-2 h-4 w-4" />
|
|
Tasks
|
|
</CommandItem>
|
|
<CommandItem onSelect={() => go("/projects")}>
|
|
<Hexagon className="mr-2 h-4 w-4" />
|
|
Projects
|
|
</CommandItem>
|
|
<CommandItem onSelect={() => go("/goals")}>
|
|
<Target className="mr-2 h-4 w-4" />
|
|
Goals
|
|
</CommandItem>
|
|
<CommandItem onSelect={() => go("/agents")}>
|
|
<Bot className="mr-2 h-4 w-4" />
|
|
Agents
|
|
</CommandItem>
|
|
<CommandItem onSelect={() => go("/costs")}>
|
|
<DollarSign className="mr-2 h-4 w-4" />
|
|
Costs
|
|
</CommandItem>
|
|
<CommandItem onSelect={() => go("/activity")}>
|
|
<History className="mr-2 h-4 w-4" />
|
|
Activity
|
|
</CommandItem>
|
|
</CommandGroup>
|
|
|
|
{visibleIssues.length > 0 && (
|
|
<>
|
|
<CommandSeparator />
|
|
<CommandGroup heading="Tasks">
|
|
{visibleIssues.slice(0, taskLimit).map((issue) => (
|
|
<CommandItem
|
|
key={issue.id}
|
|
value={
|
|
searchQuery.length > 0
|
|
? `${searchQuery} ${issue.identifier ?? ""} ${issue.title}`
|
|
: undefined
|
|
}
|
|
onSelect={() => go(`/issues/${issue.identifier ?? issue.id}`)}
|
|
>
|
|
<CircleDot className="mr-2 h-4 w-4" />
|
|
<span className="text-muted-foreground mr-2 font-mono text-xs">
|
|
{issue.identifier ?? issue.id.slice(0, 8)}
|
|
</span>
|
|
<span className="flex-1 truncate">{issue.title}</span>
|
|
{issue.assigneeAgentId && (() => {
|
|
const name = agentName(issue.assigneeAgentId);
|
|
return name ? <Identity name={name} size="sm" className="ml-2 hidden sm:inline-flex" /> : null;
|
|
})()}
|
|
</CommandItem>
|
|
))}
|
|
</CommandGroup>
|
|
</>
|
|
)}
|
|
|
|
{agents.length > 0 && (
|
|
<>
|
|
<CommandSeparator />
|
|
<CommandGroup heading="Agents">
|
|
{agents.slice(0, 10).map((agent) => (
|
|
<CommandItem key={agent.id} onSelect={() => go(agentUrl(agent))}>
|
|
<Bot className="mr-2 h-4 w-4" />
|
|
{agent.name}
|
|
<span className="text-xs text-muted-foreground ml-2">{agent.role}</span>
|
|
</CommandItem>
|
|
))}
|
|
</CommandGroup>
|
|
</>
|
|
)}
|
|
|
|
{projects.length > 0 && !showSearchAll && (
|
|
<>
|
|
<CommandSeparator />
|
|
<CommandGroup heading="Projects">
|
|
{projects.slice(0, 10).map((project) => (
|
|
<CommandItem key={project.id} onSelect={() => go(projectUrl(project))}>
|
|
<Hexagon className="mr-2 h-4 w-4" />
|
|
{project.name}
|
|
</CommandItem>
|
|
))}
|
|
</CommandGroup>
|
|
</>
|
|
)}
|
|
</CommandList>
|
|
</CommandDialog>
|
|
);
|
|
}
|