eaa-kit 0.6.0 → 0.9.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 (97) hide show
  1. package/README.md +52 -15
  2. package/dist/astro/index.d.ts +1 -1
  3. package/dist/astro/index.js +1 -1
  4. package/dist/audit/runners/worker.js +1 -1
  5. package/dist/audit-CJDCQaFY.js +2 -0
  6. package/dist/{audit-e_uixhPG.js → audit-J2jeLo-y.js} +170 -241
  7. package/dist/{baseline-BscHfFSW.js → baseline-477B1CZ_.js} +1 -1
  8. package/dist/baseline-D9ihb-wk.js +2 -0
  9. package/dist/{baseline-D2qWmUC6.js → baseline-DrFh7joZ.js} +15 -4
  10. package/dist/baseline-wyJsSIFQ.js +127 -0
  11. package/dist/cache-D4dOIuOi.js +219 -0
  12. package/dist/{checklist-BtgkxMEa.js → checklist-Gx2g3LFC.js} +6 -6
  13. package/dist/cli/index.js +103 -147
  14. package/dist/{collect-Cu1q9NTB.js → collect-BJYk7_pJ.js} +1 -1
  15. package/dist/{command-CZKp9Wi_.js → command-BGGMf4vn.js} +35 -8
  16. package/dist/countries-DRTBubeE.js +25 -0
  17. package/dist/countries-Dg0BdytB.js +156 -0
  18. package/dist/coverage-GvaMpV64.js +3 -0
  19. package/dist/{coverage-BD2_CYns.js → coverage-zdzgSKjz.js} +4 -286
  20. package/dist/{crawl-BHkJmUkA.js → crawl-DwdqiljK.js} +5 -3
  21. package/dist/criteria-CnPJKGeb.js +286 -0
  22. package/dist/{load-vZdV_fD1.js → define-Ctf2uOEh.js} +47 -95
  23. package/dist/eleventy/index.d.ts +1 -1
  24. package/dist/eleventy/index.js +1 -1
  25. package/dist/entry-CjqjrUBY.js +174 -0
  26. package/dist/{html-Bmh7X_sM.js → html-whingnfj.js} +9 -5
  27. package/dist/index.d.ts +61 -5
  28. package/dist/index.js +3 -2
  29. package/dist/init-CPbFVMuk.js +293 -0
  30. package/dist/jsdom-BUYuVJJm.js +3 -0
  31. package/dist/{jsdom-CQar6OQS.js → jsdom-CsW_xVcA.js} +11 -12
  32. package/dist/{json-HJDgJp09.js → json-CyLmvF5P.js} +1 -1
  33. package/dist/{json-PNg6BeXp.js → json-SGCgxSPT.js} +4 -3
  34. package/dist/load-CH-ltdlq.js +99 -0
  35. package/dist/load-D7lBeOsq.js +2 -0
  36. package/dist/nuxt/index.d.ts +1 -1
  37. package/dist/nuxt/index.js +1 -1
  38. package/dist/pages-DxY5Z0gl.js +300 -0
  39. package/dist/{playwright-C-miJP2b.js → playwright-ukCr_5o3.js} +1 -1
  40. package/dist/{pool-dkexq5xo.js → pool-B4tEUa2S.js} +6 -2
  41. package/dist/{project-MFrXcw1M.js → project-BLFdCbOq.js} +1 -1
  42. package/dist/{project-CzOnkLH6.js → project-v2PoRw70.js} +18 -1
  43. package/dist/{completeness-Dwq3CPB3.js → remediation-Bbs4KcX1.js} +72 -42
  44. package/dist/{render-CtsqR0k-.js → render-C6zYfaba.js} +69 -7
  45. package/dist/{result-DfUru6y_.js → result-B7_zVxAX.js} +1 -1
  46. package/dist/result-CRmjjoAA.js +2 -0
  47. package/dist/{review-CdMK2GpQ.js → review-Bz0fO9_I.js} +9 -1
  48. package/dist/{review-DIbOTmOM.js → review-a-2ghjQ5.js} +1 -1
  49. package/dist/{routes-CmdRUuOs.js → routes-CSctpS1P.js} +1 -1
  50. package/dist/{run-YiqyQA2b.d.ts → run-BK2blxMI.d.ts} +8 -0
  51. package/dist/{run-D7hdVXLA.js → run-DzVEOkiF.js} +6 -2
  52. package/dist/{sarif-BKvq_AUm.js → sarif-9BAgNiOa.js} +5 -3
  53. package/dist/site-BHMtf3q2.js +72 -0
  54. package/dist/start-DzOM0p6I.js +101 -0
  55. package/dist/statement/templates/at.de.md +14 -0
  56. package/dist/statement/templates/at.en.md +14 -0
  57. package/dist/statement/templates/be.de.md +148 -0
  58. package/dist/statement/templates/be.en.md +142 -0
  59. package/dist/statement/templates/be.fr.md +146 -0
  60. package/dist/statement/templates/be.nl.md +147 -0
  61. package/dist/statement/templates/ch.de.md +14 -0
  62. package/dist/statement/templates/ch.en.md +14 -0
  63. package/dist/statement/templates/cz.cs.md +137 -0
  64. package/dist/statement/templates/cz.en.md +139 -0
  65. package/dist/statement/templates/de.de.md +14 -0
  66. package/dist/statement/templates/de.en.md +14 -0
  67. package/dist/statement/templates/dk.da.md +141 -0
  68. package/dist/statement/templates/dk.en.md +141 -0
  69. package/dist/statement/templates/es.en.md +14 -0
  70. package/dist/statement/templates/es.es.md +15 -0
  71. package/dist/statement/templates/fi.en.md +139 -0
  72. package/dist/statement/templates/fi.fi.md +141 -0
  73. package/dist/statement/templates/fr.en.md +14 -0
  74. package/dist/statement/templates/fr.fr.md +15 -0
  75. package/dist/statement/templates/ie.en.md +144 -0
  76. package/dist/statement/templates/it.en.md +14 -0
  77. package/dist/statement/templates/it.it.md +15 -0
  78. package/dist/statement/templates/nl.en.md +14 -0
  79. package/dist/statement/templates/nl.nl.md +15 -0
  80. package/dist/statement/templates/pl.en.md +143 -0
  81. package/dist/statement/templates/pl.pl.md +144 -0
  82. package/dist/statement/templates/pt.en.md +142 -0
  83. package/dist/statement/templates/pt.pt.md +145 -0
  84. package/dist/statement/templates/se.en.md +139 -0
  85. package/dist/statement/templates/se.sv.md +142 -0
  86. package/dist/vite/index.d.ts +1 -1
  87. package/dist/vite/index.js +1 -1
  88. package/dist/watch-B2RoUbo0.js +122 -0
  89. package/dist/webpack/index.d.ts +1 -1
  90. package/dist/webpack/index.js +1 -1
  91. package/dist/{worksheet-eUjwYLxC.js → worksheet-B_kQ1pxq.js} +3 -2
  92. package/package.json +4 -3
  93. package/dist/audit-DK2StT1_.js +0 -2
  94. package/dist/coverage-7bQqWNfN.js +0 -2
  95. package/dist/init-BjKYttxc.js +0 -119
  96. package/dist/jsdom-DMvU2h-f.js +0 -3
  97. package/dist/load-Bc_xDGAh.js +0 -2
