eaa-kit 0.5.0 → 0.7.0

package/dist/webpack/index.js

@@ -1,4 +1,4 @@
-import { n as auditBuild, r as stderrLogger, t as BuildAuditError } from "../run-C2nKFcb-.js";
+import { n as auditBuild, r as stderrLogger, t as BuildAuditError } from "../run-DrS0Komf.js";
 import path from "node:path";
 //#region src/webpack/index.ts
 var EaaKitWebpackPlugin = class {

package/dist/worksheet-BIxMtbUd.js

@@ -0,0 +1,64 @@
+import { t as WCAG22_AA_CRITERIA } from "./criteria-CnPJKGeb.js";
+import { n as DEFAULT_TAGS } from "./result-B7_zVxAX.js";
+import { a as manualCheckFor, i as rulesByCriterion, o as understandingUrl } from "./coverage-cb5kPp48.js";
+//#region src/audit/worksheet.ts
+function buildWorksheet(options) {
+	const rules = rulesByCriterion(options.tags ?? DEFAULT_TAGS);
+	const unautomatable = WCAG22_AA_CRITERIA.filter((criterion) => (rules.get(criterion.number) ?? []).length === 0);
+	const lines = [
+		"# Manual accessibility review",
+		"",
+		`Of the ${WCAG22_AA_CRITERIA.length} WCAG 2.2 success criteria at Levels A and AA,`,
+		`**${unautomatable.length} have no automated rule at all**: no engine, this one included, can`,
+		"reach a verdict on them. They are the part of conformance a person has to do, and this is",
+		"the list of them.",
+		"",
+		`Record what you find in \`${options.recordPath}\`, which is the file \`eaa-kit audit --review\``,
+		"reads. Ticking a box below records nothing: this document is generated from the record and",
+		"never read back into it.",
+		"",
+		"For each criterion, set `result` to one of:",
+		"",
+		"- `met` — you checked it and the site meets it.",
+		"- `not-met` — you checked it and it does not. Say what is wrong in `note`.",
+		"- `not-applicable` — there is nothing on this site the criterion applies to. Not the same",
+		"  as `met`, and never counted as though it were.",
+		"- `unreviewed` — nobody has looked yet. What every entry starts as.",
+		"",
+		"Set `reviewedOn` to the day you checked it. An entry with no date cannot be shown to still",
+		"hold, and an audit run with `--review-max-age` will not count it.",
+		""
+	];
+	lines.push("## Criteria no automated rule can reach", "", "These are the review. Nothing in any eaa-kit report says anything about them.", "");
+	for (const criterion of unautomatable) lines.push(...criterionEntry(criterion, [], options.review));
+	lines.push("## Criteria an audit can reach", "", "An audit reaches these when the rules below actually match something on the site. A run", "that found nothing to check has not shown the criterion is met, so they are worth a look", "too — and where this engine could not decide a rule, the check to do by hand is named.", "");
+	for (const criterion of WCAG22_AA_CRITERIA) {
+		const forCriterion = rules.get(criterion.number) ?? [];
+		if (forCriterion.length === 0) continue;
+		lines.push(...criterionEntry(criterion, forCriterion, options.review));
+	}
+	lines.push("---", "", "A completed review is not a compliance statement, and this tool cannot check that anything", "recorded here is true. It records what somebody says they checked, which is the same", "standing as the claims in the statement it generates.", "");
+	return lines.join("\n");
+}
+function criterionEntry(criterion, rules, review) {
+	const entry = review?.criteria[criterion.number];
+	const lines = [`- [${entry !== void 0 && entry.result !== "unreviewed" ? "x" : " "}] **${criterion.number} ${criterion.title}** (Level ${criterion.level})`];
+	const url = understandingUrl(criterion.number);
+	if (url !== void 0) lines.push(`      What it requires: ${url}`);
+	if (rules.length > 0) {
+		lines.push(`      Rules that touch it: ${rules.join(", ")}`);
+		for (const rule of rules) {
+			const manual = manualCheckFor(rule);
+			if (manual !== void 0) lines.push(`      ${rule}: ${manual.check}`);
+		}
+	}
+	if (entry !== void 0 && entry.result !== "unreviewed") {
+		const on = entry.reviewedOn === void 0 ? "no date recorded" : `on ${entry.reviewedOn}`;
+		lines.push(`      Recorded: ${entry.result} (${on})`);
+		if (entry.note !== void 0) lines.push(`      Note: ${entry.note}`);
+	}
+	lines.push("");
+	return lines;
+}
+//#endregion
+export { buildWorksheet };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eaa-kit",
-  "version": "0.5.0",
+  "version": "0.7.0",
   "description": "WCAG 2.2 AA auditor and EU accessibility statement generator for seven countries (AT, DE, CH, ES, FR, IT, NL). Audits a static build or a running site from the command line.",
   "type": "module",
   "license": "MIT",
@@ -79,7 +79,8 @@
     "typecheck": "tsc --noEmit",
     "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 && node dist/cli/index.js audit tests/fixtures/site --include about/** --format json --output .eaa-kit/smoke-base.json && node dist/cli/index.js audit tests/fixtures/site --include about/** --format json --output .eaa-kit/smoke-head.json && node dist/cli/index.js diff .eaa-kit/smoke-base.json .eaa-kit/smoke-head.json --format json",
+    "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 baseline tests/fixtures/site --output .eaa-kit/smoke-baseline.json && node dist/cli/index.js baseline tests/fixtures/site --output .eaa-kit/smoke-baseline.json --prune && node dist/cli/index.js checklist --record .eaa-kit/smoke-review.json --output .eaa-kit/smoke-review.md && node dist/cli/index.js audit tests/fixtures/site --include about/** --review .eaa-kit/smoke-review.json --coverage && 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 && node dist/cli/index.js audit tests/fixtures/site --include about/** --format json --no-cache --output .eaa-kit/smoke-base.json && node dist/cli/index.js audit tests/fixtures/site --include about/** --format json --no-cache --output .eaa-kit/smoke-head.json && node dist/cli/index.js diff .eaa-kit/smoke-base.json .eaa-kit/smoke-head.json --format json",
+    "bench": "pnpm build && node scripts/bench.mjs",
     "examples": "pnpm build && node scripts/generate-examples.mjs",
     "test:packaged": "pnpm build && node scripts/test-packaged.mjs"
   },

package/dist/audit-DyHPmGeD.js

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

package/dist/baseline-0u4df12v.js

@@ -1,2 +0,0 @@
-import { a as readBaseline, r as applyBaseline, t as BaselineError } from "./baseline-CuAS2lMk.js";
-export { BaselineError, applyBaseline, readBaseline };

package/dist/jsdom-22Bkt65v.js

@@ -1,3 +0,0 @@
-import "./result-BWcYXeRs.js";
-import { n as runJsdomAudit } from "./jsdom-B--cEH-G.js";
-export { runJsdomAudit };

package/dist/load-CFq2VQtT.js

@@ -1,2 +0,0 @@
-import { r as loadAuditConfig } from "./load-yAR4wzez.js";
-export { loadAuditConfig };