Equalize Digital Accessibility Checker

What is this?

Audit and check your website for accessibility before you hit publish. In-post accessibility scanner and guidance for WCAG compliance. No API or per page fees.

• Plugin Website
• Documentation
• Compare Free to Pro
• Get Pro
• WP Accessibility Meetup
• WP Accessibility Facebook Group

Want to contribute?

Prerequisites

At Equalize Digital, we make use of a specific toolset to develop our code. Please ensure you have the following tools installed before contributing.

• Composer
• NPM

Getting started

Check out this repository from GitHub, then run:

composer install
npm install
npm run build

Dev environment setup

There are no special requirements for the dev environment aside from the standard WordPress/PHP runtime used by the plugin—use whatever local stack you prefer (e.g. Local by Flywheel, DesktopServer, LocalWP).

As long as you follow the Getting Started steps above, the plugin will run in your local environment.

Running tests

This plugin includes unit tests for the PHP code and Jest tests for the JavaScript code. The Jest tests have no prerequisites, but the PHP tests require a local WordPress installation.

Jest tests

To run the Jest tests, you can use the following command:

npm run test:jest

PHP unit tests

The PHP tests are a little more involved because they require a local WordPress installation. A Docker-based setup is included to make running them straightforward.

Docker and Docker Compose must be installed and running. The build script uses Docker Compose v2 style commands (eg docker compose vs docker-compose).

Start the containers to run the tests and stop them when you are finished development.

To run the tests (will start the containers if not already running) run:

npm run test:php

To stop the PHP unit test container, run:

npm run test:php:stop

Package scripts

• npm run build - builds JavaScript & CSS
• npm run dev - watches and automatically builds JavaScript & CSS
• npm run dist - builds a distributable .zip for the plugin into ./dist
• npm run dist:dotorg - builds a distributable .zip for dotorg, keeps build folder
• npm run lint - lints the plugin's PHP and JavaScript
• npm run lint-staged-precommit - runs lint-staged and JS lint for precommit
• npm run lint:php - lints the plugin's PHP
• npm run lint:php:fix - fixes linting issues in the plugin's PHP
• npm run lint:js - lints the plugin's JavaScript
• npm run lint:js:fix - fixes linting issues in the plugin's JavaScript
• npm run test:php - sets up PHP unit test environment and runs the plugin's PHP unit tests
• npm run test:php:run - runs PHP unit tests in the already active container (does not wipe the database first)
• npm run test:php:coverage - runs PHP unit test with coverage report
• npm run test:php:stop - stops the PHP unit test container
• npm run test:jest - runs Jest tests
• npm run prepare - runs husky
• npm run phpstan - runs PHPStan static analysis

Support

This is a developer portal for Accessibility Checker and should not be used for support. Please visit the support forums for support.

Contributions

Anyone is welcome to contribute to Accessibility Checker. Please read the guidelines for contributing to this repository.

There are various ways you can contribute:

• Raise an issue on GitHub.
• Send us a Pull Request with your bug fixes and/or new features.