| 1 | Interactive live variant mode: select elements in the browser, pick a design action, and get AI-generated HTML+CSS variants hot-swapped via the dev server's HMR. |
| 2 | |
| 3 | ## Prerequisites |
| 4 | |
| 5 | A running dev server with hot module replacement (Vite, Next.js, Bun, etc.), OR a static HTML file open in the browser. |
| 6 | |
| 7 | Codex: run live helper commands, the app dev server, and any dependency-installing setup with `sandbox_permissions: "require_escalated"` from the start; live mode depends on localhost and package-manager network access that the sandbox blocks. |
| 8 | |
| 9 | ## The contract (read once) |
| 10 | |
| 11 | Execute in order. No step skipped, no step reordered. |
| 12 | |
| 13 | 1. `live.mjs`: boot. |
| 14 | 2. Open the app URL that serves `pageFile` (infer from `package.json`, docs, terminal output, or an open tab). Never use `serverPort`; it's the helper, not the app. **Cursor:** `browser_navigate` to that URL before polling; do not skip. **Other harnesses:** use the available browser tool; if the URL is uncertain, ask the user once. |
| 15 | 3. Poll loop with the default long timeout (600000 ms). After every event or `--reply`, run `live-poll.mjs` again immediately. Never pass a short `--timeout=`. |
| 16 | |
| 17 | The global bar **Impeccable mark** dims and shows a pulsing amber dot when no agent is long-polling `/poll`. Hover the mark for the hint; restart `live-poll.mjs` to reconnect. |
| 18 | 4. On `generate`: read screenshot if present; load the action's reference; plan three distinct directions; write all variants in one edit; `--reply done`; poll again. |
| 19 | 5. On `steer`: read the message and `pageUrl`; do the work (page edits, navigation help, or a short reply in the `--reply` message); `--reply steer_done`; poll again. No pickup ack. The Steer bar unlocks when `steer_done` arrives over SSE. |
| 20 | 6. On `accept` / `discard`: the poll script runs `live-accept.mjs`, acknowledges the delivered event, and prints `_completionAck`. Plain accepts/discards are terminal immediately; carbonize accepts remain recoverable until you finish cleanup, run `live-complete.mjs --id EVENT_ID`, and only then poll again. |
| 21 | 7. If interrupted, run `live-status.mjs` or `live-resume.mjs` before guessing. The durable journal replays unacknowledged work after helper restart. |
| 22 | 8. On `exit`: run the cleanup at the bottom. |
| 23 | |
| 24 | Harness policy: |
| 25 | - **Claude Code**: run the poll as a **background task** (no short timeout). The harness notifies you when it completes, so the main conversation stays free. Do not block the shell. |
| 26 | - **Cursor**: run **one-shot** poll in a **background terminal** with notify on `"type":"(steer|generate|accept|discard|exit)"`. After each event the poll exits; handle it, `--reply`, then start `live-poll.mjs` again. Do **not** use `--stream` on Cursor: incremental stdout notify is slower in practice than exit-based notify (~5s vs sub-second in testing). |
| 27 | - **Codex**: run the poll in the **foreground** (blocking shell; not a background task, not a subagent). Codex background exec sessions do not reliably surface poll stdout back into the conversation at the moment events arrive, so a "fire-and-forget" background poll will stall live mode. |
| 28 | - **Other harnesses**: one-shot foreground unless you know stdout reliably returns to this session when a shell exits. |
| 29 | |
| 30 | Chat is overhead. No recap, no tutorial output, no pasting PRODUCT / DESIGN bodies. Spend tokens on tools and edits; on failure, one or two short sentences. |
| 31 | |
| 32 | ## Start |
| 33 | |
| 34 | ```bash |
| 35 | node .agents/skills/impeccable/scripts/live.mjs |
| 36 | ``` |
| 37 | |
| 38 | Output JSON: `{ ok, serverPort, serverToken, pageFiles, hasProduct, product, productPath, hasDesign, design, designPath }`. `pageFiles` is the list of HTML entries the live script was injected into. Keep PRODUCT.md and DESIGN.md in mind for variant generation; **DESIGN.md wins on visual decisions; PRODUCT.md wins on strategic/voice decisions.** When DESIGN.md is missing, identity is **not** absent; extract it from CSS variables, computed styles, and sibling components on the page (see Step 4 Phase A). Identity preservation is the default; departure from existing identity requires an explicit trigger from PRODUCT.md anti-references or the user's freeform prompt. |
| 39 | |
| 40 | `serverPort` and `serverToken` belong to the small **Impeccable live helper** HTTP server (serves `/live.js`, SSE, and `/poll`). That port is **not** your dev server and is usually not the URL you open to view the app. The browser page is whatever origin serves one of the `pageFiles` entries (Vite / Next / Bun / tunnel / LAN hostname). |
| 41 | |
| 42 | If output is `{ ok: false, error: "config_missing" | "config_invalid", path }`, this project hasn't been configured for live mode (or its config is stale). See **First-time setup** at the bottom. |
| 43 | |
| 44 | ## Poll loop |
| 45 | |
| 46 | **Default (portable, all harnesses):** |
| 47 | |
| 48 | ``` |
| 49 | LOOP: |
| 50 | node .agents/skills/impeccable/scripts/live-poll.mjs # default long timeout; no --timeout= |
| 51 | Read JSON; dispatch on "type" |
| 52 | |
| 53 | "generate" → Handle Generate; reply done; LOOP |
| 54 | "steer" → Handle Steer; reply steer_done; LOOP |
| 55 | "accept" → Handle Accept; complete carbonize cleanup if required; LOOP |
| 56 | "discard" → Handle Discard; LOOP |
| 57 | "prefetch" → Handle Prefetch; LOOP |
| 58 | "manual_edit_apply" → Handle Manual Edit Apply; reply done|partial|error; LOOP |
| 59 | "timeout" → LOOP |
| 60 | "exit" → break → Cleanup |
| 61 | ``` |
| 62 | |
| 63 | **Stream mode (experimental, not for Cursor):** |
| 64 | |
| 65 | ``` |
| 66 | node .agents/skills/impeccable/scripts/live-poll.mjs --stream # stays running; one JSON line per event |
| 67 | Handle event; run --reply in a separate command |
| 68 | Repeat until "exit" line → Cleanup |
| 69 | ``` |
| 70 | |
| 71 | Stream keeps one process alive and waits for `--reply` ack before polling again. Useful only when the harness reads incremental stdout reliably and quickly. **Cursor is not one of those:** background pattern notify on a long-running shell was ~5s to pick up events vs sub-second for one-shot exit notify. Default to one-shot everywhere unless you have measured otherwise. |
| 72 | |
| 73 | ## Recovery commands |
| 74 | |
| 75 | The live helper persists an append-only journal under `.impeccable/live/sessions/`. Browser checkpoints are advisory but durable; the journal is canonical. This is local durable recovery state, not project source. |
| 76 | |
| 77 | Use these commands when the chat was interrupted, polling was missed, the helper restarted, or the browser reloaded: |
| 78 | |
| 79 | ```bash |
| 80 | node .agents/skills/impeccable/scripts/live-status.mjs |
| 81 | node .agents/skills/impeccable/scripts/live-resume.mjs --id SESSION_ID |
| 82 | node .agents/skills/impeccable/scripts/live-complete.mjs --id SESSION_ID |
| 83 | ``` |
| 84 | |
| 85 | - `live-status.mjs` prints connected helper state, active durable sessions, and queued pending events. It works even when the helper is down by reading the journal directly. |
| 86 | - `live-resume.mjs` prints the active snapshot, pending event, checkpoint phase, visible variant, parameter values, and the next safe agent action. |
| 87 | - `live-complete.mjs` is the canonical manual final acknowledgement. Use it after carbonize/manual cleanup is verified and no further poll acknowledgement will happen automatically. |
| 88 | |
| 89 | Server restart rule: start `live-server.mjs` again, then poll. Startup requeues unacknowledged pending events from the journal, so do not ask the user to click Go again unless `live-resume.mjs` says no active session exists. |
| 90 | |
| 91 | ## Handle `generate` |
| 92 | |
| 93 | **Replace mode** (default): `{id, action, freeformPrompt?, count, pageUrl, element, screenshotPath?, comments?, strokes?}`. |
| 94 | |
| 95 | **Insert mode** (`event.mode === "insert"`): `{id, mode: "insert", count, pageUrl, insert: { position, anchor }, placeholder: { width, height }, freeformPrompt?, screenshotPath?, comments?, strokes?}`. No `action`. Requires a non-empty `freeformPrompt` **or** annotations. Screenshot is sent only when annotations exist (same rule as replace). Use `placeholder` dimensions as a soft size hint for net-new content. |
| 96 | |
| 97 | Speed matters; the user is watching a spinner. Minimize tool calls by using the wrap/insert helper and writing all variants in a single edit. |
| 98 | |
| 99 | ### Insert mode branch |
| 100 | |
| 101 | When `event.mode === "insert"`: |
| 102 | |
| 103 | 1. Read the screenshot if `event.screenshotPath` is present (annotations only). |
| 104 | 2. Run the insert helper instead of wrap: |
| 105 | |
| 106 | ```bash |
| 107 | node .agents/skills/impeccable/scripts/live-insert.mjs --id EVENT_ID --count EVENT_COUNT --position after \ |
| 108 | --element-id "ANCHOR_ID" --classes "class1,class2" --tag "section" --text "ANCHOR_TEXT" |
| 109 | ``` |
| 110 | |
| 111 | - `--position` ← `event.insert.position` (`before` | `after`) |
| 112 | - Anchor flags ← `event.insert.anchor` (same mapping as wrap: id, classes, tag, text) |
| 113 | |
| 114 | The scaffold has **no** `data-impeccable-variant="original"`. Variants are net-new HTML+CSS inserted at `insertLine`. Load `brand.md` or `product.md` (freeform only, no action sub-command). Write all variants in one edit, then `--reply done`. |
| 115 | |
| 116 | For Svelte/SvelteKit targets, `live-insert.mjs` returns `previewMode: "svelte-component"` with `mode: "insert"`, `file` pointing at a temporary `node_modules/.impeccable-live/<id>/manifest.json`, `componentDir` pointing at the variant component files, and `sourceFile` pointing at the real `.svelte` route. Write each inserted variant as a real Svelte component (`v1.svelte`, `v2.svelte`, …) under `componentDir`. Insert variants must be non-empty net-new content with a single top-level root, no `data-impeccable-*` attributes, and CSS in each component's `<style>` block. Do **not** edit the route source during generation; the browser mounts the temporary component before/after the live anchor while the user cycles variants. On Accept, `live-accept.mjs` inserts the selected component markup into `sourceFile` immediately and deletes the temp session after the source write succeeds. |
| 117 | |
| 118 | For non-Svelte targets, on accept/discard, `live-accept.mjs` removes the wrapper block; the anchor element is untouched. |
| 119 | |
| 120 | ### Replace mode (default) |
| 121 | |
| 122 | ### 1. Read the screenshot (if present) |
| 123 | |
| 124 | `event.screenshotPath` is **only sent when the user placed at least one comment or stroke before Go.** When present, it's an absolute path to a PNG of the element as rendered with the annotations baked in. **Read it before planning**: annotations encode user intent not recoverable from `element.outerHTML` alone. |
| 125 | |
| 126 | When `screenshotPath` is absent, don't ask for one and don't go looking for the current rendering. The omission is deliberate: without annotations, a screenshot would anchor the model on the existing design and fight the three-distinct-directions brief. Work from `element.outerHTML`, the computed styles in `event.element`, and the freeform prompt if present. |
| 127 | |
| 128 | `event.comments` and `event.strokes` carry structured metadata alongside the visual. Treat the screenshot as primary; use the structured data for specifics worth quoting (e.g. the exact text of a comment). |
| 129 | |
| 130 | Reading annotations precisely: |
| 131 | |
| 132 | - **Comment position carries meaning.** Its `{x, y}` is element-local CSS px (same coord space as `element.boundingRect`). Find the child under that point and apply the comment text LOCALLY to that sub-element. A comment near the title is about the title, not a global description. |
| 133 | - **Comments and strokes are independent annotations** unless clearly paired by overlap or tight proximity. Don't let the visual weight of a prominent stroke override the precise location of a textually-specific comment elsewhere. |
| 134 | - **Strokes are gestures; read them by shape.** Closed loop = "this thing" (emphasis / focus); arrow = direction (move / point to); cross or slash = delete; free scribble = emphasis or delete depending on context. A loop around region X means "pay attention to X," not "only change pixels inside X." |
| 135 | - **When a stroke's intent is ambiguous** (circle or arrow? emphasis or move?), state your reading in one sentence of rationale rather than silently guessing. If the uncertainty materially changes the brief, ask one short clarifying question before generating. |
| 136 | |
| 137 | ### 2. Wrap the element |
| 138 | |
| 139 | ```bash |
| 140 | node .agents/skills/impeccable/scripts/live-wrap.mjs --id EVENT_ID --count EVENT_COUNT --element-id "ELEMENT_ID" --classes "class1,class2" --tag "div" --text "TEXT_SNIPPET" |
| 141 | ``` |
| 142 | |
| 143 | Flag mapping. Keep them separate, don't collapse into `--query`: |
| 144 | |
| 145 | - `--element-id` ← `event.element.id` |
| 146 | - `--classes` ← `event.element.classes` joined with commas |
| 147 | - `--tag` ← `event.element.tagName` |
| 148 | - `--text` ← first ~80 chars of `event.element.textContent` (trim, single-line). **Pass this every call.** When the picked element shares classes + tag with sibling components (a list of `<Card>`s, repeating sections), this is what disambiguates which branch in source to wrap. Without it, wrap silently lands on the first match and may rewrite the wrong element. |
| 149 | |
| 150 | The helper searches ID first, then classes, then tag + class combo. If `event.pageUrl` implies the file (e.g. `/` is usually `index.html`), pass `--file PATH` to skip the search. `--query` is a fallback for raw text search only; do not use it for normal element lookups. |
| 151 | |
| 152 | If `--text` matches multiple candidates equally well, wrap exits with `{ error: "element_ambiguous", candidates: [...] }` and `fallback: "agent-driven"`: read the candidate line ranges, decide which one matches the picked element from page context, and write the wrapper manually per the fallback flow. |
| 153 | |
| 154 | Output on success: `{ file, insertLine, commentSyntax, styleMode, styleTag, cssSelectorPrefixExamples, cssAuthoring }`. |
| 155 | |
| 156 | For Svelte/SvelteKit targets, `live-wrap.mjs` returns `previewMode: "svelte-component"` with `file` pointing at a temporary `node_modules/.impeccable-live/<id>/manifest.json`, `componentDir` pointing at the variant component files, and `sourceFile` pointing at the real `.svelte` route. Write each variant as a real Svelte component (`v1.svelte`, `v2.svelte`, …) under `componentDir`; use the `propContract` prop names for dynamic text (`{propName}`), not literal snapshot strings. Put variant CSS in each component's `<style>` block with semantic class selectors (no `@scope`, no `data-impeccable-*`). Reply with `--file` set to the manifest path; the browser dynamically imports and mounts the compiled components so Svelte HMR does not reset page state while the user cycles variants. On Accept, `live-accept.mjs` inlines the accepted component back into `sourceFile` immediately after source promotion succeeds. |
| 157 | |
| 158 | **Params on the Svelte component path go in a sidecar, never as an attribute.** Svelte parses `{` inside an attribute value as the start of an expression, so a `data-impeccable-params='[{…}]'` attribute on a component element fails to compile (`Expected token }`). Declare params for this path in `componentDir/params.json`, keyed by variant number, using the exact param schema from section 7: |
| 159 | |
| 160 | ```json |
| 161 | { |
| 162 | "1": [ |
| 163 | {"id":"density","kind":"steps","default":"snug","label":"Density","options":[ |
| 164 | {"value":"airy","label":"Airy"},{"value":"snug","label":"Snug"},{"value":"packed","label":"Packed"} |
| 165 | ]} |
| 166 | ], |
| 167 | "2": [ |
| 168 | {"id":"accent","kind":"range","min":0,"max":1,"step":0.05,"default":0.5,"label":"Accent"} |
| 169 | ] |
| 170 | } |
| 171 | ``` |
| 172 | |
| 173 | Author the component `<style>` against `var(--p-<id>, default)` for `range`/`toggle` and `[data-p-<id>="…"]` for `steps`; wrap those selectors in `:global(...)` so the knob values the runtime sets on the mounted root reach your rules. The browser reads `params.json`, docks the panel, and drives `--p-*` / `data-p-*` on the mounted component exactly as it does for the HTML/JSX path. |
| 174 | |
| 175 | `styleMode` controls how preview CSS must be authored. Treat it as a detected capability mode, not a framework guess: |
| 176 | |
| 177 | - `scoped`: use `@scope ([data-impeccable-variant="N"])` rules. |
| 178 | - `astro-global-prefixed`: use explicit `[data-impeccable-variant="N"]` selector prefixes and the exact `styleTag` returned by the tool. |
| 179 | |
| 180 | Use `cssAuthoring` as the source of truth for the current file. It includes the exact `styleTag`, selector strategy, selector examples, requirements, and forbidden patterns. Do not apply a framework-specific exception unless the returned `styleMode` / `cssAuthoring.mode` says to. |
| 181 | |
| 182 | **Fallback errors.** Wrap only writes into files it judges to be source (tracked by git, not marked GENERATED, not listed in config's `generatedFiles`). If it can't land on a source file, it errors without writing; accepting a variant into a generated file is silent data loss. Three shapes: |
| 183 | |
| 184 | - `{ error: "file_is_generated", file, hint }`: user-supplied `--file` points at a generated file. |
| 185 | - `{ error: "element_not_in_source", generatedMatch, hint }`: element exists only in a generated file (the next build would wipe any edits). |
| 186 | - `{ error: "element_not_found", hint }`: element isn't in any project file; likely runtime-injected (JS component, dynamic render from data). |
| 187 | |
| 188 | All three carry `fallback: "agent-driven"`. Follow **Handle fallback** below. |
| 189 | |
| 190 | ### 3. Load the action's reference |
| 191 | |
| 192 | If `event.action` is `impeccable` (the default freeform action), use SKILL.md's shared laws plus the loaded register reference (`brand.md` or `product.md`). Do not load a sub-command reference. **Freeform is not a pass to skip parameters:** you still follow the composition budget and the freeform bias in **§7 Parameters** below. Sub-command files list MUST-have signature knobs; freeform has no such file, so sizing knobs from surface weight and primary axes is entirely on you. |
| 193 | |
| 194 | Any other `event.action` (`bolder`, `quieter`, `distill`, `polish`, `typeset`, `colorize`, `layout`, `adapt`, `animate`, `delight`, `overdrive`): Read `reference/<action>.md` before planning. Each sub-command encodes a specific discipline; skipping its reference produces generic output. Those files may require specific params; layer them on top of the §7 budget, not instead of it. |
| 195 | |
| 196 | ### 4. Plan three variants: identity first, then mode, then axes |
| 197 | |
| 198 | The wrong frame for live mode is "show three different design directions." Live runs on an existing surface; the brand has already been chosen. The job is variation **within identity**, not selection between identities. Failure mode: three editorial-typographic variants on a brief that wasn't editorial. Bigger failure mode: three off-brand variants the user can't accept because they don't look like their product. |
| 199 | |
| 200 | Four phases. Do them in order. |
| 201 | |
| 202 | #### Phase A: Extract the identity (non-skippable) |
| 203 | |
| 204 | The existing surface has an identity already. Read it before planning anything. Sources, in priority order: |
| 205 | |
| 206 | 1. **DESIGN.md** if loaded: read the visual system fields (palette, type pairing, motion, components). This is the authoritative answer. |
| 207 | 2. **CSS custom properties** in the page's stylesheets (`:root { --color-...; --font-...; ... }`): these are de-facto tokens. |
| 208 | 3. **Computed styles** on the picked element and its parent: colors, fonts, spacing scales, corner radii. |
| 209 | 4. **Sibling components on the page**: what visual rhetoric do existing components use? (Asymmetric or centered? Dense or airy? Bold or quiet?) |
| 210 | |
| 211 | Write down what you see in **one sentence**. The sentence describes the surface that's actually on screen; it is not aspirational, not opinionated, not edited toward what the brand "should" be. Capture, in roughly this order: |
| 212 | |
| 213 | - The dominant surface color and accent color, by hex or token name (use the actual values, not categories like "warm" or "neutral"). |
| 214 | - The type pairing: the actual font names loaded, primary first. |
| 215 | - The layout topology: how the dominant elements are arranged (stacked / side-by-side / grid / asymmetric / overlay). |
| 216 | - The surface treatment: corners, borders, shadows, density of decoration. |
| 217 | - The voice tone you read off the copy itself, not off the aesthetic feel. |
| 218 | |
| 219 | Be specific. "Modern" is not a color, "elegant" is not a type pairing, "clean" is not a layout. If you can't extract a real value for an axis, skip it rather than fabricate. The point is to record what is, not to describe what you wish it were. |
| 220 | |
| 221 | Do not include adjectives that name an aesthetic family ("editorial-leaning", "terminal-flavored", "brutalist"); those are conclusions, not data. They belong to Phase C lane selection in departure mode, not to identity description. Letting them sneak into Phase A is how the identity-lock collapses into a self-fulfilling prophecy. |
| 222 | |
| 223 | This sentence is the **identity lock**. Every variant must be readable as the same brand if rendered side by side. Skipping this phase is the primary cause of off-brand variants. Absence of DESIGN.md is never an excuse; extract from CSS and computed styles instead. |
| 224 | |
| 225 | #### Phase B: Pick mode (default vs departure) |
| 226 | |
| 227 | **Default mode**: the existing identity is preserved. Variants vary expression axes within it. *This is the right mode for ~90% of live sessions.* The user picked an element on a real product they're shipping; they expect variants of *their* hero, not three different brands' heroes. |
| 228 | |
| 229 | **Departure mode**: the existing identity is rejected. Variants propose alternatives consistent with PRODUCT.md voice. Trigger only when at least one is true: |
| 230 | |
| 231 | - PRODUCT.md anti-references explicitly call out the current surface ("the current `index.html` is itself an example"; "diffuse away from this"; "the page on screen is the failure"). Generic anti-references that describe what to avoid in general do **not** trigger departure mode; only ones that point at *this* surface specifically. |
| 232 | - The user's freeform prompt explicitly asks for departure ("rebuild this from scratch", "what if it weren't editorial at all", "show me something completely different"). |
| 233 | |
| 234 | If you're unsure, you're in default mode. The cost of being wrong about default is "three on-brand variants with similar feel": recoverable, the user picks none. The cost of being wrong about departure is "three off-brand variants": unrecoverable, the user is annoyed. |
| 235 | |
| 236 | #### Phase C: Plan three variants |
| 237 | |
| 238 | **Default mode.** Each variant commits to a different **primary axis** of difference, while preserving the identity sentence. The six axes: |
| 239 | |
| 240 | 1. **Hierarchy**: which element commands the eye? |
| 241 | 2. **Layout topology**: stacked / side-by-side / grid / asymmetric / overlay |
| 242 | 3. **Typographic system**: pairing logic, scale ratio, case/weight strategy *within the available faces* |
| 243 | 4. **Color strategy**: which existing palette role carries the surface (Restrained / Committed / Full palette / Drenched). Use the brand's existing palette tokens, not new colors. |
| 244 | 5. **Density**: minimal / comfortable / dense |
| 245 | 6. **Structural decomposition**: merge, split, progressive disclosure |
| 246 | |
| 247 | Three variants → three DIFFERENT axes. The trio reads as *the same brand at three angles*. Do not introduce new fonts, new palette hues, or new aesthetic-family signals; those belong to departure mode. |
| 248 | |
| 249 | **While planning each variant, also name its 2–3 parameter knobs** (per the §7 budget table). Parameters are part of the design, not a decoration added afterward. If the variant explores density, expose a density knob. If it explores color commitment, expose a color-amount range. Deciding "what's tunable" during planning produces better knobs than retrofitting them onto finished HTML. |
| 250 | |
| 251 | **Departure mode.** Each variant anchors to a different **aesthetic direction**, derived from the brand's stated voice and register in PRODUCT.md. Do NOT pick from a fixed catalog of lane categories. The right three directions for this brand are not the same as the right three for another brand, and picking from a list is itself the training-data reflex (the model selects "Swiss-grid, Terminal, Industrial-signage" every time because those are the furthest-from-editorial items in any enumerated list). |
| 252 | |
| 253 | Instead, work from the brand: |
| 254 | |
| 255 | 1. Read PRODUCT.md's Brand Personality words. What physical, spatial, or material experiences would embody those words if design were not involved? (A personality described as "specific, earned, unmistakable" evokes a hand-stamped letter, a numbered print, a watchmaker's loupe. A personality described as "restless, loud, unfiltered" evokes a concert poster, a spray-painted wall, a megaphone.) |
| 256 | 2. From those physical experiences, derive three visual directions that are genuinely different from each other AND from the current surface you're departing. |
| 257 | 3. Avoid the **reflex-reject lanes** in [brand.md](brand.md). Don't trade one monoculture for another. If you find yourself reaching for "Swiss-grid" or "Terminal" or "Industrial-signage" by reflex, you are pattern-matching a catalog in your training data, not reading the brand. Start over from the personality words. |
| 258 | 4. Each direction must be expressible in one concrete sentence that names a real-world referent ("a museum exhibition label system for a contemporary art gallery" not "clean and minimal"). If your sentence contains only adjectives, it's not concrete enough. |
| 259 | 5. **While planning each direction, also name its 2–3 parameter knobs** (per the §7 budget table). The same principle as default mode: decide "what's tunable" during planning, not after writing the HTML. A departure-mode hero with 0 parameters is not "bold creative vision," it's a missed opportunity for the user to fine-tune the direction they pick. |
| 260 | |
| 261 | #### Phase D: Squint test |
| 262 | |
| 263 | **Default mode squint.** Read each variant's identity sentence and compare to the locked identity from Phase A. If any variant has drifted to a different palette, type voice, or visual rhetoric, it has crossed into departure mode by accident; rework. Then check that each variant commits to a different primary axis. Three "tighter density" variants is failure. |
| 264 | |
| 265 | **Departure mode squint.** Two passes, family before sentence: |
| 266 | |
| 267 | 1. **Family pass.** Label each variant with one design-family word of your own choosing (any concrete noun: *exhibition, storefront, cockpit, recipe-card, playbill, field-manual*). If any two variants share a label, or if the label could apply to the other variants equally well, rework. Do not use a fixed vocabulary list for the labels. *This pass is non-negotiable in departure mode and catches the monoculture failure that the sentence pass misses.* |
| 268 | 2. **Sentence pass.** Write three one-sentence descriptions side by side. If two of them rhyme ("both feature big type" / "both are stacks of sections" / "both center the CTA"), rework the offender. |
| 269 | |
| 270 | **When the primary axis is color or theme, forbid the trio from sharing theme + dominant hue.** Two dark-plus-one-dark is not distinct. Aim for three color worlds, not three shades of the same. |
| 271 | |
| 272 | **For action-specific invocations**, each variant must vary along the dimension the action names: |
| 273 | |
| 274 | - `bolder`: amplify a different dimension per variant (scale / saturation / structural change). Not three "slightly bigger" variants. |
| 275 | - `quieter`: pull back a different dimension (color / ornament / spacing). |
| 276 | - `distill`: remove a different class of excess (visual noise / redundant content / nested structure). |
| 277 | - `polish`: target a different refinement axis (rhythm / hierarchy / micro-details like corner radii, focus states, optical kerning). |
| 278 | - `typeset`: different type pairing AND different scale ratio each. Not three riffs on one pairing. |
| 279 | - `colorize`: different hue family each (not shades of one hue). Vary chroma and contrast strategy. |
| 280 | - `layout`: different structural arrangement (stacked / side-by-side / grid / asymmetric). Not spacing tweaks. |
| 281 | - `adapt`: different target context per variant (mobile-first / tablet / desktop / print or low-data). Don't make three mobile layouts. |
| 282 | - `animate`: different motion vocabulary (cascade stagger / clip wipe / scale-and-focus / morph / parallax). Not three staggered fades. |
| 283 | - `delight`: different flavor of personality (unexpected micro-interaction / typographic surprise / illustrated accent / sonic-or-haptic moment / easter-egg interaction). |
| 284 | - `overdrive`: different convention broken (scale / structure / motion / input model / state transitions). Skip `overdrive.md`'s "propose and ask" step; live mode is non-interactive. |
| 285 | |
| 286 | ### 5. Apply the freeform prompt (if present) |
| 287 | |
| 288 | `event.freeformPrompt` is the user's ceiling on direction (all variants must honor it), but still explore meaningfully different *interpretations*. The interpretations stay within whichever mode you picked in Phase B. |
| 289 | |
| 290 | In **default mode**, the prompt narrows the axes you choose, not the identity. *"Make it feel more confident"* → variant 1 amplifies hierarchy (one element commands the eye), variant 2 commits the existing accent color (Committed strategy on the brand's hue), variant 3 tightens density and removes decorative slack. Three different axes, same brand. |
| 291 | |
| 292 | In **departure mode**, the prompt narrows the lanes you draw from, not the families. *"Make it feel like a newspaper front page"* would itself be a departure-mode prompt; honor it but pick three meaningfully different newspaper-adjacent lanes (broadsheet vs. tabloid vs. trade journal), and run the family pass to confirm they don't collapse into one. |
| 293 | |
| 294 | When the prompt and PRODUCT.md anti-references conflict (the prompt asks for X, the anti-references ban X), the anti-references win; they describe the brand's standing position, the prompt is one moment. |
| 295 | |
| 296 | ### 6. Write all variants in a single edit |
| 297 | |
| 298 | Complete HTML replacement of the original element for each variant, not a CSS-only patch. Consider the element's context (computed styles, parent structure, CSS variables from `event.element`). |
| 299 | |
| 300 | Write CSS + all variants in ONE edit at the `insertLine` reported by `wrap`. Colocate CSS as a `<style>` tag inside the variant wrapper; `<style>` works anywhere in modern browsers and this ensures CSS and HTML arrive atomically (no FOUC). |
| 301 | |
| 302 | Use the `cssAuthoring` object returned by `live-wrap.mjs` to author the temporary preview CSS. The style opening tag shown below is the common case; replace it with `cssAuthoring.styleTag` when the tool returns a different one. The variant markup shape is otherwise stable: |
| 303 | |
| 304 | ```html |
| 305 | <!-- Variants: insert below this line --> |
| 306 | <style data-impeccable-css="SESSION_ID"> |
| 307 | /* rules matching cssAuthoring.rulePattern */ |
| 308 | </style> |
| 309 | <div data-impeccable-variant="1"> |
| 310 | <!-- variant 1: full element replacement (single top-level element) --> |
| 311 | </div> |
| 312 | <div data-impeccable-variant="2" style="display: none"> |
| 313 | <!-- variant 2: full element replacement --> |
| 314 | </div> |
| 315 | <div data-impeccable-variant="3" style="display: none"> |
| 316 | <!-- variant 3: full element replacement --> |
| 317 | </div> |
| 318 | ``` |
| 319 | |
| 320 | **Each variant div contains exactly one top-level element: the full replacement for the original.** Use the same tag as the original (e.g. `<section>` if the user picked a `<section>`). Loose siblings (heading + paragraph + div as direct children of the variant div) break the outline tracking and the accept flow, which both assume one child. |
| 321 | |
| 322 | The first variant has no `display: none` (visible by default). All others do. If variants use only inline styles and no preview CSS, omit the `<style>` tag entirely. |
| 323 | |
| 324 | One edit, all variants; the browser's MutationObserver picks everything up in one pass. |
| 325 | |
| 326 | For `styleMode: "scoped"`, author every `:scope` rule with a descendant combinator. The `@scope` boundary is the **variant wrapper `<div data-impeccable-variant="N">`**, not the element you're designing. A bare `:scope { background: cream; }` styles the wrapper, not the inner replacement, so the cream lands on a `display: contents` shell while the actual element keeps page defaults. Always step in: `:scope > .card`, `:scope > section`, `:scope .hero-title`, etc. The fake test agent's CSS in `tests/live-e2e/agent.mjs` is a faithful template; every scoped rule starts `:scope > ...`. |
| 327 | |
| 328 | **JSX / TSX target files.** Wrap `<style>` content in a template literal so the CSS `{` / `}` aren't parsed as JSX expressions, and use `className=` / `style={{…}}` on every variant element. Keep `data-impeccable-*` attributes as-is; they're plain strings: |
| 329 | |
| 330 | ```tsx |
| 331 | <style data-impeccable-css="SESSION_ID">{` |
| 332 | @scope ([data-impeccable-variant="1"]) { ... } |
| 333 | @scope ([data-impeccable-variant="2"]) { ... } |
| 334 | `}</style> |
| 335 | <div data-impeccable-variant="1"> |
| 336 | {/* variant 1 */} |
| 337 | </div> |
| 338 | <div data-impeccable-variant="2" style={{ display: 'none' }}> |
| 339 | {/* variant 2 */} |
| 340 | </div> |
| 341 | ``` |
| 342 | |
| 343 | The wrap script already gives you a single-rooted JSX wrapper: a `<div data-impeccable-variants="…">` outer element with the marker comments tucked inside. Drop the variants block above into the "Variants: insert below this line" comment and the source stays valid TSX. |
| 344 | |
| 345 | ### 7. Parameters (composition-sized, 0–4 per variant) |
| 346 | |
| 347 | Each variant can expose **coarse** knobs alongside the full HTML/CSS replacement. The browser docks a small panel to the right of the outline with one control per parameter. The user drags/clicks and sees instant feedback: there is zero regeneration cost because the knob toggles a CSS variable or data attribute that the variant's scoped CSS is already authored against. |
| 348 | |
| 349 | **What “optional” does not mean.** Parameters are not nice-to-have decoration on large work. The word meant “omit controls that are redundant or cosmetic,” not “default to zero because three variants were enough work.” |
| 350 | |
| 351 | **When to add.** As soon as the variant’s scoped CSS has a meaningful continuous or stepped axis: density, color amount, type scale, motion intensity, column weight, and so on. If you can imagine the user muttering “a bit tighter” or “a touch more accent” **without** wanting a full regeneration, wire that axis. **Not** micro-margins or one-off nudges; those are not parameters. |
| 352 | |
| 353 | **Freeform (`action` is `impeccable`) bias.** You did not load a sub-command reference, so you must **choose** signature axes yourself. Match the budget table: for a hero or large composition, that means **2–3 axes per variant**, not 1. Prefer knobs that sit on the dimensions where your three variants actually differ (if density varies, expose it as a `steps` knob; if color commitment varies, expose it as a `range`). A hero that ships with **0** params is almost always a mistake, not a judgment call. A hero with exactly **1** param is underweight unless the design is genuinely a fixed-point comparison. Start from the budget table, not from zero. |
| 354 | |
| 355 | **Budget scales with the element's visual weight, not token budget.** Knobs need real estate to read as tunable; three sliders on a single control are noise. |
| 356 | |
| 357 | - **Leaf / tiny**: a single button, icon, input, bare heading, solitary paragraph: **0 params.** |
| 358 | - **Small composition**: labeled input, simple card, short callout (≤ ~5 visual children): **0–1** params when one dominant axis is obvious; otherwise **0.** |
| 359 | - **Medium composition**: section component, nav cluster, dense card, short feature block (6–15 visual children): **target 2**; **1** is acceptable if the block is simple; **0** only when variants are truly fixed points. |
| 360 | - **Large composition**: hero section, full page region, spread layout, strong internal structure (16+ visual children or multiple sub-sections): **target 2–3**; **up to 4** when several independent axes (e.g. structure `steps` + `density` + one accent) are all authored in scoped CSS. |
| 361 | |
| 362 | **When in doubt, ask whether a dial exists before defaulting to zero.** The user can always request more variants, but the point of live mode is instant tuning without another Go. Crowding the panel is bad; **under-shipping** knobs on a dense composition is the more common failure for freeform. Count by **visual** children, not DOM depth; a shallow-but-wide hero is still large. |
| 363 | |
| 364 | **Hard cap per variant**: at most **four** parameters so the panel stays legible; rare fifth only if the reference explicitly allows it. |
| 365 | |
| 366 | **How to declare.** Put a JSON manifest on the variant wrapper (HTML/JSX path). **On the Svelte `svelte-component` path, do not use this attribute** (Svelte can't compile `{` inside an attribute value). Declare params in `componentDir/params.json` keyed by variant number instead (see the Svelte component paragraph in the wrap section). The param schema below is identical for both paths. |
| 367 | |
| 368 | ```html |
| 369 | <div data-impeccable-variant="1" data-impeccable-params='[ |
| 370 | {"id":"color-amount","kind":"range","min":0,"max":1,"step":0.05,"default":0.5,"label":"Color amount"}, |
| 371 | {"id":"density","kind":"steps","default":"snug","label":"Density","options":[ |
| 372 | {"value":"airy","label":"Airy"}, |
| 373 | {"value":"snug","label":"Snug"}, |
| 374 | {"value":"packed","label":"Packed"} |
| 375 | ]}, |
| 376 | {"id":"serif","kind":"toggle","default":false,"label":"Serif display"} |
| 377 | ]'> |
| 378 | ...variant content... |
| 379 | </div> |
| 380 | ``` |
| 381 | |
| 382 | **Three kinds:** |
| 383 | |
| 384 | - `range`: smooth slider. Drives a CSS custom property `--p-<id>` on the variant wrapper. Author CSS with `var(--p-color-amount, 0.5)`. Fields: `min`, `max`, `step`, `default` (number), `label`. |
| 385 | - `steps`: segmented radio. Drives a data attribute `data-p-<id>` on the variant wrapper. Author CSS with `:scope[data-p-density="airy"] .grid { ... }`. Fields: `options` (array of `{value, label}`), `default` (string), `label`. |
| 386 | - `toggle`: on/off switch. Drives BOTH a CSS var (`--p-<id>: 0|1`) and a data attribute (present when on, absent when off). Use whichever is more convenient. Fields: `default` (boolean), `label`. |
| 387 | |
| 388 | **Signature params per action.** For named sub-commands, read that action’s `reference/<action>.md` for one or two **MUST** params (e.g. `layout` → `density`). Those are non-negotiable when the design can express them. **Freeform has no file-level MUST**; the **Freeform (`impeccable`) bias** in this section is the stand-in. If the user’s action is both stylized and sub-command (e.g. `colorize`), the sub-command’s MUST list takes precedence for its axes; still respect the **Hard cap** and add no redundant duplicate knobs. |
| 389 | |
| 390 | **Reset on variant switch.** User dials density on v1, flips to v2, v2 starts at v2's declared defaults. Known limitation; preservation across variants may land later. |
| 391 | |
| 392 | **On accept**, the browser sends the user's current values in the accept event. `live-accept.mjs` writes them as a sibling comment: |
| 393 | |
| 394 | ```html |
| 395 | <!-- impeccable-param-values SESSION_ID: {"color-amount":0.7,"density":"packed"} --> |
| 396 | ``` |
| 397 | |
| 398 | The carbonize cleanup step (see below) reads that comment and bakes the chosen values into the final CSS. For `steps`/`toggle` attribute selectors: keep only the branch matching the chosen value, drop the others, collapse `:scope[data-p-density="packed"] .grid` to a semantic class rule. For `range` vars: either substitute the literal or keep the var with the chosen value as its new default. |
| 399 | |
| 400 | ### 8. Signal done |
| 401 | |
| 402 | ```bash |
| 403 | node .agents/skills/impeccable/scripts/live-poll.mjs --reply EVENT_ID done --file RELATIVE_PATH |
| 404 | ``` |
| 405 | |
| 406 | `RELATIVE_PATH` is relative to project root (`public/index.html`, `src/App.tsx`, etc.); the browser fetches source directly if the dev server lacks HMR. |
| 407 | |
| 408 | Then run `live-poll.mjs` again immediately. |
| 409 | |
| 410 | ### Aborting an in-flight session |
| 411 | |
| 412 | If wrap or generation fails after the browser has flipped to GENERATING (e.g. wrap landed on the wrong source branch and you've already reverted it, or generation hit an unrecoverable error), tell the **browser** so its bar resets to PICKING: |
| 413 | |
| 414 | ```bash |
| 415 | node .agents/skills/impeccable/scripts/live-poll.mjs --reply EVENT_ID error "Short reason" |
| 416 | ``` |
| 417 | |
| 418 | Don't run `live-accept --discard` for this; that's a pure file mutator, the browser doesn't see it, and the bar gets stuck on the GENERATING dots forever (the user has to refresh). `--discard` is only correct when the **browser** initiated the discard (user clicked ✕ during CYCLING) and the agent is just running source-side cleanup the browser already triggered. |
| 419 | |
| 420 | ## Handle fallback |
| 421 | |
| 422 | When wrap returns `fallback: "agent-driven"`, the deterministic flow doesn't apply. Pick up here. |
| 423 | |
| 424 | The goal is the same: give the user three variants to choose from AND persist the accepted one in a place the next build won't wipe. The difference is that you have to pick the right source file yourself. |
| 425 | |
| 426 | ### Step 1: Identify where the element actually lives |
| 427 | |
| 428 | Use the error payload: |
| 429 | |
| 430 | - `element_not_in_source` with `generatedMatch: "public/docs/foo.html"`: the served HTML is generated. Find the generator (grep for writers of that path, e.g. `scripts/build-sub-pages.js`, an Astro/Next template) and locate the template or partial that emits this element. |
| 431 | - `element_not_found`: the element is runtime-injected. Look for the component that renders it (React/Vue/Svelte), the JS that assembles it, or the data source that feeds it. |
| 432 | - `file_is_generated` with `file: "..."`: user pointed at a generated file explicitly. Same resolution as `element_not_in_source`. |
| 433 | |
| 434 | Read the candidate source until you're confident where a change to the element would belong. If the change is purely visual, that source might be a shared stylesheet, not the template. |
| 435 | |
| 436 | ### Step 2: Show three variants in the DOM for preview |
| 437 | |
| 438 | The browser bar is waiting for variants. Even without a wrapper in source, you still need to show something: |
| 439 | |
| 440 | 1. Manually write the wrapper scaffold into the **served** file (the one the browser actually loaded). Use the same structure `live-wrap.mjs` produces; `<!-- impeccable-variants-start ID --><div data-impeccable-variants="ID" data-impeccable-variant-count="3" style="display: contents">…</div><!-- end -->`. |
| 441 | 2. Insert your three variant divs inside it, same shape as the deterministic path. |
| 442 | 3. Signal done with `--reply EVENT_ID done --file <served file>`. The browser's no-HMR fallback will fetch and inject. |
| 443 | |
| 444 | This served-file edit is **temporary**: next regen wipes it, and that's fine. The real work happens on accept. |
| 445 | |
| 446 | ### Step 3: On accept, write to true source |
| 447 | |
| 448 | When the accept event arrives (`_acceptResult.handled` will usually be `false` here because accept also refuses to persist into generated files; see Handle accept for the carbonize branch), extract the accepted variant's content and write it into the source you identified in Step 1: |
| 449 | |
| 450 | - Structural change → edit the template / component source. |
| 451 | - Visual-only change → add or update rules in the appropriate stylesheet; remove the inline `<style>` scope. |
| 452 | - Dynamic from data → update the data source or the render logic. |
| 453 | |
| 454 | Then remove the temporary wrapper from the served file if it's still there. |
| 455 | |
| 456 | ### Step 4: On discard, clean up the served file |
| 457 | |
| 458 | Remove the wrapper you inserted in Step 2. Nothing else to do. |
| 459 | |
| 460 | ## Handle `accept` |
| 461 | |
| 462 | Event: `{id, variantId, _acceptResult, _completionAck}`. The poll script already ran `live-accept.mjs` to handle the file operation deterministically, then acknowledged event delivery to the helper. The browser DOM is already updated. |
| 463 | |
| 464 | - The accept event includes `pageUrl`; the poll script must forward it to `live-accept.mjs --page-url PAGE_URL` so accept-time cleanup only scrubs staged copy edits for the current page. |
| 465 | - `_completionAck.ok !== true`: do not poll yet. Run `live-status.mjs` / `live-resume.mjs`, complete the cleanup manually if needed, then run `live-complete.mjs --id EVENT_ID`. |
| 466 | - `_acceptResult.handled: true` and `carbonize: false`: nothing to do. Poll again. |
| 467 | - `_acceptResult.handled: true` and `carbonize: true`: **post-accept cleanup is required before the next poll.** See the "Required after accept (carbonize)" section below. The `event._acceptResult.todo` field, `_completionAck.requiresComplete`, and a stderr banner all point at this required follow-up; none are decorative. After cleanup, run `live-complete.mjs --id EVENT_ID`, then poll again. |
| 468 | - `_acceptResult.handled: false, mode: "fallback"`: the session lived in a generated file and the script refused to persist there. You've already written the accepted variant into true source during Handle fallback Step 3; just clean up the temporary wrapper in the served file if any, and poll again. |
| 469 | - `_acceptResult.handled: false` without `mode`: manual cleanup: read file, find markers, edit. |
| 470 | |
| 471 | ### Required after accept (carbonize) |
| 472 | |
| 473 | When `_acceptResult.carbonize === true`, the accepted variant was stitched into source with helper markers and inline CSS so the browser can render it immediately with no visual gap. That stitch-in is **temporary**. The agent must rewrite it into permanent form before doing anything else. Skipping this leaves dead `@scope` rules for unaccepted variants, a pointless `data-impeccable-variant` wrapper, and `impeccable-carbonize-start/end` comment noise in the source file; all of which accumulate across sessions. |
| 474 | |
| 475 | Do these five steps in the current thread, synchronously, before the next poll. Do not poll again until the file is clean. |
| 476 | |
| 477 | 1. **Locate the carbonize block** in the source file (`_acceptResult.file`). It's bracketed by `<!-- impeccable-carbonize-start SESSION_ID -->` and `<!-- impeccable-carbonize-end SESSION_ID -->` and contains a `<style data-impeccable-css="SESSION_ID">` element. If the variant declared parameters, an `<!-- impeccable-param-values SESSION_ID: {...} -->` comment sits alongside the style tag with the user's chosen values; read it first; it drives steps 3 and 4 below. |
| 478 | 2. **Move the CSS rules** into the project's real stylesheet. Which stylesheet depends on the project (e.g. `site/styles/workflow.css` for an Astro project, or the component's co-located CSS file for a Vite/Next project; pick whichever already owns styling for the surrounding element). |
| 479 | 3. **Bake in parameter values while rewriting selectors.** For `@scope ([data-impeccable-variant="N"])` wrappers: retarget to real, semantic classes on the accepted HTML (`.why-visual--v2 .v2-label { … }`). For `:scope[data-p-<id>="VALUE"]` selectors: keep only the branch matching the chosen value from the param-values comment; drop the others (they're dead after accept). For `var(--p-<id>, DEFAULT)` in the CSS: either substitute the literal value, or if the param is still useful as a knob going forward, leave the var and update its initial declaration to the chosen value. |
| 480 | 4. **Unwrap the accepted content.** Delete the inner `<div data-impeccable-variant="N" style="display: contents">` that wraps it. On JSX/TSX, also delete the outer `<div data-impeccable-carbonize="SESSION_ID" style={{ display: 'contents' }}>` wrapper if present (accept adds it so ternary/`return` slots keep a single root). Drop `data-impeccable-params` and any `data-p-*` attributes; those are live-mode plumbing, not source. |
| 481 | 5. **Delete the inline `<style>` block, the `<!-- impeccable-param-values -->` comment if present, and both `<!-- impeccable-carbonize-start/end -->` markers.** Also drop any `@scope` rules for variants other than the accepted one; those are dead code now. |
| 482 | |
| 483 | After the file is clean, run `live-complete.mjs --id SESSION_ID`, verify it reports `phase: "completed"`, then poll again. |
| 484 | |
| 485 | A background agent may be used for the rewrite, but the current thread is responsible for verifying the five steps are complete before issuing the next poll. In practice, inline is usually faster and less error-prone. |
| 486 | |
| 487 | ## Handle `discard` |
| 488 | |
| 489 | Event: `{id, _acceptResult, _completionAck}`. The poll script already restored the original, removed all variant markers, and acknowledged `discarded` durable completion. Nothing to do unless `_completionAck.ok !== true`; in that case run `live-complete.mjs --id EVENT_ID --discarded`, then poll again. |
| 490 | |
| 491 | ## Handle `steer` |
| 492 | |
| 493 | Event: `{id, message, pageUrl}`. The user typed or spoke into the global bar **Steer** control: page-level direction without picking an element or launching variant generation. |
| 494 | |
| 495 | The mic button uses the browser **Web Speech API** (MVP): click to start, speak, stop automatically when the utterance ends, then the transcript submits as a steer event. Click again while listening to cancel without submitting. |
| 496 | |
| 497 | This is lighter than `generate`: no screenshot, no element context, no variant cycling. Read `message` and inspect the live page or project files as needed, then either make edits or answer in prose. |
| 498 | |
| 499 | When finished: |
| 500 | |
| 501 | ```bash |
| 502 | node .agents/skills/impeccable/scripts/live-poll.mjs --reply EVENT_ID steer_done ["Optional short note for a browser toast"] |
| 503 | ``` |
| 504 | |
| 505 | On failure: |
| 506 | |
| 507 | ```bash |
| 508 | node .agents/skills/impeccable/scripts/live-poll.mjs --reply EVENT_ID error "Short reason" |
| 509 | ``` |
| 510 | |
| 511 | Then poll again immediately. Do not send a separate "picked up" reply. The Steer bar stays locked until `steer_done` or `error` arrives over SSE. |
| 512 | |
| 513 | ## Handle `prefetch` |
| 514 | |
| 515 | Event: `{pageUrl}`. The browser fires this the first time the user selects an element on a given route, as a latency shortcut; it signals the user is likely about to Go on a page you haven't read yet. |
| 516 | |
| 517 | Resolve `pageUrl` to the underlying file: |
| 518 | |
| 519 | - Root `/` → the `pageFile` returned by `live.mjs` (usually `public/index.html` or equivalent). |
| 520 | - Sub-routes (e.g. `/docs`, `/docs/live`) → the generated or source file for that route. Use your knowledge of the project layout (multi-page static sites often resolve `/foo` → `public/foo/index.html`; SPAs may map all routes to a single entry). |
| 521 | |
| 522 | Read the file into context, then poll again. No `--reply`: this is speculative pre-work; Go will come later. If you can't confidently resolve the route to a file, skip and poll again. |
| 523 | |
| 524 | Dedupe is the browser's job (one prefetch per unique pathname per session); trust it. If the same file shows up twice from different routes mapping to the same file, the second Read is cached anyway. |
| 525 | |
| 526 | ## Handle `manual_edit_apply` |
| 527 | |
| 528 | Event: `{id, pageUrl, batch: {entries}, evidencePath?, chunk?, repair?, deadlineMs}`. |
| 529 | |
| 530 | The user already clicked Apply. Do not ask what to do, discard, or redirect to Go. The parent live thread keeps the foreground poll loop and sends the final `/poll --reply --data`. |
| 531 | |
| 532 | When native subagents are available, delegate source edits to `impeccable_manual_edit_applier` / `impeccable-manual-edit-applier`. Pass cwd, scripts path, event id, page URL, chunk/deadline, `batch`, `evidencePath`, and the canonical JSON result schema. The subagent must not poll or reply. If unavailable, apply inline with the same contract. |
| 533 | |
| 534 | If `repair` is present, the previous Apply changed source but final validation failed. Fix the current source and return the same canonical JSON result; do not roll files back yourself. The browser will ask the user before any rollback. |
| 535 | |
| 536 | After source edits finish, reply exactly once with `node .agents/skills/impeccable/scripts/live-poll.mjs --reply EVENT_ID done --data '{"status":"done","appliedEntryIds":["8hexid"],"failed":[],"files":["src/page.html"],"notes":[]}'`. Use `status:"partial"` or `status:"error"` with `failed[]` when not every entry applied. Then poll again. Never reply without the event id; `--reply done --file ...` is invalid for manual Apply. |
| 537 | |
| 538 | ## Exit |
| 539 | |
| 540 | The user can stop live mode by: |
| 541 | - Saying "stop live mode" / "exit live" in chat |
| 542 | - Closing the browser tab (SSE drops, poll returns `exit` after 8s) |
| 543 | - The browser's exit button |
| 544 | |
| 545 | When the poll returns `exit`, proceed to cleanup. If the poll is still running as a background task, kill it first. |
| 546 | |
| 547 | ## Cleanup |
| 548 | |
| 549 | ```bash |
| 550 | node .agents/skills/impeccable/scripts/live-server.mjs stop |
| 551 | ``` |
| 552 | |
| 553 | Stops the HTTP server and runs `live-inject.mjs --remove` to strip `localhost:…/live.js` from the HTML entry. To stop the server but keep the inject tag (for a quick restart), use `stop --keep-inject`. `.impeccable/live/config.json` persists as project config for future sessions. |
| 554 | |
| 555 | Then: |
| 556 | - Remove any leftover variant wrappers (search for `impeccable-variants-start` markers). |
| 557 | - Remove any leftover carbonize blocks (search for `impeccable-carbonize-start` markers). |
| 558 | |
| 559 | ## First-time setup (config missing or invalid) |
| 560 | |
| 561 | If `live.mjs` outputs `{ ok: false, error: "config_missing" | "config_invalid", path }`, write the live config at the reported path. By default this is `.impeccable/live/config.json`. |
| 562 | |
| 563 | Schema: |
| 564 | |
| 565 | ```json |
| 566 | { |
| 567 | "files": ["<path-or-glob>", "<path-or-glob>", ...], |
| 568 | "exclude": ["<optional-glob>", ...], |
| 569 | "insertBefore": "</body>", |
| 570 | "commentSyntax": "html", |
| 571 | "cspChecked": true |
| 572 | } |
| 573 | ``` |
| 574 | |
| 575 | `files` is the inject target; **the HTML files the browser actually loads**, not necessarily source. Each entry is either a literal path (`"public/index.html"`) or a glob pattern (`"public/**/*.html"`). Tracked or generated doesn't matter here; wrap has its own generated-file guard and routes accepts through the fallback flow. |
| 576 | |
| 577 | `exclude` (optional) is a list of glob patterns matching files to skip, even if a `files` glob would have included them. Use for email templates, demo fixtures, or any HTML that isn't a live page. |
| 578 | |
| 579 | `cspChecked` tracks whether the CSP detection step below has already run. Absent on first setup; set to `true` after CSP is checked (whether patched, declined, or not needed). |
| 580 | |
| 581 | **Hard-excluded paths (cannot be overridden).** `**/node_modules/**` and `**/.git/**` are never matched regardless of what the user writes. These are vendor/metadata directories and injecting into them would silently instrument third-party code. |
| 582 | |
| 583 | **Glob syntax.** `**` matches any number of path segments (including zero), `*` matches any characters except `/`, `?` matches a single character except `/`. Paths are always relative to the project root with forward slashes. |
| 584 | |
| 585 | | Framework | `files` | `insertBefore` | `commentSyntax` | |
| 586 | |-----------|---------|----------------|-----------------| |
| 587 | | SPA with single shell (Vite / React / Plain HTML) | `["index.html"]` | `</body>` | `html` | |
| 588 | | Next.js (App Router) | `["app/layout.tsx"]` | `</body>` | `jsx` | |
| 589 | | Next.js (Pages) | `["pages/_document.tsx"]` | `</body>` | `jsx` | |
| 590 | | Nuxt | `["app.vue"]` | `</body>` | `html` | |
| 591 | | Svelte / SvelteKit | `["src/app.html"]` | `</body>` | `html` | |
| 592 | | Astro | `[" <root layout .astro>"]` | `</body>` | `html` | |
| 593 | | Multi-page (separate HTML per route) | `["public/**/*.html"]`: a glob covering the served directory | `</body>` | `html` | |
| 594 | |
| 595 | Pick an anchor that exists in every file (`</body>` almost always works). Use `insertAfter` if the anchor should match **after** a specific line. |
| 596 | |
| 597 | For multi-page sites, **prefer a glob over a literal file list**. New pages added later are picked up automatically on the next `live-inject.mjs` run; no config maintenance needed. |
| 598 | |
| 599 | For multi-page sites whose pages are *rebuilt* by a generator (Astro, static-site generators, custom scripts like `build-sub-pages.js`), the inject survives only until the next regeneration. Re-run `live.mjs` after each build. Accept is unaffected; it writes to true source via the fallback flow. |
| 600 | |
| 601 | ### Drift-heal warning |
| 602 | |
| 603 | On every `live.mjs` boot, after inject, the project is scanned for HTML files under common page-source roots (`public/`, `src/`, `app/`, `pages/`). If any exist that aren't covered by the resolved `files` list, the output includes a `configDrift` field: |
| 604 | |
| 605 | ```json |
| 606 | { |
| 607 | "ok": true, |
| 608 | "serverPort": 8400, |
| 609 | "pageFiles": [ "..." ], |
| 610 | "configDrift": { |
| 611 | "orphans": ["public/new-section/index.html", "public/docs/new-command.html"], |
| 612 | "orphanCount": 2, |
| 613 | "hint": "2 HTML file(s) exist but aren't in config.files. Consider adding them, or use a glob pattern like \"public/**/*.html\"." |
| 614 | } |
| 615 | } |
| 616 | ``` |
| 617 | |
| 618 | When `configDrift` is present, surface it to the user once per session before entering the poll loop: |
| 619 | |
| 620 | > Noticed N HTML file(s) in the project that aren't in `config.files`: |
| 621 | > |
| 622 | > - `public/new-section/index.html` |
| 623 | > - `public/docs/new-command.html` |
| 624 | > |
| 625 | > Add them, or switch `files` to a glob like `["public/**/*.html"]` and let it track new pages automatically? |
| 626 | |
| 627 | Don't auto-update the config; let the user decide. `configDrift` is `null` when there's no drift. |
| 628 | |
| 629 | ### CSP detection (first-time only) |
| 630 | |
| 631 | If `config.cspChecked === true`, skip this entire section. You already asked this user once; the answer sticks. |
| 632 | |
| 633 | Otherwise, run the detection helper: |
| 634 | |
| 635 | ```bash |
| 636 | node .agents/skills/impeccable/scripts/detect-csp.mjs |
| 637 | ``` |
| 638 | |
| 639 | Output: `{ shape, signals }` where `shape` is one of `append-arrays`, `append-string`, `middleware`, `meta-tag`, or `null`. The shape is named by *patch mechanism*, so one template covers many frameworks. |
| 640 | |
| 641 | - **`null`**: no CSP; skip to writing `.impeccable/live/config.json` with `cspChecked: true`. |
| 642 | - **`append-arrays`**: CSP defined as structured directive arrays. Auto-patchable. See *append-arrays* below. Covers: |
| 643 | - Monorepo helpers with `additionalScriptSrc` / `additionalConnectSrc` options (Next.js + shared config package) |
| 644 | - SvelteKit `kit.csp.directives` |
| 645 | - Nuxt `nuxt-security` module's `contentSecurityPolicy` |
| 646 | - **`append-string`**: CSP written as a literal value string. Auto-patchable. See *append-string* below. Covers: |
| 647 | - Inline `next.config.*` `headers()` with a CSP literal |
| 648 | - Nuxt `routeRules` / `nitro.routeRules` headers |
| 649 | - **`middleware`** or **`meta-tag`**: rarer. Detected but not auto-patched in v1. Show the user the detected files and ask them to add `http://localhost:8400` to `script-src` and `connect-src` manually, then mark `cspChecked: true` and proceed. |
| 650 | |
| 651 | #### Consent prompt template |
| 652 | |
| 653 | Use this phrasing so the experience is consistent across agents: |
| 654 | |
| 655 | > **CSP patch needed.** I detected a Content Security Policy in your project that blocks `http://localhost:8400`: the live picker won't load without an allowance. Here's the change I'd make: |
| 656 | > |
| 657 | > ```diff |
| 658 | > [file: <patchTarget>] |
| 659 | > [exact diff, 2–5 lines] |
| 660 | > ``` |
| 661 | > |
| 662 | > It's guarded by `NODE_ENV === "development"` so the extra entry only appears in dev and never reaches production. You can remove it any time by reverting this file. Apply? [y/n] |
| 663 | |
| 664 | On "no": skip the patch, mention live won't work until the user adds the allowance manually, still write `cspChecked: true` (the question's been asked). |
| 665 | |
| 666 | On "yes": apply the Shape-specific patch below, then write `cspChecked: true`. |
| 667 | |
| 668 | #### append-arrays |
| 669 | |
| 670 | CSP expressed as structured directive arrays. Patch mechanism: declare a dev-only array, spread it into the script-src and connect-src arrays. |
| 671 | |
| 672 | **Declare near the top of the file that holds the CSP arrays:** |
| 673 | |
| 674 | ```ts |
| 675 | // Dev-only allowance so impeccable live mode can load. Guarded by NODE_ENV. |
| 676 | const __impeccableLiveDev = |
| 677 | process.env.NODE_ENV === "development" ? ["http://localhost:8400"] : []; |
| 678 | ``` |
| 679 | |
| 680 | **Append `...__impeccableLiveDev` to the script-src and connect-src directive arrays.** Per-framework specifics: |
| 681 | |
| 682 | - **Next.js + monorepo helper**: edit the *app's* `next.config.*` (not the shared helper), appending to `additionalScriptSrc` and `additionalConnectSrc` passed into `createBaseNextConfig` (or equivalent). Keeps the shared package clean. |
| 683 | - **SvelteKit**: edit `svelte.config.js`, appending to `kit.csp.directives['script-src']` and `kit.csp.directives['connect-src']`. |
| 684 | - **Nuxt + nuxt-security**: edit `nuxt.config.*`, appending to `security.headers.contentSecurityPolicy['script-src']` and `['connect-src']`. |
| 685 | |
| 686 | Reference outputs: |
| 687 | - `tests/framework-fixtures/nextjs-turborepo/expected-after-patch.ts` (Next.js) |
| 688 | - `tests/framework-fixtures/sveltekit-csp/expected-after-patch.js` (SvelteKit) |
| 689 | |
| 690 | Idempotency: if `__impeccableLiveDev` already exists in the file, the patch is already applied; skip asking and just mark `cspChecked: true`. |
| 691 | |
| 692 | #### append-string |
| 693 | |
| 694 | CSP built as a literal value string. Two-point patch: declare a dev-only string near the top, interpolate it into the CSP at the `script-src` and `connect-src` directives. |
| 695 | |
| 696 | ```ts |
| 697 | // Dev-only allowance so impeccable live mode can load. |
| 698 | const __impeccableLiveDev = |
| 699 | process.env.NODE_ENV === "development" ? " http://localhost:8400" : ""; |
| 700 | ``` |
| 701 | |
| 702 | Then in the CSP value string: |
| 703 | - `script-src 'self' 'unsafe-inline'` → `` `script-src 'self' 'unsafe-inline'${__impeccableLiveDev}` `` |
| 704 | - `connect-src 'self'` → `` `connect-src 'self'${__impeccableLiveDev}` `` |
| 705 | |
| 706 | (Leading space on the dev string so it concatenates cleanly into the existing value. Convert the literal CSP directives into template strings as part of the edit if they aren't already.) |
| 707 | |
| 708 | Per-framework specifics: |
| 709 | - **Next.js inline `headers()`**: edit `next.config.*`, splicing the variable into the CSP value. |
| 710 | - **Nuxt `routeRules`**: edit `nuxt.config.*`, splicing into the CSP in `routeRules['/**'].headers['Content-Security-Policy']`. |
| 711 | |
| 712 | Reference outputs: |
| 713 | - `tests/framework-fixtures/nextjs-inline-csp/expected-after-patch.js` (Next.js) |
| 714 | - `tests/framework-fixtures/nuxt-csp/expected-after-patch.ts` (Nuxt) |
| 715 | |
| 716 | ### Troubleshooting |
| 717 | |
| 718 | If a user says "no" to the CSP patch at setup time and later complains that live doesn't work: their dev CSP blocks `http://localhost:8400`. Fix: delete `cspChecked` from `.impeccable/live/config.json` and re-run `live.mjs`: setup will ask again. |
| 719 | |
| 720 | Then re-run `live.mjs`. |
| 721 |