axe-core-npm

This repository contains 7 packages, which can be used for automated accessibility testing powered by axe core.

The packages are listed below:

• @axe-core/cli
• @axe-core/playwright
• @axe-core/puppeteer
• @axe-core/react
• @axe-core/reporter-earl
• @axe-core/webdriverio
• @axe-core/webdriverjs

Development

Fetch dependencies and link packages together:

npm install

Run the linter:

npm run lint

Run the code formatter:

npm run fmt

Please refer to respective README for installation, usage, and configuration notes.

Philosophy

We believe that automated testing has an important role to play in achieving digital equality and that in order to do that, it must achieve mainstream adoption by professional web developers. That means that the tests must inspire trust, must be fast, must work everywhere and must be available everywhere.

Manifesto

1. Automated accessibility testing rules must have a zero false positive rate
2. Automated accessibility testing rules must be lightweight and fast
3. Automated accessibility testing rules must work in all modern browsers
4. Automated accessibility testing rules must, themselves, be tested automatically

Change Log

All notable changes to this project will be documented in this file. See Conventional Commits for commit guidelines.

4.10.1 (2024-10-29)

Bug Fixes

• Update axe-core to v4.10.1 (#1124) (099818b)
• Update axe-core to v4.10.2 (#1128) (aaaa34e)

4.10.0 (2024-08-16)

Bug Fixes

• cli: include dotenv dep (#1103) (5d34355), closes #1102
• playwright: Add missing await on page.evaluate (#1063) (20b8bbf)

Features

• Update axe-core to v4.10.0 (#1088) (bb94776)

4.9.1 (2024-05-15)

Bug Fixes

• playwright: skip unloaded iframes (#1060) (d30dae4)

• Update axe-core to v4.9.1 (#1055) (8644fbd)

4.9.0 (2024-04-01)

Bug Fixes

• get correct new window handle with Selenium 3 workaround (#1031) (b72c735), closes #1027 /github.com/dequelabs/axe-core-maven-html/blob/ad58b26a8d0e2f1afed33b2c5cbca22b54644b99/selenium/src/main/java/com/deque/html/axecore/extensions/WebDriverExtensions.java#L126 #936

Features

• Update axe-core to v4.9.0 (#1028) (7e152b6)

4.8.5 (2024-02-08)

Bug Fixes

• Update axe-core to v4.8.4 (#1008) (d54f145)

4.8.4 (2024-01-23)

Bug Fixes

• webdriverjs: use new headless argument to fix selenium-webdriver@4.17.0 breaking release (#992) (0daba98)

4.8.3 (2024-01-09)

Bug Fixes

• allow cjs version of packages to export a default value (#943) (b5aee34)
• Update axe-core to v4.8.3 (#968) (be9002c)
• Update axe-core to v4.8.3 (#978) (1c83740)
• webdriverio: fix types between v8 and <v8 (#962) (0511338)
• webdriverio: work with @wdio/globals (#882) (2e016b4)
• webdriverjs: fix default commonJs export (#927) (b07d38c)

Reverts

• Revert "fix: Update axe-core to v4.8.3 (#968)" (#977) (0aff5d8), closes #968 #977
• Revert "chore: merge master into develop (#955)" (#956) (07e7d9e), closes #955 #956

4.8.2 (2023-11-30)

Bug Fixes

• allow cjs version of packages to export a default value (#943) (b5aee34)
• webdriverio: work with @wdio/globals (#882) (2e016b4)
• webdriverjs: fix default commonJs export (#927) (b07d38c)

4.8.1 (2023-10-11)

Bug Fixes

• cli: better error message for ChromeDriver version mismatch (#680) (10cf350), closes #679
• cli: improve error message on script timeout (#681) (b407c6c)
• cli: include required files when publishing (#851) (3f1ff4b)
• cli: respect --exit regardless of other flags (#750) (bfa2328)
• pin axe-core version to accept patch updates only (#838) (2456ed6)
• skip unloaded iframes for all apis (#752) (0b15629)

Features

• cli: add --chrome-path option (#700) (#704) (ada5d28)
• react: export logToConsole fn (#812) (480fb12)
• Update axe-core to v4.8.2 (#835) (2ac1eaf)

4.8.0 (2023-09-28)

Bug Fixes

• cli: better error message for ChromeDriver version mismatch (#680) (10cf350), closes #679
• cli: improve error message on script timeout (#681) (b407c6c)
• cli: respect --exit regardless of other flags (#750) (bfa2328)
• pin axe-core version to accept patch updates only (#838) (2456ed6)
• skip unloaded iframes for all apis (#752) (0b15629)

Features

• cli: add --chrome-path option (#700) (#704) (ada5d28)
• react: export logToConsole fn (#812) (480fb12)
• Update axe-core to v4.8.2 (#835) (2ac1eaf)

4.7.3 (2023-06-09)

Bug Fixes

• webdriverjs: skip unloaded iframes (#743) (9cb50eb)

4.7.2 (2023-06-01)

Bug Fixes

• packages/cli: revert ESM (#730) (4e1fb95)
• playwright: Enable usage with @playwright/test (#731) (0d0c9d1)

4.7.1 (2023-05-02)

Bug Fixes

• proper imports in esm context (#718) (f2a41bc)
• react: include .mjs file in publish (#722) (a7bf92f)

4.7.0 (2023-04-28)

Bug Fixes

• cli: do not inject script tags due to pages not allowing script tags (#710) (2e0fdb4)

Features

• enable esm import (#713) (076bfa9)
• support WDIO v8 (#708) (1e40ec0)
• Update axe-core to v4.7.0 (#709) (d418d09)

4.6.1 (2023-03-28)

Bug Fixes

• cli: increase --timeout default to 90 seconds (to match --help) (#683) (d11481b)
• Update axe-core to v4.6.3 (#698) (a7d53a4)
• work with extremely large results (#667) (395d5fc)

Features

• webdriverio: deprecate @wdio/sync support (#677) (6121e55)

4.6.0 (2023-01-19)

Bug Fixes

• playwright: update playwright to support updated types (#635) (1339ec7)
• use SerialContextObject type instead of ContextObject (#632) (630b545)

Features

• support shadow dom selectors (#619) (6065b56)
• Update axe-core to v4.6.1 (#633) (8bab5b2)

4.5.2 (2022-11-15)

Bug Fixes

• cli: include all functions in types file (#603) (30042ef)
• cli: use correct driver typings (#604) (d33bbdf)
• update to use axe-core 4.5.2 (#607) (61312ff)

4.5.1 (2022-11-03)

Bug Fixes

• update to use axe-core 4.5.1 (#597) (173bf05)

4.5.0 (2022-10-26)

Features

• upgrade to use axe-core@4.5.0 (#589) (4343d9d)

4.4.5 (2022-09-26)

Bug Fixes

• change playwright to devdep and use playwright-core types (#563) (c89fa58)
• cli: display stack trace on errors by default (#555) (a47100c)
• only set allowedOrigin when needed (#566) (a83907b)
• provide proper typings for axe-cli (#559) (e4ccfa5)

4.4.4 (2022-08-10)

Bug Fixes

• puppeteer: support puppeteer v15 (#535) (246481c)
• update to support puppeteer v14 (#528) (77eea1c)

4.4.3 (2022-06-03)

Bug Fixes

• puppeteer,playwright: wait for finishRun to complete before closing the page (#496) (7dc6a03)
• react: revert export to not use default (#481) (d932c9d)
• reporter-earl: fix main export (#483) (af77177)
• selenium-webdriverjs peer dependency to allow newer versions (#258) (2dc2788)

Features

• include missing cache file (#520) (9b2b375)

4.4.2 (2022-03-14)

Bug Fixes

• playwright: use axe-core source without require.resolve() (#473) (62d9240)

4.4.1 (2022-02-15)

Bug Fixes

• cli: update packages to use latest version of ChromeDriver ([
• react: fallback on _reactInternals (#455) (13f9fd0)

4.4.0 (2022-02-10)

Bug Fixes

• cli: add endTimer() for page load timer (#236) (e0a19a3)
• cli: add timeout waiting for page to be ready (#250) (cbb795f)
• cli: find axe-core when installed globally (#232) (75c273d)
• cli: pass chromedriver-path arg to webdriver (#416) (14e5125)
• cli: provide a more robust error message if analysis fails (#421) (9f1fa5d)
• pass chrome options to chromeOptions.addArguments() (#262) (715f463)
• playwright: allow include/exclude chaining when given a string by the user (#391) (4b8ab26)
• playwright: Make package public (#264) (35074ba)
• selenium-webdriverjs peer dependency to allow newer versions (#258) (2dc2788)
• types: return this rather than the class (#360) (7999891)
• update axe-core to 4.2.1 (#254) (9d90185)
• webdriverio,webdriverjs: fix setLegacyMode return type (#445) (147626a)
• webdriverio: include/exclude chaining and iframe selectors (#409) (ca8aa31)
• webdriverio: inject axe-core branding into all iframes (#231) (3f41c27)
• webdriverio: Recursively find <frame> (#238) (7e6a80d)
• webdriverio: support wdio using puppeteer without esm (#447) (95dda29)
• webdriverio: use executeAsync() vs execute() (#346) (0e4aa3a)
• webdriverJS: include/exclude chaining and iframe selectors (#404) (c7c50fb)
• webdriverjs: prevent selnium undefined -> null transformation (#402) (5095f43)
• webdriverjs: prevent selnium undefined -> null transformation (#402) (be3912d)
• webdriverjs: Recursively find <frame> (#209) (0d20e1f)
• webdriverjs: Reject with actual Errors (not strings) (#423) (3fdb50a), closes #422 #421 #387 #308 #207
• webdriverjs: resolve promise (#347) (d1548a5)

Features

• Add .setLegacyMode (#356) (f9d021b)
• playwright: add playwright integration (#245) (fec4ada)
• playwright: allow AxeBuilder to use different version of axe-core (#335) (f803c98)
• playwright: Upgrade to axe-core@4.3.2 (#334) (b94c75a)
• puppeteer: Deprecate Frame constructors & Puppeteer < 3.0.3 (#339) (1ea3047)
• puppeteer: support puppeteer v9 (#242) (753a919)
• puppeteer: Upgrade to axe-core 4.3 (#327) (3c9aff1)
• react: Add configuration option to optional disable cache (deduplication) (#309) (435811c)
• react: Add support for custom logger (#181) (1f97433)
• update `axe-core@4.2.2` (#263) (8c609e1)
• update axe-core to 4.2.0 (#240) (4e8f7fe)
• update to use `axe-core@4.2.3` (#280) (8aebba5)
• upgrade axe-core to 4.4.1 (#441) (765c81a)
• wdio: Upgrade to support, and use types of v7 (#364) (734e7bd)
• webdriverio: allow AxeBuilder to use different version of axe-core (#333) (25a8c1b)
• webdriverio: Upgrade to axe-core@4.3.3 (#331) (2135347)
• webdriverjs: upgrade to axe-core 4.3 (#312) (b416e74)

4.3.3 (2021-10-26)

Bug Fixes

• only set allowedOrigin when needed (0561721)

4.3.1 (2021-09-20)

Bug Fixes

• cli,reporter-earl,react: use correct version of axe-core (#378) (0c7d050)

4.3.0 (2021-09-20)

Bug Fixes

• cli: add timeout waiting for page to be ready (#250) (cbb795f)
• playwright: Make package public (#264) (35074ba)
• types: return this rather than the class (#360) (7999891)
• webdriverio: use executeAsync() vs execute() (#346) (0e4aa3a)
• webdriverjs: resolve promise (#347) (d1548a5)
• pass chrome options to chromeOptions.addArguments() (#262) (715f463)
• selenium-webdriverjs peer dependency to allow newer versions (#258) (2dc2788)
• update axe-core to 4.2.1 (#254) (9d90185)

Features

• wdio: Upgrade to support, and use types of v7 (#364) (734e7bd)
• Add .setLegacyMode (#356) (f9d021b)
• playwright: add playwright integration (#245) (fec4ada)
• playwright: allow AxeBuilder to use different version of axe-core (#335) (f803c98)
• playwright: Upgrade to axe-core@4.3.2 (#334) (b94c75a)
• puppeteer: Deprecate Frame constructors & Puppeteer < 3.0.3 (#339) (1ea3047)
• puppeteer: Upgrade to axe-core 4.3 (#327) (3c9aff1)
• react: Add configuration option to optional disable cache (deduplication) (#309) (435811c)
• react: Add support for custom logger (#181) (1f97433)
• webdriverio: allow AxeBuilder to use different version of axe-core (#333) (25a8c1b)
• webdriverio: Upgrade to axe-core@4.3.3 (#331) (2135347)
• webdriverjs: upgrade to axe-core 4.3 (#312) (b416e74)
• update `axe-core@4.2.2` (#263) (8c609e1)
• update to use `axe-core@4.2.3` (#280) (8aebba5)

4.2.2 (2021-06-23)

Bug Fixes

• playwright: Make package public (#264) (35074ba)
• pass chrome options to chromeOptions.addArguments() (#262) (715f463)
• selenium-webdriverjs peer dependency to allow newer versions (#258) (2dc2788)
• update axe-core to 4.2.1 (#254) (9d90185)
• cli: add timeout waiting for page to be ready (#250) (cbb795f)

Features

• update to use `axe-core@4.2.3` (#280) (8aebba5)
• react: Add support for custom logger (#181) (1f97433)
• update `axe-core@4.2.2` (#263) (8c609e1)
• playwright: add playwright integration (#245) (fec4ada)

4.2.1 (2021-05-19)

Bug Fixes

• update axe-core to 4.2.1 (#254) (9d90185)
• cli: add timeout waiting for page to be ready (#250) (cbb795f)

4.2.0 (2021-05-05)

Bug Fixes

• cli: add endTimer() for page load timer (#236) (e0a19a3)
• cli: find axe-core when installed globally (#232) (75c273d)
• webdriverio: inject axe-core branding into all iframes (#231) (3f41c27)
• webdriverio: Recursively find <frame> (#238) (7e6a80d)
• webdriverjs: Recursively find <frame> (#209) (0d20e1f)

Features

• puppeteer: support puppeteer v9 (#242) (753a919)
• update axe-core to 4.2.0 (#240) (4e8f7fe)

4.1.1 (2021-01-28)

Bug Fixes

• cli: create a directory when one does not exist (#187) (814cabf)
• react: Add example using Next.js (#109) (bd009d9), closes #103
• react: handle undefined config (#183) (6326e13)
• react: Prevent config TypeError (708c463)

Features

• react: add support for runOnly. (#101) (cfadde3)

4.1.0 (2020-11-20)

Bug Fixes

• react: Add example using Next.js (#109) (bd009d9), closes #103

Features

• react: add support for runOnly. (#101) (cfadde3)

4.0.0 (2020-08-25)

Bug Fixes

• cli: add timeout to webdriver.js (#47) (b9a3a3d)
• cli: change default mocha timeout for testing (#18) (f1e770c)
• cli: Enable program to work with pkg (#48) (a9ccea6)
• cli: fix main in package.json so that we can use functions in axe-test-urls file (#26) (651af8f)
• cli: fix webdriver being passed from index.js (#33) (7c939d6)
• cli: start webdriver correctly (#69) (90675b4)
• puppeteer: check to see if frame exist before injecting JS (#77) (9847f39)
• puppeteer: fix the spelling of puppeteer in package file (#59) (8048bf2)
• puppeteer: get results from iframes with branding (#55) (7e71380)
• puppeteer: get results from within iframes (#42) (4c4ef7a)
• webdriverjs: Enable library to work in pkged programs (#49) (e073487)
• webdriverjs: Remove deprecated "error-less" callback (#27) (7218bf6)
• webdriverjs: Require new when instantiating (#31) (c0aa15c)
• Make packages public (#23) (56395f0)

Features

• add @axe-core/react (#53) (ea3b15a)
• update @axe-core/* to use axe-core v4.0.1 (#56) (4b0ea09)
• cli: replace axe-webdriverjs in favor of @axe-core/webdriverjs (#51) (734a795)
• Add @axe-core/cli (#6) (2db54c2)
• add @axe-core/puppeteer (#7) (0518feb)
• add @axe-core/reporter-earl (#16) (7f77253)
• add @axe-core/webdriverio (#15) (d44289e)
• add @axe-core/webdriverjs (#11) (b1c4940)
• add disableFrame method (#39) (2825bb6)
• setup automated releases (#17) (ad14584)

BREAKING CHANGES

• webdriverjs: use new AxeBuilder(), not AxeBuilder()
• webdriverjs: you must handle errors