Pa11y Webservice's API changes between major versions. This is a guide to help you make the switch when this happens.
Pa11y Webservice 4 requires Node.js version 12 or greater. Versions 8 and 10 are not supported any more.
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.
Pa11y Webservice 3 requires Node.js version 8 or greater. Versions 4 and 6 are not supported any more.
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.
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.