pa11y

pa11y
Name	pa11y
Programming language	JavaScript
Operating system	Cross-platform
Genre	Accessibility testing
License	MIT License

pa11y

pa11y is an open-source automated accessibility testing tool designed to evaluate web pages for compliance with accessibility standards such as Web Content Accessibility Guidelines and Accessible Rich Internet Applications. It is used by developers, quality assurance teams, and accessibility specialists to identify issues across web applications and static sites, integrating with continuous integration services and developer workflows. The project sits within the broader landscape of web tooling alongside projects from organizations like W3C, Mozilla Corporation, Google, Microsoft, and Apple Inc..

Overview

pa11y performs automated audits of web content to detect violations of accessibility rules drawn from standards such as Web Content Accessibility Guidelines and checks implemented in technologies by W3C, World Wide Web Consortium, and browser vendors including Google Chrome, Mozilla Firefox, Microsoft Edge, and Apple Safari. It builds on accessibility engines and APIs developed by projects including axe-core, Google Lighthouse, and WAVE (web accessibility evaluation tool), and complements manual testing practices used by practitioners at organizations like Deque Systems, The Paciello Group, International Association of Accessibility Professionals, and Royal National Institute of Blind People. pa11y is distributed under the MIT License and runs on platforms supported by Node.js and package managers such as npm and Yarn.

Features and Components

pa11y includes core components that facilitate automated checks: a runner that executes audits, a reporter that formats results, and a configurable suite of checks derived from standards and engines such as axe-core and Google Lighthouse. Its feature set typically includes support for multiple reporters (e.g., JSON, HTML), custom rulesets, and option hooks to integrate with headless browsers like Puppeteer and Playwright. pa11y can target single pages, multi-page crawls, and single-page applications, interoperating with testing frameworks like Jest (JavaScript testing framework), Mocha (JavaScript framework), and Cypress (software). Reporting outputs are consumable by platforms including Jenkins, Travis CI, CircleCI, GitHub Actions, and GitLab CI/CD.

Command-line Interface and API

pa11y provides a command-line interface that developers invoke in environments such as Unix, Linux, macOS, and Microsoft Windows shells, integrating into build scripts and task runners like Grunt, Gulp, and Make (software). The CLI accepts flags and configuration files compatible with JSON and YAML formats and can be scripted from languages that interoperate with Node.js, including projects maintained by OpenJS Foundation contributors. Additionally, pa11y exposes a programmatic API enabling integration with server-side applications built on Express (web framework), Koa (web framework), and Fastify, and can send results to dashboards maintained by teams at companies such as Atlassian, GitHub, and LaunchDarkly.

Usage and Workflows

Typical workflows incorporate pa11y into continuous integration pipelines for codebases hosted on platforms like GitHub, GitLab, Bitbucket, and Azure DevOps. Teams create audit gates referencing standards from Web Content Accessibility Guidelines levels A and AA, combine pa11y with visual regression tools from BackstopJS or Percy (company), and link findings to issue trackers like JIRA, GitHub Issues, and Trello. Accessibility specialists at institutions such as University of Oxford, Harvard University, and United Nations style guides often use pa11y reports alongside manual audits informed by resources from W3C, WebAIM, and National Federation of the Blind.

Integration and Tooling

pa11y integrates with headless browser automation tools including Puppeteer, Playwright, and Selenium (software), and with accessibility engines like axe-core and test runners such as Jest, Mocha, and Cypress. It can output artifacts compatible with observability and reporting platforms like Sentry (software), Datadog, New Relic, and Elastic Stack, and be invoked within containerized environments using Docker and orchestration systems like Kubernetes. Developers commonly pair pa11y with linters and bundlers including ESLint, Webpack, and Babel (software), and connect results to enterprise pipelines managed via Jenkins, TeamCity, or Bamboo (software).

Adoption and Community

pa11y is adopted by a mix of commercial organizations, public sector entities, and open-source projects. Contributors and adopters span companies and institutions such as Google, Microsoft, Amazon (company), BBC, Guardian Media Group, The New York Times, National Health Service (England), and academic groups at Massachusetts Institute of Technology, Stanford University, and University of Cambridge. Community resources include discussions on platforms like GitHub, Stack Overflow, Reddit (website), and mailing lists affiliated with W3C interest groups and local meetups organized by chapters of International Association of Accessibility Professionals and OpenJS Foundation events.

Development and Maintenance

pa11y development is collaborative, leveraging contributions from individual developers, accessibility consultants, and companies. The project follows practices common to open-source software hosted on GitHub, including issue tracking, pull request reviews, and continuous integration testing with services such as Travis CI and GitHub Actions. Maintenance activities coordinate with downstream projects like axe-core and browser vendors including Google, Mozilla, and Microsoft to ensure parity with evolving specifications from W3C and evolving browser APIs in Chromium and Gecko engines. Community governance models reflect patterns used by foundations like the Linux Foundation and OpenJS Foundation.

Category:Accessibility software