JSPM – a11y@0.1.2

Package Exports

a11y

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (a11y) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Easy accessibility audits powered by the Chrome Accessibility Tools.

Install

$ npm install -g a11y

PhantomJS, which is used for generating the screenshots, is installed automagically, but in some rare cases it might fail to and you'll get an Error: spawn EACCES error. Download PhantomJS manually and reinstall a11y if that happens.

CLI usage

Run an audit against a URL:

$ a11y <url>

Example

Query help:

$ a11y --help

Verbose mode:

$ a11y <url> --verbose

Write audit to file:

$ a11y <url> >> audit.txt

Module usage

var a11y = require('a11y');

a11y('http://twitter.com', function (err, reports) {
    var output = JSON.parse(reports);
    var audit = output.audit; // a11y Formatted report
    var report = output.report; // DevTools Accessibility Audit formatted report
});