Migrating to v4.x DevTools Nuget
Steps for migrating to version 4.x of axe DevTools for Web for C# Nuget
Axe DevTools Nuget v4.x
, while not a major rewrite, contains some large changes. The most notable changes are summarized below, followed by more specific changes to relevant packages.
Summary
The axe-devtools-*
suite of nuget packages, involved primarily a rebranding perspective.
Beware of breaking changes
Given the rebranding of the API, it is fair to outline that migration to v4.0 involves following this migration guide in a step by step fashion
Environment Setup
There is no changes with the default environment requirements. The desired requirements are as below:
- Dotnet .NET Framework 4.5.2 or at least .NET Standard 2.0
Installing axe DevTools NuGet
Ensure you have access to Deque's registry. If not, refer to setup.
After successfully accessing setup, you may install axe DevTools NuGet by including the following to your .csproj file.
<PackageReference Include="axe-devtools-selenium" Version="4.0.0" />
Noteworthy Changes
Asides installation, some noteworthy changes include:
- Namespaces have been changed from
Deque.Attest
toDeque.AxeDevtools
. - The
Attest
class has been renamed toAxeSelenium
. - The Environment variable for configuring custom rules has been changed from
ATTEST_PATH
toAXE_RULESET_PATH
. - The default ruleset has changed. Axe DevTools audits a given page with
wcag2.1
as the default ruleset. No change is required by the end-user. If one wished to configure a different ruleset, they may use the respective ruleset api.