CHANGELOG.md

v0.18.0 (Thu May 09 2024)

🚀 Enhancement

• Release 0.18.0 #458 (@skratchdot @yannbf)
• Fix coverage reports, add lcov as extra reporter #456 (@yannbf)

🐛 Bug Fix

• add --testTimeout cli option from jest #409 (@skratchdot @yannbf)

Authors: 2

• ◬ (@skratchdot)
• Yann Braga (@yannbf)

---

v0.17.0 (Mon Mar 11 2024)

🚀 Enhancement

• Release 0.17.0 #438 (@JReinhold @shilman @valentinpalkovic @yannbf @ndelangen)
• Support Storybook 8 #429 (@yannbf)
• Support unhandled rendering errors #421 (@yannbf)

🐛 Bug Fix

• Prebundle dependencies #431 (@yannbf)
• Update internal example to Storybook 8 #430 (@yannbf)
• swap storybook/jest to storybook/test #427 (@ndelangen)
• Add PR template #428 (@yannbf)
• Fix build step #425 (@valentinpalkovic)
• Remove --prerelease from sb upgrade CI #423 (@JReinhold)
• Support stories with meta id for permalinking #419 (@yannbf)

📝 Documentation

• Docs: Add remark regarding pnp support #432 (@yannbf)
• docs: replace postRender(deprecated) with postVisit #418 (@junkisai)

Authors: 6

• Jeppe Reinhold (@JReinhold)
• Junki Saito (@junkisai)
• Michael Shilman (@shilman)
• Norbert de Langen (@ndelangen)
• Valentin Palkovic (@valentinpalkovic)
• Yann Braga (@yannbf)

---

v0.16.0 (Mon Nov 27 2023)

🚀 Enhancement

• Introduce logLevel configuration #406 (@yannbf)

🐛 Bug Fix

• Filter duplicated error messages in browser logs #405 (@yannbf)
• Fix sync issues between tests #404 (@yannbf)
• Refactor: Extract the setup page scripts into a separate file #403 (@yannbf)
• Docs: Adds feedback form to migration documentation #402 (@jonniebigodes)
• Bump jest-playwright-preset from v3.0.1 to v4.0.0 #400 (@kemuridama)
• Improve type safety and code quality #383 (@bryanjtc @yannbf)
• Refactor: Improve internal code #378 (@bryanjtc @yannbf)

Authors: 4

• @jonniebigodes
• Bryan Thomas (@bryanjtc)
• Ryo Ochiai (@kemuridama)
• Yann Braga (@yannbf)

---

v0.15.2 (Tue Nov 21 2023)

🐛 Bug Fix

• Remove Node 14 from engines field #353 (@legobeat @yannbf)
• Docs: Add react native remark to troubleshooting section #398 (@yannbf)
• Fix "Browser has been closed" crash on uncaught page errors #397 (@yannbf)
• Clarify difference between skipped and excluded tags #396 (@IanVS @yannbf)
• Refactor: Rename "render" hooks to "visit" hooks #394 (@yannbf)
• Docs: Update tags documentation #393 (@yannbf)

Authors: 3

• @legobeat
• Ian VanSchooten (@IanVS)
• Yann Braga (@yannbf)

---

v0.15.1 (Thu Nov 16 2023)

🐛 Bug Fix

• fix: Make tags optional in TestRunnerConfig #391 (@stramel)

Authors: 2

• Michael Stramel (@stramel)
• Yann Braga (@yannbf)

---

v0.15.0 (Thu Nov 16 2023)

🚀 Enhancement

• Add support for test filtering via tags #382 (@yannbf)

🐛 Bug Fix

• fix: switch checkStorybook to use GET method #385 (@stramel)
• Chore: update wait-on and lockfile #389 (@yannbf)
• Add storyshots migration guides #380 (@yannbf @shilman @jonniebigodes)

Authors: 4

• @jonniebigodes
• Michael Shilman (@shilman)
• Michael Stramel (@stramel)
• Yann Braga (@yannbf)

---

