eaa-kit 0.2.1 → 0.4.0

package/README.md

@@ -9,6 +9,7 @@ in Austria.
 
 ```bash
 npx eaa-kit audit                 # WCAG 2.2 AA report; finds your build itself
+npx eaa-kit diff a.json b.json    # what a change made worse, and what it fixed
 npx eaa-kit init                  # write an eaa.config.json
 npx eaa-kit statement             # Barrierefreiheitserklärung from that config
 ```
@@ -62,12 +63,54 @@ eaa-kit baseline ./dist
 eaa-kit audit ./dist --baseline eaa-baseline.json
 ```
 
+**Says what a change did.** Two reports, and the difference between them: what is new, what
+was fixed, and what the later run never looked at — which is kept apart, because a
+violation missing from a run that stopped early was not fixed by anybody.
+
+```bash
+eaa-kit diff before.json after.json
+```
+
+**Says what to do about it.** Not "images must have alternative text" and a link — who the
+barrier stops, what to change, and the corrected form of *your* markup, in your framework's
+idiom where that differs. Deterministic and offline: no model, no API key, nothing that
+could invent a fix that looks right and is not.
+
+```
+✗ image-alt critical, WCAG 1.1.1
+    A screen reader announces this image by its filename, or skips it entirely.
+    Fix: Add alt text describing what the image conveys…
+    → <img src="/assets/logo.svg" alt="What this image shows">
+    written in src/components/Header.astro:12
+```
+
+**Says how much of WCAG it could reach.** WCAG 2.2 has 55 success criteria at Levels A and
+AA. axe-core has rules touching 23 of them. Every run says so, and `--coverage` lists all
+55 with what this run reached on each — never as a percentage, because most of WCAG cannot
+be automated and a score would present that as a fact about your site.
+
+**Says what it did not measure.** A crawl that stopped at its page limit, or could not
+fetch forty URLs, no longer produces a report that looks like a complete one.
+
 **Reports in four shapes**: a console report for whoever ran it, JSON for other tools,
 SARIF for GitHub code scanning, and a self-contained HTML page for the client whose site
 it is.
 
-**Runs in your build**, as an [Astro integration](docs/integrations.md#astro-integration)
-or the bundled [GitHub Action](docs/integrations.md#github-actions).
+**Runs in your build**: a [Vite plugin](docs/integrations.md#vite-plugin) covering SvelteKit
+and Remix too, and integrations for
+[Astro](docs/integrations.md#astro-integration),
+[Nuxt](docs/integrations.md#nuxt-module),
+[Eleventy](docs/integrations.md#eleventy-plugin) and
+[webpack](docs/integrations.md#webpack-plugin) — or the bundled
+[GitHub Action](docs/integrations.md#github-actions).
+
+**Audits what a CMS serves.** WordPress, TYPO3, Craft, Laravel, Symfony, Rails and Django
+write no HTML to disk, so eaa-kit names the command that gets the site running and audits
+that instead — following the site's own sitemap, wherever it keeps it.
+
+```bash
+eaa-kit audit --url http://localhost:8000 --sitemap /sitemap_index.xml
+```
 
 ## Documentation
 
@@ -76,8 +119,10 @@ or the bundled [GitHub Action](docs/integrations.md#github-actions).
 | [Auditing a build](docs/audit.md) | The `audit` command, both engines, exit codes, and what an automated run can and cannot tell you |
 | [The statement command](docs/statement.md) | The config file, the three countries, and filling a statement from audit results |
 | [Baselines](docs/baseline.md) | Adopting the tool on a site that already has violations |
+| [Comparing two runs](docs/reports.md#comparing-two-runs) | The `diff` command, and what it refuses to call fixed |
+| [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 |
 | [Report formats](docs/reports.md) | The JSON contract, SARIF, and the HTML report |
-| [Integrations](docs/integrations.md) | Astro and GitHub Actions |
+| [Integrations](docs/integrations.md) | The build plugins, the GitHub Action, and the two builders that get a command instead |
 
 Complete generated output for every format is checked in under [examples/](examples).
 
@@ -89,7 +134,9 @@ The two things worth knowing before you rely on any of it:
 text is accurate, whether a page makes sense in reading order, or whether a form can
 actually be completed with a screen reader. A clean report means nothing was found by this
 engine, which is not the same as a site being accessible — and none of the four output
-formats will say otherwise on your behalf.
+formats will say otherwise on your behalf. This is not a disclaimer the tool leaves you to
+take on faith: it counts it. Of the 55 WCAG 2.2 A and AA criteria, 34 have no automated
+rule at all, and every report says so.
 
 **The browserless engine cannot decide everything.** jsdom has no layout, so rules that
 depend on rendering — colour contrast, target size, computed overflow — cannot be

package/dist/astro/index.d.ts

@@ -1,8 +1,4 @@
-import { t as ImpactLevel } from "../impact-EEB9ZXmC.js";
-//#region src/cli/audit.d.ts
-declare const OUTPUT_FORMATS: readonly ['console', 'json', 'sarif', 'html'];
-type OutputFormat = (typeof OUTPUT_FORMATS)[number];
-//#endregion
+import { n as IntegrationOptions } from "../run-BMASMmwO.js";
 //#region src/astro/index.d.ts
 /**
  * An Astro integration that audits the build Astro just produced.
@@ -37,35 +33,12 @@ interface AstroIntegrationLike {
     'astro:build:done'?: (options: BuildDoneOptions) => void | Promise<void>;
   };
 }
-interface EaaKitIntegrationOptions {
-  /** Lowest impact that fails the build. Defaults to 'serious'. */
-  failOn?: ImpactLevel;
-  /**
-   * Whether a failing audit fails the build. Defaults to true.
-   *
-   * The CLI has no equivalent because a shell can ignore an exit code; a build
-   * hook cannot. Turning this off is for the first week of adopting the tool on
-   * an existing site — after that, a baseline is the honest way to go green,
-   * because it records what is wrong instead of hiding it.
-   */
-  failBuild?: boolean;
-  /** Skip the audit entirely. For turning it off by environment. */
-  enabled?: boolean;
-  include?: string[];
-  exclude?: string[];
-  /** Audit pages under their real site URL instead of file://. */
-  baseUrl?: string;
-  /** Audit in real Chromium. Needs the playwright peer. */
-  browser?: boolean;
-  /** Worker threads for the browserless engine. */
-  concurrency?: number;
-  /** Accept the violations recorded in this file; fail only on new ones. */
-  baseline?: string;
-  /** Write a report as well as printing one. */
-  format?: OutputFormat;
-  /** Where to write it. Required for `format` to do anything useful. */
-  output?: string;
-}
+/**
+ * The same options every build-time integration takes; see IntegrationOptions
+ * for what each one does. Aliased rather than restated so the Astro and Vite
+ * entries cannot drift apart.
+ */
+type EaaKitIntegrationOptions = IntegrationOptions;
 declare class AstroAuditError extends Error {
   readonly name = "AstroAuditError";
 }

package/dist/astro/index.js

@@ -1,3 +1,4 @@
+import { n as auditBuild, t as BuildAuditError } from "../run-DB34BSOZ.js";
 import { fileURLToPath } from "node:url";
 //#region src/astro/index.ts
 var AstroAuditError = class extends Error {
@@ -14,33 +15,12 @@ function eaaKit(options = {}) {
 	return {
 		name: "eaa-kit",
 		hooks: { "astro:build:done": async ({ dir, logger }) => {
-			if (options.enabled === false) {
-				logger.info("skipped (enabled: false)");
-				return;
+			try {
+				await auditBuild(fileURLToPath(dir), options, logger);
+			} catch (cause) {
+				if (cause instanceof BuildAuditError) throw new AstroAuditError(cause.message);
+				throw cause;
 			}
-			const { runAuditCommand } = await import("../audit-B2dIKpJ5.js");
-			const { exitCode } = await runAuditCommand(fileURLToPath(dir), {
-				...options.failOn ? { failOn: options.failOn } : {},
-				...options.include ? { include: options.include } : {},
-				...options.exclude ? { exclude: options.exclude } : {},
-				...options.baseUrl ? { baseUrl: options.baseUrl } : {},
-				...options.browser ? { browser: true } : {},
-				...options.concurrency === void 0 ? {} : { concurrency: options.concurrency },
-				...options.baseline ? { baseline: options.baseline } : {},
-				...options.format ? { format: options.format } : {},
-				...options.output ? { output: options.output } : {}
-			});
-			if (exitCode === 0) {
-				logger.info("no violations at or above the threshold");
-				return;
-			}
-			const message = exitCode === 2 ? "the audit could not be completed, so this build was not checked" : "accessibility violations at or above the threshold";
-			if (options.failBuild === false) {
-				logger.warn(`${message} (failBuild: false, so the build continues)`);
-				return;
-			}
-			logger.error(message);
-			throw new AstroAuditError(`eaa-kit: ${message}`);
 		} }
 	};
 }

package/dist/audit/runners/worker.js

@@ -1,4 +1,4 @@
-import { n as auditPage } from "../../jsdom-BEu6Ra_2.js";
+import { t as auditPage } from "../../jsdom-DCpGSLfW.js";
 import { parentPort, workerData } from "node:worker_threads";
 //#region src/audit/runners/worker.ts
 /**