# Cypress-axe-dirk

## How to use

### Configuration

To use cypress-axe-dirk you first have to add _addAxePluginEvents()_ to your index.ts file.

### Commands

To get an assertion on accessibility you need to use the _assertAccessibility()_ command. To save an accessibility report you need to use the _saveAccessibility()_ command.

## Artifacts

### scan.json

The scan.json file is a json file that includes the accessibility of all the files that have been scanned by the saveAccessibility command.

### report-_report_name_.html

The report-_report_name_.html file is a file that includes a report of the page that has been scanned.

### meta_report.html

The meta_report.html file is a file that includes a summary of all the scanned files.