agentleFS
JoviDeCroockJoviDeCroock/pracht/skills/audit-a11y/SKILL.md

audit-a11y

Skill106 starsChanged 7 months agoMITView on GitHub

Run axe-core against every pracht route in a headless browser and report alt text, contrast, landmark, focus, and form-label issues by severity. Use for "audit a11y", "check accessibility", "WCAG compliance", "axe my app".

  • Reads credentials
  • Installs packages

1 other project uses a version of this.

Adopted by

Most recently taken up by

The file

We split this skill into the rules it gives an agent

8 rules. About 0 are common, 5 are distinctive, and 3 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈5

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 3

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    Prefer the production build/runtime — production HTML is what users actually receive.

    line 25
  2. Distinctive:

    Run the server as a managed background process, wait for readiness, and clean it up when the audit ends:

    line 31
  3. Distinctive:

    After Step 5 (or on any failure), kill the background process — do not leave a stray server holding the port.

    line 40
  4. Very specific:

    If Playwright is already wired (see scaffold-e2e), reuse it.

    line 48
  5. Very specific:

    If Playwright is not wired, scaffold a one-off script using playwright directly.

    line 55
  6. Distinctive:

    Run against the production build/runtime if at all possible — minified production markup is what real users hit.

    line 153
  7. Distinctive:

    Do not auto-fix. Suggest, then let the user review per component.

    line 159
  8. Distinctive:

    Always clean up background servers you started, even when the audit fails partway.

    line 162

≈ “Common” is an estimate: at least 1 in 5 of the 350,495 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

Pracht Audit A11y

Static linting cannot prove a route is accessible — many issues only appear in the rendered DOM. This skill renders each route in a real browser and runs axe-core against the result.

Step 1: Boot the app

Prefer the production build/runtime — production HTML is what users actually receive. pracht preview builds and serves it for Node and Cloudflare targets. It refuses Vercel targets (it prints guidance and exits nonzero): for a Vercel app, run vercel dev yourself or point BASE_URL at a deployed preview instead. Fall back to pracht dev only if the user can't build.

Run the server as a managed background process, wait for readiness, and clean it up when the audit ends:

pracht preview &   # run in the background (use the Bash tool's background mode)
# wait for readiness before auditing:
until curl -sf http://localhost:3000 > /dev/null; do sleep 1; done

After Step 5 (or on any failure), kill the background process — do not leave a stray server holding the port.

Or, if BASE_URL is set, target the deployed app and skip the local server entirely.

Step 2: Install runner

If Playwright is already wired (see scaffold-e2e), reuse it. Install the axe adapter plus tsx (the Step 5 runner — it is not a pracht dependency):

pnpm add -D @axe-core/playwright tsx

If Playwright is not wired, scaffold a one-off script using playwright directly. Prefer Playwright over Puppeteer for consistency with existing project tooling.

Step 3: Enumerate routes

MCP: if pracht dev-mcp is registered, prefer its inspect_*, doctor, and verify tools to the CLI.

pracht inspect routes --json

Prerequisite: pracht inspect needs a vite config with the pracht plugin wired up.

For dynamic-segment routes, ask the user once for example params (or skip with a note in the report).

Step 4: Generate the audit script

scripts/audit-a11y.ts:

import { chromium } from "playwright";
import AxeBuilder from "@axe-core/playwright";

const BASE = process.env.BASE_URL ?? "http://localhost:3000";
const ROUTES: string[] = [/* injected from pracht inspect routes */];

const browser = await chromium.launch();
const context = await browser.newContext();
const page = await context.newPage();

const results = [];
for (const path of ROUTES) {
  await page.goto(`${BASE}${path}`, { waitUntil: "networkidle" });
  const axe = await new AxeBuilder({ page })
    .withTags(["wcag2a", "wcag2aa", "wcag21aa", "best-practice"])
    .analyze();
  results.push({ path, violations: axe.violations });
}

await browser.close();
console.log(JSON.stringify(results, null, 2));

Step 5: Run and aggregate

pnpm exec tsx scripts/audit-a11y.ts > a11y-report.json

Then stop the background server from Step 1.

Aggregate by:

  • Per-route summary: violation count, worst severity.
  • Per-rule summary: which rule fires most across the app — usually reveals a single component (header, footer, form) that authors every page.

Step 6: Report

Report findings with a primary severity of error / warn / info, mapping axe impacts: critical + serious → error, moderate → warn, minor → info. Keep the raw axe impact as a secondary column.

## Per-route summary

| Route       | Critical | Serious | Moderate | Minor |
| ----------- | -------- | ------- | -------- | ----- |
| /           | 0        | 1       | 2        | 0     |

## Per-rule summary (top offenders)

- `color-contrast` — 12 violations across 8 routes
  → Likely source: shared Button component (src/components/Button.tsx)
- `image-alt` — 5 violations across 3 routes
  → Likely source: <img> in shells/marketing.tsx

## Detail

[per-route violations with selectors and help URLs]

Step 7: Targeted fixes

For the top 3 issues, propose concrete patches:

  • color-contrast → suggest tokenized color pairs from existing CSS vars.
  • image-alt → list every <img> missing alt and propose either a description or alt="" (decorative).
  • landmark-one-main → confirm shells render exactly one <main> element.
  • label → list inputs without associated <label> and propose htmlFor/for or wrapping pattern.

Rules

  1. Run against the production build/runtime if at all possible — minified production markup is what real users hit.
  2. axe with WCAG 2.1 AA + best-practice tags is the default; ask before downgrading.
  3. Aggregate by rule before per-route — the same component is usually responsible for most violations.
  4. Do not auto-fix. Suggest, then let the user review per component.
  5. For SPA routes that need interaction before content appears, ask the user for a setup hook (e.g., a script that logs in and lands on the dashboard).
  6. Always clean up background servers you started, even when the audit fails partway.
  7. axe sees one page at a time, not what happens between pages. The client router moves focus to the new page and announces its title or first <h1> after each navigation. If vite.config.ts sets client: { accessibleNavigation: false }, report that the app must do both itself, and check that it does.

$ARGUMENTS

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.