pa11y-reporter-tsv

Pa11y TSV Reporter

A Tab-Separated-Value reporter for Pa11y 5.0.

Table Of Contents

• Requirements
  • Compatibility chart
• Usage
  • Command-Line
  • JavaScript
• Contributing
• License

Requirements

Pa11y TSV Reporter is compatible with Pa11y 5 and later versions. It will not work with older versions of Pa11y.

Compatibility chart

Pa11y version	Pa11y CLI reporter version
1.x - 4.x	Unsupported
5.x	1.x
6.x	2.x

Usage

Command-Line

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

npm install -g pa11y pa11y-reporter-tsv

Run Pa11y using the TSV reporter:

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

JavaScript

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

const tsv = require('pa11y-reporter-tsv');
const pa11y = require('pa11y');

pa11y('http://example.com').then(results => {
    // Returns a string with the results formatted as TSV
    const tsvResults = tsv.results(results);
    console.log(tsvResults);
});

Contributing

There are many ways to contribute to Pa11y TSV 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 Pull Request:

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 TSV Reporter is licensed under the Lesser General Public License (LGPL-3.0).
Copyright © 2017, Team Pa11y

Changelog

2.0.0 (2020-04-27)

• Drop support for Node.js versions older than 10.
• Whitelist the files to be published on npm. This reduces the size of the package.
• Update devDependencies.
• Update test matrix to include Node 10, 12 and 14.