Gulp Puppeteer Accessibility Audit

Gulp plugin for Puppeteer Accessibility Audit

Installation

1npm install --save-dev gulp-puppeteer-accessibility-audit

or

1yarn add --dev gulp-puppeteer-accessibility-audit

Usage

1const paa = require('gulp-puppeteer-accessibility-audit');
2
3gulp.task('audit', function () {
4  return gulp.src('./**/*.html')
5    .pipe(paa())
6    .pipe(paa.reporter());
7});

Reporters

There are 3 reporters available for use.

• reporter - Reports at the end all passes and fails, does not trigger a failure
• failAfterError - Reports at the end but only prints failures and will emit an error
• failOnError - Will emit an error on the first failure

Config

All config data passed into paa will be passed directly to Puppeteer Accessibility Audit

• puppeteerConfig is passed to: puppeteer.launch
• viewport is passed to: page.setViewport
• auditScopeSelector is used to target the audit and is passed to a document.querySelector.

For example

1const paa = require('gulp-puppeteer-accessibility-audit');
2
3gulp.task('audit', function () {
4  return gulp.src('./**/*.html')
5    .pipe(paa({
6      puppeteerConfig: {
7        timeout: 5000,
8        headless: false
9      },
10      viewport: {
11        width: 1920,
12        height: 1080
13      },
14      auditScopeSelector: "#content"
15    }))
16    .pipe(paa.reporter());
17});

Credits

Lots of copy and pasting of gulp-a11y by Michael Pezzi