Skip to content

Latest commit

 

History

History
40 lines (24 loc) · 1.85 KB

MIGRATION.md

File metadata and controls

40 lines (24 loc) · 1.85 KB

Migration guide

Pa11y Webservice's API changes between major versions. This is a guide to help you make the switch when this happens.

Table of contents

Migrating from 3.0 to 4.0

Pa11y Webservice 4 requires Node.js version 12 or greater. Versions 8 and 10 are not supported any more.

Migrating from 2.0 to 3.0

PhantomJS to Headless Chrome

Pa11y Webservice 3 uses version 5 of Pa11y, which replaces PhantomJS with Headless Chrome. This allows us to use more modern JavaScript APIs and make Pa11y testing more stable.

As a result of this change, Pa11y Webservice's requirements have changed, and you may need to install additional dependencies required by Chrome before being able to use this version.

Node.js support

Pa11y Webservice 3 requires Node.js version 8 or greater. Versions 4 and 6 are not supported any more.

Miscellaneous

The default viewport dimensions for Pa11y have been changed from 1024x768 to 1280x1024. This could make pa11y report a different number of errors if different content appears on the page based on its width, so results obtained with v2 and v3 may not be comparable.

Migrating from 1.0 to 2.0

Node.js support

The only breaking change in Pa11y Webservice 2.0 is that Node.js 0.10 and 0.12 are no longer supported. We'll be using newer ES6 features in upcoming releases which will not work in these older Node.js versions.