mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-10-11 14:10:50 +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>
358 lines
15 KiB
TypeScript
358 lines
15 KiB
TypeScript
import { useEffect, useMemo, useState } from "react";
|
|
import { ChevronDown, ChevronRight, HelpCircle } from "lucide-react";
|
|
import { isValidRoutineDateString, syncRoutineVariablesWithTemplate, type RoutineVariable } from "@paperclipai/shared";
|
|
import { Badge } from "@/components/ui/badge";
|
|
import { Collapsible, CollapsibleContent, CollapsibleTrigger } from "@/components/ui/collapsible";
|
|
import {
|
|
Dialog,
|
|
DialogContent,
|
|
DialogDescription,
|
|
DialogHeader,
|
|
DialogTitle,
|
|
} from "@/components/ui/dialog";
|
|
import { Input } from "@/components/ui/input";
|
|
import { Label } from "@/components/ui/label";
|
|
import {
|
|
Select,
|
|
SelectContent,
|
|
SelectItem,
|
|
SelectTrigger,
|
|
SelectValue,
|
|
} from "@/components/ui/select";
|
|
import { Textarea } from "@/components/ui/textarea";
|
|
|
|
const variableTypes: RoutineVariable["type"][] = ["text", "textarea", "number", "boolean", "select", "date"];
|
|
|
|
function serializeVariables(value: RoutineVariable[]) {
|
|
return JSON.stringify(value);
|
|
}
|
|
|
|
function parseSelectOptions(value: string) {
|
|
return value
|
|
.split(",")
|
|
.map((entry) => entry.trim())
|
|
.filter(Boolean);
|
|
}
|
|
|
|
function updateVariableList(
|
|
variables: RoutineVariable[],
|
|
name: string,
|
|
mutate: (variable: RoutineVariable) => RoutineVariable,
|
|
) {
|
|
return variables.map((variable) => (variable.name === name ? mutate(variable) : variable));
|
|
}
|
|
|
|
function defaultValueForType(type: RoutineVariable["type"], current: RoutineVariable["defaultValue"]) {
|
|
if (type === "boolean") return null;
|
|
if (type === "date") {
|
|
return typeof current === "string" && isValidRoutineDateString(current) ? current : null;
|
|
}
|
|
return current;
|
|
}
|
|
|
|
export function RoutineVariablesEditor({
|
|
title,
|
|
description,
|
|
value,
|
|
onChange,
|
|
}: {
|
|
title: string;
|
|
description: string;
|
|
value: RoutineVariable[];
|
|
onChange: (value: RoutineVariable[]) => void;
|
|
}) {
|
|
const [open, setOpen] = useState(true);
|
|
const syncedVariables = useMemo(
|
|
() => syncRoutineVariablesWithTemplate([title, description], value),
|
|
[description, title, value],
|
|
);
|
|
const syncedSignature = serializeVariables(syncedVariables);
|
|
const currentSignature = serializeVariables(value);
|
|
|
|
useEffect(() => {
|
|
if (syncedSignature !== currentSignature) {
|
|
onChange(syncedVariables);
|
|
}
|
|
}, [currentSignature, onChange, syncedSignature, syncedVariables]);
|
|
|
|
if (syncedVariables.length === 0) {
|
|
return null;
|
|
}
|
|
|
|
return (
|
|
<Collapsible open={open} onOpenChange={setOpen} className="overflow-hidden rounded-lg border border-border/70">
|
|
<CollapsibleTrigger className="flex w-full items-center justify-between px-3 py-2 text-left">
|
|
<div>
|
|
<p className="text-sm font-medium">Variables</p>
|
|
<p className="text-xs text-muted-foreground">
|
|
Detected from `{"{{name}}"}` placeholders in the title and instructions.
|
|
</p>
|
|
</div>
|
|
{open ? <ChevronDown className="h-4 w-4 text-muted-foreground" /> : <ChevronRight className="h-4 w-4 text-muted-foreground" />}
|
|
</CollapsibleTrigger>
|
|
<CollapsibleContent className="divide-y divide-border/70 border-t border-border/70">
|
|
{syncedVariables.map((variable) => (
|
|
<div key={variable.name} className="p-4">
|
|
<div className="mb-3 flex flex-wrap items-center gap-2">
|
|
<Badge variant="outline" className="font-mono text-xs">
|
|
{`{{${variable.name}}}`}
|
|
</Badge>
|
|
<span className="text-xs text-muted-foreground">
|
|
Prompt the user for this value before each manual run.
|
|
</span>
|
|
</div>
|
|
|
|
<div className="grid gap-3 md:grid-cols-2">
|
|
<div className="space-y-1.5">
|
|
<Label className="text-xs">Label</Label>
|
|
<Input
|
|
value={variable.label ?? ""}
|
|
onChange={(event) => onChange(updateVariableList(syncedVariables, variable.name, (current) => ({
|
|
...current,
|
|
label: event.target.value || null,
|
|
})))}
|
|
placeholder={variable.name.replaceAll("_", " ")}
|
|
/>
|
|
</div>
|
|
|
|
<div className="space-y-1.5">
|
|
<Label className="text-xs">Type</Label>
|
|
<Select
|
|
value={variable.type}
|
|
onValueChange={(type) => onChange(updateVariableList(syncedVariables, variable.name, (current) => ({
|
|
...current,
|
|
type: type as RoutineVariable["type"],
|
|
defaultValue: defaultValueForType(type as RoutineVariable["type"], current.defaultValue),
|
|
options: type === "select" ? current.options : [],
|
|
})))}
|
|
>
|
|
<SelectTrigger>
|
|
<SelectValue />
|
|
</SelectTrigger>
|
|
<SelectContent>
|
|
{variableTypes.map((type) => (
|
|
<SelectItem key={type} value={type}>{type}</SelectItem>
|
|
))}
|
|
</SelectContent>
|
|
</Select>
|
|
</div>
|
|
|
|
<div className="space-y-1.5 md:col-span-2">
|
|
<div className="flex items-center justify-between gap-3">
|
|
<Label className="text-xs">Default value</Label>
|
|
<label className="flex items-center gap-2 text-xs text-muted-foreground">
|
|
<input
|
|
type="checkbox"
|
|
checked={variable.required}
|
|
onChange={(event) => onChange(updateVariableList(syncedVariables, variable.name, (current) => ({
|
|
...current,
|
|
required: event.target.checked,
|
|
})))}
|
|
/>
|
|
Required
|
|
</label>
|
|
</div>
|
|
|
|
{variable.type === "textarea" ? (
|
|
<Textarea
|
|
rows={3}
|
|
value={variable.defaultValue == null ? "" : String(variable.defaultValue)}
|
|
onChange={(event) => onChange(updateVariableList(syncedVariables, variable.name, (current) => ({
|
|
...current,
|
|
defaultValue: event.target.value || null,
|
|
})))}
|
|
/>
|
|
) : variable.type === "boolean" ? (
|
|
<Select
|
|
value={variable.defaultValue === true ? "true" : variable.defaultValue === false ? "false" : "__unset__"}
|
|
onValueChange={(next) => onChange(updateVariableList(syncedVariables, variable.name, (current) => ({
|
|
...current,
|
|
defaultValue: next === "__unset__" ? null : next === "true",
|
|
})))}
|
|
>
|
|
<SelectTrigger>
|
|
<SelectValue />
|
|
</SelectTrigger>
|
|
<SelectContent>
|
|
<SelectItem value="__unset__">No default</SelectItem>
|
|
<SelectItem value="true">True</SelectItem>
|
|
<SelectItem value="false">False</SelectItem>
|
|
</SelectContent>
|
|
</Select>
|
|
) : variable.type === "select" ? (
|
|
<div className="grid gap-3 md:grid-cols-2">
|
|
<div className="space-y-1.5">
|
|
<Label className="text-xs">Options</Label>
|
|
<Input
|
|
value={variable.options.join(", ")}
|
|
onChange={(event) => {
|
|
const options = parseSelectOptions(event.target.value);
|
|
onChange(updateVariableList(syncedVariables, variable.name, (current) => ({
|
|
...current,
|
|
options,
|
|
defaultValue:
|
|
typeof current.defaultValue === "string" && options.includes(current.defaultValue)
|
|
? current.defaultValue
|
|
: null,
|
|
})));
|
|
}}
|
|
placeholder="high, medium, low"
|
|
/>
|
|
</div>
|
|
<div className="space-y-1.5">
|
|
<Label className="text-xs">Default option</Label>
|
|
<Select
|
|
value={typeof variable.defaultValue === "string" ? variable.defaultValue : "__unset__"}
|
|
onValueChange={(next) => onChange(updateVariableList(syncedVariables, variable.name, (current) => ({
|
|
...current,
|
|
defaultValue: next === "__unset__" ? null : next,
|
|
})))}
|
|
>
|
|
<SelectTrigger>
|
|
<SelectValue placeholder="No default" />
|
|
</SelectTrigger>
|
|
<SelectContent>
|
|
<SelectItem value="__unset__">No default</SelectItem>
|
|
{variable.options.map((option) => (
|
|
<SelectItem key={option} value={option}>{option}</SelectItem>
|
|
))}
|
|
</SelectContent>
|
|
</Select>
|
|
</div>
|
|
</div>
|
|
) : variable.type === "date" ? (
|
|
<Input
|
|
type="date"
|
|
value={typeof variable.defaultValue === "string" ? variable.defaultValue : ""}
|
|
onChange={(event) => onChange(updateVariableList(syncedVariables, variable.name, (current) => ({
|
|
...current,
|
|
defaultValue: event.target.value || null,
|
|
})))}
|
|
/>
|
|
) : (
|
|
<Input
|
|
type={variable.type === "number" ? "number" : "text"}
|
|
value={variable.defaultValue == null ? "" : String(variable.defaultValue)}
|
|
onChange={(event) => onChange(updateVariableList(syncedVariables, variable.name, (current) => ({
|
|
...current,
|
|
defaultValue: event.target.value || null,
|
|
})))}
|
|
placeholder={variable.type === "number" ? "42" : "Default value"}
|
|
/>
|
|
)}
|
|
</div>
|
|
</div>
|
|
</div>
|
|
))}
|
|
</CollapsibleContent>
|
|
</Collapsible>
|
|
);
|
|
}
|
|
|
|
type BuiltinVariableDoc = {
|
|
name: string;
|
|
example: string;
|
|
description: string;
|
|
};
|
|
|
|
const BUILTIN_VARIABLE_DOCS: BuiltinVariableDoc[] = [
|
|
{
|
|
name: "date",
|
|
example: "2026-04-28",
|
|
description: "Current date in YYYY-MM-DD format (UTC) at the time the routine runs.",
|
|
},
|
|
{
|
|
name: "timestamp",
|
|
example: "April 28, 2026 at 12:17 PM UTC",
|
|
description: "Human-readable date and time (UTC) at the time the routine runs.",
|
|
},
|
|
];
|
|
|
|
export function RoutineVariablesHint() {
|
|
const [helpOpen, setHelpOpen] = useState(false);
|
|
|
|
return (
|
|
<>
|
|
<div className="flex items-center justify-between gap-2 rounded-lg border border-dashed border-border/70 px-3 py-2 text-xs text-muted-foreground">
|
|
<span>
|
|
Use `{"{{variable_name}}"}` placeholders in the title or instructions to prompt for inputs when the routine runs.
|
|
</span>
|
|
<button
|
|
type="button"
|
|
onClick={() => setHelpOpen(true)}
|
|
className="shrink-0 rounded-full p-0.5 text-muted-foreground transition-colors hover:bg-accent/50 hover:text-foreground focus-visible:outline-none focus-visible:ring-2 focus-visible:ring-ring"
|
|
aria-label="Show variable help"
|
|
>
|
|
<HelpCircle className="h-3.5 w-3.5" />
|
|
</button>
|
|
</div>
|
|
|
|
<Dialog open={helpOpen} onOpenChange={setHelpOpen}>
|
|
<DialogContent className="sm:max-w-xl">
|
|
<DialogHeader>
|
|
<DialogTitle>Routine variables</DialogTitle>
|
|
<DialogDescription>
|
|
How to prompt for inputs and which variables Paperclip fills in automatically.
|
|
</DialogDescription>
|
|
</DialogHeader>
|
|
|
|
<div className="space-y-5 text-sm">
|
|
<section className="space-y-2">
|
|
<h3 className="text-xs font-semibold uppercase tracking-(--tracking-caps) text-muted-foreground">
|
|
Custom variables
|
|
</h3>
|
|
<p className="text-muted-foreground">
|
|
Type{" "}
|
|
<code className="rounded bg-muted px-1 py-0.5 font-mono text-xs text-foreground">
|
|
{"{{variable_name}}"}
|
|
</code>{" "}
|
|
anywhere in the title or instructions. Paperclip detects each placeholder, lists it
|
|
under <span className="font-medium text-foreground">Variables</span>, and prompts
|
|
for a value before each run.
|
|
</p>
|
|
<ul className="list-disc space-y-1 pl-5 text-muted-foreground">
|
|
<li>Names must start with a letter and may use letters, numbers, and underscores.</li>
|
|
<li>Pick a type (text, textarea, number, boolean, select, date), default value, and whether it is required.</li>
|
|
<li>Variable names ending in capital Date, such as startDate, are created as date variables by default.</li>
|
|
<li>The same name reused across the title and instructions is treated as one variable.</li>
|
|
</ul>
|
|
</section>
|
|
|
|
<section className="space-y-2">
|
|
<h3 className="text-xs font-semibold uppercase tracking-(--tracking-caps) text-muted-foreground">
|
|
Built-in variables
|
|
</h3>
|
|
<p className="text-muted-foreground">
|
|
These are filled in automatically — no setup needed and they will not appear in the
|
|
Variables list.
|
|
</p>
|
|
<div className="overflow-hidden rounded-lg border border-border/70">
|
|
<table className="w-full text-left text-xs">
|
|
<thead className="bg-muted/40 text-muted-foreground">
|
|
<tr>
|
|
<th className="px-3 py-2 font-medium">Placeholder</th>
|
|
<th className="px-3 py-2 font-medium">Example</th>
|
|
<th className="px-3 py-2 font-medium">Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody className="divide-y divide-border/70">
|
|
{BUILTIN_VARIABLE_DOCS.map((entry) => (
|
|
<tr key={entry.name} className="align-top">
|
|
<td className="px-3 py-2">
|
|
<Badge variant="outline" className="font-mono text-xs">{`{{${entry.name}}}`}</Badge>
|
|
</td>
|
|
<td className="px-3 py-2 font-mono text-muted-foreground">{entry.example}</td>
|
|
<td className="px-3 py-2 text-muted-foreground">{entry.description}</td>
|
|
</tr>
|
|
))}
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
</DialogContent>
|
|
</Dialog>
|
|
</>
|
|
);
|
|
}
|