Commands
The two commands of the plugin, their arguments and what they write.
/barrierlab:page
/barrierlab:page <url|file> [--base-url <url>] [--width <px>] [--dark]
Audits one page and reports it in four sections. The arguments are passed to barrierlab --json
as given.
| Argument | Meaning |
|---|---|
<url|file> |
The page: a URL or a local HTML file. |
--base-url <url> |
Where linked stylesheets of a local file are resolved. |
--width <px> |
Viewport width the media queries are evaluated for. |
--dark |
Evaluate the dark colour scheme. |
Steps of a run:
- The engine runs and its JSON is stored as
.barrierlab/runs/<UTC timestamp>/report.json. Exit code 0 or 1 is a completed run. Exit code 2 means the page could not be read: the error is shown and no report is written. scripts/digest.pybuilds the frame of the report.- The agent writes below the frame and stores the result as
report.mdnext toreport.json. digest.py --checkverifies the finished report; anything it names as missing is put back.
The command writes only inside .barrierlab/runs/. It proposes changes to the source as diffs and
does not apply them.
/barrierlab:doctor
/barrierlab:doctor
Checks the setup and changes nothing. One line per check, ok, missing or failed, with the
fix:
barrierlabis onPATH.- Findings carry a source position. A binary built against an older rule set prints none;
reinstall it with
cargo install --force --git https://github.com/casoon/barrierlab-cli. python3is available, 3.9 or newer.- The digest runs on the fixture that ships with the plugin.