Files
msd-core/gsd-core/workflows/sketch.md
Tom Boucher fb2d122d7f feat(#3841): assert gsd-tools identity on every state-mutating verb (#3848)
* feat(#3841): assert gsd-tools identity before any state-mutating verb

only this package publishes. The path-based branches — a project-local install,
a runtime config directory — had no such guarantee; they trusted their
configured location. This closes them.

Mechanism: once resolution finishes, and before any verb runs, the preamble
probes the tool it picked with `runtime-identity --raw` and matches the answer
with a shell `case` pattern ANCHORED to the start of the compact payload
(`{"packageName":"@opengsd/gsd-core"`). An unanchored substring match accepts
the decoy `{"packageName":"get-shit-done-cc","note":"@opengsd/gsd-core"}`, which
any colliding package could publish. The outcome is exported as the two-valued
`GSD_IDENTITY_STATUS` (`ok`/`unverified`), so the gate is asserted on a VALUE
rather than on warning prose. Rollout is warn-then-fail per the #3146 ruling:
`unverified` prints one line naming BOTH causes and continues, because
`no_identity_verb` cannot tell a foreign package from an `@opengsd/gsd-core`
older than the verb, and at rollout the old-version case is the common one.

The blocker was byte budget, not design. The preamble is inlined into 112
shipped files and several sat within single-digit bytes of frozen ceilings
(`gsd-verifier.md` 16 bytes, `gsd-executor.md` 33, `execute-phase.md` 234); a
first attempt broke five of them. What made room was collapsing the resolver's
twenty near-identical `elif [ -f … ]` arms into one candidate-list helper
(`_gsd_at`), which buys far more than the assertion costs. The preamble is now
2,624 bytes against 4,500 — a net 1,876 bytes SMALLER per inlined file, so every
capped file moved away from its ceiling rather than toward it. No cap raised, no
size-budget exception added, no override token emitted.

Resolution order, every runtime-home probe, the `unset -f gsd_run` re-source
fix, the fail-closed `exit 1`, and the `CLAUDE_ENV_FILE` persistence are all
preserved byte-for-byte in substring terms; the snippet still begins with
`_GSD_SHIM_NAME=` and still ends with `fi`, which the parity extractors anchor
on. `gsd-core/references/gsd-run-resolver.md` is re-synced byte-equal.

Also fixes two stale claims found in passing: CONTEXT.md and FEATURES.md both
described an `[ -x ]` guard as the load-bearing re-source defense. That guard
was tried and REMOVED in #3831 — it rejected the bare function name, fell
through every branch, and hit `exit 1`, which kills a sourced caller's shell.
`unset -f gsd_run` is the actual mechanism.

Refs #3841

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* fix(#3841): pair the anchor's brace by requiring a closed identity payload

The matrix went red on `tests/new-project-mvp-prompt.test.cjs` — "new-project.md
has unbalanced braces: net depth 2" — plus a knock-on report from its parent
`bug #1516` describe, which is the same failure counted once at the child and
once at the block.

Root cause: that guard (:182-189, mirroring #3784 bd53925f) walks characters and
increments on `{`, decrements on `}`, with no awareness of shell quoting. It
scans `new-project.md` PLUS every `new-project/steps/*.md`, and both
`new-project.md` and `steps/auto-mode-config.md` carry one inlined preamble copy
— hence net 2 from a snippet that was off by exactly one. The unpaired brace was
the `{` inside the single-quoted `case` pattern of the identity anchor, which is
correct shell and invisible to a text scanner.

Fix in the snippet, not the guard. The pattern now anchors at BOTH ends:
`'{"packageName":"@opengsd/gsd-core"'*'}'`. That balances 51/51 with a brace that
does real work rather than a cosmetic pair — a truncated payload whose prefix
matches now fails too, where before it verified. Safe for any future additive
field: a JSON object's own closing brace is always the last character, whatever
type the last value has, which is pinned by two negative-space tests (a nested
object and an array-valued last key must both still verify). Cost: +3 bytes,
against the 1,873 the resolver fold already gave back.

The alternative considered and rejected was dropping the literal `{` for a `?`
glob. It balances too, but weakens the anchor from "must be an opening brace" to
"must be any one character", and the anchor is the entire point.

Two guards added so this cannot recur silently:
- runtime-launcher-parity (F0) pins brace balance at the SNIPPET, so the next
  edit to that pattern fails on the file it broke instead of surfacing three
  files downstream in a test whose name mentions neither the launcher nor this
  issue. It also asserts depth never goes negative, since a `}` preceding its
  `{` nets to zero while being unbalanced at every prefix.
- runtime-identity gains behavioral truncated-payload and trailing-garbage
  fixtures, so the added `}` is proven load-bearing rather than merely present.

Verified: snippet 51/51 braces; new-project combined net depth 0; the seven
other preamble-bearing files with nonzero depth are unchanged from merged next
(their own prose, not the preamble, and not in any guard's scan set); all 112
inlined copies and the resolver reference re-synced byte-equal; sync:launcher
idempotent on the second run.

Refs #3841

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* chore(#3841): backfill changeset PR number

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

---------

Co-authored-by: sim <sim@local>
Co-authored-by: Claude Opus 5 <noreply@anthropic.com>
2026-08-25 01:05:53 -04:00

16 KiB

Explore design directions through throwaway HTML mockups before committing to implementation. Each sketch produces 2-3 variants for comparison. Saves artifacts to `.planning/sketches/`. Companion to `/gsd:sketch --wrap-up`.

Supports two modes:

  • Idea mode (default) — user describes a design idea to sketch
  • Frontier mode — no argument or "frontier" / "what should I sketch?" — analyzes existing sketch landscape and proposes consistency and frontier sketches

<required_reading> Read all files referenced by the invoking prompt's execution_context before starting.

@/.claude/gsd-core/references/sketch-theme-system.md @/.claude/gsd-core/references/sketch-variant-patterns.md @/.claude/gsd-core/references/sketch-interactivity.md @/.claude/gsd-core/references/sketch-tooling.md </required_reading>

``` ### GSD ► SKETCHING ```

Parse $ARGUMENTS for:

  • --quick flag → set QUICK_MODE=true
  • --text flag → set TEXT_MODE=true
  • frontier or empty → set FRONTIER_MODE=true
  • Remaining text → the design idea to sketch

Text mode: If TEXT_MODE is enabled, replace AskUserQuestion calls with plain-text numbered lists.

## Routing
  • FRONTIER_MODE is true → Jump to frontier_mode
  • Otherwise → Continue to setup_directory
## Frontier Mode — Propose What to Sketch Next

Load the Sketch Landscape

If no .planning/sketches/ directory exists, tell the user there's nothing to analyze and offer to start fresh with an idea instead.

Otherwise, load in this order:

a. MANIFEST.md — the design direction, reference points, and sketch table with winners.

b. Findings skills — glob ./.claude/skills/sketch-findings-*/SKILL.md and read any that exist, plus their references/*.md. These contain curated design decisions from prior wrap-ups.

c. All sketch READMEs — read .planning/sketches/*/README.md for design questions, winners, and tags.

Analyze for Consistency Sketches

Review winning variants across all sketches. Look for:

  • Visual consistency gaps: Two sketches made independent design choices that haven't been tested together.
  • State combinations: Individual states validated but not seen in sequence.
  • Responsive gaps: Validated at one viewport but the real app needs multiple.
  • Theme coherence: Individual components look good but haven't been composed into a full-page view.

If consistency risks exist, present them as concrete proposed sketches with names and design questions. If no meaningful gaps, say so and skip.

Analyze for Frontier Sketches

Think laterally about the design direction from MANIFEST.md and what's been explored:

  • Unsketched screens: UI surfaces assumed but unexplored.
  • Interaction patterns: Static layouts validated but transitions, loading, drag-and-drop need feeling.
  • Edge case UI: 0 items, 1000 items, errors, slow connections.
  • Alternative directions: Fresh takes on "fine but not great" sketches.
  • Polish passes: Typography, spacing, micro-interactions, empty states.

Present frontier sketches as concrete proposals numbered from the highest existing sketch number.

Get Alignment and Execute

Present all consistency and frontier candidates, then ask which to run. When the user picks sketches, update .planning/sketches/MANIFEST.md and proceed directly to building them starting at build_sketches.

Create `.planning/sketches/` and themes directory if they don't exist:
mkdir -p .planning/sketches/themes

Check for existing sketches to determine numbering:

ls -d .planning/sketches/[0-9][0-9][0-9]-* 2>/dev/null | sort | tail -1

Check commit_docs config:

_GSD_SHIM_NAME="gsd-tools.cjs"; _GSD_RUNTIME_ROOT="${RUNTIME_DIR:-$(git rev-parse --show-toplevel 2>/dev/null || pwd)}"; GSD_TOOLS="${_GSD_RUNTIME_ROOT}/gsd-core/bin/${_GSD_SHIM_NAME}"; _gsd_at() { for _p; do if [ -f "$_p" ]; then GSD_TOOLS="$_p"; return 0; fi; done; return 1; }; if _gsd_at "${_GSD_RUNTIME_ROOT}/gsd-core/bin/${_GSD_SHIM_NAME}" "${_GSD_RUNTIME_ROOT}/.claude/gsd-core/bin/${_GSD_SHIM_NAME}" "${_GSD_RUNTIME_ROOT}/.codex/gsd-core/bin/${_GSD_SHIM_NAME}"; then gsd_run() { node "$GSD_TOOLS" "$@"; }; elif unset -f gsd_run; _G="$(command -v gsd_run)"; then GSD_TOOLS="$_G"; gsd_run() { "$GSD_TOOLS" "$@"; }; elif _gsd_at "${CLAUDE_CONFIG_DIR:-$HOME/.claude}/gsd-core/bin/${_GSD_SHIM_NAME}" "${HERMES_HOME:-$HOME/.hermes}/gsd-core/bin/${_GSD_SHIM_NAME}" "${CURSOR_CONFIG_DIR:-$HOME/.cursor}/gsd-core/bin/${_GSD_SHIM_NAME}" "${CODEX_HOME:-$HOME/.codex}/gsd-core/bin/${_GSD_SHIM_NAME}" "${GEMINI_CONFIG_DIR:-$HOME/.gemini}/gsd-core/bin/${_GSD_SHIM_NAME}" "${COPILOT_CONFIG_DIR:-$HOME/.copilot}/gsd-core/bin/${_GSD_SHIM_NAME}" "${WINDSURF_CONFIG_DIR:-$HOME/.codeium/windsurf}/gsd-core/bin/${_GSD_SHIM_NAME}" "${AUGMENT_CONFIG_DIR:-$HOME/.augment}/gsd-core/bin/${_GSD_SHIM_NAME}" "${TRAE_CONFIG_DIR:-$HOME/.trae}/gsd-core/bin/${_GSD_SHIM_NAME}" "${QWEN_CONFIG_DIR:-$HOME/.qwen}/gsd-core/bin/${_GSD_SHIM_NAME}" "${CODEBUDDY_CONFIG_DIR:-$HOME/.codebuddy}/gsd-core/bin/${_GSD_SHIM_NAME}" "${CLINE_CONFIG_DIR:-$HOME/.cline}/gsd-core/bin/${_GSD_SHIM_NAME}" "${GROK_AGENTS_HOME:-$HOME/.agents}/gsd-core/bin/${_GSD_SHIM_NAME}" "${ANTIGRAVITY_CONFIG_DIR:-$HOME/.gemini/antigravity}/gsd-core/bin/${_GSD_SHIM_NAME}" "${OPENCODE_CONFIG_DIR:-${XDG_CONFIG_HOME:-$HOME/.config}/opencode}/gsd-core/bin/${_GSD_SHIM_NAME}" "${KILO_CONFIG_DIR:-${XDG_CONFIG_HOME:-$HOME/.config}/kilo}/gsd-core/bin/${_GSD_SHIM_NAME}"; then gsd_run() { node "$GSD_TOOLS" "$@"; }; else echo "ERROR: gsd-tools.cjs not found at $GSD_TOOLS and gsd_run is not on PATH. Run: npx -y @opengsd/gsd-core@latest --claude --local" >&2; exit 1; fi; GSD_IDENTITY_STATUS=unverified; case "$(gsd_run runtime-identity --raw 2>/dev/null || true)" in '{"packageName":"@opengsd/gsd-core"'*'}') GSD_IDENTITY_STATUS=ok;; esac; export GSD_IDENTITY_STATUS; [ "$GSD_IDENTITY_STATUS" = ok ] || echo "WARNING: \"$GSD_TOOLS\" did not prove it is @opengsd/gsd-core - it is either a different package or an @opengsd/gsd-core older than the runtime-identity verb. See docs/how-to/diagnose-a-foreign-gsd-tools.md" >&2; if [ -n "${CLAUDE_ENV_FILE:-}" ] && [ -n "${GSD_TOOLS:-}" ]; then printf "export PATH='%s':\"\$PATH\"\n" "${GSD_TOOLS%/*}" >> "$CLAUDE_ENV_FILE" 2>/dev/null || true; fi
RESPONSE_LANGUAGE=$(gsd_run query config-get response_language --default "" 2>/dev/null || echo "")
COMMIT_DOCS=$(gsd_run query config-get commit_docs 2>/dev/null || echo "true")

If response_language is set: All user-facing questions, prompts, and explanations in this workflow MUST be presented in {response_language}. Technical terms, code, file paths, and subagent prompts stay in English — only user-facing output is translated.

**If `QUICK_MODE` is true:** Skip mood intake. Use whatever the user provided in `$ARGUMENTS` as the design direction. Jump to `load_spike_context`.

Otherwise:

Before sketching anything, explore the design intent through conversation. Ask one question at a time — using AskUserQuestion in normal mode, or a plain-text numbered list if TEXT_MODE is active.

Questions to cover (adapt to what the user has already shared):

  1. Feel: "What should this feel like? Give me adjectives, emotions, or a vibe."
  2. References: "What apps, sites, or products have a similar feel to what you're imagining?"
  3. Core action: "What's the single most important thing a user does here?"

After each answer, briefly reflect what you heard and how it shapes your thinking.

When you have enough signal, ask: "I think I have a good sense of the direction. Ready for me to sketch, or want to keep discussing?"

Only proceed when the user says go.

## Load Spike Context

If spikes exist for this project, read them to ground the sketches in reality. Mockups are still pure HTML, but they should reflect what's actually been proven — real data shapes, real component names, real interaction patterns.

a. Glob for ./.claude/skills/spike-findings-*/SKILL.md and read any that exist, plus their references/*.md. These contain validated patterns and requirements.

b. Read .planning/spikes/MANIFEST.md if it exists — it may hold separate ### {idea-key} sections for several unrelated ideas. Check the Requirements list of the idea key relevant to this sketch's design direction (or all of them if none clearly matches) for non-negotiable design constraints (e.g., "must support streaming", "must render markdown"). These requirements should be visible in the mockup even though the mockup doesn't implement them for real.

c. Read .planning/spikes/CONVENTIONS.md if it exists — the established stack informs what's buildable and what interaction patterns are idiomatic.

How spike context improves sketches:

  • Use real field names and data shapes from spike findings instead of generic placeholders
  • Show realistic UI states that match what the spikes proved (e.g., if streaming was validated, show a streaming message state)
  • Reference real component names and patterns from the target stack
  • Include interaction states that reflect what the spikes discovered (loading, error, reconnection states)

If no spikes exist, skip this step.

Break the idea into 2-5 design questions. Present as a table:
Sketch Design question Approach Risk
001 Does a two-panel layout feel right? Sidebar + main, variants: fixed/collapsible/floating High — sets page structure
002 How should the form controls look? Grouped cards, variants: stacked/inline/floating labels Medium

Each sketch answers one specific visual question. Good sketches:

  • "Does this layout feel right?" — build with real-ish content
  • "How should these controls be grouped?" — build with actual labels and inputs
  • "What does this interaction feel like?" — build the hover/click/transition
  • "Does this color palette work?" — apply to actual UI, not a swatch grid

Bad sketches:

  • "Design the whole app" — too broad
  • "Set up the component library" — that's implementation
  • "Pick a color palette" — apply it to UI instead

Present the table and get alignment before building.

## Research the Target Stack

Before sketching, ground the design in what's actually buildable. Sketches are HTML, but they should reflect real constraints of the target implementation.

a. Identify the target stack. Check for package.json, Cargo.toml, etc. If the user mentioned a framework (React, SwiftUI, Flutter, etc.), note it.

b. Check component/pattern availability. Use context7 (resolve-library-id → query-docs) or web search to answer:

  • What layout primitives does the target framework provide?
  • Are there existing component libraries in use? What components are available?
  • What interaction patterns are idiomatic?

c. Note constraints that affect design:

  • Platform conventions (iOS nav patterns, desktop menu bars, terminal grid constraints)
  • Framework limitations (what's easy vs requires custom work)
  • Existing design tokens or theme systems already in the project

d. Let research inform variants. At least one variant should follow the path of least resistance for the target stack.

Skip when unnecessary. Greenfield project with no stack, or user says "just explore visually." The point is grounding, not gatekeeping.

Create or update `.planning/sketches/MANIFEST.md`:
# Sketch Manifest

## Design Direction
[One paragraph capturing the mood/feel/direction from the intake conversation]

## Reference Points
[Apps/sites the user referenced]

## Sketches

| # | Name | Design Question | Winner | Tags |
|---|------|----------------|--------|------|

If MANIFEST.md already exists, append new sketches to the existing table.

If no theme exists yet at `.planning/sketches/themes/default.css`, create one based on the mood/direction from the intake step. See `sketch-theme-system.md` for the full template.

Adapt colors, fonts, spacing, and shapes to match the agreed aesthetic — don't use the defaults verbatim unless they match the mood.

Build each sketch in order.

For Each Sketch:

a. Find next available number. Format: three-digit zero-padded + hyphenated descriptive name.

b. Create the sketch directory: .planning/sketches/NNN-descriptive-name/

c. Build index.html with 2-3 variants:

First round — dramatic differences: 2-3 meaningfully different approaches. Subsequent rounds — refinements: Subtler variations within the chosen direction.

Each variant is a page/tab in the same HTML file. Include:

  • Tab navigation to switch between variants (see sketch-variant-patterns.md)
  • Clear labels: "Variant A: Sidebar Layout", "Variant B: Top Nav", etc.
  • The sketch toolbar (see sketch-tooling.md)
  • All interactive elements functional (see sketch-interactivity.md)
  • Real-ish content, not lorem ipsum (use real field names from spike context if available)
  • Link to ../themes/default.css for shared theme variables

All sketches are plain HTML with inline CSS and JS. No build step, no npm, no framework.

d. Write README.md:

---
sketch: NNN
name: descriptive-name
question: "What layout structure feels right for the dashboard?"
winner: null
tags: [layout, dashboard]
---

# Sketch NNN: Descriptive Name

## Design Question
[The specific visual question this sketch answers]

## How to View
open .planning/sketches/NNN-descriptive-name/index.html

## Variants
- **A: [name]** — [one-line description of this approach]
- **B: [name]** — [one-line description]
- **C: [name]** — [one-line description]

## What to Look For
[Specific things to pay attention to when comparing variants]

e. Present to the user with a checkpoint:

CHECKPOINT: Verification Required

Sketch {NNN}: {name}

Open: open .planning/sketches/NNN-name/index.html

Compare: {what to look for between variants}


→ Which variant feels right? Or cherry-pick elements across variants.

f. Handle feedback:

  • Pick a direction: mark winner, move to next sketch
  • Cherry-pick elements: build synthesis as new variant, show again
  • Want more exploration: build new variants

Iterate until satisfied.

g. Finalize:

  1. Mark winning variant in README frontmatter (winner: "B")
  2. Add ★ indicator to winning tab in HTML
  3. Update .planning/sketches/MANIFEST.md

h. Commit (if COMMIT_DOCS is true):

gsd_run query commit "docs(sketch-NNN): [winning direction] — [key visual insight]" --files .planning/sketches/NNN-descriptive-name/ .planning/sketches/MANIFEST.md

i. Report:

◆ Sketch NNN: {name}
  Winner: Variant {X} — {description}
  Insight: {key visual decision made}
After all sketches complete:
### GSD ► SKETCH COMPLETE ✓

## Design Direction
{what we landed on overall}

## Key Decisions
{layout, palette, typography, spacing, interaction patterns}

## Open Questions
{anything unresolved or worth revisiting}

▶ Next Up

Package findings — wrap design decisions into a reusable skill

/gsd:sketch --wrap-up


Also available:

  • /gsd:sketch — sketch more (or run with no argument for frontier mode)
  • /gsd:plan-phase — start building the real UI
  • /gsd:spike — spike technical feasibility of a design pattern

<success_criteria>

  • .planning/sketches/ created (auto-creates if needed, no project init required)
  • Design direction explored conversationally before any code (unless --quick)
  • Spike context loaded — real data shapes, requirements, and conventions inform mockups
  • Target stack researched — component availability, constraints, idioms (unless greenfield/skipped)
  • Each sketch has 2-3 variants for comparison (at least one follows path of least resistance)
  • User can open and interact with sketches in a browser
  • Winning variant selected and marked for each sketch
  • All variants preserved (winner marked, not others deleted)
  • MANIFEST.md is current
  • Commits use docs(sketch-NNN): [winner] format
  • Summary presented with next-step routing </success_criteria>