eaa-kit 0.6.0 → 0.7.0

package/dist/cache-D4dOIuOi.js

@@ -0,0 +1,219 @@
+import { c as nullable, d as optional, h as string, i as enumeration, l as number, m as safeParse, t as array, u as object, y as withDefault } from "./schema-DJSF4K05.js";
+import { a as isoDate } from "./text-BF1LHMiV.js";
+import { mkdir, readFile, readdir, rm, writeFile } from "node:fs/promises";
+import path from "node:path";
+import { createHash } from "node:crypto";
+const MANIFEST_FILE = "manifest.json";
+const outcomeSchema = object({
+	ruleId: string(),
+	help: withDefault(string(), () => ""),
+	helpUrl: withDefault(string(), () => ""),
+	successCriteria: withDefault(array(string()), () => []),
+	enClauses: withDefault(array(string()), () => []),
+	tags: withDefault(array(string()), () => [])
+});
+const nodeSchema = object({
+	html: string(),
+	target: withDefault(array(string()), () => []),
+	failureSummary: optional(string())
+});
+const findingSchema = object({
+	ruleId: string(),
+	help: withDefault(string(), () => ""),
+	helpUrl: withDefault(string(), () => ""),
+	successCriteria: withDefault(array(string()), () => []),
+	enClauses: withDefault(array(string()), () => []),
+	tags: withDefault(array(string()), () => []),
+	impact: withDefault(nullable(string()), () => null),
+	nodes: withDefault(array(nodeSchema), () => [])
+});
+const incompleteSchema = object({
+	ruleId: string(),
+	help: withDefault(string(), () => ""),
+	helpUrl: withDefault(string(), () => ""),
+	successCriteria: withDefault(array(string()), () => []),
+	enClauses: withDefault(array(string()), () => []),
+	tags: withDefault(array(string()), () => []),
+	impact: withDefault(nullable(string()), () => null),
+	nodes: withDefault(array(nodeSchema), () => []),
+	reason: enumeration(["needs-review", "engine-limitation"]),
+	reasonDetail: withDefault(string(), () => "")
+});
+const entrySchema = object({
+	schemaVersion: number(),
+	/** The page this describes, as the run names it. */
+	page: string(),
+	/** ISO date the result was produced, printed by the reports. */
+	cachedOn: string(),
+	violations: withDefault(array(findingSchema), () => []),
+	incomplete: withDefault(array(incompleteSchema), () => []),
+	passes: withDefault(array(outcomeSchema), () => []),
+	inapplicable: withDefault(array(outcomeSchema), () => [])
+});
+const manifestSchema = object({
+	schemaVersion: number(),
+	/** Hash of everything in `CacheInputs`. A mismatch discards the cache. */
+	key: string(),
+	createdOn: withDefault(string(), () => "")
+});
+/**
+* The identity of a page's content.
+*
+* Path and HTML together: the same markup at two paths is two pages, because
+* the path is what a baseline, a diff and every report key on. A full digest
+* rather than the sixteen characters `elementFingerprint` uses — that one is
+* read by people in a committed file, and this one is read only by the tool,
+* where a collision would serve one page's verdicts for another's.
+*/
+function pageKey(page) {
+	return createHash("sha256").update(`${page.relativePath}\n${page.html}`).digest("hex");
+}
+/**
+* The identity of everything else the verdict depends on.
+*
+* Headers are hashed with the rest and never recorded: what a run sent can
+* change what it was served, so it belongs in the key, and a credential does
+* not belong on disk.
+*/
+function inputsKey(inputs) {
+	const headers = Object.entries(inputs.headers ?? {}).map(([name, value]) => `${name.toLowerCase()}=${value}`).sort().join("\n");
+	return createHash("sha256").update([
+		`tool=${inputs.toolVersion}`,
+		`axe=${inputs.axeVersion}`,
+		`tags=${[...inputs.tags].join(",")}`,
+		`engine=${inputs.engine}`,
+		`fast=${inputs.fast}`,
+		`viewport=${inputs.viewport ? `${inputs.viewport.width}x${inputs.viewport.height}` : ""}`,
+		`baseUrl=${inputs.baseUrl ?? ""}`,
+		`timeout=${inputs.timeoutMs ?? ""}`,
+		`headers=${createHash("sha256").update(headers).digest("hex")}`
+	].join("\n")).digest("hex");
+}
+/**
+* Open the cache for a run, discarding it if anything about the run changed.
+*
+* Everything is read up front and held in memory: an audit asks about every
+* page before it audits any, the entries are small, and a synchronous answer
+* is what lets the caller decide whether to import an engine at all.
+*/
+async function openCache(inputs, options = {}) {
+	const root = path.resolve(options.cwd ?? process.cwd(), options.dir ?? ".eaa-kit/cache");
+	const key = inputsKey(inputs);
+	const today = isoDate(options.today ?? /* @__PURE__ */ new Date());
+	const entries = await manifestMatches(root, key) ? await readEntries(root) : /* @__PURE__ */ new Map();
+	const written = /* @__PURE__ */ new Map();
+	return {
+		get(page) {
+			return entries.get(pageKey(page));
+		},
+		put(page, audit) {
+			if (audit.error !== void 0) return;
+			written.set(pageKey(page), toEntry(page, audit, today));
+		},
+		async flush() {
+			if (written.size === 0) return;
+			try {
+				await mkdir(root, { recursive: true });
+				await writeFile(path.join(root, MANIFEST_FILE), `${JSON.stringify({
+					schemaVersion: 1,
+					key,
+					createdOn: today
+				}, null, 2)}\n`, "utf8");
+				await Promise.all([...written].map(([hash, entry]) => writeFile(path.join(root, `${hash}.json`), `${JSON.stringify(entry)}\n`, "utf8")));
+			} catch {}
+		}
+	};
+}
+/**
+* Whether the stored cache was produced under the same conditions as this run.
+*
+* A mismatch empties the directory rather than leaving entries to be stepped
+* over. They can never be read again — the key that would reach them is gone —
+* and leaving them would grow `.eaa-kit/` without limit.
+*/
+async function manifestMatches(root, key) {
+	let raw;
+	try {
+		raw = await readFile(path.join(root, MANIFEST_FILE), "utf8");
+	} catch {
+		return false;
+	}
+	let parsed;
+	try {
+		parsed = JSON.parse(raw);
+	} catch {
+		await discard(root);
+		return false;
+	}
+	const result = safeParse(manifestSchema, parsed);
+	if (!result.success || result.data.schemaVersion !== 1 || result.data.key !== key) {
+		await discard(root);
+		return false;
+	}
+	return true;
+}
+async function discard(root) {
+	try {
+		await rm(root, {
+			recursive: true,
+			force: true
+		});
+	} catch {}
+}
+/** Every entry in the directory, keyed by page hash. A bad file is skipped. */
+async function readEntries(root) {
+	let files;
+	try {
+		files = await readdir(root);
+	} catch {
+		return /* @__PURE__ */ new Map();
+	}
+	const entries = /* @__PURE__ */ new Map();
+	await Promise.all(files.filter((file) => file.endsWith(".json") && file !== MANIFEST_FILE).map(async (file) => {
+		try {
+			const parsed = JSON.parse(await readFile(path.join(root, file), "utf8"));
+			const result = safeParse(entrySchema, parsed);
+			if (!result.success || result.data.schemaVersion !== 1) return;
+			entries.set(path.basename(file, ".json"), result.data);
+		} catch {}
+	}));
+	return entries;
+}
+/** The parts of a result that describe the page rather than the run. */
+function toEntry(page, audit, today) {
+	return {
+		schemaVersion: 1,
+		page: page.relativePath,
+		cachedOn: today,
+		violations: audit.violations,
+		incomplete: audit.incomplete,
+		passes: audit.passes,
+		inapplicable: audit.inapplicable
+	};
+}
+/**
+* A stored result, put back together as this run's audit.
+*
+* The page's own facts come from the cache; everything about *this* run — where
+* the file is, what URL it is audited under, which engine is running — comes
+* from the run, because those are not properties of the result. `durationMs` is
+* zero rather than the duration of a run that happened on another day, and
+* `reused` is what stops every consumer downstream from mistaking this for work
+* that was done just now.
+*/
+function fromEntry(entry, page, context) {
+	return {
+		relativePath: page.relativePath,
+		absolutePath: page.absolutePath,
+		url: context.url,
+		engine: context.engine,
+		violations: entry.violations,
+		incomplete: entry.incomplete,
+		passes: entry.passes,
+		inapplicable: entry.inapplicable,
+		durationMs: 0,
+		reused: { on: entry.cachedOn }
+	};
+}
+//#endregion
+export { fromEntry, openCache };

