@cuginoale/pa11y-report-html

Pa11y HTML Reporter

An HTML reporter for Pa11y 5.0.

Table Of Contents

• Pa11y HTML Reporter
  • Table Of Contents
  • Requirements
  • Usage
    • Command-Line
    • JavaScript
  • Contributing
  • License

Requirements

Pa11y HTML Reporter is compatible with Pa11y 5.0. It will not work with older versions of Pa11y.

Usage

Command-Line

Install Pa11y and Pa11y HTML Reporter with npm (locally or globally is fine):

npm install -g pa11y pa11y-reporter-html

Run Pa11y using the HTML reporter:

pa11y --reporter html http://example.com

JavaScript

Assuming you've installed both Pa11y and Pa11y HTML Reporter:

const html = require('pa11y-reporter-html');
const pa11y = require('pa11y');
const options = {
  screenCapture: `path/to/screenshot.png`,
}

pa11y('http://example.com', options]).then(async results => {
    // Returns a string with the results formatted as HTML
    // includes the page screen shot if provided
    const htmlResults = await html.results(results, 'path/to/screenshot.png');
    console.log(htmlResults);
});

Contributing

There are many ways to contribute to Pa11y HTML Reporter, we cover these in the contributing guide for this repo.

If you're ready to contribute some code, clone this repo locally and commit your code on a new branch.

Please write unit tests for your code, and check that everything works by running the following before opening a PR:

make ci

You can also run verifications and tests individually:

make verify              # Verify all of the code (ESLint)
make test                # Run all tests
make test-unit           # Run the unit tests
make test-unit-coverage  # Run the unit tests with coverage

License

Pa11y HTML Reporter is licensed under the Lesser General Public License (LGPL-3.0).
Copyright © 2017, Team Pa11y