eaa-kit 0.2.0 → 0.3.0

package/dist/{routes-BxbSZKXC.js → routes-C2Cgf6Ko.js}

@@ -1,4 +1,4 @@
-import { stat } from "node:fs/promises";
+import { i as toPosix, n as isDirectory } from "./fs-BmPtmFke.js";
 import path from "node:path";
 import { glob } from "tinyglobby";
 //#region src/audit/routes.ts
@@ -49,7 +49,7 @@ const CONVENTIONS = [
 * without knowing the data behind it.
 */
 function routePathFor(relativeFile, framework) {
-	let route = relativeFile.split(path.sep).join("/");
+	let route = toPosix(relativeFile);
 	if (framework === "next-app" || framework === "sveltekit") route = route.includes("/") ? route.replace(/\/[^/]+$/, "") : "";
 	else {
 		route = route.replace(/\.[^./]+$/, "");
@@ -90,11 +90,7 @@ function emittedPathsFor(route) {
 async function buildRouteMap(cwd) {
 	for (const convention of CONVENTIONS) {
 		const directory = path.join(cwd, convention.dir);
-		try {
-			if (!(await stat(directory)).isDirectory()) continue;
-		} catch {
-			continue;
-		}
+		if (!await isDirectory(directory)) continue;
 		const files = await glob([convention.pattern], {
 			cwd: directory,
 			ignore: ["**/node_modules/**"],
@@ -105,7 +101,7 @@ async function buildRouteMap(cwd) {
 		for (const file of files) {
 			const route = routePathFor(file, convention.framework);
 			if (route === void 0) continue;
-			const source = `${convention.dir}/${file.split(path.sep).join("/")}`;
+			const source = `${convention.dir}/${toPosix(file)}`;
 			for (const emitted of emittedPathsFor(route)) if (!sources.has(emitted)) sources.set(emitted, source);
 		}
 		if (sources.size > 0) return {

package/dist/run-BMASMmwO.d.ts

@@ -0,0 +1,45 @@
+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
+//#region src/integration/run.d.ts
+/**
+ * What a build-time integration does once the build has written its files.
+ *
+ * Astro, Vite and Next all reach the same point by different routes: a
+ * directory exists, and the build should stop if what is in it fails the
+ * threshold. Only the hook name and the logger differ, so only those live in
+ * the integrations.
+ */
+interface IntegrationOptions {
+  /** Lowest impact that fails the build. Defaults to 'serious'. */
+  failOn?: ImpactLevel;
+  include?: string[];
+  exclude?: string[];
+  baseUrl?: string;
+  /** Audit in real Chromium. Needs the playwright peer. */
+  browser?: boolean;
+  concurrency?: number;
+  baseline?: string;
+  format?: OutputFormat;
+  /** Write the report here instead of the build log. */
+  output?: string;
+  /**
+   * Report without failing the build. For the week it takes to adopt this on a
+   * site that already exists — a baseline is the honest way to go green after
+   * that.
+   */
+  failBuild?: boolean;
+  /** Skip entirely. For turning it off per environment without unwiring it. */
+  enabled?: boolean;
+}
+/**
+ * Thrown to fail the build. Its own class so a consumer can tell an audit
+ * failure from the build tool falling over.
+ */
+declare class BuildAuditError extends Error {
+  readonly name = "BuildAuditError";
+}
+//#endregion
+export { IntegrationOptions as n, BuildAuditError as t };

package/dist/run-BW6CVuND.js

@@ -0,0 +1,36 @@
+//#region src/integration/run.ts
+/**
+* Thrown to fail the build. Its own class so a consumer can tell an audit
+* failure from the build tool falling over.
+*/
+var BuildAuditError = class extends Error {
+	name = "BuildAuditError";
+};
+/**
+* Audit a finished build and decide whether it may proceed.
+*
+* Returns normally when the build should continue, and throws BuildAuditError
+* when it should not.
+*/
+async function auditBuild(directory, options, logger) {
+	const { enabled, failBuild, ...auditOptions } = options;
+	if (enabled === false) {
+		logger.info("skipped (enabled: false)");
+		return;
+	}
+	const { runAuditCommand } = await import("./audit-CuG2hYyo.js");
+	const { exitCode } = await runAuditCommand(directory, auditOptions);
+	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 (failBuild === false) {
+		logger.warn(`${message} (failBuild: false, so the build continues)`);
+		return;
+	}
+	logger.error(message);
+	throw new BuildAuditError(`eaa-kit: ${message}`);
+}
+//#endregion
+export { auditBuild as n, BuildAuditError as t };

package/dist/{sarif-eSCuI0eX.js → sarif-DB3WG7T9.js}

@@ -1,6 +1,8 @@
-import { i as isImpactLevel } from "./impact-DvgBjupx.js";
+import { o as isImpactLevel } from "./impact-YdoOtFqm.js";
+import { a as standardsReference } from "./text-BFmNtMsV.js";
 import { t as TOOL_VERSION } from "./version-B3v4rNoG.js";
 import { t as elementFingerprint } from "./fingerprint-DRoneAjj.js";
+import { a as ruleOutcomes, r as findingElements } from "./result-DLxd2Eip.js";
 import path from "node:path";
 //#region src/audit/report/sarif.ts
 const SARIF_VERSION = "2.1.0";
@@ -92,29 +94,16 @@ const SUPPRESSED = [{
 function toResults(finding, ruleIndex, uri, suppressions) {
 	const level = toSarifLevel(finding.impact);
 	const location = { physicalLocation: { artifactLocation: { uri } } };
-	if (finding.nodes.length === 0) return [{
+	return findingElements(finding).map(({ selector, html }) => ({
 		ruleId: finding.ruleId,
 		ruleIndex,
 		level,
 		kind: "fail",
-		message: { text: finding.help },
+		message: { text: selector === "" ? finding.help : `${finding.help}. Element: ${selector}` },
 		locations: [location],
-		partialFingerprints: fingerprint(finding.ruleId, "", ""),
+		partialFingerprints: fingerprint(finding.ruleId, selector, html),
 		...suppressions ? { suppressions } : {}
-	}];
-	return finding.nodes.map((node) => {
-		const selector = node.target.join(" ");
-		return {
-			ruleId: finding.ruleId,
-			ruleIndex,
-			level,
-			kind: "fail",
-			message: { text: `${finding.help}. Element: ${selector}` },
-			locations: [location],
-			partialFingerprints: fingerprint(finding.ruleId, selector, node.html),
-			...suppressions ? { suppressions } : {}
-		};
-	});
+	}));
 }
 /**
 * Identifies an alert across runs. Deliberately excludes the file path, so that
@@ -127,25 +116,14 @@ function fingerprint(ruleId, selector, html) {
 /** Every rule the run knows about, so the catalogue is complete in GitHub. */
 function buildRules(audits) {
 	const rules = /* @__PURE__ */ new Map();
-	for (const audit of audits) {
-		const outcomes = [
-			...audit.violations,
-			...audit.accepted ?? [],
-			...audit.incomplete,
-			...audit.passes,
-			...audit.inapplicable
-		];
-		for (const outcome of outcomes) {
-			if (rules.has(outcome.ruleId)) continue;
-			rules.set(outcome.ruleId, toSarifRule(outcome));
-		}
+	for (const audit of audits) for (const outcome of ruleOutcomes(audit)) {
+		if (rules.has(outcome.ruleId)) continue;
+		rules.set(outcome.ruleId, toSarifRule(outcome));
 	}
 	return [...rules.values()].sort((a, b) => a.id.localeCompare(b.id));
 }
 function toSarifRule(outcome) {
-	const criteria = outcome.successCriteria.map((criterion) => `WCAG ${criterion}`);
-	const clauses = outcome.enClauses.map((clause) => `EN 301 549 ${clause}`);
-	const references = [...criteria, ...clauses].join(", ");
+	const references = standardsReference(outcome.successCriteria, outcome.enClauses);
 	return {
 		id: outcome.ruleId,
 		shortDescription: { text: outcome.help },

package/dist/text-BFmNtMsV.js

@@ -0,0 +1,43 @@
+//#region src/text.ts
+/**
+* Text this package writes: escaping, counting and the standards references
+* that appear in every report and in the statement.
+*
+* Both documents eaa-kit produces embed text it did not write: an issue
+* description from a config file, axe-core's help text, and — in the audit
+* report — the markup of the element that failed, which is by definition
+* arbitrary HTML from somebody's build. Getting the escaping wrong in the
+* report would mean a page that fails an accessibility audit for having a stray
+* `<script>` hands that script to whoever opens the report.
+*/
+/** For text nodes. Leaves quotes alone, which are fine between tags. */
+function escapeText(value) {
+	return value.replace(/&/g, "&amp;").replace(/</g, "&lt;").replace(/>/g, "&gt;");
+}
+/** For attribute values, where a quote would end the attribute. */
+function escapeAttribute(value) {
+	return escapeText(value).replace(/"/g, "&quot;").replace(/'/g, "&#39;");
+}
+/** `plural(1, 'page')` is `page`, `plural(2, 'page')` is `pages`. */
+function plural(value, noun) {
+	return value === 1 ? noun : `${noun}s`;
+}
+/** `count(2, 'page')` is `2 pages`. */
+function count(value, noun) {
+	return `${value} ${plural(value, noun)}`;
+}
+/**
+* Element markup on one line, optionally bounded: one minified page must not be
+* able to fill a report or run past a terminal.
+*/
+function collapse(html, max) {
+	const flat = html.replace(/\s+/g, " ").trim();
+	if (max === void 0 || flat.length <= max) return flat;
+	return `${flat.slice(0, max - 1)}…`;
+}
+/** `WCAG 1.1.1, EN 301 549 9.1.1.1`, in that order, or an empty string. */
+function standardsReference(successCriteria, enClauses) {
+	return [...successCriteria.map((criterion) => `WCAG ${criterion}`), ...enClauses.map((clause) => `EN 301 549 ${clause}`)].join(", ");
+}
+//#endregion
+export { standardsReference as a, escapeText as i, count as n, escapeAttribute as r, collapse as t };

package/dist/vite/index.d.ts

@@ -0,0 +1,39 @@
+import { n as IntegrationOptions, t as BuildAuditError } from "../run-BMASMmwO.js";
+//#region src/vite/index.d.ts
+interface EaaKitPluginOptions extends IntegrationOptions {
+  /**
+   * Directory to audit, relative to the Vite root. Defaults to the build's own
+   * `outDir`, which is the only place the plugin can know the files went.
+   */
+  directory?: string;
+}
+/**
+ * The parts of Vite this plugin touches, described structurally.
+ *
+ * So the published .d.ts does not reference vite, and installing eaa-kit in a
+ * project that has none costs nothing and still typechecks. The same reasoning
+ * as the Astro integration and the Playwright runner.
+ */
+interface ResolvedConfigLike {
+  root: string;
+  build: {
+    outDir: string;
+  };
+  logger?: {
+    info(message: string): void;
+    warn(message: string): void;
+    error(message: string): void;
+  };
+}
+interface VitePluginLike {
+  name: string;
+  /** Build only: a dev server writes nothing to audit. */
+  apply: 'build';
+  /** Runs after the bundle is written, which is the earliest the files exist. */
+  enforce?: 'post';
+  configResolved(config: ResolvedConfigLike): void;
+  closeBundle(): Promise<void>;
+}
+declare function eaaKit(options?: EaaKitPluginOptions): VitePluginLike;
+//#endregion
+export { BuildAuditError, EaaKitPluginOptions, ResolvedConfigLike, VitePluginLike, eaaKit as default };

package/dist/vite/index.js

@@ -0,0 +1,40 @@
+import { n as auditBuild, t as BuildAuditError } from "../run-BW6CVuND.js";
+import path from "node:path";
+//#region src/vite/index.ts
+function eaaKit(options = {}) {
+	let directory;
+	let logger;
+	return {
+		name: "eaa-kit",
+		apply: "build",
+		enforce: "post",
+		configResolved(config) {
+			directory = path.resolve(config.root, options.directory ?? config.build.outDir);
+			logger = prefixed(config.logger);
+		},
+		async closeBundle() {
+			if (directory === void 0 || logger === void 0) throw new BuildAuditError("eaa-kit: the plugin was not given a resolved Vite config");
+			await auditBuild(directory, options, logger);
+		}
+	};
+}
+/**
+* Vite's own logger where there is one, the console otherwise.
+*
+* Prefixed either way: a line about accessibility in the middle of a build log
+* needs to say what produced it.
+*/
+function prefixed(logger) {
+	const write = (level, message) => {
+		const line = `eaa-kit: ${message}`;
+		if (logger === void 0) process.stderr.write(`${line}\n`);
+		else logger[level](line);
+	};
+	return {
+		info: (message) => write("info", message),
+		warn: (message) => write("warn", message),
+		error: (message) => write("error", message)
+	};
+}
+//#endregion
+export { BuildAuditError, eaaKit as default };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "eaa-kit",
-  "version": "0.2.0",
-  "description": "Build-time WCAG 2.2 AA auditor and EU accessibility statement generator for static sites (EAA / BFSG / BaFG, DACH-localised).",
+  "version": "0.3.0",
+  "description": "WCAG 2.2 AA auditor and EU accessibility statement generator (EAA / BFSG / BaFG). Audits a static build or a running site from the command line.",
   "type": "module",
   "license": "MIT",
   "repository": {
@@ -40,6 +40,10 @@
       "types": "./dist/astro/index.d.ts",
       "import": "./dist/astro/index.js"
     },
+    "./vite": {
+      "types": "./dist/vite/index.d.ts",
+      "import": "./dist/vite/index.js"
+    },
     "./package.json": "./package.json"
   },
   "files": [
@@ -54,7 +58,8 @@
     "lint": "biome check .",
     "format": "biome check --write .",
     "smoke": "pnpm build && node dist/cli/index.js audit tests/fixtures/site --include about/** --format json && node dist/cli/index.js audit tests/fixtures/site --include \"about/**\" \"blog/**\" \"drafts/**\" \"legacy.htm\" --concurrency 2 && node dist/cli/index.js audit tests/fixtures/site --include about/** --format html && node dist/cli/index.js audit tests/fixtures/site --baseline examples/baseline.json && node -e \"import('./dist/astro/index.js').then(m => { const i = m.default(); if (i.name !== 'eaa-kit' || typeof i.hooks['astro:build:done'] !== 'function') { throw new Error('astro entry point is not an integration') } console.log('astro entry ok') })\" && node dist/cli/index.js statement --config examples/eaa.config.json && node dist/cli/index.js statement --config examples/eaa.config.json --audit examples/report.json --format html",
-    "examples": "pnpm build && node scripts/generate-examples.mjs"
+    "examples": "pnpm build && node scripts/generate-examples.mjs",
+    "test:packaged": "pnpm build && node scripts/test-packaged.mjs"
   },
   "peerDependencies": {
     "playwright": ">=1.40.0",

package/dist/audit-CqrR9pIO.js

@@ -1,2 +0,0 @@
-import { r as runAuditCommand } from "./audit-D4gju2BT.js";
-export { runAuditCommand };