eaa-kit 0.9.0 → 0.11.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (106) hide show
  1. package/README.md +174 -149
  2. package/dist/astro/index.d.ts +1 -3
  3. package/dist/astro/index.js +2 -3
  4. package/dist/audit/runners/worker.js +2 -3
  5. package/dist/{audit-J2jeLo-y.js → audit-DbqNIrt6.js} +61 -35
  6. package/dist/audit-rUhqnm3o.js +1 -0
  7. package/dist/{baseline-DrFh7joZ.js → baseline-CKElWbx4.js} +4 -5
  8. package/dist/baseline-DU0EPiTq.js +1 -0
  9. package/dist/baseline-DYOejLFO.js +1 -0
  10. package/dist/{baseline-wyJsSIFQ.js → baseline-DvdsFTQy.js} +5 -6
  11. package/dist/{cache-D4dOIuOi.js → cache-DIV4G0TI.js} +24 -5
  12. package/dist/{checklist-Gx2g3LFC.js → checklist-CA0Ri71Z.js} +7 -8
  13. package/dist/cli/index.js +52 -35
  14. package/dist/{collect-BJYk7_pJ.js → collect-CjucwTEF.js} +16 -8
  15. package/dist/{command-BGGMf4vn.js → command-C8ZFvcc1.js} +6 -9
  16. package/dist/completeness-Cg-XIKWN.js +1 -0
  17. package/dist/completeness-Dzyvgr4Z.js +72 -0
  18. package/dist/component-CgbeRgJa.js +1 -0
  19. package/dist/{component-ChisoFyY.js → component-ZLd8DA_a.js} +3 -4
  20. package/dist/{countries-Dg0BdytB.js → countries-B_PE6r5R.js} +42 -18
  21. package/dist/{countries-DRTBubeE.js → countries-CCqog6dy.js} +10 -7
  22. package/dist/coverage-B9_6yv_8.js +2 -0
  23. package/dist/{coverage-zdzgSKjz.js → coverage-C1Z6t9Ct.js} +5 -7
  24. package/dist/{crawl-DwdqiljK.js → crawl-CkHJJV4w.js} +131 -23
  25. package/dist/{criteria-CnPJKGeb.js → criteria-CacF0HP1.js} +1 -2
  26. package/dist/{define-Ctf2uOEh.js → define-BdTPIfqE.js} +5 -5
  27. package/dist/detect-DnFHXpWh.js +49 -0
  28. package/dist/detect-oLDadgee.js +160 -0
  29. package/dist/doctor-q8IebwAb.js +248 -0
  30. package/dist/eleventy/index.d.ts +1 -3
  31. package/dist/eleventy/index.js +2 -3
  32. package/dist/{entry-CjqjrUBY.js → entry-kf94P140.js} +1 -2
  33. package/dist/{fingerprint-BjYV_0F7.js → fingerprint-CcoQ1WxQ.js} +1 -2
  34. package/dist/{frameworks-B4ClIJgE.js → frameworks-BboC8eNk.js} +234 -28
  35. package/dist/frameworks-Y-n3NUuG.js +1 -0
  36. package/dist/{fs-BmPtmFke.js → fs-tPD5r0wY.js} +1 -2
  37. package/dist/hosts-B48qR6Vt.js +19 -0
  38. package/dist/{html-whingnfj.js → html-Bjq3Iw3g.js} +54 -14
  39. package/dist/{impact-luGCnN8F.js → impact-BGlJ6j0Y.js} +1 -2
  40. package/dist/{impact-EEB9ZXmC.d.ts → impact-CZjUloYC.d.ts} +0 -2
  41. package/dist/index.d.ts +10 -23
  42. package/dist/index.js +3 -3
  43. package/dist/{init-CPbFVMuk.js → init-3Ti3ao5Z.js} +65 -126
  44. package/dist/issues-WLlepU95.js +120 -0
  45. package/dist/{jsdom-CsW_xVcA.js → jsdom-C4pLIMyP.js} +2 -3
  46. package/dist/jsdom-Zle--VQ1.js +2 -0
  47. package/dist/{json-SGCgxSPT.js → json-B_k4CDmR.js} +5 -6
  48. package/dist/json-IL1JxlTL.js +1 -0
  49. package/dist/{load-CH-ltdlq.js → load-C3eFEdoH.js} +3 -4
  50. package/dist/load-oQQJPNlV.js +1 -0
  51. package/dist/markdown-D-QpPYsz.js +138 -0
  52. package/dist/next-8zDgH0nP.js +119 -0
  53. package/dist/nuxt/index.d.ts +1 -3
  54. package/dist/nuxt/index.js +2 -3
  55. package/dist/{pages-DxY5Z0gl.js → pages-CCP1WfYe.js} +80 -17
  56. package/dist/{playwright-ukCr_5o3.js → playwright-ky4b_HME.js} +98 -16
  57. package/dist/{pool-B4tEUa2S.js → pool-B3XKdk57.js} +4 -5
  58. package/dist/project-B21NT_aX.js +502 -0
  59. package/dist/project-Dht13sb1.js +1 -0
  60. package/dist/{remediation-Bbs4KcX1.js → remediation-BkE7q7dT.js} +2 -193
  61. package/dist/{render-C6zYfaba.js → render-ky8cm4QF.js} +22 -20
  62. package/dist/result-DhoT4g0P.js +1 -0
  63. package/dist/{result-B7_zVxAX.js → result-g8dGsrcv.js} +1 -2
  64. package/dist/{review-Bz0fO9_I.js → review-BGjTBFvd.js} +2 -3
  65. package/dist/review-iheEjp7_.js +1 -0
  66. package/dist/{routes-CSctpS1P.js → routes-BpQeBDmM.js} +4 -5
  67. package/dist/{run-DzVEOkiF.js → run-D7tc7IU2.js} +2 -3
  68. package/dist/{run-BK2blxMI.d.ts → run-VXnP4uLp.d.ts} +2 -6
  69. package/dist/{sarif-9BAgNiOa.js → sarif-v66-PjdE.js} +7 -8
  70. package/dist/{schema-DJSF4K05.js → schema-DfC-Ww1w.js} +1 -2
  71. package/dist/setup-BYlqHlo0.js +2 -0
  72. package/dist/setup-Cf82ONw0.js +353 -0
  73. package/dist/shell-BdQYTaBQ.js +89 -0
  74. package/dist/{site-BHMtf3q2.js → site-CxVyh8IO.js} +1 -2
  75. package/dist/{start-DzOM0p6I.js → start-bdanSxZr.js} +9 -10
  76. package/dist/statement/templates/cz.cs.md +2 -1
  77. package/dist/statement/templates/cz.en.md +2 -1
  78. package/dist/statement/templates/dk.da.md +3 -2
  79. package/dist/statement/templates/dk.en.md +4 -3
  80. package/dist/statement/templates/pt.en.md +3 -2
  81. package/dist/statement/templates/pt.pt.md +3 -3
  82. package/dist/statement/templates/se.en.md +9 -0
  83. package/dist/statement/templates/se.sv.md +8 -0
  84. package/dist/{text-BF1LHMiV.js → text-CISDPU49.js} +11 -3
  85. package/dist/{version-B3v4rNoG.js → version-C8aJm8YJ.js} +1 -2
  86. package/dist/vite/index.d.ts +1 -3
  87. package/dist/vite/index.js +2 -3
  88. package/dist/{watch-B2RoUbo0.js → watch-CefxwMsZ.js} +3 -4
  89. package/dist/webpack/index.d.ts +1 -3
  90. package/dist/webpack/index.js +2 -3
  91. package/dist/{worksheet-B_kQ1pxq.js → worksheet-CcBo9G7s.js} +4 -5
  92. package/dist/workspaces-BBFXOyeV.js +85 -0
  93. package/package.json +15 -13
  94. package/dist/audit-CJDCQaFY.js +0 -2
  95. package/dist/baseline-477B1CZ_.js +0 -2
  96. package/dist/baseline-D9ihb-wk.js +0 -2
  97. package/dist/component-DcCn3BJS.js +0 -2
  98. package/dist/coverage-GvaMpV64.js +0 -3
  99. package/dist/frameworks-etFg_O8K.js +0 -2
  100. package/dist/jsdom-BUYuVJJm.js +0 -3
  101. package/dist/json-CyLmvF5P.js +0 -2
  102. package/dist/load-D7lBeOsq.js +0 -2
  103. package/dist/project-BLFdCbOq.js +0 -2
  104. package/dist/project-v2PoRw70.js +0 -291
  105. package/dist/result-CRmjjoAA.js +0 -2
  106. package/dist/review-a-2ghjQ5.js +0 -2
