feat: provide global getStoryContext utility

[yannbf]

Issue #97

Release notes

Features

getStoryContext utility #125

While running tests using the hooks, you might want to get information from a story, such as the parameters passed to it, or its args. The test runner now provides a getStoryContext utility function that fetches the story context for the current story:

await getStoryContext(page, context);

You can use it for multiple use cases, and here's an example that combines the story context and accessibility testing:

// .storybook/test-runner.js
const { getStoryContext } = require('@storybook/test-runner');
const { injectAxe, checkA11y } = require('axe-playwright');
 
module.exports = {
 async preRender(page, context) {
   await injectAxe(page);
 },
 async postRender(page, context) {
  // Get entire context of a story, including parameters, args, argTypes, etc.
  const storyContext = await getStoryContext(page, context);
  // Do not test a11y for stories that disable a11y
  if (storyContext.parameters?.a11y?.disable) {
    return;
  }
  
   await checkA11y(page, '#root', {
     detailedReport: true,
     detailedReportOptions: {
       html: true,
     },
     // pass axe options defined in @storybook/addon-a11y
     axeOptions: storyContext.parameters?.a11y?.options
   })
 },
};
<!-- GITHUB_RELEASE PR BODY: canary-version -->
<details>
  <summary>📦 Published PR as canary version: <code>0.2.0--canary.125.f7e708e.0</code></summary>
  <br />

  :sparkles: Test out this PR locally via:
  
  ```bash
  npm install @storybook/[email protected]
  # or 
  yarn add @storybook/[email protected]

Version

Published prerelease version: v0.2.0-next.0

Changelog

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)

⚠️ Pushed to next

• add fake failure for testing purposes (@yannbf)
• chore: add reports when workflow fails (@yannbf)

📝 Documentation

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

Authors: 3

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

[shilman]

LOVE LOVE LOVE ❤️

[yannbf]

@shilman I reworked on the API to make it more legible, please re-check! 🙏