package/README.md CHANGED
@@ -6,20 +6,42 @@ Build-time WCAG 2.2 AA auditor and EU accessibility statement generator for stat
6
6
  built for the freelancers and small agencies who have to comply with the European
7
7
  Accessibility Act (in force since 28 June 2025) without an accessibility budget. It started
8
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 **seven countries**: Austria, Germany, Switzerland,
10
- Spain, France, Italy and the Netherlands, each in its own language as well as English.
11
-
12
- 0.6.0 adds the half no engine can do. Of the 55 WCAG 2.2 A and AA success criteria, 34 have
13
- no automated rule at all: `checklist` writes those down as a review somebody works through,
14
- `audit --review` reads the answers back beside what the run measured, and `statement` now
15
- refuses to publish a claim of full conformance that either one contradicts. Sites behind a
16
- login or a preview protection are auditable too.
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.
17
37
 
18
38
  ```bash
39
+ npx eaa-kit # nothing to set up: finds your site, audits it, writes a report
19
40
  npx eaa-kit audit # WCAG 2.2 AA report; finds your build itself
20
41
  npx eaa-kit diff a.json b.json # what a change made worse, and what it fixed
21
- npx eaa-kit init # write an eaa.config.json
22
- npx eaa-kit statement # accessibility statement, in one of seven countries
42
+ npx eaa-kit init # the config, a baseline and a CI workflow
43
+ npx eaa-kit statement # accessibility statement, in one of fifteen countries
44
+ npx eaa-kit countries # which ones, in which languages, under which law
23
45
  npx eaa-kit checklist # the manual review no engine can do for you
24
46
  ```
