# axe-matchers

**Repository Path**: mirrors_dequelabs/axe-matchers

## Basic Information

- **Project Name**: axe-matchers
- **Description**: [DEPRECATED] Ruby integration for aXe-core, the accessibility testing engine
- **Primary Language**: Unknown
- **License**: MPL-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-09-24
- **Last Updated**: 2026-07-25

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# [DEPRECATED] axe-matchers

[![No Maintenance Intended](http://unmaintained.tech/badge.svg)](http://unmaintained.tech/)

> This repository has been deprecated. The package has been moved to [axe-core-gems](https://github.com/dequelabs/axe-core-gems). These set of packages will be available via [rubygems.org](https://rubygems.org/) prefixed with [ `@axe-core-*` ](https://rubygems.org/search?utf8=%E2%9C%93&query=axe-core-).

---

Automated accessibility testing powered by aXe.

Provides Cucumber step definitions and RSpec matchers for auditing accessibility.

Uses the [aXe core][axe-core] javascript library for accessibility testing.

# 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

# Getting Started

## Installation

Add this line to your application's Gemfile:

``` ruby
gem 'axe-matchers'
```

And then execute:

``` sh
$ bundle install
```

Or install it yourself as:

``` sh
$ gem install axe-matchers
```

## Usage

### Cucumber

A set of step definitions have been provided for accessibility testing through Cucumber, using [WebDrivers][webdrivers].

Read the documentation for the [Cucumber Integration][cucumber-integration].

### RSpec

A set of matchers have been provided for accessibility testing through RSpec using [WebDrivers][webdrivers].

Read the documentation for the [RSpec Integration][rspec-integration]

# The Accessibility Rules

axe-matchers uses axe-core@3x, which can test for accessibility inside of Shadow DOM HTML subtrees. See the [axe-core repository](https://github.com/dequelabs/axe-core) for more information.

The complete list of rules run by axe-core can be found in [doc/rule-descriptions.md][axe-rule-descriptions].

# WebDrivers

axe-matchers supports Capybara, Selenium, and Watir webdrivers; each tested with Firefox, Chrome, and Safari. Additionally, selenium-chrome-headless and capybara-webkit are supported.

*__Notes:__*

* Chrome requires [ChromeDriver][chrome-driver] (tested with 2.35)
* Safari requires [SafariDriver][safari-driver] (tested with 2.48)

# Contributing

Read the documentation on [contributing][contributing]

[webdrivers]: #webdrivers
[cucumber-integration]: ./docs/Cucumber.md
[rspec-integration]: ./docs/RSpec.md
[contributing]: ./CONTRIBUTING.md

[axe-core]: https://github.com/dequelabs/axe-core
[axe-rule-descriptions]: https://github.com/dequelabs/axe-core/blob/master/doc/rule-descriptions.md

[chrome-driver]: https://sites.google.com/a/chromium.org/chromedriver/
[safari-driver]: https://code.google.com/p/selenium/wiki/SafariDriver