eslint-config-pa11y

Linter configuration for Pa11y projects. We use this configuration to ensure Pa11y's coding style remains consistent across our repositories.

Table Of Contents

• Requirements
• Usage
• Contributing
• License

Requirements

This library requires Node.js 20 or above.

Usage

To include these config files in your project, install this module as a development dependency. Using npm:

npm install --save-dev eslint-config-pa11y

The logging will mention any further peer dependencies required.

Contributing

There are many ways to contribute to eslint-config-pa11y, we cover these in the contributing guide for this repo.

If you're ready to contribute some code, clone this repo locally and commit your code on a new branch.

Please check that everything works by running the following before opening a PR:

npm test

Testing the GitHub Actions workflows

This project's GitHub Actions workflows can be tested locally using nektos/act, which can be installed with Homebrew:

brew install act

To run the testing workflow locally:

act

To validate the testing workflow, without running it:

act --dryrun

To validate the publishing workflow:

act --dryrun release

Add --verbose to any act command for more output.

Support

When we release a new major version we will continue to support the previous major version for 6 months. This support will be limited to fixes for critical bugs and security issues.

License

Licensed under the Lesser General Public License (LGPL-3.0).
Copyright © 2017-2025, Team Pa11y