Project

workarea-a11y

0.0
No commit activity in last 3 years
No release in over 3 years
workarea-a11yworkarea-commerce/workarea-a11yHomepageDocumentationSource CodeBug TrackerWiki
This plugin integrates accessibility (a11y) tooling into the test suite, failing builds based on various uncovered WCAG offenses.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Popularity
Downloads
2,400
Stars
0
Forks
0
Watchers
3
 Releases
Current version
1.2.1
Total releases
1
First release
2019-08-21
Latest release
2019-08-21
 Issues
Open Issues
0
Closed Issues
1
Total Issues
1
Issue Closure Rate
100%
 Pull Requests
Open Pull Requests
0
Closed Pull Requests
0
Merged Pull Requests
2
Pull Request Acceptance Rate
100%
 Development
Primary Language
Ruby
Licenses
Business Software License
Average date of last 50 commits
2019-10-27
Reverse Dependencies
0

 Dependencies

Runtime

axe_core_rails
~> 3.2.2
workarea
>= 3.0.0
 Project Readme

Workarea A11y

A Workarea Commerce plugin that integrates Deque's aXe Accessibility Engine into your project's test suite, failing tests for pages that are found containing WCAG offenses.

Currently this plugin:

  • is not configurable
  • only checks against Storefront
  • will fail CI builds until offenses are fixed
  • will fail your local tests until offenses are fixed
  • works for all versions of Workarea greater-than or equal to v3.0.0

This plugin is also intended to be used in tandem with the aXe Chrome Developer Tools which can give you much more insight into what's going on when you're trying to debug the offenses.

Getting Started

Add the gem to your application's Gemfile:

# ...
gem 'workarea-a11y'
# ...

Update your application's bundle.

cd path/to/application
bundle

Usage

Install this plugin and run:

bin/rails workarea:test:storefront

Or push your branch up to your project's remote repository and check the CI build.

Gotchas

The aXe Chrome Developer Tools are run by the developer on-demand, which can differ from the automatic approach taken by this plugin. This means that your results may vary when using both approaches in tandem. The Developer Tools will often uncover more offenses than the test suite integration so it is recommended that both be used.

The Developer Tools can also be affected by other Chrome extensions. For example, the LastPass Chrome Extension will apply an overlay to inputs of type 'email' to show the user that LastPass may be able to interact with the field. Using the Developer Tools, aXe will throw a warning because of this, since it is run manually after the page and LastPass have loaded, whereas the test integration will not have the LastPass extension loaded.

This plugins is also only able to test pages that the test suite covers. In this way it acts quite similarly to the v3.2.0 Duplicate ID checker feature in Workarea.

Be sure to keep these gotchas in mind while you work to stay efficient while working through the reported offenses.

Workarea Commerce Documentation

See https://developer.workarea.com for Workarea Commerce documentation.

License

Workarea A11Y is released under the Business Software License