Skip to content

Commit 480db9c

Browse files
authored
🧪 Verify Storybook 10 local TDD compatibility (#249)
## Why The Storybook SDK needed a real end-to-end verification pass against the latest stable Storybook release and the actual local TDD workflow, not just isolated package tests. ## What changed - upgraded the bundled example Storybook app to Storybook 10.3.6 - documented Storybook 10 compatibility requirements in the Storybook SDK README - fixed local TDD metadata sanitization so Storybook iframe URLs keep `&viewMode=story` - hardened the context review-queue test to avoid local `.vizzly` state leaking into cloud-path assertions - cleaned up a couple of Storybook SDK Playwright references in comments/docs ## Test plan - `npm run lint` - `npm test` - `cd clients/storybook && npm test` - `cd clients/storybook && npm run build` - `cd clients/storybook/example-storybook && npm run build-storybook` - `cd clients/storybook && node ../../bin/vizzly.js tdd start --json` - `cd clients/storybook && node ../../bin/vizzly.js storybook ./example-storybook/dist` - `cd clients/storybook && node ../../bin/vizzly.js tdd stop --json`
1 parent ea4946d commit 480db9c

10 files changed

Lines changed: 824 additions & 1631 deletions

File tree

clients/storybook/README.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,18 @@ npm install @vizzly-testing/storybook
1212

1313
The plugin is automatically discovered by the Vizzly CLI via the `@vizzly-testing/*` scope.
1414

15+
## Storybook 10 Compatibility
16+
17+
The plugin works with the current stable Storybook 10 release. If you're upgrading an existing
18+
Storybook app to the latest major, keep these Storybook 10 requirements in mind:
19+
20+
- `.storybook/main.js|ts` and related presets must be valid ESM
21+
- Storybook 10 requires Node `20.19+` or `22.12+`
22+
- `@storybook/addon-essentials` is zero-config in Storybook 10, so many apps no longer need to
23+
list it explicitly in `addons`
24+
25+
Storybook's official migration guide: https://storybook.js.org/docs/releases/migration-guide
26+
1527
## Quick Start
1628

1729
### CLI Usage
@@ -137,7 +149,7 @@ Configuration is merged in this order (later overrides earlier):
137149
- `--include <pattern>` - Include story pattern (glob)
138150
- `--exclude <pattern>` - Exclude story pattern (glob)
139151
- `--config <path>` - Path to custom config file
140-
- `--browser-args <args>` - Additional Puppeteer browser arguments
152+
- `--browser-args <args>` - Additional Playwright browser arguments
141153
- `--headless` - Run browser in headless mode (default: true)
142154
- `--full-page` - Capture full page screenshots (default: true)
143155
- `--no-full-page` - Capture viewport-only screenshots

clients/storybook/example-storybook/.storybook/main.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
export default {
22
stories: ['../src/**/*.stories.@(js|jsx|ts|tsx)'],
3-
addons: ['@storybook/addon-essentials'],
3+
addons: [],
44
framework: {
55
name: '@storybook/react-vite',
66
options: {},

0 commit comments

Comments
 (0)