v0.14.1 (Mon Nov 13 2023)

🐛 Bug Fix

• Fix: Do not set test root outside index json mode #387 (@yannbf)

Authors: 1

• Yann Braga (@yannbf)

---

v0.14.0 (Wed Nov 08 2023)

🚀 Enhancement

• Feature: Support .story files #376 (@yannbf)
• BREAKING: Upgrade Jest to v29 #348 (@yannbf @legobeat)
• BREAKING: Bump minimum Node.js version to ^14.15.0 #354 (@legobeat)
• Add waitForPageReady utility #361 (@yannbf)

🐛 Bug Fix

• Documentation: restructure docs and include more recipes #373 (@yannbf)
• Run nyc with correct packager manager command #364 (@ferdinandhummel-gph @yannbf)
• deps/devDeps: bump semver to latest [CVE-2022-25883] #349 (@legobeat)
• Make userAgent configurable #342 (@jaknas)
• devDeps: Bump auto from v10 to v11 #346 (@legobeat)
• CI: Fix yarn 2 issue #352 (@yannbf)
• chore: set engines.node to >=12.0.0 #351 (@legobeat)
• Maintenance: Update to yarn berry #344 (@yannbf)
• Maintenance: Remove csf upgrade in nightly check #343 (@yannbf)

🏠 Internal

• chore: disable yarn telemetry by default #350 (@legobeat)
• chore: dedupe dependency versions in yarn.lock #347 (@legobeat)

📝 Documentation

• Docs: Expand ejected config docs with an example #363 (@yannbf)

Authors: 4

• @ferdinandhummel-gph
• @legobeat
• Jakub Naskręski (@jaknas)
• Yann Braga (@yannbf)

---

v0.13.0 (Fri Aug 04 2023)

🚀 Enhancement

• Add ability to fail on console errors #321 (@work933k @yannbf)
• Support importing stories from separate packages #339 (@yannbf)

🐛 Bug Fix

• Maintenance: Update storybook example to vite and typescript #340 (@yannbf)
• Add coverage directory option #272 (@ferdinandhummel-gph @yannbf)

Authors: 3

• @ferdinandhummel-gph
• @work933k
• Yann Braga (@yannbf)

---

v0.12.0 (Thu Jul 27 2023)

🚀 Enhancement

🐛 Bug Fix

• maintenance: remove no-manager-cache flag in example storybook #331 (@MH4GF)
• Fix extra args not being passed to jest #322 (@zyulyaev @yannbf)
• Fix empty coverage report #324 (@bryanjtc @yannbf)
• docs: fix github actions example for shard usage #320 (@MH4GF)

Authors: 5

• Bryan Thomas (@bryanjtc)
• Hirotaka Miyagi (@MH4GF)
• Nikita Zyulyaev (@zyulyaev)
• Valentin Palkovic (@valentinpalkovic)
• Yann Braga (@yannbf)

---

v0.11.0 (Tue Jun 20 2023)

🚀 Enhancement

• Release 0.11.0 #318 (@bryanjtc @yannbf @ndelangen @unshame @valentinpalkovic @vanessayuenn)
• Bundle with tsup and replace babel-jest #250 (@bryanjtc @yannbf @ndelangen)

🐛 Bug Fix

• Change dependencies from future npm tag to next #315 (@yannbf)
• fix: nyc command with shard option #257 (@bryanjtc @yannbf)
• Improve ejected config types #297 (@yannbf)
• fix: Remove last reference to regenerator-runtime #303 (@bryanjtc)
• fix(test-storybook): Fix test-runner-jest.config.js file not being found in STORYBOOK_CONFIG_DIR on Windows #296 (@unshame)
• Upgrade glob to v10 #299 (@valentinpalkovic)

Authors: 6

• Bryan Thomas (@bryanjtc)
• Norbert de Langen (@ndelangen)
• UnShame (@unshame)
• Valentin Palkovic (@valentinpalkovic)
• Vanessa Yuen (@vanessayuenn)
• Yann Braga (@yannbf)

