https://github.com/be-lenka/be-a11y
Accessibility Checker is a Node.js-based CLI tool designed to scan and report common accessibility issues in HTML
https://github.com/be-lenka/be-a11y
accessibility-checker accessibility-testing eaa-checker
Last synced: 11 months ago
JSON representation
Accessibility Checker is a Node.js-based CLI tool designed to scan and report common accessibility issues in HTML
- Host: GitHub
- URL: https://github.com/be-lenka/be-a11y
- Owner: be-lenka
- License: mit
- Created: 2025-05-28T16:07:44.000Z (11 months ago)
- Default Branch: master
- Last Pushed: 2025-05-28T19:10:20.000Z (11 months ago)
- Last Synced: 2025-05-28T20:25:32.887Z (11 months ago)
- Topics: accessibility-checker, accessibility-testing, eaa-checker
- Language: JavaScript
- Homepage:
- Size: 18.6 KB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Be-Accesible !
Accessibility Checker is a Node.js-based CLI tool designed to scan and report common accessibility issues in HTML-based projects. It supports both local directory scanning and remote URL analysis, making it ideal for developers and QA engineers aiming to ensure their HTML templates and frontend code adhere to accessibility best practices.
## Features
- ✅ Checks heading level order (e.g., h1 → h3 skipped)
- 🖼️ Verifies `![]()
` tags have `alt` attributes
- ↔️ Checks `![]()
` alt have a certain length
- ♿ Detects missing or invalid `aria-label` and `aria-labelledby`
- 👀 Identifies elements that should have accessible labels (like ``, ``, ``)
- 🎨 Checks color contrast between text and background (WCAG 2.1 AA level)
- 📂 Supports scanning entire directories with `.html`, `.php`, `.latte`, `.twig`, `.edge` templates
- 🌐 Supports analyzing live pages via URL
- 📤 Optional JSON export of results
- 🎨 Color-coded, grouped CLI output for easy readability (reports file + line number)
- ▶️ Ignores common build and vendor directories
- 📝 CI-friendly (non-zero exit on issues)
## Usage
#### Install dependencies:
```bash
npm install
```
#### Run the script
You can analyze either a local directory or a remote URL.
```bash
node index.js /path/to/html/files/
# or
node index.js https://google.com
```
#### Export results to JSON (optional)
```bash
node index.js /path/to/html/files report.json
# or
node index.js https://google.com report.json
```
## Future Tools
- GitHub Action support
## TLDR
🏛️ European Accessibility Act (EAA) Compliance
The European Accessibility Act (EAA), effective from June 28, 2025, mandates that a range of products and services, including websites and mobile applications, meet accessibility requirements to ensure equal access for persons with disabilities across the EU. This directive aims to harmonize accessibility standards, facilitating easier cross-border trade and enhancing the availability of accessible products and services .
Accessibility Checker assists organizations in aligning with EAA requirements by:
- Identifying Non-Compliance: Detects common accessibility issues that could lead to non-compliance with EAA standards.
- Facilitating Remediation: Provides detailed reports, enabling developers to address and rectify accessibility shortcomings effectively.
- Supporting Inclusive Design: Encourages the adoption of accessibility best practices, contributing to the creation of inclusive digital environments.
By integrating Accessibility Checker into your development workflow, you can proactively address accessibility concerns, ensuring your digital products and services are compliant with the EAA and accessible to all users.
For more information on the European Accessibility Act, visit the [European Commission's official page](https://commission.europa.eu/strategy-and-policy/policies/justice-and-fundamental-rights/disability/union-equality-strategy-rights-persons-disabilities-2021-2030/european-accessibility-act_en).