ReadMe.md

automated-a11y-reporter

Open source Java based command line utility to generate HTML accessibility reports from JSON reports. This utility only works with JSON reports generated by the libraries in the Organisation automated-a11y

Pre-requisites

1. JDK 1.8 or above

Configuration

1. Download the latest version zip archive from releases
2. Unpack the archive to a11y-reports directory. a11y-reports directory contains a11y-report, a11y-report.bat and a11y.jar
3. Add a11y-reports directory to system PATH
4. Execute a11y-report --version in terminal/cmd to make sure that a11y-report is configured

Usage

a11y-report -j=<jsonDir> -e=<engine> -o=<outputDir>

• jsonDir - JSON reports path generated by the libraries in the Organisation automated-a11y
• engine - Accessibility engine axe or htmlcs
• outputDir(Optional) - Output directory to save the HTML report. Generates in CWD if not provided

HTML CodeSniffer Report Generation

a11y-report -j=<jsonDir> -e=htmlcs -o=<outputDir>

HTML Reports will be generated in <outputDir> folder. Below are the report screenshots

Consolidated Report

Page Report

Axe Report Generation

a11y-report -j=<jsonDir> -e=axe -o=<outputDir>

HTML Reports will be generated in <outputDir> folder. Below are the report screenshots

Consolidated Report

Page Report