---

v0.10.0 (Mon Apr 03 2023)

🚀 Enhancement

• New prerelease structure / upgrade to SB7 #210 (@shilman)

🐛 Bug Fix

• Bump @storybook/csf to 0.1.0 #288 (@kasperpeulen)
• support Storybook 7.0.0 #283 (@yannbf)
• Update getStorybookMain to throw an error if stories are not found in main.js #278 (@valentinpalkovic)
• Extend hooks api with prepare and getHttpHeaders properties #245 (@yannbf)
• Use preview api instead of store #273 (@kasperpeulen)
• Support other test-runner config extensions #259 (@yannbf)
• Use ipv4 loopback address #252 (@IanVS)
• Fix safe json stringify code #239 (@hansottowirtz)
• feat: add shard cli option #243 (@Niznikr @yannbf)
• Updating deps to handle TS 4.9 #237 (@kasperpeulen)
• Fix target url in error feedback #233 (@yannbf)
• Remove unused development packages #227 (@yannbf)
• Make setup-page globally available for index.json mode compatibility #217 (@yannbf)
• Upgrade CSF to next #212 (@shilman)
• Fix missing dependencies #209 (@bryanjtc)

📝 Documentation

• Document index.json mode for Svelte CSF #263 (@JReinhold)
• Docs: add recipe for browser name #221 (@yannbf)

Authors: 9

• Bryan Thomas (@bryanjtc)
• Hans Otto Wirtz (@hansottowirtz)
• Ian VanSchooten (@IanVS)
• Jeppe Reinhold (@JReinhold)
• Kasper Peulen (@kasperpeulen)
• Michael Shilman (@shilman)
• Robert Niznik (@Niznikr)
• Valentin Palkovic (@valentinpalkovic)
• Yann Braga (@yannbf)

---

v0.9.4 (Wed Feb 01 2023)

🐛 Bug Fix

• Release 0.9.4 #258 (@yannbf)
• Support other test-runner config extensions #259 (@yannbf)
• Use ipv4 loopback address #252 (@IanVS)
• Fix safe json stringify code #239 (@hansottowirtz)

Authors: 3

• Hans Otto Wirtz (@hansottowirtz)
• Ian VanSchooten (@IanVS)
• Yann Braga (@yannbf)

---

v0.9.3 (Fri Jan 20 2023)

🐛 Bug Fix

• feat: add shard cli option #246 (@yannbf)
• feat: add shard cli option #243 (@Niznikr @yannbf)

Authors: 2

• Robert Niznik (@Niznikr)
• Yann Braga (@yannbf)

---

v0.9.2 (Tue Dec 20 2022)

🐛 Bug Fix

• Fix target url in error feedback #234 (@yannbf)

Authors: 1

• Yann Braga (@yannbf)

---

v0.9.1 (Mon Nov 21 2022)

🐛 Bug Fix

• Release 0.9.1 #223 (@yannbf @shilman)
• Fix missing dependencies #209 (@bryanjtc)
• Make setup-page globally available for index.json mode compatibility #217 (@yannbf)
• Upgrade nightly to next instead of future #213 (@shilman)

Authors: 3

• Bryan Thomas (@bryanjtc)
• Michael Shilman (@shilman)
• Yann Braga (@yannbf)

---

v0.9.0 (Wed Oct 12 2022)

🚀 Enhancement

• feat: add cli option --ci #204 (@italoteix)

🐛 Bug Fix

• Upgrade preset-env to latest #202 (@shilman)
• Fix nightly check for failures #197 (@yannbf)
• Improve error logging and ensure non-zero exit #201 (@IanVS)

📝 Documentation

• Docs: update coverage section now that the addon supports Vite #205 (@yannbf)

Authors: 4

• Ian VanSchooten (@IanVS)
• Ítalo Teixeira (@italoteix)
• Michael Shilman (@shilman)
• Yann Braga (@yannbf)

---

v0.8.0 (Fri Oct 07 2022)

🚀 Enhancement

