README.md

axe-core-nuget

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

The packages are listed below:

• Deque.AxeCore.Playwright
• Deque.AxeCore.Selenium
• Deque.AxeCore.Commons

Building

• To build all projects, run dotnet build from the root of the repo
• To build one project, run dotnet build from that project's folder (eg, packages/commons/src)

Testing

• To run all tests, run dotnet test from the root of the repo
• To run one test project, run dotnet test from that test project's folder (eg, packages/commons/test)
• To run one individual test case, run dotnet test --filter "Name=TestCaseMethodName"
  • dotnet test --list-tests will list the available test cases
• To have integration tests use headed browsers instead of headless ones, run dotnet test -e HEADED=1

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

License

• The Deque.AxeCore.Playwright NuGet package and its source code under the packages/playwright/ directory are distributed under the terms of the MIT License.
• The Deque.AxeCore.Selenium NuGet package and its source code under the packages/selenium/ directory are distributed under the terms of the MIT License.
• The Deque.AxeCore.Commons NuGet package, its source code under packages/commons/ directory, its embedded copy of axe-core, and all other source code in this repository outside of the packages/ directory are distributed under the terms of the Mozilla Public License, version 2.0.

Note that the (MIT licensed) Deque.AxeCore.Playwright and Deque.AxeCore.Selenium NuGet packages each have a dependency on the (MPL licensed) Deque.AxeCore.Commons NuGet package.

Acknowledgments

• Deque.AxeCore.Playwright is a fork of IsaacWalker/PlaywrightAxeDotnet. We thank @IsaacWalker for his work and for agreeing to re-home the library as an officially supported integration package.
• Deque.AxeCore.Selenium is a fork of TroyWalshProf/SeleniumAxeDotnet, which in turn is a fork of javnov/axe-selenium-csharp. We thank @TroyWalshProf, @javnov, and all the other contributors to those projects for their work. We especially thank @TroyWalshProf for agreeing to re-home the library as an officially supported integration package.