@kinora/vitest-reporter 0.1.0 → 0.2.0

package/dist/index.d.mts

@@ -4,7 +4,7 @@ import { Reporter, TestModule, Vitest } from "vitest/node";
 type IncludeTests = 'browser' | 'all';
 //#endregion
 //#region src/index.d.ts
-interface KinoraVitestReporterOptions {
+export interface KinoraVitestReporterOptions {
   /** kinora server base URL. Defaults to env KINORA_URL, then the hosted cloud. Set for self-host. */
   url?: string;
   /** Project API token. Defaults to env KINORA_TOKEN (keep it out of the config file). */
@@ -25,7 +25,7 @@ interface KinoraVitestReporterOptions {
    */
   include?: IncludeTests;
 }
-declare class KinoraVitestReporter implements Reporter {
+export default class KinoraVitestReporter implements Reporter {
   private readonly options;
   private startedAt;
   constructor(options: KinoraVitestReporterOptions);
@@ -34,4 +34,4 @@ declare class KinoraVitestReporter implements Reporter {
   onTestRunEnd(modules: ReadonlyArray<TestModule>): Promise<void>;
 }
 //#endregion
-export { KinoraVitestReporterOptions, KinoraVitestReporter as default };
+export {};

package/dist/index.mjs

@@ -1,6 +1,6 @@
 import { readFile } from "node:fs/promises";
 import process from "node:process";
-import { DEFAULT_KINORA_URL, DEFAULT_UPLOAD_ATTACHMENTS, IngestError, STORY_ANNOTATION, createIngestClient, detectCiEnv, isUploadableAttachment, makeTestKey, stripAnsi } from "@kinora/core";
+import { A11Y_IMPACTS, DEFAULT_KINORA_URL, DEFAULT_UPLOAD_ATTACHMENTS, IngestError, MAX_A11Y_NODES, MAX_A11Y_VIOLATIONS, STORY_ANNOTATION, createIngestClient, detectCiEnv, isUploadableAttachment, makeTestKey, stripAnsi } from "@kinora/core";
 //#region src/convert.ts
 function identity(test) {
 	const file = test.module.relativeModuleId;
@@ -28,6 +28,66 @@ function storyOf(test, titlePath) {
 	if (!meta.componentName) return meta.storyId.replace("--", "/");
 	return `${meta.componentName}/${titlePath[1]}`;
 }
+const MAX_TEXT = 300;
+const truncate = (s) => s.length > MAX_TEXT ? `${s.slice(0, MAX_TEXT)}…` : s;
+const isImpact = (v) => A11Y_IMPACTS.includes(v);
+function selector(target) {
+	if (!Array.isArray(target)) return "";
+	return truncate(target.map((t) => Array.isArray(t) ? t.join(" >>> ") : String(t)).join(" "));
+}
+function violation(v) {
+	if (!v.id) return [];
+	const nodes = v.nodes ?? [];
+	return [{
+		id: v.id,
+		...isImpact(v.impact) && { impact: v.impact },
+		help: truncate(v.help ?? v.id),
+		...v.helpUrl && { helpUrl: v.helpUrl },
+		nodes: nodes.slice(0, MAX_A11Y_NODES).map((n) => selector(n.target)).filter(Boolean),
+		nodeCount: nodes.length
+	}];
+}
+const AXE_FAILURE = /Expected the HTML found at \$\('(.+?)'\) to have no violations:[\s\S]*?Received:\s*"(.+?) \(([\w-]+)\)"[\s\S]*?more information on this issue here:\s*(https:\/\/\S+)/g;
+function a11yFromError(test) {
+	const message = test.result().errors?.find((e) => e.message.includes("toHaveNoViolations"))?.message;
+	if (!message) return void 0;
+	const byRule = /* @__PURE__ */ new Map();
+	for (const [, target, help, id, helpUrl] of stripAnsi(message).matchAll(AXE_FAILURE)) {
+		const v = byRule.get(id) ?? {
+			id,
+			help: truncate(help),
+			helpUrl,
+			nodes: [],
+			nodeCount: 0
+		};
+		if (v.nodes.length < MAX_A11Y_NODES) v.nodes.push(truncate(target));
+		v.nodeCount++;
+		byRule.set(id, v);
+	}
+	return byRule.size ? {
+		status: "failed",
+		violations: [...byRule.values()].slice(0, MAX_A11Y_VIOLATIONS)
+	} : void 0;
+}
+function a11yOf(test) {
+	const report = test.meta().reports?.find((r) => r.type === "a11y");
+	const status = report?.status;
+	if (status !== "passed" && status !== "warning" && status !== "failed") return a11yFromError(test);
+	const result = report?.result ?? {};
+	if (result.error) {
+		const { message } = result.error;
+		const text = typeof message === "string" ? message : typeof result.error === "string" ? result.error : "The accessibility check failed.";
+		return {
+			status: "failed",
+			violations: [],
+			error: truncate(text)
+		};
+	}
+	return {
+		status,
+		violations: (result.violations ?? []).slice(0, MAX_A11Y_VIOLATIONS).flatMap(violation)
+	};
+}
 function slug(name) {
 	return name.toLowerCase().replace(/[^a-z0-9]+/g, "-").replace(/^-|-$/g, "") || "screenshot";
 }
@@ -75,6 +135,7 @@ function toNormTest(test) {
 	const { file, titlePath, projectName } = identity(test);
 	const diagnostic = test.diagnostic();
 	const story = storyOf(test, titlePath);
+	const a11y = a11yOf(test);
 	return {
 		testKey: makeTestKey(file, titlePath, projectName),
 		title: test.name,
@@ -99,7 +160,8 @@ function toNormTest(test) {
 			message: cleanMessage(e.message),
 			stack: e.stack
 		})),
-		attachments: attachmentsOf(test)
+		attachments: attachmentsOf(test),
+		...a11y && { a11y }
 	};
 }
 function toNormTests(modules, include = "browser") {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@kinora/vitest-reporter",
   "type": "module",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "Vitest reporter that uploads browser-mode and Storybook test results to a kinora server",
   "author": "Joris Gallot",
   "license": "MIT",
@@ -28,21 +28,21 @@
     "dist"
   ],
   "engines": {
-    "node": ">=20"
+    "node": ">=20.20.2"
   },
   "publishConfig": {
     "access": "public"
   },
   "peerDependencies": {
-    "vitest": ">=4.1.0"
+    "vitest": ">=4.1.11"
   },
   "dependencies": {
-    "@kinora/core": "0.7.0"
+    "@kinora/core": "0.9.0"
   },
   "devDependencies": {
-    "@types/node": "^26.5.1",
+    "@types/node": "^26.6.5",
     "@vitest/coverage-v8": "^5.0.3",
-    "tsdown": "^0.22.14",
+    "tsdown": "^0.23.1",
     "typescript": "~6.0.3",
     "vitest": "^5.0.3"
   },