Skip to content

kodalabs-io/eqo

Use this GitHub action with your project
Add this Action to an existing workflow or create a new one
View on Marketplace
eqo - RGAA accessibility engine

eqo

RGAA v4.1.2 accessibility compliance analyzer for NextJS projects.

Documentation NPM version License CI Status

Audit your Next.js source code and rendered pages against all 106 RGAA v4.1.2 criteria (aligned with WCAG 2.1 A/AA). Automate ~65% of the criteria, generate reports in 5 formats, block CI on regressions, and feed your legal accessibility declaration — without false promises about what automation can and cannot do.

→ Full documentation


Features

  • 106 RGAA v4.1.2 criteria — complete catalog, automation level stated per criterion
  • Two-phase analysis — Babel AST static analysis + Playwright runtime (real Chromium)
  • 5 output formats — JSON, HTML, SARIF (GitHub Code Scanning), Markdown, JUnit
  • CI/CD native — configurable threshold, exit code 1 on failure, inline PR annotations
  • Honest by designneeds-review criteria are clearly marked, never inflated
  • GitHub Action included
  • i18nen-US (default) and fr-FR

Installation

pnpm add -D @kodalabs-io/eqo
# npm install -D @kodalabs-io/eqo
# bun add -D @kodalabs-io/eqo

For runtime analysis (browser), install the Playwright peer dependencies:

pnpm add -D playwright @axe-core/playwright axe-core
pnpm exec playwright install chromium

No browser? Start with --static-only. Themes 1, 2, 5, 6, 8, 9, 11 — no Playwright needed.


Quick Start

1. Initialize

pnpm eqo init   # npx eqo init  ·  bunx eqo init

Creates rgaa.config.ts in your project root.

2. Configure

// rgaa.config.ts
import { defineConfig } from "@kodalabs-io/eqo";

export default defineConfig({
  baseUrl: "http://localhost:3000",
  projectName: "my-app",
  locale: "fr-FR",

  pages: [
    { path: "/",              name: "Home" },
    { path: "/contact",       name: "Contact" },
    { path: "/accessibilite", name: "Accessibility" },
  ],

  output: [
    { format: "json",     path: "./public/rgaa-report.json" },
    { format: "sarif",    path: "./reports/rgaa.sarif" },
    { format: "markdown", path: "./reports/rgaa.md" },
  ],

  thresholds: {
    complianceRate: 0,    // 0 = never block CI. Set to 80 to enforce a threshold.
    failOn: "threshold",
  },
});

3. Run

npx eqo analyze               # Full audit: static + browser
npx eqo analyze --static-only # No browser — runs in seconds
npx eqo analyze --threshold 80 # Override threshold for a one-off check

GitHub Actions

name: Accessibility Audit
on:
  push:
    branches: [main]
  pull_request:

jobs:
  rgaa:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - name: Start Next.js app
        run: |
          npm install && npm run build && npm start &
          npx wait-on http://localhost:3000

      - name: Run RGAA audit
        uses: kodalabs-io/eqo@v1
        with:
          threshold: 0        # 0 = report only, never blocks CI
          locale: fr-FR
          upload-sarif: true  # Adds inline annotations to your PR diff

Set threshold: 80 to fail the pipeline if compliance drops below 80%.


Documentation

Introduction RGAA law, who must comply, and Eqo's honest scope
Getting Started Install, configure, and run your first audit in 5 minutes
Configuration Full rgaa.config.ts reference — every option explained
Accessibility Page Build your /accessibilite page in Next.js
CI/CD Integration Blocking strategies, thresholds, PR comments
CLI Reference All eqo commands and flags
API Reference Programmatic usage as a library

License

MIT — Copyright © 2026 Koda Labs

About

RGAA v4.1.2 accessibility compliance analyzer for NextJS projects

Topics

Resources

License

Code of conduct

Contributing

Stars

Watchers

Forks

Sponsor this project

  •  

Contributors