• Add isTestRunner utility #198 (@yannbf @IanVS)

🐛 Bug Fix

• Fix StorybookTestRunnerError – length on undefined #194 (@ericclemmons)

Authors: 3

• Eric Clemmons (@ericclemmons)
• Ian VanSchooten (@IanVS)
• Yann Braga (@yannbf)

---

v0.7.2 (Fri Sep 16 2022)

🐛 Bug Fix

• Support Storybook 7.0 play function exceptions #190 (@tmeasday @yannbf)
• fix snapshots & remove vscode color settings #192 (@ndelangen)

Authors: 4

• Michael Shilman (@shilman)
• Norbert de Langen (@ndelangen)
• Tom Coleman (@tmeasday)
• Yann Braga (@yannbf)

---

v0.7.1 (Tue Sep 06 2022)

🐛 Bug Fix

• Add missing dependencies #187 (@IanVS)

📝 Documentation

• docs(README): Update a11y recipe #186 ([email protected])

Authors: 4

• Ian VanSchooten (@IanVS)
• Michael Shilman (@shilman)
• Nagisa Ando (@nagisaando)
• Yann Braga (@yannbf)

---

v0.7.0 (Fri Aug 26 2022)

Release Notes

Update Jest to 28 (#174)

This release updates the internal version of Jest to version 28. You can now remove jest and jest-preset-playwright from your package.json if you're not using them in other parts of your project!

---

🚀 Enhancement

• Update Jest to 28 #174 (@yannbf)

Authors: 1

• Yann Braga (@yannbf)

---

v0.6.4 (Fri Aug 26 2022)

Release Notes

add --junit flag to test runner (#179)

The test runner now supports JUnit XML test reports out of the box with a --junit flag:

yarn test-storybook --junit

With that flag, the test runner will add jest-junit to the reporters list and generate a test report in a JUnit XML format. You can further configure the behavior of jest-junit by either setting specific JEST_JUNIT_* environment variables or by defining a jest-junit field in your package.json with the options you want, which will be respected when generating the report. You can look at all available options here: https://github.com/jest-community/jest-junit#configuration

---

🐛 Bug Fix

• add --junit flag to test runner #179 (@yannbf)

📝 Documentation

• Add remark regarding different coverage providers #180 (@yannbf)

Authors: 1

• Yann Braga (@yannbf)

---

v0.6.3 (Wed Aug 24 2022)

Release Notes

Support storyStoreV7 in coverage check (#177)

This release fixes an issue where the coverage check was not working for projects using storyStoreV7.

---

🐛 Bug Fix

• Support storyStoreV7 in coverage check #177 (@yannbf)

Authors: 1

• Yann Braga (@yannbf)

---

v0.6.2 (Wed Aug 24 2022)

Release Notes

feat: turn Jest into an internal dependency (#175)

The Storybook test runner will now contain Jest as an internal dependency, which means that if you installed Jest just for the purpose of using the Storybook test runner, you can now remove it!

---

🐛 Bug Fix

• feat: turn Jest into an internal dependency #175 (@yannbf)

Authors: 1

• Yann Braga (@yannbf)

---

v0.6.1 (Tue Aug 23 2022)

Release Notes

support Storybook 7.0 root selector (#172)

Feature:

In Storybook 7.0, the root selector changed from #root to #storybook-root. Both selectors are now supported in the internals of the test runner

---

🐛 Bug Fix

• support Storybook 7.0 root selector #172 (@yannbf)

Authors: 1

• Yann Braga (@yannbf)

---

v0.6.0 (Tue Aug 23 2022)

Release Notes

fix --watch cli option (#168)

Fixes

The --watch flag was previously not working, and now it's fixed.

feat: throw error on unconfigured coverage when running with --coverage (#166)

Features

The test runner now throws an error when running yarn test-storybook --coverage and the coverage is not correctly set up. This could mean that an user might be running --coverage without instrumenting their code with istanbul, which would lead to problems!

feat: add console logs on test failure (#157)

Features

feat: add console logs on test failure This version adds console logs to the output of failed tests, in order to as provide as much information as possible to help you diagnose your issues.

feat: jest 28 support (#154)

Features

This release updates jest-playwright to version 2.0.0 which adds support for Jest 28. In order to maintain backwards compatibility with Jest 27, you might have to take a few steps in case you are installing the test runner for the first time, or if you don't keep package locks in your project.

You can find more info at https://github.com/storybookjs/test-runner#jest-27-support

---

🚀 Enhancement

• feat: add console logs on test failure #157 (@yannbf)
• feat: jest 28 support #154 (@andykenward @yannbf)

🐛 Bug Fix

• Add commit hooks #170 (@yannbf)
• undo Jest 28 support #169 (@yannbf)
• fix --watch cli option #168 (@yannbf)
• feat: throw error on unconfigured coverage when running with --coverage #166 (@yannbf)
• Document new cli options #167 (@yannbf)
• Add nightly check for failures #165 (@yannbf)
• Update stories in example Storybook #164 (@yannbf)
• use storybook@future on nightly script #162 (@yannbf)

Authors: 2

• Andy Kenward (@andykenward)
• Yann Braga (@yannbf)

---

v0.5.0 (Mon Jul 18 2022)

Release Notes

Replace is-localhost-ip with can-bind-to-host (#144)

Features

This release replaces an internal dependency is-localhost-ip with can-bind-to-host due to a licensing issue in can-bind-to-host.

---

🚀 Enhancement

Authors: 2

• Slava Knyazev (@knyzorg)
• Yann Braga (@yannbf)

---

v0.4.0 (Tue Jul 12 2022)

🚀 Enhancement

• Fetch index.json and refer to "index json" mode. #124 (@tmeasday @yannbf)

🐛 Bug Fix

• fix: support index.html URLs #139 (@yannbf)
• Document need for a custom snapshotResolver #131 (@FokkeZB)

Authors: 4

• Fokke Zandbergen (@FokkeZB)
• Kaelig Deloumeau-Prigent (@kaelig)
• Tom Coleman (@tmeasday)
• Yann Braga (@yannbf)

---

v0.3.0 (Fri Jun 24 2022)

Release Notes

Support code coverage (#120)

Support code coverage (#120)

---

🚀 Enhancement

• Support code coverage #120 (@yannbf)

🐛 Bug Fix

• Improve code coverage for coverage merging #130 (@yannbf)

Authors: 1

• Yann Braga (@yannbf)

---

v0.2.0 (Tue Jun 21 2022)

Release Notes

feat: provide global getStoryContext utility (#125)

---

🚀 Enhancement

• feat: provide global getStoryContext utility #125 (@yannbf)

🐛 Bug Fix

• chore(DEPS): update jest-playwright-preset #119 (@bodograumann)
• chore(CI): add sb versions to report [skip release] #118 (@yannbf)
• feat: support DOM snapshot testing #117 (@yannbf)
• Add reporting to CI #113 (@yannbf)

📝 Documentation

• Updates readme to lock Jest to version 27 #115 (@jonniebigodes)

Authors: 3

• @jonniebigodes
• Bodo Graumann (@bodograumann)
• Yann Braga (@yannbf)

---

v0.1.1 (Wed May 25 2022)

🐛 Bug Fix

• Add Jest compatibility check #111 (@yannbf)

📝 Documentation

• Document issue with Jest on Windows CI #105 (@joshwooding)

Authors: 2

• Josh Wooding (@joshwooding)
• Yann Braga (@yannbf)

---

v0.1.0 (Thu May 19 2022)

Release Notes

fix: Support Storybook 6.5 (#107)

Breaking change 💥

This version adds support to Storybook 6.5 and drops support for Storybook 6.4. Unfortunately there was a breaking change in an internal API from @storybook/store which is used by the test runner, which only affects users that use the auto title feature.

Changes included from this pull request (#107)

---

🚀 Enhancement

• fix: Support Storybook 6.5 #107 ([email protected] @yannbf @valentinpalkovic)

Authors: 3

• Valentin Palkovic (@valentinpalkovic)
• Valentin Palkovič ([email protected])
• Yann Braga (@yannbf)

---

v0.0.8 (Thu Apr 28 2022)

🐛 Bug Fix

• Move storybook packages to peer deps #101 (@IanVS @yannbf)
• Limit jest to version 26 or 27 #98 (@bodograumann)

📝 Documentation

• Document limitation for .mdx stories #102 (@IanVS)

Authors: 3

• Bodo Graumann (@bodograumann)
• Ian VanSchooten (@IanVS)
• Yann Braga (@yannbf)

---

v0.0.7 (Fri Apr 22 2022)

🐛 Bug Fix

• Fixup README typo. #93 (@MichaelHatherly)
• Add output limit #94 (@yannbf)

Authors: 2

• Michael Hatherly (@MichaelHatherly)
• Yann Braga (@yannbf)

---

v0.0.6 (Tue Apr 12 2022)

🐛 Bug Fix

• Log a warning if you try and run against a lazy-compiled storybook #90 (@tmeasday)

Authors: 2

• Tom Coleman (@tmeasday)
• Yann Braga (@yannbf)

---

v0.0.5 (Thu Apr 07 2022)

🐛 Bug Fix

• cleanup page opened log #86 (@yannbf)
• Add ability to test docs pages via VIEW_MODE env var #79 (@shilman)
• cleanup jsdom related code #67 (@yannbf)

🔩 Dependency Updates

• Cleanup dependencies #72 (@shilman)

Authors: 3

• Gert Hengeveld (@ghengeveld)
• Michael Shilman (@shilman)
• Yann Braga (@yannbf)

---

v0.0.4 (Wed Feb 23 2022)

🐛 Bug Fix

• fix: use correct import in generated test #65 (@yannbf)

Authors: 1

• Yann Braga (@yannbf)

---

v0.0.3 (Wed Feb 23 2022)

🐛 Bug Fix

• fix: reset page between tests #47 (@yannbf)
• feat: add typeahead jest plugin #61 (@yannbf)
• feat: auto detect stories json mode #60 (@yannbf)
• feat: add url flag #58 (@yannbf)
• feat: add browsers flag #55 (@yannbf)
• fix: add file location to eject error message #57 (@yannbf)
• feat: add eject command #54 (@yannbf)
• Test-runner file for hook configuration #53 (@shilman)
• feat: add update snapshot command to cli #52 (@yannbf)
• fix: improve error message in start-storybook #51 (@yannbf)
• Respect stories defined in main.js #46 (@yannbf)

Authors: 2

• Michael Shilman (@shilman)
• Yann Braga (@yannbf)

---

v0.0.2 (Thu Feb 03 2022)

🐛 Bug Fix

• Add setPreRender/setPostRender hooks & example #38 (@shilman @yannbf)
• Add CLI wrapper #41 (@yannbf)
• Cleanup play function checks #37 (@yannbf)
• Support auto title stories #35 (@yannbf)
• Add stories.json support #31 (@shilman)
• Add test runner to ci #26 (@yannbf @shilman)
• Update ci recipes and timeout feedback #27 (@yannbf)
• fix: move test-runner default configuration location and resolution #25 (@yannbf)

📝 Documentation

• docs(README): add section about jest #29 (@yannbf)

Authors: 2

• Michael Shilman (@shilman)
• Yann Braga (@yannbf)

---

v0.0.1 (Thu Jan 06 2022)

🐛 Bug Fix

• MVP Prototype #11 (@shilman @yannbf)
• docs: update README with instructions #17 (@yannbf)
• Clean up prototype #16 (@shilman)
• Sanitize target and reference urls and wait for Storybook selector before running test #13 (@yannbf)

⚠️ Pushed to main

• Fix prefix (@shilman)
• add linear export to gh workflow (@yannbf)
• Initial commit (@shilman)

Authors: 2

• Michael Shilman (@shilman)
• Yann Braga (@yannbf)