Skip to content

Latest commit

 

History

History
230 lines (143 loc) · 9.89 KB

CHANGELOG.md

File metadata and controls

230 lines (143 loc) · 9.89 KB
Raw

Changelog

Unreleased

8.2.1 (2024-10-21)

  • [fix] Simplify the promise queue implementation #102
  • [fix] Minor code re-organizations #102

8.2.0

  • [new] Add parameter for Axe context #98

8.1.0

  • [new] Add --port option #97

8.0.2

  • [fix] Ensure Storybook is ready before extract-ing stories #94

8.0.1

  • [fix] Wait a random amount of time before selecting a port, to try to avoid port conflicts when multiple test runs start at the same time #92

8.0.0 (2024-03-05)

  • [breaking] Support Node >= 18 #91
  • [new] Support Storybook v8 #90

7.2.0 (2024-02-12)

  • [new] Add config parameter, which is passed to axe.configure #88

7.1.4 (2024-02-09)

  • [fix] Update all deps

7.1.3 (2023-11-08)

  • [fix] Automatically install Chromium and add note about installing other browsers #85

7.1.2 (2023-08-07)

  • [fix] Update most deps #82
  • [fix] Build for Node 12 / ES2017. Node 12 is the minimum supported version of Node for this project #78

7.1.1 (2023-05-17)

  • [fix] Replace @storybook/preview-web peer dependency with @storybook/preview-api (which is what @storybook/react actually uses)

7.1.0 (2023-04-17)

  • [new] Add --storybook-url option, which deprecates --storybook-address

7.0.0 (2023-04-03)

Storybook 7 is now officially supported!

  • [breaking] Drop Storybook 6 support

6.3.1 (2023-04-03)

  • [fix] Update all dependencies

6.3.0 (2023-01-18)

  • [maintenance] Update all dependencies
  • [maintenance] Prune unneeded dependencies
  • [new] Add mode option to Story parameters. Most useful for its warn option, which will print errors detected for a story but not fail the test suite.