25
47
 
@@ -64,7 +86,7 @@ listing the barriers a real audit found.
64
86
 
65
87
  ```bash
66
88
  eaa-kit statement --output src/content/a11y.md
67
- eaa-kit statement --country FR --lang fr # or ES, IT, NL, AT, DE, CH
89
+ eaa-kit statement --country PL --lang pl # eaa-kit countries lists all fifteen
68
90
  ```
69
91
 
70
92
  Each country's statement is a document under its own law rather than a translation of
@@ -114,13 +136,28 @@ eaa-kit audit --review eaa-review.json --coverage
114
136
  ```
115
137
 
116
138
  **Says how much of WCAG it could reach.** WCAG 2.2 has 55 success criteria at Levels A and
117
- AA. axe-core has rules touching 23 of them. Every run says so, and `--coverage` lists all
118
- 55 with what this run reached on each — never as a percentage, because most of WCAG cannot
119
- be automated and a score would present that as a fact about your site.
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.
120
143
 
121
144
  **Says what it did not measure.** A crawl that stopped at its page limit, or could not
122
145
  fetch forty URLs, no longer produces a report that looks like a complete one.
123
146
 
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.
150
+
151
+ ```bash
152
+ eaa-kit audit ./dist --watch
153
+ ```
154
+
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.
160
+
124
161
  **Reports in four shapes**: a console report for whoever ran it, JSON for other tools,
125
162
  SARIF for GitHub code scanning, and a self-contained HTML page for the client whose site
126
163
  it is.
@@ -167,7 +204,7 @@ eaa-kit audit --url https://preview.example.com --basic-auth user:password
167
204
  | --- | --- |
168
205
  | [Auditing a build](docs/audit.md) | The `audit` command, both engines, exit codes, and what an automated run can and cannot tell you |
169
206
  | [Defaults from eaa.config](docs/audit.md#defaults-from-eaaconfig) | Writing the flags down once, and what still overrides them |
170
- | [The statement command](docs/statement.md) | The config file, the seven countries, and filling a statement from audit results |
207
+ | [The statement command](docs/statement.md) | The config file, the fifteen countries, and filling a statement from audit results |
171
208
  | [Baselines](docs/baseline.md) | Adopting the tool on a site that already has violations |
172
209
  | [Comparing two runs](docs/reports.md#comparing-two-runs) | The `diff` command, and what it refuses to call fixed |
173
210
  | [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 |
@@ -1,4 +1,4 @@
1
- import { n as IntegrationOptions } from "../run-YiqyQA2b.js";
1
+ import { n as IntegrationOptions } from "../run-BK2blxMI.js";
2
2
  //#region src/astro/index.d.ts
3
3
  /**
4
4
  * An Astro integration that audits the build Astro just produced.
@@ -1,4 +1,4 @@
1
- import { n as auditBuild, t as BuildAuditError } from "../run-D7hdVXLA.js";
1
+ import { n as auditBuild, t as BuildAuditError } from "../run-DzVEOkiF.js";
2
2
  import { fileURLToPath } from "node:url";
3
3
  //#region src/astro/index.ts
4
4
  var AstroAuditError = class extends Error {
@@ -1,4 +1,4 @@
1
- import { t as auditPage } from "../../jsdom-CQar6OQS.js";
1
+ import { t as auditPage } from "../../jsdom-CsW_xVcA.js";
2
2
  import { enableCompileCache } from "node:module";
3
3
  import { parentPort, workerData } from "node:worker_threads";
4
4
  //#region src/audit/runners/worker.ts
@@ -0,0 +1,2 @@
1
+ import { n as runAuditCommand } from "./audit-J2jeLo-y.js";
2
+ export { runAuditCommand };