Documentation menuManual checklist
Manual checklist
Work through the WCAG 2.2 A/AA success criteria that automated tests cannot cover.
Automated rules find only part of the barriers. @weber-development/surjection-checklist guides the manual part: the 55 success criteria of WCAG 2.2 level A and AA, each with a short instruction in English and German.
npx surjection-checklist init --project "Muster AG"
npx surjection-checklist apply --checklist checklist.json --results a11y.json
npx surjection-checklist edit --checklist checklist.json --locale de --out checklist.html
npx surjection-checklist status --checklist checklist.json
Commands
| Command | What it does |
|---|---|
init | Creates checklist.json for a project (--level A or AA, default AA) |
apply | Marks criteria with automated findings as failed. It never marks a criterion as passed, because automated rules cover only part of it |
edit | Writes a self-contained HTML page. Set each criterion to passed, failed or not applicable, add notes, then download the updated checklist.json |
status | Prints how many criteria are untested, passed, failed and not applicable |
markdown | Writes the checklist as Markdown |
statement | Writes the conformance status and known issues for the accessibility statement |
The editor saves your progress in the browser until you download the file. It works offline and sends nothing anywhere.
Into the statement and the report
npx surjection-checklist statement --checklist checklist.json --locale de --out statement-fields.json
Merge the fields into your statement config and run surjection statement. Pass the checklist to the report with --checklist to include it as a section.
statement refuses to run while criteria are still untested. The status is "fully conformant" only when no criterion failed, and every failed criterion becomes a known issue (your note, or the criterion title). Whether the result holds remains your judgement as the tester.