eaa-kit 0.7.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.
- package/README.md +182 -135
- package/dist/astro/index.d.ts +1 -3
- package/dist/astro/index.js +2 -3
- package/dist/audit/runners/worker.js +2 -3
- package/dist/{audit-DRjAY2iY.js → audit-DbqNIrt6.js} +85 -219
- package/dist/audit-rUhqnm3o.js +1 -0
- package/dist/{baseline-BpE7DbDq.js → baseline-CKElWbx4.js} +18 -8
- package/dist/baseline-DU0EPiTq.js +1 -0
- package/dist/baseline-DYOejLFO.js +1 -0
- package/dist/baseline-DvdsFTQy.js +126 -0
- package/dist/{cache-D4dOIuOi.js → cache-DIV4G0TI.js} +24 -5
- package/dist/{checklist-DDd9jewi.js → checklist-CA0Ri71Z.js} +8 -9
- package/dist/cli/index.js +115 -158
- package/dist/{collect-Cu1q9NTB.js → collect-CjucwTEF.js} +16 -8
- package/dist/{command-3r4fht5f.js → command-C8ZFvcc1.js} +33 -10
- package/dist/completeness-Cg-XIKWN.js +1 -0
- package/dist/completeness-Dzyvgr4Z.js +72 -0
- package/dist/component-CgbeRgJa.js +1 -0
- package/dist/{component-ChisoFyY.js → component-ZLd8DA_a.js} +3 -4
- package/dist/countries-B_PE6r5R.js +180 -0
- package/dist/countries-CCqog6dy.js +28 -0
- package/dist/coverage-B9_6yv_8.js +2 -0
- package/dist/{coverage-cb5kPp48.js → coverage-C1Z6t9Ct.js} +5 -7
- package/dist/{crawl-BHkJmUkA.js → crawl-CkHJJV4w.js} +135 -25
- package/dist/{criteria-CnPJKGeb.js → criteria-CacF0HP1.js} +1 -2
- package/dist/{load-BaWMa-G_.js → define-BdTPIfqE.js} +46 -99
- package/dist/detect-DnFHXpWh.js +49 -0
- package/dist/detect-oLDadgee.js +160 -0
- package/dist/doctor-q8IebwAb.js +248 -0
- package/dist/eleventy/index.d.ts +1 -3
- package/dist/eleventy/index.js +2 -3
- package/dist/entry-kf94P140.js +173 -0
- package/dist/{fingerprint-BjYV_0F7.js → fingerprint-CcoQ1WxQ.js} +1 -2
- package/dist/{frameworks-B4ClIJgE.js → frameworks-BboC8eNk.js} +234 -28
- package/dist/frameworks-Y-n3NUuG.js +1 -0
- package/dist/{fs-BmPtmFke.js → fs-tPD5r0wY.js} +1 -2
- package/dist/hosts-B48qR6Vt.js +19 -0
- package/dist/{html-BIxxF3FC.js → html-Bjq3Iw3g.js} +56 -14
- package/dist/{impact-luGCnN8F.js → impact-BGlJ6j0Y.js} +1 -2
- package/dist/{impact-EEB9ZXmC.d.ts → impact-CZjUloYC.d.ts} +0 -2
- package/dist/index.d.ts +50 -26
- package/dist/index.js +3 -2
- package/dist/init-3Ti3ao5Z.js +232 -0
- package/dist/issues-WLlepU95.js +120 -0
- package/dist/{jsdom-CsW_xVcA.js → jsdom-C4pLIMyP.js} +2 -3
- package/dist/jsdom-Zle--VQ1.js +2 -0
- package/dist/{json-Bus6YhxB.js → json-B_k4CDmR.js} +5 -6
- package/dist/json-IL1JxlTL.js +1 -0
- package/dist/load-C3eFEdoH.js +98 -0
- package/dist/load-oQQJPNlV.js +1 -0
- package/dist/markdown-D-QpPYsz.js +138 -0
- package/dist/next-8zDgH0nP.js +119 -0
- package/dist/nuxt/index.d.ts +1 -3
- package/dist/nuxt/index.js +2 -3
- package/dist/pages-CCP1WfYe.js +363 -0
- package/dist/{playwright-ukCr_5o3.js → playwright-ky4b_HME.js} +98 -16
- package/dist/{pool-B4tEUa2S.js → pool-B3XKdk57.js} +4 -5
- package/dist/project-B21NT_aX.js +502 -0
- package/dist/project-Dht13sb1.js +1 -0
- package/dist/{remediation-C0klJblu.js → remediation-BkE7q7dT.js} +2 -176
- package/dist/{render-C1sUZZI_.js → render-ky8cm4QF.js} +50 -24
- package/dist/result-DhoT4g0P.js +1 -0
- package/dist/{result-B7_zVxAX.js → result-g8dGsrcv.js} +1 -2
- package/dist/{review-CdMK2GpQ.js → review-BGjTBFvd.js} +11 -4
- package/dist/review-iheEjp7_.js +1 -0
- package/dist/{routes-CmdRUuOs.js → routes-BpQeBDmM.js} +4 -5
- package/dist/{run-DrS0Komf.js → run-D7tc7IU2.js} +2 -3
- package/dist/{run-BK2blxMI.d.ts → run-VXnP4uLp.d.ts} +2 -6
- package/dist/{sarif-BNCE0PNT.js → sarif-v66-PjdE.js} +9 -9
- package/dist/{schema-DJSF4K05.js → schema-DfC-Ww1w.js} +1 -2
- package/dist/setup-BYlqHlo0.js +2 -0
- package/dist/setup-Cf82ONw0.js +353 -0
- package/dist/shell-BdQYTaBQ.js +89 -0
- package/dist/site-CxVyh8IO.js +71 -0
- package/dist/start-bdanSxZr.js +100 -0
- package/dist/statement/templates/be.de.md +148 -0
- package/dist/statement/templates/be.en.md +142 -0
- package/dist/statement/templates/be.fr.md +146 -0
- package/dist/statement/templates/be.nl.md +147 -0
- package/dist/statement/templates/cz.cs.md +138 -0
- package/dist/statement/templates/cz.en.md +140 -0
- package/dist/statement/templates/dk.da.md +142 -0
- package/dist/statement/templates/dk.en.md +142 -0
- package/dist/statement/templates/fi.en.md +139 -0
- package/dist/statement/templates/fi.fi.md +141 -0
- package/dist/statement/templates/ie.en.md +144 -0
- package/dist/statement/templates/pl.en.md +143 -0
- package/dist/statement/templates/pl.pl.md +144 -0
- package/dist/statement/templates/pt.en.md +143 -0
- package/dist/statement/templates/pt.pt.md +145 -0
- package/dist/statement/templates/se.en.md +148 -0
- package/dist/statement/templates/se.sv.md +150 -0
- package/dist/{text-BF1LHMiV.js → text-CISDPU49.js} +11 -3
- package/dist/{version-B3v4rNoG.js → version-C8aJm8YJ.js} +1 -2
- package/dist/vite/index.d.ts +1 -3
- package/dist/vite/index.js +2 -3
- package/dist/watch-CefxwMsZ.js +121 -0
- package/dist/webpack/index.d.ts +1 -3
- package/dist/webpack/index.js +2 -3
- package/dist/{worksheet-BIxMtbUd.js → worksheet-CcBo9G7s.js} +4 -5
- package/dist/workspaces-BBFXOyeV.js +85 -0
- package/package.json +16 -14
- package/dist/audit-Bwm1xBdJ.js +0 -2
- package/dist/baseline-rtnj3RHB.js +0 -2
- package/dist/component-DcCn3BJS.js +0 -2
- package/dist/coverage-n1X9CkiG.js +0 -3
- package/dist/frameworks-etFg_O8K.js +0 -2
- package/dist/init-DrFfzjvm.js +0 -119
- package/dist/jsdom-BUYuVJJm.js +0 -3
- package/dist/json-CrQmoTj6.js +0 -2
- package/dist/load-n62iXDq_.js +0 -2
- package/dist/project-CzOnkLH6.js +0 -274
- package/dist/project-MFrXcw1M.js +0 -2
- package/dist/result-CRmjjoAA.js +0 -2
- package/dist/review-DIbOTmOM.js +0 -2
package/README.md
CHANGED
|
@@ -2,38 +2,30 @@
|
|
|
2
2
|
|
|
3
3
|
[](https://github.com/likeBloodMoon/eaa-kit/actions/workflows/ci.yml)
|
|
4
4
|
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
the
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
audited again, and a run with nothing to re-audit never loads an engine at all: twenty
|
|
14
|
-
pages go from ~2,520 ms to ~230 ms, which is about what starting the process costs. A
|
|
15
|
-
reused result is never passed off as a fresh one — every report says how much was reused
|
|
16
|
-
and from when, and `diff` will not call a page fixed that this run did not look at. The
|
|
17
|
-
statement now also says how many of WCAG's 55 criteria a person checked by hand, and
|
|
18
|
-
`pnpm bench` prints the numbers in this paragraph for your own machine.
|
|
19
|
-
|
|
20
|
-
0.6.0 added the half no engine can do. Of the 55 WCAG 2.2 A and AA success criteria, 34
|
|
21
|
-
have no automated rule at all: `checklist` writes those down as a review somebody works
|
|
22
|
-
through, `audit --review` reads the answers back beside what the run measured, and
|
|
23
|
-
`statement` refuses to publish a claim of full conformance that either one contradicts.
|
|
24
|
-
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.
|
|
25
13
|
|
|
26
14
|
```bash
|
|
15
|
+
npx eaa-kit # nothing to set up: finds your site, audits it, writes a report
|
|
27
16
|
npx eaa-kit audit # WCAG 2.2 AA report; finds your build itself
|
|
28
17
|
npx eaa-kit diff a.json b.json # what a change made worse, and what it fixed
|
|
29
|
-
npx eaa-kit init #
|
|
30
|
-
npx eaa-kit statement # accessibility statement, in one of
|
|
18
|
+
npx eaa-kit init # the config, a baseline and a CI pipeline
|
|
19
|
+
npx eaa-kit statement # accessibility statement, in one of fifteen countries
|
|
20
|
+
npx eaa-kit countries # which ones, in which languages, under which law
|
|
31
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
|
|
32
24
|
```
|
|
33
25
|
|
|
34
26
|
> **Not legal advice.** eaa-kit reports what an automated engine can and cannot determine
|
|
35
|
-
> about your markup. Automated testing catches a minority of accessibility barriers
|
|
36
|
-
> a
|
|
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.
|
|
37
29
|
|
|
38
30
|
## Install
|
|
39
31
|
|
|
@@ -41,108 +33,185 @@ npx eaa-kit checklist # the manual review no engine can do for you
|
|
|
41
33
|
pnpm add -D eaa-kit # npm i -D eaa-kit
|
|
42
34
|
```
|
|
43
35
|
|
|
44
|
-
Node 22.22, 24.15 or 26
|
|
45
|
-
|
|
46
|
-
|
|
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.
|
|
47
56
|
|
|
48
|
-
##
|
|
57
|
+
## Auditing
|
|
49
58
|
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
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.
|
|
56
64
|
|
|
57
65
|
```bash
|
|
58
66
|
eaa-kit audit ./dist --fail-on serious
|
|
59
67
|
```
|
|
60
68
|
|
|
61
|
-
|
|
62
|
-
|
|
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:
|
|
63
80
|
|
|
64
81
|
```bash
|
|
65
82
|
eaa-kit audit --url http://localhost:3000
|
|
83
|
+
eaa-kit audit --url http://localhost:8000 --sitemap /sitemap_index.xml
|
|
66
84
|
```
|
|
67
85
|
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
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.
|
|
72
95
|
|
|
73
96
|
```bash
|
|
74
|
-
eaa-kit
|
|
75
|
-
|
|
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
|
|
76
113
|
```
|
|
77
114
|
|
|
78
|
-
|
|
79
|
-
another's, so where a national regime asks for more than this — France's RGAA declaration,
|
|
80
|
-
Italy's filing with AgID — the text says so instead of letting a generated file look like
|
|
81
|
-
it settles the matter.
|
|
115
|
+
### Failing only on what is new
|
|
82
116
|
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
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.
|
|
86
120
|
|
|
87
121
|
```bash
|
|
88
122
|
eaa-kit baseline ./dist
|
|
89
123
|
eaa-kit audit ./dist --baseline eaa-baseline.json
|
|
90
124
|
```
|
|
91
125
|
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
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.
|
|
95
129
|
|
|
96
130
|
```bash
|
|
97
131
|
eaa-kit diff before.json after.json
|
|
98
132
|
```
|
|
99
133
|
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
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.
|
|
104
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.
|
|
145
|
+
|
|
146
|
+
```bash
|
|
147
|
+
eaa-kit audit ./dist --watch
|
|
105
148
|
```
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
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
|
|
111
170
|
```
|
|
112
171
|
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
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:
|
|
118
178
|
|
|
119
179
|
```bash
|
|
120
|
-
eaa-kit
|
|
121
|
-
eaa-kit audit --review eaa-review.json --coverage
|
|
180
|
+
eaa-kit statement --country SE --lang sv --date 2027-01-01
|
|
122
181
|
```
|
|
123
182
|
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
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.
|
|
188
|
+
|
|
189
|
+
## The part no engine can do
|
|
129
190
|
|
|
130
|
-
|
|
131
|
-
|
|
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.
|
|
132
195
|
|
|
133
|
-
|
|
134
|
-
the
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
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.
|
|
200
|
+
|
|
201
|
+
```bash
|
|
202
|
+
eaa-kit checklist --output a11y-review.md
|
|
203
|
+
eaa-kit audit --review eaa-review.json --coverage
|
|
204
|
+
```
|
|
138
205
|
|
|
139
|
-
|
|
140
|
-
SARIF for GitHub code scanning, and a self-contained HTML page for the client whose site
|
|
141
|
-
it is.
|
|
206
|
+
## Setting it up
|
|
142
207
|
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
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.
|
|
212
|
+
|
|
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
|
|
146
215
|
keys that mean the same thing to it. A flag you type still wins, so a one-off `--browser`
|
|
147
216
|
check needs no edit to a committed file.
|
|
148
217
|
|
|
@@ -150,31 +219,14 @@ check needs no edit to a committed file.
|
|
|
150
219
|
{ "audit": { "dir": "build", "failOn": "critical", "browser": true } }
|
|
151
220
|
```
|
|
152
221
|
|
|
153
|
-
|
|
154
|
-
and Remix
|
|
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
|
|
155
224
|
[Astro](docs/integrations.md#astro-integration),
|
|
156
225
|
[Nuxt](docs/integrations.md#nuxt-module),
|
|
157
226
|
[Eleventy](docs/integrations.md#eleventy-plugin) and
|
|
158
|
-
[webpack](docs/integrations.md#webpack-plugin)
|
|
159
|
-
[GitHub Action](docs/integrations.md#github-actions).
|
|
160
|
-
|
|
161
|
-
**Audits what a CMS serves.** WordPress, TYPO3, Craft, Laravel, Symfony, Rails and Django
|
|
162
|
-
write no HTML to disk, so eaa-kit names the command that gets the site running and audits
|
|
163
|
-
that instead — following the site's own sitemap, wherever it keeps it.
|
|
164
|
-
|
|
165
|
-
```bash
|
|
166
|
-
eaa-kit audit --url http://localhost:8000 --sitemap /sitemap_index.xml
|
|
167
|
-
```
|
|
168
|
-
|
|
169
|
-
**Reaches a site behind a login.** A preview deployment or a staging CMS refuses anonymous
|
|
170
|
-
requests, which used to put both out of reach. `--basic-auth` and a repeatable `--header`
|
|
171
|
-
cover them, on the crawl and in the browser, and the credentials are never written into a
|
|
172
|
-
report, a baseline or a SARIF log — nor accepted from `eaa.config`, which is a committed
|
|
173
|
-
file.
|
|
174
|
-
|
|
175
|
-
```bash
|
|
176
|
-
eaa-kit audit --url https://preview.example.com --basic-auth user:password
|
|
177
|
-
```
|
|
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).
|
|
178
230
|
|
|
179
231
|
## Documentation
|
|
180
232
|
|
|
@@ -182,46 +234,41 @@ eaa-kit audit --url https://preview.example.com --basic-auth user:password
|
|
|
182
234
|
| --- | --- |
|
|
183
235
|
| [Auditing a build](docs/audit.md) | The `audit` command, both engines, exit codes, and what an automated run can and cannot tell you |
|
|
184
236
|
| [Defaults from eaa.config](docs/audit.md#defaults-from-eaaconfig) | Writing the flags down once, and what still overrides them |
|
|
185
|
-
| [The statement command](docs/statement.md) | The config file, the
|
|
237
|
+
| [The statement command](docs/statement.md) | The config file, the fifteen countries, and filling a statement from audit results |
|
|
186
238
|
| [Baselines](docs/baseline.md) | Adopting the tool on a site that already has violations |
|
|
187
239
|
| [Comparing two runs](docs/reports.md#comparing-two-runs) | The `diff` command, and what it refuses to call fixed |
|
|
188
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 |
|
|
189
241
|
| [Recording a manual review](docs/review.md) | The `checklist` command, the record, and what a review is not allowed to do |
|
|
190
|
-
| [Report formats](docs/reports.md) | The JSON contract, SARIF, and the HTML report |
|
|
191
|
-
| [Integrations](docs/integrations.md) | The build plugins, the GitHub Action,
|
|
192
|
-
|
|
193
|
-
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 |
|
|
194
244
|
|
|
195
|
-
|
|
245
|
+
Generated output for every format is checked in under [examples/](examples).
|
|
196
246
|
|
|
197
|
-
|
|
247
|
+
## What it cannot tell you
|
|
198
248
|
|
|
199
|
-
|
|
200
|
-
|
|
201
|
-
|
|
202
|
-
|
|
203
|
-
|
|
204
|
-
take on faith: it counts it. Of the 55 WCAG 2.2 A and AA criteria, 34 have no automated
|
|
205
|
-
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.
|
|
206
254
|
|
|
207
|
-
|
|
208
|
-
depend on rendering
|
|
209
|
-
evaluated. axe-core does not know that and
|
|
210
|
-
|
|
211
|
-
|
|
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
|
|
212
260
|
you](docs/audit.md#what-the-browserless-engine-can-and-cannot-tell-you).
|
|
213
261
|
|
|
214
|
-
|
|
215
|
-
|
|
216
|
-
|
|
217
|
-
|
|
218
|
-
|
|
219
|
-
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.
|
|
220
267
|
|
|
221
268
|
## Changelog
|
|
222
269
|
|
|
223
|
-
See [CHANGELOG.md](CHANGELOG.md), and [ROADMAP.md](ROADMAP.md) for what
|
|
224
|
-
|
|
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.
|
|
225
272
|
|
|
226
273
|
## License
|
|
227
274
|
|
package/dist/astro/index.d.ts
CHANGED
|
@@ -1,5 +1,4 @@
|
|
|
1
|
-
import { n as IntegrationOptions } from "../run-
|
|
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 };
|
package/dist/astro/index.js
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
import { n as auditBuild, t as BuildAuditError } from "../run-
|
|
1
|
+
import { n as auditBuild, t as BuildAuditError } from "../run-D7tc7IU2.js";
|
|
2
2
|
import { fileURLToPath } from "node:url";
|
|
3
|
-
|
|
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-
|
|
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
|
-
|
|
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 {};
|