6.2.0 (2022-09-29)

  • [new] Export types for Story parameters
  • [maintenance] Update all dependencies
  • [new] Allow use of axe runOptions for stories [#65]#65)

6.1.0 (2022-07-07)

  • [new] Allow each test to specify a timeout #59
  • [fix] Prevent the xunit reporter from printing an extra undefined with each failure.

6.0.1 (2022-06-21)

  • [fix] Prevent error messages being printed twice when using the xunit reporter.

6.0.0 (2022-06-21)

  • [breaking] Remove --format option
  • [new] Add --reporter option, which can be any built-in Mocha reporter
  • [new] Add --reporter-options option, which is mostly useful with the xunit reporter
  • [fix] Mark waitForSelector as deprecated; use play functions instead (https://storybook.js.org/docs/react/writing-stories/play-function)
  • [maintenance] Upgrade all dependencies
  • [maintenance] Use MochaJS internally for running the "tests"
  • [maintenance] Use TypeScript to build the package, instead of esbuild

5.0.1 (2022-05-20)

  • [fix] Access static storybook via file server so everything works with storyStoreV7 (fixing #51)
  • [maintenance] Upgrade all dependencies

5.0.0 (2021-11-29)

  • [breaking] Only support Storybook 6.4 and up #46
  • [maintenance] Upgrade Playwright to 1.16.3

4.1.3 (2021-10-29)

  • [fix] Fix for issue #44. Prevent the command from blowing up when addon parameters cannot be serialized #45

4.1.2 (2021-10-21)

  • [maintenance] Use esbuild to build the project, instead of Babel #40
  • [fix] Update playwright (from 1.14.1 to 1.15.2), yargs (from 17.1.2 to 17.2.1), and zod (from 3.8.2 to 3.9.8)

4.1.1 (2021-9-27)

  • [maintenance] Use Zod to validate story parameters, instead of custom logic #37
  • [fix] Allow waitForSelector to select any element in the DOM (whether visible or not) #38

4.1.0 (2021-9-20)

  • [new] Add waitForSelector story parameter #35

4.0.1 (2021-9-14)

  • [fix] Ensure prefers-reduced-motion is turned on #33

4.0.0 (2021-09-13)

  • [breaking] Drop support for Node 10 #29
  • [maintenance] Change promise queue implementation so we don't have to worry about how ES6 class properties are compiled
  • [maintenance] Update dev dependencies
  • [maintenance] Update Playwright from 1.12 to 1.14.1

3.0.2 (2021-04-08)

  • [fix] Make ts-dedent a regular, instead of dev, dependency #27
  • Update all dependencies

3.0.1 (2021-03-03)

  • [fix] Lower supported Node version from 12 to 10 #25
  • Update dependencies #26

3.0.0 (2021-03-02)

  • [fix] Upgrade playwright to v1.8.0
  • [new] A --storybook-address option has been added. Provide a URL where your storybook server is hosted to test those stories instead of using a static build directory. #23
  • [breaking] Rename disabled option to skip, to match percy-storybook #24

2.0.1 (2021-01-22)

  • [fix] Handle errors during browser initialization - #22
  • [maintenance] Refactor browser functionality into a single class - #13
  • [maintenance] Group suite files into a suite/ directory - #19

2.0.0 (2021-01-04)

  • [breaking] axe-core is now a peer dependency (anyone using this library will need to install axe-core themselves) - #11
  • [new] A --format option has been added. The only possible value of it currently is spec (which is also the default) - #10
  • Removed the mocha dependency and implemented our own test formatting - #8
  • Updated all dependencies
  • [new] A --failing-impact option has been added. Specify at what impact level you consider failing - #9

1.3.0 (2020-10-27)

  • [new] Add --pattern option - #4
  • Add .nvmrc file - #3

1.2.0 (2020-10-13)

  • [new] Add --timeout option
  • [fix] Update all dependencies
  • [fix] Only parse CLI options once
  • Remove unnecessary dev dependencies

1.1.2 (2020-09-25)

  • [fix] Use Result.isPassing to determine if a result... is passing
  • Update documentation
  • Add .node-version file
  • Add demo:setup script to make local testing easier

1.1.1 (2020-09-23)

This release is the same as v1.1.0, but the repo/package has been renamed from axe-storybook to axe-storybook-testing. The new name hopefully better reflects what it does.

1.1.0 (2020-09-23)

  • [new] Start up Chromium with --force-prefers-reduced-motion, to help prevent animations from causing flakiness. Unfortunately, this doesn't do anything for Firefox or Webkit.

1.0.0 (2020-09-20)

v1 release! 🎉

  • [breaking] Rename --build_dir option to --build-dir
  • [new] Improve performance by around 5x, by using Storybook's client API to render stories, instead of page navigations.
  • [fix] Disable the 'bypass' rule by default.
  • [fix] Force one call to axe.run to finish before the next can start, preventing dequelabs/axe-core#1041 when things go wrong in a test.
  • Update dependencies.
  • Change the Mocha reporter to "spec".
  • Add integration tests.
  • Use types from @storybook/client-api, instead of writing our own, for story data.

0.3.0 (2020-09-17)

  • [new] Add more information to the failure messages
  • [fix] Improve performance by only injecting axe-core onto the page once (and not for every test).
  • Update all dependencies

0.2.1 (2020-09-16)

  • [new] Group checks by the stories's component title
  • [fix] Ensure the top-level Mocha describe is displayed, by waiting to "write" the tests until the stories have been found

0.2.0 (2020-09-14)

  • [breaking] Remove --debug option
  • [new] Add --headless option (defaults to true)
  • [new] Add --browser option (defaults to chromium. Accepts chromium, firefox, or webkit)
  • [new] Display the violating html in results
  • [fix] Don't log undefined to the console when there are test failures
  • Switch to Playwright, instead of Puppeteer
  • Remove AxePuppeteer, and write our own AxePlaywright integration
  • Write Mocha tests, instead of doing our own formatting of results

0.1.0 (2020-09-11)

Initial release!