package/dist/{checklist-BtgkxMEa.js → checklist-DDd9jewi.js}

@@ -1,5 +1,5 @@
 import { n as count } from "./text-BF1LHMiV.js";
-import { a as emitDocument, o as fail, s as note } from "./command-CZKp9Wi_.js";
+import { a as emitDocument, o as fail, s as note } from "./command-3r4fht5f.js";
 import "./review-CdMK2GpQ.js";
 import { access } from "node:fs/promises";
 import path from "node:path";
@@ -7,7 +7,7 @@ import path from "node:path";
 async function runChecklistCommand(options = {}) {
 	const cwd = options.cwd ?? process.cwd();
 	const recordPath = options.record ?? "eaa-review.json";
-	const { WCAG22_AA_CRITERIA } = await import("./coverage-7bQqWNfN.js");
+	const { WCAG22_AA_CRITERIA } = await import("./coverage-n1X9CkiG.js");
 	const { answeredCount, blankReview, readReview, ReviewError, writeReview } = await import("./review-DIbOTmOM.js");
 	let existing;
 	try {
@@ -23,7 +23,7 @@ async function runChecklistCommand(options = {}) {
 	if (options.reviewedBy !== void 0) record.reviewedBy = options.reviewedBy;
 	await writeReview(recordPath, record, cwd);
 	note(existing === void 0 ? `Review record written to ${recordPath}` : `Review record updated at ${recordPath}: ${count(answeredCount(record), "criterion")} already answered`);
-	const { buildWorksheet } = await import("./worksheet-eUjwYLxC.js");
+	const { buildWorksheet } = await import("./worksheet-BIxMtbUd.js");
 	await emitDocument(buildWorksheet({
 		recordPath,
 		review: record

package/dist/cli/index.js

@@ -1,15 +1,15 @@
 #!/usr/bin/env node
 import { c as meetsThreshold, n as IMPACT_LEVELS, o as impactRank, s as isImpactLevel, t as DEFAULT_FAIL_ON } from "../impact-luGCnN8F.js";
 import { c as nullable, d as optional, h as string, l as number, m as safeParse, n as boolean, p as record, t as array, u as object, y as withDefault } from "../schema-DJSF4K05.js";
-import { c as ConfigError, i as loadConfig, s as COUNTRIES, u as STATEMENT_LOCALES } from "../load-vZdV_fD1.js";
-import { c as StatementError, i as readAuditReport, o as checkStatementEvidence, s as refuses, t as renderStatement } from "../render-CtsqR0k-.js";
+import { c as ConfigError, i as loadConfig, s as COUNTRIES, u as STATEMENT_LOCALES } from "../load-BaWMa-G_.js";
+import { c as StatementError, i as readAuditReport, o as checkStatementEvidence, s as refuses, t as renderStatement } from "../render-C1sUZZI_.js";
 import { n as count, t as collapse } from "../text-BF1LHMiV.js";
 import { t as TOOL_VERSION } from "../version-B3v4rNoG.js";
 import { t as elementFingerprint } from "../fingerprint-BjYV_0F7.js";
-import { a as pruneBaseline, c as writeBaseline, i as buildBaseline, n as DEFAULT_BASELINE_FILE, o as readBaseline, r as applyBaseline, t as BaselineError } from "../baseline-D2qWmUC6.js";
-import { a as emitDocument, c as runEngine, d as parseHeader, i as baselineInvocation, l as warn, n as auditDefaults, o as fail, r as auditInvocation, s as note, t as advise, u as basicAuth } from "../command-CZKp9Wi_.js";
+import { a as pruneBaseline, c as writeBaseline, i as buildBaseline, n as DEFAULT_BASELINE_FILE, o as readBaseline, r as applyBaseline, t as BaselineError } from "../baseline-BpE7DbDq.js";
+import { a as emitDocument, c as runEngine, d as parseHeader, i as baselineInvocation, l as warn, n as auditDefaults, o as fail, r as auditInvocation, s as note, t as advise, u as basicAuth } from "../command-3r4fht5f.js";
 import { t as DEFAULT_REVIEW_FILE } from "../review-CdMK2GpQ.js";
-import { n as runAuditCommand, r as resolvePages, t as OUTPUT_FORMATS } from "../audit-e_uixhPG.js";
+import { n as runAuditCommand, r as resolvePages, t as OUTPUT_FORMATS } from "../audit-DRjAY2iY.js";
 import { enableCompileCache } from "node:module";
 import { readFile } from "node:fs/promises";
 import path from "node:path";
@@ -155,6 +155,8 @@ const reportSchema = object({
 	pages: withDefault(array(object({
 		path: string(),
 		error: withDefault(nullable(string()), () => null),
+		/** Present when the later run reused this page rather than auditing it. */
+		reusedFrom: optional(string()),
 		violations: withDefault(array(object({
 			ruleId: string(),
 			impact: withDefault(nullable(string()), () => null),
@@ -205,9 +207,22 @@ function entriesOf(report) {
 	}
 	return entries;
 }
-/** Pages a run reached a verdict on. A page that errored is not one of them. */
+/**
+* Pages a run reached a verdict on *itself*.
+*
+* A page that errored is not one of them, and neither is a page whose result
+* was reused from a cache: this comparison exists to say what changed between
+* two runs, and a run that did not look at a page learned nothing about it. The
+* difference matters in one direction only, and it is the direction that lies —
+* a violation present in the earlier report and absent from a reused page would
+* otherwise be announced as fixed, which is a changelog of work nobody did.
+*
+* A report written before reuse existed carries no marker, and is read exactly
+* as it was meant when it was written: those runs audited every page they
+* listed.
+*/
 function auditedPages(report) {
-	return new Set(report.pages.filter((page) => page.error === null).map((page) => page.path));
+	return new Set(report.pages.filter((page) => page.error === null && page.reusedFrom === void 0).map((page) => page.path));
 }
 function sideOf(report) {
 	return {
@@ -423,7 +438,8 @@ async function runStatementCommand(options = {}) {
 		const statement = await renderStatement(config, {
 			...options.locale ? { locale: options.locale } : {},
 			...options.country ? { country: options.country } : {},
-			...audit ? { audit } : {}
+			...audit ? { audit } : {},
+			...review ? { review } : {}
 		});
 		note(`Statement for ${config.site.url} from ${path.basename(configPath)} (${statement.template}, ${format})`);
 		if (audit) {
@@ -548,7 +564,7 @@ function parseBasicAuth(value) {
 const program = new Command();
 program.exitOverride();
 program.name("eaa-kit").description("WCAG 2.2 AA auditor and EU accessibility statement generator for static sites.\nNot legal advice.").version(TOOL_VERSION, "-v, --version");
-program.command("audit").description("Audit built HTML against WCAG 2.2 AA").argument("[dir]", "directory holding the built site (default: found automatically)").option("--include <globs...>", "glob patterns to audit, relative to dir").option("--exclude <globs...>", "glob patterns to skip").option("--base-url <url>", "audit pages under their real site URL").option("--url <url>", "audit a running site instead of a build directory").option("--no-build", "never run the project build or start its server").option("--per-page", "also list every page and its result").option("--manual", "what to check by hand for the rules this engine cannot evaluate").option("--coverage", "list every WCAG 2.2 A/AA criterion and what this run reached on it").option("--allow-remote", "allow --url to crawl a host that is not localhost").option("--ignore-robots", "crawl paths robots.txt disallows").option("--sitemap <path>", "where the site lists its pages, if not /sitemap.xml").option("--max-pages <n>", "stop the crawl after this many pages", parsePositive).option("--max-depth <n>", "how far from the entry URL to follow links", parseDepth).option("--header <header>", "send this header with every request, e.g. \"Authorization: Bearer …\". Repeatable", collectHeader).option("--basic-auth <user:password>", "send an Authorization header for basic auth", parseBasicAuth).option("--fail-on <impact>", `exit 1 on violations at or above this impact (${IMPACT_LEVELS.join("|")}; default: ${DEFAULT_FAIL_ON})`, parseImpact).option("--format <format>", `output format (${OUTPUT_FORMATS.join("|")}; default: console)`, parseFormat).option("--output <path>", "write the report to a file instead of stdout").option("--browser", "audit in real Chromium, covering the rules jsdom cannot evaluate").option("--fast", "skip the rules the browserless engine cannot decide anyway, losing their element lists").option("--concurrency <n>", "pages to audit at once, or 1 for none (default: from the page and core count)", parseConcurrency).option("--baseline <path>", "accept the violations recorded in this file; fail only on new ones").option("--review <path>", "what a person checked, from eaa-kit checklist").option("--review-max-age <days>", "stop counting review entries older than this", parseDepth).option("--config <path>", "take defaults from this config file, otherwise it is searched for").action(async (dir, flags) => {
+program.command("audit").description("Audit built HTML against WCAG 2.2 AA").argument("[dir]", "directory holding the built site (default: found automatically)").option("--include <globs...>", "glob patterns to audit, relative to dir").option("--exclude <globs...>", "glob patterns to skip").option("--base-url <url>", "audit pages under their real site URL").option("--url <url>", "audit a running site instead of a build directory").option("--no-build", "never run the project build or start its server").option("--per-page", "also list every page and its result").option("--manual", "what to check by hand for the rules this engine cannot evaluate").option("--coverage", "list every WCAG 2.2 A/AA criterion and what this run reached on it").option("--allow-remote", "allow --url to crawl a host that is not localhost").option("--ignore-robots", "crawl paths robots.txt disallows").option("--sitemap <path>", "where the site lists its pages, if not /sitemap.xml").option("--max-pages <n>", "stop the crawl after this many pages", parsePositive).option("--max-depth <n>", "how far from the entry URL to follow links", parseDepth).option("--header <header>", "send this header with every request, e.g. \"Authorization: Bearer …\". Repeatable", collectHeader).option("--basic-auth <user:password>", "send an Authorization header for basic auth", parseBasicAuth).option("--fail-on <impact>", `exit 1 on violations at or above this impact (${IMPACT_LEVELS.join("|")}; default: ${DEFAULT_FAIL_ON})`, parseImpact).option("--format <format>", `output format (${OUTPUT_FORMATS.join("|")}; default: console)`, parseFormat).option("--output <path>", "write the report to a file instead of stdout").option("--browser", "audit in real Chromium, covering the rules jsdom cannot evaluate").option("--fast", "skip the rules the browserless engine cannot decide anyway, losing their element lists").option("--concurrency <n>", "pages to audit at once, or 1 for none (default: from the page and core count)", parseConcurrency).option("--baseline <path>", "accept the violations recorded in this file; fail only on new ones").option("--no-cache", "audit every page, reusing no result from an earlier run").option("--review <path>", "what a person checked, from eaa-kit checklist").option("--review-max-age <days>", "stop counting review entries older than this", parseDepth).option("--config <path>", "take defaults from this config file, otherwise it is searched for").action(async (dir, flags) => {
 	const defaults = await auditDefaults({ ...flags.config ? { config: flags.config } : {} });
 	const invocation = auditInvocation(dir, defaults, flags);
 	const { exitCode } = await runAuditCommand(invocation.dir, invocation.options);
@@ -561,7 +577,7 @@ program.command("baseline").description("Record the violations a build already h
 	process.exitCode = exitCode;
 });
 program.command("checklist").description("Write the manual review: the 34 WCAG criteria no automated rule can reach").option("--record <path>", `where the answers live (default: ${DEFAULT_REVIEW_FILE})`).option("--output <path>", "write the worksheet here instead of stdout").option("--reviewed-by <name>", "who is carrying out the review").action(async (flags) => {
-	const { runChecklistCommand } = await import("../checklist-BtgkxMEa.js");
+	const { runChecklistCommand } = await import("../checklist-DDd9jewi.js");
 	const { exitCode } = await runChecklistCommand(flags);
 	process.exitCode = exitCode;
 });
@@ -570,11 +586,11 @@ program.command("diff").description("Compare two JSON reports: what a change mad
 	process.exitCode = exitCode;
 });
 program.command("init").description("Write an eaa.config.json to generate statements from").option("--output <path>", "write here instead of eaa.config.json").option("--force", "overwrite a config that is already there").option("-y, --yes", "take every default without asking").action(async (flags) => {
-	const { runInitCommand } = await import("../init-BjKYttxc.js");
+	const { runInitCommand } = await import("../init-DrFfzjvm.js");
 	const { exitCode } = await runInitCommand(flags);
 	process.exitCode = exitCode;
 });
-program.command("statement").description("Generate an EU accessibility statement from eaa.config").option("--config <path>", "path to the config file, otherwise it is searched for").option("--lang <locale>", `statement language (${STATEMENT_LOCALES.join("|")})`, parseLocale).option("--country <code>", `override the country template (${COUNTRIES.join("|")})`, parseCountry).option("--audit <path>", "list the barriers from an eaa-kit audit --format json report").option("--review <path>", "check the conformance claim against a review record; nothing from it is published").option("--format <format>", `output format (${STATEMENT_FORMATS.join("|")}), otherwise from the --output extension`, parseStatementFormat).option("--output <path>", "write the statement to a file instead of stdout").action(async (flags) => {
+program.command("statement").description("Generate an EU accessibility statement from eaa.config").option("--config <path>", "path to the config file, otherwise it is searched for").option("--lang <locale>", `statement language (${STATEMENT_LOCALES.join("|")})`, parseLocale).option("--country <code>", `override the country template (${COUNTRIES.join("|")})`, parseCountry).option("--audit <path>", "list the barriers from an eaa-kit audit --format json report").option("--review <path>", "say how many criteria a person checked, and check the conformance claim against them").option("--format <format>", `output format (${STATEMENT_FORMATS.join("|")}), otherwise from the --output extension`, parseStatementFormat).option("--output <path>", "write the statement to a file instead of stdout").action(async (flags) => {
 	const { lang, ...options } = flags;
 	const { exitCode } = await runStatementCommand({
 		...options,

package/dist/{command-CZKp9Wi_.js → command-3r4fht5f.js}

@@ -122,14 +122,14 @@ async function runEngine(pages, options) {
 		...options.timeoutMs === void 0 ? {} : { timeoutMs: options.timeoutMs }
 	};
 	if (!options.browser) {
-		const { runPooledAudit } = await import("./pool-dkexq5xo.js");
+		const { runPooledAudit } = await import("./pool-B4tEUa2S.js");
 		return runPooledAudit(pages, {
 			...runnerOptions,
 			...options.fast ? { fast: true } : {},
 			...options.concurrency === void 0 ? {} : { concurrency: options.concurrency }
 		});
 	}
-	const { BrowserUnavailableError, runBrowserAudit } = await import("./playwright-C-miJP2b.js");
+	const { BrowserUnavailableError, runBrowserAudit } = await import("./playwright-ukCr_5o3.js");
 	try {
 		return await runBrowserAudit(options.directory, pages, {
 			...runnerOptions,
@@ -176,7 +176,7 @@ async function emitDocument(body, output, cwd) {
 * on different settings than it names would be worse than stopping.
 */
 async function auditDefaults(options = {}) {
-	const { loadAuditConfig } = await import("./load-Bc_xDGAh.js");
+	const { loadAuditConfig } = await import("./load-n62iXDq_.js");
 	const loaded = await loadAuditConfig({
 		...options.cwd ? { cwd: options.cwd } : {},
 		...options.config ? { path: options.config } : {}
@@ -186,8 +186,8 @@ async function auditDefaults(options = {}) {
 	return loaded.audit;
 }
 function auditInvocation(dir, defaults, flags) {
-	const { build, config: _config, header, basicAuth, ...typed } = flags;
-	const { dir: configDir, build: configBuild, headers: _fromFile, ...fromConfig } = defaults;
+	const { build, cache, config: _config, header, basicAuth, ...typed } = flags;
+	const { dir: configDir, build: configBuild, cache: configCache, headers: _fromFile, ...fromConfig } = defaults;
 	const headers = requestHeaders({
 		...header ? { header } : {},
 		...basicAuth ? { basicAuth } : {}
@@ -198,6 +198,7 @@ function auditInvocation(dir, defaults, flags) {
 			...fromConfig,
 			...typed,
 			...build === false || configBuild === false ? { noBuild: true } : {},
+			...cache === false || configCache === false ? { noCache: true } : {},
 			...headers === void 0 ? {} : { headers }
 		}
 	};