turbosnap-debug
TurboSnap Debug
Public TurboSnap diagnostic contract for customers, support, and engineers.
This package is the single source of truth for:
- normalized diagnosis codes
- the evidence ladder
- the command catalog
- the diagnosis card output contract
- the local documentation guidance
- the support workflow across low-evidence and stats-rich cases
- reusable intake templates and prompt snippets
- preview-bail trace minimization guidance
Quick start
- Read
reference/workflow-playbook.mdand identify which workflow phase you are in. - Read
reference/diagnosis-taxonomy.mdand identify the most likely diagnosis code from the evidence already provided. - Read
reference/evidence-ladder.mdand decide whether you can diagnose immediately or need one more targeted artifact. - Use
reference/command-catalog.mdonly when evidence is incomplete or the repo is available and targeted proof is needed. - If the issue is a preview/config bail and the task is to restore TurboSnap, read
reference/trace-minimization.md. - Render the result using
reference/output-contract.md. - If a human user needs follow-up reading, use the local guidance in
reference/docs-map.md.
Workflow phases
Use one adaptive workflow:
triage: classify the current TurboSnap state from logs, config, and symptomsartifact-request: ask for the smallest next artifact when evidence is incompletetrace-validation: use changed files, a stats artifact, or trace output to validate the bail or minimize the fix pathrecommendation: return the smallest valid fix, a safer alternative if needed, and the exact next step
Infer the current phase from the evidence:
- build URL, logs, and no stats file or trace output usually means
triage - a likely diagnosis but one missing proof artifact usually means
artifact-request - changed files plus stats file, pasted contents, or trace output usually means
trace-validation - enough evidence to act and explain usually means
recommendation
Required workflow
1) Start with current evidence
Prefer evidence already in the conversation:
- CLI output
chromatic.config.json,package.jsonscripts, or CI snippets- Storybook build details
- hosted metadata URLs under
.chromatic/as human-shareable references - changed file lists
- prior
chromaticorchromatic tracecommand output - screenshots or customer summaries
Do not jump to speculative fixes if the current evidence already maps cleanly to a diagnosis code.
2) Classify before probing
Map the issue to one normalized diagnosis code from reference/diagnosis-taxonomy.md.
If the case includes multiple signals, choose:
- the strongest hard-bail or availability state first
- otherwise the highest-confidence active-tracing diagnosis
- otherwise
TS_NEEDS_MORE_EVIDENCE
3) Follow the workflow phases
Use the workflow in reference/workflow-playbook.md.
The default path is:
- Triage: classify the build state and name the bail or active-tracing diagnosis
- Artifact request: ask for the smallest next artifact
- Trace validation: if stats, changed files, or trace output are available, validate and minimize only when needed
- Recommendation: return the diagnosis card, the likely fix path, and the exact next step
Do not skip directly to --untraced or repo surgery when the current phase is still classification.
4) Preserve TurboSnap, but stay truthful
The remediation posture is to restore or preserve TurboSnap where possible.
That does not permit hiding reality:
- if TurboSnap is unavailable, say so
- if TurboSnap is disabled for the current build, say so
- if a full rebuild is happening now, say so
Then pivot to the exact fix path that restores TurboSnap on the next run.
5) Output a diagnosis card every time
Always return the diagnosis card from reference/output-contract.md.
Default tone:
- customer-safe, but technically honest
- use terms like
bail reason,trace, anduntracedwhen they improve precision - define those terms plainly when the user is unlikely to know them
- ask for one artifact at a time when evidence is incomplete
- include a deeper technical note only when it changes the recommendation or materially helps a support handoff
If you cannot reach a confident fix:
- name the most likely diagnosis
- state confidence honestly
- ask for the next artifact
- or append the support-ready summary format
Prompting and intake
Use reference/intake-templates.md when:
- an internal user wants a prompt to hand to the skill
- a customer needs a copy-paste request for the next artifact
- the team wants a standard intake form for SE handoff
The canonical prompt templates should live in this skill so they stay versioned with the workflow.
Customer-facing snippets should still be shared as needed:
- keep them short
- request one artifact at a time
- avoid internal field names unless the user already used them
- prefer a single exact command over a list of options
- do not fetch hosted metadata inside the installed skill; ask the user to provide a local file path or pasted contents instead
Boundaries
- Do not recommend “just leave TurboSnap off” as the intended end state in v1.
- Do not suggest
--externals,--untraced,--storybook-base-dir, or--storybook-config-dirunless the evidence points there. - When suggesting
--untraced, keep the minimal technical set explicit and compress the safer recommendation into one monorepo-safe picomatch glob when possible. - Do not ask for large evidence bundles when one smaller artifact would settle the branch.
References and examples
reference/workflow-playbook.mdreference/diagnosis-taxonomy.mdreference/evidence-ladder.mdreference/command-catalog.mdreference/intake-templates.mdreference/trace-minimization.mdreference/output-contract.mdreference/docs-map.mdexamples/internal-investigation.mdexamples/customer-guided-debug.mdevaluations/README.md
More from chromaui/chromatic-skills
chromatic-themes
Configure Chromatic to capture visual test snapshots across multiple themes (light/dark mode, design tokens, branded variants) using the Modes API and @storybook/addon-themes. Use when the user wants to test components with different themes in Chromatic, set up light/dark mode visual testing, configure @storybook/addon-themes with Chromatic, or apply theme modes at the project, component, or story level.
6chromatic-viewports
Configure Chromatic to capture visual test snapshots at multiple viewport sizes using the Modes API. Use when the user wants to test responsive components at different screen sizes, set up viewport breakpoints for Chromatic visual testing, apply viewports to individual stories or globally, control snapshot height with cropToViewport, or migrate from the legacy chromatic.viewports API to the new Modes API.
6chromatic-setup-ci
Configure CI/CD pipelines to run Chromatic visual tests automatically. Use when the user wants to set up Chromatic in CI, add Chromatic to GitHub Actions / GitLab / Bitbucket Pipelines / CircleCI / Jenkins / Azure Pipelines, automate visual testing, or run Chromatic on every push.
6chromatic-troubleshoot-config
Diagnose Storybook configuration issues that block Chromatic or local Storybook, including missing stories, framework or builder mismatches, addon conflicts, preview errors, static asset path issues, and package version drift. Use when Storybook fails to build, Chromatic cannot verify Storybook, stories are missing, or a team needs the smallest config change to restore a working Storybook surface.
6chromatic-turbosnap-debug
Diagnose TurboSnap behavior using logs, config, git context, support-shareable hosted metadata references, and targeted trace commands. Use when you need to classify why TurboSnap is enabled, disabled, unavailable, or tracing the wrong stories, then recommend the smallest valid next step.
6chromatic-workflow-debug
Diagnose Chromatic workflow issues involving git history, baselines, pull request event shape, merge queues, merge-base failures, replacement builds, and patch builds. Use when builds compare against the wrong baseline, an ancestor build is not found, pull request comparisons look wrong, or CI git context does not match Chromatic's expectations.
5