GitHub - 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 • Jun 1, 2025 17:58

Extracto

Accessibility Checker is a Node.js-based CLI tool designed to scan and report common accessibility issues in HTML - be-lenka/be-a11y

Resumen

Resumen Principal

"Be-Accesible! Accessibility Checker" es una herramienta CLI basada en Node.js diseñada para identificar y reportar problemas comunes de accesibilidad en proyectos basados en HTML. Ofrece una notable flexibilidad al permitir el escaneo tanto de directorios locales que contienen archivos .html, .php, .latte, .twig y .edge**, **como el análisis de URLs remotas** de páginas web activas. La herramienta realiza un conjunto exhaustivo de verificaciones, incluyendo la correcta **jerarquía de encabezados**, la **presencia y longitud de atributos alt** en imágenes, la validez de **aria-labelyaria-labelledby`**, la necesidad de etiquetas accesibles para elementos interactivos y el contraste de color según WCAG 2.1 AA. Su diseño, que incluye una salida CLI legible y codificada por colores, exportación opcional a JSON y compatibilidad con Integración Continua (CI), lo convierte en un recurso invaluable para desarrolladores y ingenieros de QA que buscan integrar las mejores prácticas de accesibilidad desde las primeras etapas del desarrollo. Esto es crucial, especialmente de cara a la Ley de Accesibilidad Europea (EAA), que entrará en vigor el 28 de junio de 2025, ayudando a las organizaciones a asegurar la conformidad y la creación de entornos digitales inclusivos.

Elementos Clave

Versatilidad de Escaneo y Formatos Compatibles: La herramienta "Be-Accesible!" no solo es capaz de analizar páginas web activas a través de URLs, sino que también soporta el escaneo de directorios locales completos. Esta característica es fundamental para entornos de desarrollo, ya que permite verificar una amplia gama de formatos de plantillas, incluyendo .html, .php, .latte, .twig y .edge, asegurando una cobertura integral antes del despliegue.
Detección Exhaustiva de Problemas de Accesibilidad: El verificador ejecuta un conjunto robusto de chequeos específicos y críticos que abordan problemas comunes pero significativos. Esto incluye la validación de la orden de los niveles de encabezado (evitando saltos como h1 → h3), la verificación de la existencia y longitud de los atributos alt en las etiquetas <img>, la correcta implementación de aria-label y aria-labelledby, la identificación de elementos que deberían tener etiquetas accesibles (como <button>, <a> y <svg>), y la comprobación del contraste de color entre texto y fondo según el nivel WCAG 2.1 AA.
**Integración Ef

Contenido

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 <img> tags have alt attributes
↔️ Checks <img> alt have a certain length
♿ Detects missing or invalid aria-label and aria-labelledby
👀 Identifies elements that should have accessible labels (like <button>, <a>, <svg>)
🎨 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:

Run the script

You can analyze either a local directory or a remote URL.

node index.js /path/to/html/files/

# or

node index.js https://google.com

Export results to JSON (optional)

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.