@kinora/reporter 0.7.0 → 0.8.1

package/README.md

@@ -71,6 +71,28 @@ Each mounted story id is recorded on the test as a `kinora:story` annotation. Al
 
 More in the [component testing guide](https://docs.kinora.dev/guides/component-testing/).
 
+## Accessibility
+
+kinora records the axe scans attached to a test: the rules broken, their impact and the elements
+they hit. `scanA11y` runs the scan with `@axe-core/playwright` (add it to your dev dependencies)
+and attaches the result:
+
+```ts
+import { scanA11y } from '@kinora/reporter/a11y'
+import { expect, test } from '@playwright/test'
+
+test('checkout is accessible', async ({ page }) => {
+  await page.goto('/checkout')
+  const { violations } = await scanA11y(page)
+  expect(violations).toEqual([]) // leave it out to record the violations as warnings
+})
+```
+
+A scan you build yourself works too, as long as it is attached to the test with
+`testInfo.attach(name, { body: JSON.stringify(results), contentType: 'application/json' })`.
+An assertion alone is invisible to a reporter. More in the
+[accessibility guide](https://docs.kinora.dev/guides/reporter/#accessibility).
+
 ## Documentation
 
 Full reporter options, PR/MR comments, CI examples, and self-hosting are in the docs:

package/dist/a11y.d.mts

@@ -0,0 +1,15 @@
+import { Page } from "@playwright/test";
+import AxeBuilder from "@axe-core/playwright";
+//#region src/a11y.d.ts
+export type AxeResults = Awaited<ReturnType<AxeBuilder['analyze']>>;
+export declare const A11Y_ATTACHMENT = "accessibility-scan-results";
+/**
+ * Scans the page with axe (`@axe-core/playwright`) and attaches the result to the running test,
+ * which is where kinora reads it: without the attachment, a reporter only sees the test fail.
+ *
+ * Returns axe's result. Assert on `violations` to fail the test on them, or leave them be to
+ * record them as warnings. `configure` narrows or widens the scan, e.g.
+ * `axe => axe.withTags(['wcag2a', 'wcag2aa'])`.
+ */
+export declare function scanA11y(page: Page, configure?: (axe: AxeBuilder) => AxeBuilder): Promise<AxeResults>;
+//#endregion

package/dist/a11y.mjs

@@ -0,0 +1,25 @@
+import { test } from "@playwright/test";
+//#region src/a11y.ts
+const A11Y_ATTACHMENT = "accessibility-scan-results";
+/**
+* Scans the page with axe (`@axe-core/playwright`) and attaches the result to the running test,
+* which is where kinora reads it: without the attachment, a reporter only sees the test fail.
+*
+* Returns axe's result. Assert on `violations` to fail the test on them, or leave them be to
+* record them as warnings. `configure` narrows or widens the scan, e.g.
+* `axe => axe.withTags(['wcag2a', 'wcag2aa'])`.
+*/
+async function scanA11y(page, configure) {
+	const { default: Axe } = await import("@axe-core/playwright").catch(() => {
+		throw new Error("scanA11y needs @axe-core/playwright: add it to your dev dependencies.");
+	});
+	const axe = new Axe({ page });
+	const results = await (configure?.(axe) ?? axe).analyze();
+	await test.info().attach(A11Y_ATTACHMENT, {
+		body: JSON.stringify(results),
+		contentType: "application/json"
+	});
+	return results;
+}
+//#endregion
+export { A11Y_ATTACHMENT, scanA11y };

package/dist/ct.d.mts

@@ -1,12 +1,12 @@
 import { TestInfo, expect } from "@playwright/test";
 //#region src/ct.d.ts
 type Annotations = TestInfo['annotations'];
-declare function recordStory(annotations: Annotations, storyId: string): void;
-declare function withStoryAnnotations<M extends (storyId: string, ...rest: any[]) => unknown>(mount: M, annotations: Annotations): M;
+export declare function recordStory(annotations: Annotations, storyId: string): void;
+export declare function withStoryAnnotations<M extends (storyId: string, ...rest: any[]) => unknown>(mount: M, annotations: Annotations): M;
 /**
  * Drop-in replacement for `test` from `@playwright/test` in component tests: `mount` records
  * the mounted story id on the test, which lets kinora group results by component and story.
  */
-declare const test: import("@playwright/test").TestType<import("@playwright/test").PlaywrightTestArgs & import("@playwright/test").PlaywrightTestOptions, import("@playwright/test").PlaywrightWorkerArgs & import("@playwright/test").PlaywrightWorkerOptions>;
+export declare const test: import("@playwright/test").TestType<import("@playwright/test").PlaywrightTestArgs & import("@playwright/test").PlaywrightTestOptions, import("@playwright/test").PlaywrightWorkerArgs & import("@playwright/test").PlaywrightWorkerOptions>;
 //#endregion
-export { expect, recordStory, test, withStoryAnnotations };
+export { expect };

package/dist/index.d.mts

@@ -1,7 +1,7 @@
 import { AttachmentKind, CiMeta, GitMeta } from "@kinora/core";
 import { FullConfig, FullResult, Reporter, Suite } from "@playwright/test/reporter";
 //#region src/index.d.ts
-interface KinoraReporterOptions {
+export interface KinoraReporterOptions {
   /** 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). */
@@ -30,7 +30,7 @@ interface KinoraReporterOptions {
    */
   uploadAttachments?: AttachmentKind[];
 }
-declare class KinoraReporter implements Reporter {
+export default class KinoraReporter implements Reporter {
   private readonly options;
   private suite;
   private config;
@@ -39,5 +39,4 @@ declare class KinoraReporter implements Reporter {
   onEnd(result: FullResult): Promise<void>;
   private maybePostPrComment;
 }
-//#endregion
-export { KinoraReporterOptions, KinoraReporter as default };
+//#endregion

package/dist/index.mjs

@@ -1,7 +1,7 @@
-import { readFileSync } from "node:fs";
+import { readFileSync, statSync } from "node:fs";
 import { readFile } from "node:fs/promises";
 import process from "node:process";
-import { DEFAULT_KINORA_URL, DEFAULT_UPLOAD_ATTACHMENTS, IngestError, createIngestClient, detectCiEnv, effectiveAttachments, isUploadableAttachment, makeTestKey, postPrComment, resolvePrContext } from "@kinora/core";
+import { DEFAULT_KINORA_URL, DEFAULT_UPLOAD_ATTACHMENTS, IngestError, a11yFromScans, createIngestClient, detectCiEnv, effectiveAttachments, isUploadableAttachment, makeTestKey, parseAxeScan, postPrComment, resolvePrContext } from "@kinora/core";
 //#region src/index.ts
 function identity(test) {
 	let file = "";
@@ -24,9 +24,24 @@ function identity(test) {
 		projectName
 	};
 }
+const MAX_SCAN_BYTES = 20971520;
+function axeScans(attachments) {
+	return attachments.flatMap((a) => {
+		if (!a.contentType.includes("json")) return [];
+		try {
+			const text = a.body ? a.body.length <= MAX_SCAN_BYTES ? a.body.toString("utf8") : void 0 : a.path && statSync(a.path).size <= MAX_SCAN_BYTES ? readFileSync(a.path, "utf8") : void 0;
+			const scan = text ? parseAxeScan(text) : void 0;
+			return scan ? [scan] : [];
+		} catch {
+			return [];
+		}
+	});
+}
 function toNormTest(test) {
 	const { file, titlePath, projectName } = identity(test);
 	const last = test.results.at(-1);
+	const attachments = effectiveAttachments(test.results);
+	const a11y = a11yFromScans(axeScans(attachments), test.ok());
 	return {
 		testKey: makeTestKey(file, titlePath, projectName),
 		title: test.title,
@@ -49,12 +64,13 @@ function toNormTest(test) {
 			stack: e.stack,
 			location: e.location
 		}] : []),
-		attachments: effectiveAttachments(test.results).map((a) => ({
+		attachments: attachments.map((a) => ({
 			name: a.name,
 			contentType: a.contentType,
 			path: a.path,
 			hasBody: a.body != null
-		}))
+		})),
+		...a11y && { a11y }
 	};
 }
 function countsOf(tests) {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@kinora/reporter",
   "type": "module",
-  "version": "0.7.0",
+  "version": "0.8.1",
   "description": "Playwright reporter that uploads test results to a kinora server",
   "author": "Joris Gallot",
   "license": "MIT",
@@ -21,31 +21,39 @@
   ],
   "exports": {
     ".": "./dist/index.mjs",
-    "./ct": "./dist/ct.mjs"
+    "./ct": "./dist/ct.mjs",
+    "./a11y": "./dist/a11y.mjs"
   },
   "main": "./dist/index.mjs",
   "files": [
     "dist"
   ],
   "engines": {
-    "node": ">=20"
+    "node": ">=20.20.2"
   },
   "publishConfig": {
     "access": "public"
   },
   "peerDependencies": {
+    "@axe-core/playwright": ">=4.7.0",
     "@playwright/test": ">=1.40.0"
   },
+  "peerDependenciesMeta": {
+    "@axe-core/playwright": {
+      "optional": true
+    }
+  },
   "dependencies": {
-    "@kinora/core": "0.7.0"
+    "@kinora/core": "0.10.1"
   },
   "devDependencies": {
-    "@playwright/test": "^1.63.0",
-    "@types/node": "^26.5.1",
-    "@vitest/coverage-v8": "^4.1.11",
-    "tsdown": "^0.22.14",
+    "@axe-core/playwright": "^4.13.0",
+    "@playwright/test": "^1.64.0",
+    "@types/node": "^26.6.5",
+    "@vitest/coverage-v8": "^5.0.4",
+    "tsdown": "^0.23.1",
     "typescript": "~6.0.3",
-    "vitest": "^4.1.11"
+    "vitest": "^5.0.4"
   },
   "scripts": {
     "build": "tsdown",