package/README.md CHANGED
@@ -2,52 +2,30 @@
2
2
 
3
3
  [![CI](https://github.com/likeBloodMoon/eaa-kit/actions/workflows/ci.yml/badge.svg)](https://github.com/likeBloodMoon/eaa-kit/actions/workflows/ci.yml)
4
4
 
5
- Build-time WCAG 2.2 AA auditor and EU accessibility statement generator for static sites,
6
- built for the freelancers and small agencies who have to comply with the European
7
- Accessibility Act (in force since 28 June 2025) without an accessibility budget. It started
8
- in the DACH region — the BFSG in Germany, the BaFG in Austria — and the statement now names
9
- the statute and supervisory body of **fifteen countries**: Austria, Belgium, Czechia,
10
- Denmark, Finland, France, Germany, Ireland, Italy, the Netherlands, Poland, Portugal,
11
- Spain, Sweden and Switzerland, each in its own language as well as English.
12
-
13
- 0.9.0 needs no setup. `npx eaa-kit` on its own finds the site, audits it, writes an HTML
14
- report and says which command comes next. `init` fills itself in from what the built site
15
- states, and also writes a baseline and a GitHub Actions workflow tailored to the project.
16
- Every error a new user is likely to hit ends with the command to type next. A `--url` run
17
- checks where the address leads before it crawls: a redirect to another site is shown and
18
- needs a yes (or `--redirects follow`), and a sign-in wall stops the run instead of being
19
- audited as the site. `audit --watch` re-checks the build on every save, and eight countries
20
- join the statement. Their citations were established from secondary sources and are marked
21
- as such in `eaa-kit countries` and the docs until they are checked against the primary
22
- text.
23
-
24
- 0.7.0 made a run cost what it should. A page that has not changed byte for byte is not
25
- audited again, and a run with nothing to re-audit never loads an engine at all: twenty
26
- pages go from ~2,520 ms to ~230 ms, which is about what starting the process costs. A
27
- reused result is never passed off as a fresh one — every report says how much was reused
28
- and from when, and `diff` will not call a page fixed that this run did not look at. The
29
- statement now also says how many of WCAG's 55 criteria a person checked by hand, and
30
- `pnpm bench` prints the numbers in this paragraph for your own machine.
31
-
32
- 0.6.0 added the half no engine can do. Of the 55 WCAG 2.2 A and AA success criteria, 34
33
- have no automated rule at all: `checklist` writes those down as a review somebody works
34
- through, `audit --review` reads the answers back beside what the run measured, and
35
- `statement` refuses to publish a claim of full conformance that either one contradicts.
36
- Sites behind a login or a preview protection are auditable too.
5
+ eaa-kit checks a website against WCAG 2.2 AA and writes the accessibility statement the
6
+ European Accessibility Act asks for. It is meant for freelancers and small agencies, who
7
+ have had to comply since 28 June 2025 and rarely have an accessibility budget.
8
+
9
+ It started with the German BFSG and the Austrian BaFG. The statement now covers fifteen
10
+ countries: Austria, Belgium, Czechia, Denmark, Finland, France, Germany, Ireland, Italy,
11
+ the Netherlands, Poland, Portugal, Spain, Sweden and Switzerland. Each is written in the
12
+ country's own language as well as English, and names its statute and supervisory body.
37
13
 
38
14
  ```bash
39
15
  npx eaa-kit # nothing to set up: finds your site, audits it, writes a report
40
16
  npx eaa-kit audit # WCAG 2.2 AA report; finds your build itself
41
17
  npx eaa-kit diff a.json b.json # what a change made worse, and what it fixed
42
- npx eaa-kit init # the config, a baseline and a CI workflow
18
+ npx eaa-kit init # the config, a baseline and a CI pipeline
43
19
  npx eaa-kit statement # accessibility statement, in one of fifteen countries
44
20
  npx eaa-kit countries # which ones, in which languages, under which law
45
21
  npx eaa-kit checklist # the manual review no engine can do for you
22
+ npx eaa-kit detect # what it makes of this project, and why
23
+ npx eaa-kit doctor # everything it needs here, checked on one screen
46
24
  ```
47
25
 
48
26
  > **Not legal advice.** eaa-kit reports what an automated engine can and cannot determine
49
- > about your markup. Automated testing catches a minority of accessibility barriers; it is
50
- > a floor, not a certificate.
27
+ > about your markup. Automated testing catches a minority of accessibility barriers, so a
28
+ > clean run is a starting point and never a certificate.
51
29
 
52
30
  ## Install
53
31
 
@@ -55,116 +33,185 @@ npx eaa-kit checklist # the manual review no engine can do for you
55
33
  pnpm add -D eaa-kit # npm i -D eaa-kit
56
34
  ```
57
35
 
58
- Node 22.22, 24.15 or 26 and newer. jsdom, which the browserless engine is built on,
59
- supports only the even-numbered release lines, so the odd-numbered ones (23, 25) are not
60
- supported here either.
36
+ You need Node 22.22, 24.15, or 26 or newer. The odd-numbered lines (23, 25) are not
37
+ supported, because jsdom, which the browserless engine is built on, supports only the
38
+ even-numbered ones.
39
+
40
+ ## New in 0.11
41
+
42
+ - `--format markdown` writes a short summary for a CI job page or a pull request comment,
43
+ and `--summary <path>` writes it beside another format. The GitHub Action puts it on the
44
+ job page by default.
45
+ - `init` writes a GitLab CI job or a Bitbucket pipeline when the repository lives there,
46
+ as well as the GitHub Actions workflow it wrote before.
47
+ - From 1 January 2027, Swedish statements name Digitaliseringsmyndigheten instead of PTS.
48
+ The switch follows the date the statement is generated on, whichever version is
49
+ installed.
50
+ - The HTML report prints cleanly, and with a baseline it says what changed since then.
51
+ - Credentials given with `--header` or `--basic-auth` now go only to the audited site.
52
+ Before, a redirect to another host, or that site's own third-party assets in browser
53
+ mode, could receive them too.
54
+
55
+ The [changelog](CHANGELOG.md) has the rest, and every earlier release.
61
56
 
62
- ## What it does
57
+ ## Auditing
63
58
 
64
- **Audits your build.** Globs the HTML out of `./dist`, parses it with jsdom and runs
65
- axe-core against it. No Chromium download, fast enough for CI, and it never fetches
66
- anything or executes your site's JavaScript. `--browser` swaps in real Chromium for the
67
- rules that need layout and CSS; `--fast` goes the other way and skips the rules the
68
- browserless engine cannot decide anyway, rather than running them and discarding the
69
- answer.
59
+ eaa-kit collects the HTML in your build output, parses it with jsdom and runs axe-core on
60
+ it. It downloads no browser, it is fast enough for CI, and it never fetches anything or
61
+ runs your site's JavaScript. `--browser` uses real Chromium instead, for the rules that need
62
+ layout and CSS. `--fast` skips the rules the browserless engine cannot decide anyway,
63
+ instead of running them and throwing the answer away.
70
64
 
71
65
  ```bash
72
66
  eaa-kit audit ./dist --fail-on serious
73
67
  ```
74
68
 
75
- Sites that render on a server and never write HTML to disk — Next.js without a static
76
- export, Nuxt, SvelteKit, anything behind a CMS — are audited running instead:
69
+ It recognises forty-one stacks, from Next.js, Astro and Nuxt to Qwik, MkDocs and Zola, and
70
+ finds the sites in a monorepo from its root. A site that renders on a server and never
71
+ writes HTML to disk, such as Next.js without a static export, Nuxt or SvelteKit, is built,
72
+ started and crawled when you run `eaa-kit audit` with no directory. A Next.js app is
73
+ audited page by page from its own build manifests, so pages nothing links to are covered
74
+ too. A single-page app's empty shell is reported as not audited, instead of passing.
75
+
76
+ A site behind a CMS is never started for you. Start it yourself and audit it while it runs.
77
+ WordPress, TYPO3, Craft, Laravel, Symfony, Rails and Django write no HTML to disk, so
78
+ eaa-kit tells you the command that gets the site running, and follows the site's own
79
+ sitemap wherever it keeps it:
77
80
 
78
81
  ```bash
79
82
  eaa-kit audit --url http://localhost:3000
83
+ eaa-kit audit --url http://localhost:8000 --sitemap /sitemap_index.xml
80
84
  ```
81
85
 
82
- **Writes the statement.** A Barrierefreiheitserklärung, a déclaration d'accessibilité, a
83
- dichiarazione di accessibilità — whatever the country calls it — from one config file, as
84
- Markdown or HTML, naming that country's statute and supervisory body, and optionally
85
- listing the barriers a real audit found.
86
+ Before it crawls, a `--url` run checks where the address leads. A redirect to another site
87
+ needs your confirmation (or `--redirects follow`), and a sign-in page stops the run instead
88
+ of being audited as if it were the site.
89
+
90
+ A preview deployment or a staging CMS refuses anonymous requests. `--basic-auth` and a
91
+ repeatable `--header` get past that, both when crawling and in the browser. The
92
+ credentials go to the audited site and nowhere else. They are never written into a report,
93
+ a baseline or a SARIF log, and `eaa.config` does not accept them, because it is a committed
94
+ file.
86
95
 
87
96
  ```bash
88
- eaa-kit statement --output src/content/a11y.md
89
- eaa-kit statement --country PL --lang pl # eaa-kit countries lists all fifteen
97
+ eaa-kit audit --url https://preview.example.com --basic-auth user:password
98
+ ```
99
+
100
+ ### What it tells you to do
101
+
102
+ Each finding says who the barrier stops, what to change, and gives the corrected form of
103
+ your own markup, in your framework's idiom where that differs. The advice is written into
104
+ the tool, so it works offline and needs no model or API key, and it cannot invent a fix
105
+ that looks right and is wrong.
106
+
107
+ ```
108
+ ✗ image-alt critical, WCAG 1.1.1
109
+ A screen reader announces this image by its filename, or skips it entirely.
110
+ Fix: Add alt text describing what the image conveys…
111
+ → <img src="/assets/logo.svg" alt="What this image shows">
112
+ written in src/components/Header.astro:12
90
113
  ```
91
114
 
92
- Each country's statement is a document under its own law rather than a translation of
93
- another's, so where a national regime asks for more than this — France's RGAA declaration,
94
- Italy's filing with AgID — the text says so instead of letting a generated file look like
95
- it settles the matter.
115
+ ### Failing only on what is new
96
116
 
97
- **Fails only on what is new.** The first run on a site that already exists finds
98
- everything at once. A baseline records what is already wrong so the build fails on
99
- regressions instead, without ever letting an accepted barrier look like a passing one.
117
+ The first run on an existing site finds everything at once. A baseline records what is
118
+ already wrong, so the build fails on regressions instead. An accepted barrier is still
119
+ reported as a barrier, and never as a pass.
100
120
 
101
121
  ```bash
102
122
  eaa-kit baseline ./dist
103
123
  eaa-kit audit ./dist --baseline eaa-baseline.json
104
124
  ```
105
125
 
106
- **Says what a change did.** Two reports, and the difference between them: what is new, what
107
- was fixed, and what the later run never looked at — which is kept apart, because a
108
- violation missing from a run that stopped early was not fixed by anybody.
126
+ `diff` compares two reports: what is new, what was fixed, and what the later run never
127
+ looked at. That last group is kept apart, because a violation missing from a run that
128
+ stopped early was not fixed by anybody.
109
129
 
110
130
  ```bash
111
131
  eaa-kit diff before.json after.json
112
132
  ```
113
133
 
114
- **Says what to do about it.** Not "images must have alternative text" and a link — who the
115
- barrier stops, what to change, and the corrected form of *your* markup, in your framework's
116
- idiom where that differs. Deterministic and offline: no model, no API key, nothing that
117
- could invent a fix that looks right and is not.
134
+ ### Only what changed, and while you work
135
+
136
+ A page whose markup has not changed byte for byte since the last run keeps the result it
137
+ already had, and a run with nothing to re-audit never loads an engine. Twenty pages take
138
+ about 230 ms instead of about 2,520 ms, which is roughly what starting the process costs.
139
+ Every report counts reused results apart from fresh ones, and `diff` will not call a page
140
+ fixed that this run did not look at. `--no-cache` audits everything. `pnpm bench` measures
141
+ these numbers on your own machine.
142
+
143
+ `--watch` audits again every time the build changes. With the cache, only the pages you
144
+ touched are audited again, so the report is usually ready by the time you switch windows.
118
145
 
146
+ ```bash
147
+ eaa-kit audit ./dist --watch
119
148
  ```
120
- ✗ image-alt critical, WCAG 1.1.1
121
- A screen reader announces this image by its filename, or skips it entirely.
122
- Fix: Add alt text describing what the image conveys…
123
- → <img src="/assets/logo.svg" alt="What this image shows">
124
- written in src/components/Header.astro:12
149
+
150
+ ### Reports
151
+
152
+ There are five formats. The console report is for whoever ran the command, JSON is for
153
+ other tools, SARIF is for GitHub code scanning, and Markdown is a short summary for a CI job
154
+ or a pull request. The HTML report is a single file you can send to the client whose site it
155
+ is, and it prints or saves as a PDF.
156
+
157
+ A run that stopped at its page limit, or could not fetch some URLs, says so. Its report does
158
+ not look like a complete one.
159
+
160
+ ## The statement
161
+
162
+ eaa-kit writes the statement from one config file, as Markdown or HTML: a
163
+ Barrierefreiheitserklärung, a déclaration d'accessibilité, a dichiarazione di
164
+ accessibilità, or whatever the country calls it. It names the country's statute and
165
+ supervisory body, and can list the barriers an audit found.
166
+
167
+ ```bash
168
+ eaa-kit statement --output src/content/a11y.md
169
+ eaa-kit statement --country PL --lang pl # eaa-kit countries lists all fifteen
125
170
  ```
126
171
 
127
- **Records the part no engine can do.** 34 of the 55 criteria have no automated rule at
128
- all. `eaa-kit checklist` writes them out as a worksheet and a record; `audit --review`
129
- reads the record back and reports what a person checked *beside* what the run measured,
130
- never folded into it. A review never overrules the engine, never counts an entry nobody
131
- answered, and never counts one that has aged out.
172
+ Each country's statement is written under its own law, not translated from another
173
+ country's. Where a national regime asks for more, such as France's RGAA declaration or
174
+ Italy's filing with AgID, the text says so.
175
+
176
+ When the law has already scheduled a change of supervisor, the statement follows the date
177
+ it is generated on. `--date` previews either side:
132
178
 
133
179
  ```bash
134
- eaa-kit checklist --output a11y-review.md
135
- eaa-kit audit --review eaa-review.json --coverage
180
+ eaa-kit statement --country SE --lang sv --date 2027-01-01
136
181
  ```
137
182
 
138
- **Says how much of WCAG it could reach.** WCAG 2.2 has 55 success criteria at Levels A and
139
- AA. This tool has rules for 21 of them, and 34 need a person. Every run says so, and
140
- `--coverage` lists all 55 with what this run reached on each — never as a percentage,
141
- because most of WCAG cannot be automated and a score would present that as a fact about
142
- your site.
183
+ The statement says what you told it, and eaa-kit cannot check whether that is true. A
184
+ statement claiming full conformance for a site that does not conform is worse than none, so
185
+ given evidence it refuses to write one: `statement --audit` will not claim full
186
+ conformance over a report that lists barriers, and `--review` will not claim it over
187
+ criteria somebody recorded as not met.
143
188
 
144
- **Says what it did not measure.** A crawl that stopped at its page limit, or could not
145
- fetch forty URLs, no longer produces a report that looks like a complete one.
189
+ ## The part no engine can do
146
190
 
147
- **Keeps up while you work.** `--watch` audits again every time the build changes. Because
148
- of the cache below, only the pages you touched are audited again, so the report is ready
149
- by the time you switch windows.
191
+ WCAG 2.2 has 55 success criteria at Levels A and AA. This tool has rules for 21 of them,
192
+ and the other 34 need a person. Every run says so, and `--coverage` lists all 55 with what
193
+ the run reached on each. There is no percentage, because most of WCAG cannot be automated
194
+ and a score would present that as a fact about your site.
195
+
196
+ `eaa-kit checklist` writes the 34 out as a worksheet and a record. `audit --review` reads
197
+ the record back and reports what a person checked next to what the run measured, without
198
+ mixing the two. A review never overrules the engine, and it never counts an entry nobody
199
+ answered or one that has aged out.
150
200
 
151
201
  ```bash
152
- eaa-kit audit ./dist --watch
202
+ eaa-kit checklist --output a11y-review.md
203
+ eaa-kit audit --review eaa-review.json --coverage
153
204
  ```
154
205
 
155
- **Audits only what changed.** A page whose markup is byte-identical to the last run's keeps
156
- the result it already had, and a run with nothing to re-audit never loads an engine —
157
- twenty pages in ~230 ms instead of ~2,520 ms, which is about what starting the process
158
- costs. Reuse is counted apart from auditing in all four reports, and `diff` will not call a
159
- page fixed that this run did not look at. `--no-cache` audits everything regardless.
206
+ ## Setting it up
160
207
 
161
- **Reports in four shapes**: a console report for whoever ran it, JSON for other tools,
162
- SARIF for GitHub code scanning, and a self-contained HTML page for the client whose site
163
- it is.
208
+ `eaa-kit init` asks the few things it cannot work out, fills in the rest from what the built
209
+ site states, and writes the config. It then offers a baseline and a CI pipeline written for
210
+ the project: a GitHub Actions workflow, a GitLab CI job or a Bitbucket pipeline, depending on
211
+ where the repository is hosted. It never overwrites a pipeline file that is already there.
164
212
 
165
- **Says it once.** The flags a project runs on every build belong in the project, not in the
166
- build script that repeats them. `eaa.config` — the same file the statement reads — takes an
167
- [`audit` block](docs/audit.md#defaults-from-eaaconfig) of defaults, and `baseline` reads the
213
+ Flags you would repeat on every run can go in `eaa.config`, the same file the statement
214
+ reads, as an [`audit` block](docs/audit.md#defaults-from-eaaconfig). `baseline` reads the
168
215
  keys that mean the same thing to it. A flag you type still wins, so a one-off `--browser`
169
216
  check needs no edit to a committed file.
170
217
 
@@ -172,31 +219,14 @@ check needs no edit to a committed file.
172
219
  { "audit": { "dir": "build", "failOn": "critical", "browser": true } }
173
220
  ```
174
221
 
175
- **Runs in your build**: a [Vite plugin](docs/integrations.md#vite-plugin) covering SvelteKit
176
- and Remix too, and integrations for
222
+ It also runs inside your build: a [Vite plugin](docs/integrations.md#vite-plugin) that
223
+ covers SvelteKit and Remix as well, integrations for
177
224
  [Astro](docs/integrations.md#astro-integration),
178
225
  [Nuxt](docs/integrations.md#nuxt-module),
179
226
  [Eleventy](docs/integrations.md#eleventy-plugin) and
180
- [webpack](docs/integrations.md#webpack-plugin) — or the bundled
181
- [GitHub Action](docs/integrations.md#github-actions).
182
-
183
- **Audits what a CMS serves.** WordPress, TYPO3, Craft, Laravel, Symfony, Rails and Django
184
- write no HTML to disk, so eaa-kit names the command that gets the site running and audits
185
- that instead — following the site's own sitemap, wherever it keeps it.
186
-
187
- ```bash
188
- eaa-kit audit --url http://localhost:8000 --sitemap /sitemap_index.xml
189
- ```
190
-
191
- **Reaches a site behind a login.** A preview deployment or a staging CMS refuses anonymous
192
- requests, which used to put both out of reach. `--basic-auth` and a repeatable `--header`
193
- cover them, on the crawl and in the browser, and the credentials are never written into a
194
- report, a baseline or a SARIF log — nor accepted from `eaa.config`, which is a committed
195
- file.
196
-
197
- ```bash
198
- eaa-kit audit --url https://preview.example.com --basic-auth user:password
199
- ```
227
+ [webpack](docs/integrations.md#webpack-plugin), and the bundled
228
+ [GitHub Action](docs/integrations.md#github-actions). GitLab and Bitbucket have
229
+ [pipelines of their own](docs/integrations.md#gitlab-ci).
200
230
 
201
231
  ## Documentation
202
232
 
@@ -209,41 +239,36 @@ eaa-kit audit --url https://preview.example.com --basic-auth user:password
209
239
  | [Comparing two runs](docs/reports.md#comparing-two-runs) | The `diff` command, and what it refuses to call fixed |
210
240
  | [Coverage of WCAG](docs/audit.md#how-much-of-wcag-a-run-reaches) | What an automated engine can reach at all, and what it cannot |
211
241
  | [Recording a manual review](docs/review.md) | The `checklist` command, the record, and what a review is not allowed to do |
212
- | [Report formats](docs/reports.md) | The JSON contract, SARIF, and the HTML report |
213
- | [Integrations](docs/integrations.md) | The build plugins, the GitHub Action, and the two builders that get a command instead |
214
-
215
- Complete generated output for every format is checked in under [examples/](examples).
242
+ | [Report formats](docs/reports.md) | The JSON contract, SARIF, the Markdown summary and the HTML report |
243
+ | [Integrations](docs/integrations.md) | The build plugins, the GitHub Action, GitLab CI and Bitbucket Pipelines |
216
244
 
217
- ## What it will not tell you
245
+ Generated output for every format is checked in under [examples/](examples).
218
246
 
219
- The two things worth knowing before you rely on any of it:
247
+ ## What it cannot tell you
220
248
 
221
- **Automated testing finds a minority of barriers.** It cannot judge whether alternative
222
- text is accurate, whether a page makes sense in reading order, or whether a form can
223
- actually be completed with a screen reader. A clean report means nothing was found by this
224
- engine, which is not the same as a site being accessible — and none of the four output
225
- formats will say otherwise on your behalf. This is not a disclaimer the tool leaves you to
226
- take on faith: it counts it. Of the 55 WCAG 2.2 A and AA criteria, 34 have no automated
227
- rule at all, and every report says so.
249
+ Automated testing finds a minority of barriers. It cannot judge whether alternative text is
250
+ accurate, whether a page makes sense in reading order, or whether a form can actually be
251
+ completed with a screen reader. A clean report means this engine found nothing, which is
252
+ different from the site being accessible, and none of the formats will claim otherwise on
253
+ your behalf. Every report also counts the 34 criteria no automated rule covers.
228
254
 
229
- **The browserless engine cannot decide everything.** jsdom has no layout, so rules that
230
- depend on rendering — colour contrast, target size, computed overflow — cannot be
231
- evaluated. axe-core does not know that and will report some of them as *passing*. eaa-kit
232
- never passes those on: they are reported as **not evaluated**, with the reason, whatever
233
- axe-core said about them. See [what the browserless engine can and cannot tell
255
+ The browserless engine cannot decide everything either. jsdom has no layout, so rules that
256
+ depend on rendering, such as colour contrast, target size and computed overflow, cannot be
257
+ evaluated. axe-core does not know that, and reports some of them as passing. eaa-kit reports
258
+ them as not evaluated, with the reason, whatever axe-core said. See [what the browserless
259
+ engine can and cannot tell
234
260
  you](docs/audit.md#what-the-browserless-engine-can-and-cannot-tell-you).
235
261
 
236
- The same applies to the statement: it says what you told it. eaa-kit cannot check whether
237
- those claims are true, and a statement claiming full conformance for a site that is not
238
- conformant is worse than no statement at all — which is why, given evidence, it now refuses
239
- to write that particular one. `statement --audit` will not claim full conformance over a
240
- report listing barriers, and `--review` will not claim it over criteria somebody recorded as
241
- not met.
262
+ ## Contributing and security
263
+
264
+ [CONTRIBUTING.md](CONTRIBUTING.md) covers setting up the repository and what a change needs
265
+ before it is merged. To report a vulnerability, follow [SECURITY.md](SECURITY.md) rather than
266
+ opening a public issue.
242
267
 
243
268
  ## Changelog
244
269
 
245
- See [CHANGELOG.md](CHANGELOG.md), and [ROADMAP.md](ROADMAP.md) for what 0.6.0 is meant to
246
- add and what it deliberately will not.
270
+ See [CHANGELOG.md](CHANGELOG.md) for every release, and [ROADMAP.md](ROADMAP.md) for what
271
+ is planned on the way to 1.0 and what will deliberately stay out.
247
272
 
248
273
  ## License
249
274
 
@@ -1,5 +1,4 @@
1
- import { n as IntegrationOptions } from "../run-BK2blxMI.js";
2
- //#region src/astro/index.d.ts
1
+ import { n as IntegrationOptions } from "../run-VXnP4uLp.js";
3
2
  /**
4
3
  * An Astro integration that audits the build Astro just produced.
5
4
  *
@@ -50,5 +49,4 @@ declare class AstroAuditError extends Error {
50
49
  * and `baseline` is the answer after that.
51
50
  */
52
51
  declare function eaaKit(options?: EaaKitIntegrationOptions): AstroIntegrationLike;
53
- //#endregion
54
52
  export { AstroAuditError, AstroIntegrationLike, AstroLoggerLike, BuildDoneOptions, EaaKitIntegrationOptions, eaaKit as default };
@@ -1,6 +1,6 @@
1
- import { n as auditBuild, t as BuildAuditError } from "../run-DzVEOkiF.js";
1
+ import { n as auditBuild, t as BuildAuditError } from "../run-D7tc7IU2.js";
2
2
  import { fileURLToPath } from "node:url";
3
- //#region src/astro/index.ts
3
+ // src/astro/index.ts
4
4
  var AstroAuditError = class extends Error {
5
5
  name = "AstroAuditError";
6
6
  };
@@ -24,5 +24,4 @@ function eaaKit(options = {}) {
24
24
  } }
25
25
  };
26
26
  }
27
- //#endregion
28
27
  export { AstroAuditError, eaaKit as default };
@@ -1,7 +1,7 @@
1
- import { t as auditPage } from "../../jsdom-CsW_xVcA.js";
1
+ import { t as auditPage } from "../../jsdom-C4pLIMyP.js";
2
2
  import { enableCompileCache } from "node:module";
3
3
  import { parentPort, workerData } from "node:worker_threads";
4
- //#region src/audit/runners/worker.ts
4
+ // src/audit/runners/worker.ts
5
5
  /**
6
6
  * One audit worker: a thread that owns its own jsdom and axe-core, and audits
7
7
  * whatever page the pool hands it.
@@ -27,5 +27,4 @@ const options = workerData ?? {};
27
27
  port.on("message", async (page) => {
28
28
  port.postMessage(await auditPage(page, options));
29
29
  });
30
- //#endregion
31
30
  export {};