@lullabot/playwright-testing 0.1.0 → 1.0.1

package/bin/github-a11y-summary

@@ -1,5 +1,5 @@
 #!/usr/bin/env node
 
-const { main } = require('../lib/github/a11y-summary.js')
+const { main } = require("../lib/github/a11y-summary.js");
 
-main()
+main();

package/bin/github-failure-summary

@@ -1,8 +1,8 @@
 #!/usr/bin/env node
 
-const { main } = require('../lib/github/failure-summary.js')
+const { main } = require("../lib/github/failure-summary.js");
 
 main().catch((error) => {
-  console.error(error)
-  process.exit(1)
-})
+  console.error(error);
+  process.exit(1);
+});

package/lib/accessibility-baseline-file.d.ts

@@ -1,6 +1,6 @@
-import type { TestInfo } from '@playwright/test';
-import type { AccessibilityBaselineEntry } from './accessibility-baseline.js';
-export type ScanKind = 'wcag' | 'best-practice';
+import type { TestInfo } from "@playwright/test";
+import type { AccessibilityBaselineEntry } from "./accessibility-baseline.js";
+export type ScanKind = "wcag" | "best-practice";
 export interface OnDiskBaselineFile {
     note: string;
     violations: AccessibilityBaselineEntry[];
@@ -18,7 +18,7 @@ export interface OnDiskBaselineFile {
  * clear state explicitly — for example, between tests in a unit-test
  * suite that reuses a mocked TestInfo.
  */
-export declare function nextAccessibilityScanCount(testInfo: Pick<TestInfo, 'testId'> | object, scan: ScanKind): number;
+export declare function nextAccessibilityScanCount(testInfo: Pick<TestInfo, "testId"> | object, scan: ScanKind): number;
 export declare function resetAccessibilityScanCounts(testInfo: object): void;
 /**
  * Build the on-disk baseline file path for a single scan call.
@@ -34,14 +34,14 @@ export declare function resetAccessibilityScanCounts(testInfo: object): void;
  * explicit-name snapshot path — that logic is private to `toMatchSnapshot()`
  * for its auto-counter naming — so we build the stem ourselves.
  */
-export declare function baselineFilePath(testInfo: Pick<TestInfo, 'snapshotPath' | 'titlePath' | 'title'>, scan: ScanKind, callCount: number): string;
+export declare function baselineFilePath(testInfo: Pick<TestInfo, "snapshotPath" | "titlePath" | "title">, scan: ScanKind, callCount: number): string;
 /**
  * Return true if a Playwright snapshot file already exists on disk for
  * this test — i.e. the test has been previously committed under snapshot
  * mode. Used to preserve snapshot-mode behaviour for existing tests while
  * defaulting new (snapshotless) tests into on-disk baseline mode.
  */
-export declare function snapshotExists(testInfo: Pick<TestInfo, 'snapshotPath' | 'titlePath' | 'title'>): Promise<boolean>;
+export declare function snapshotExists(testInfo: Pick<TestInfo, "snapshotPath" | "titlePath" | "title">): Promise<boolean>;
 export declare function readBaselineFile(filePath: string): Promise<OnDiskBaselineFile | null>;
 export declare function writeBaselineFile(filePath: string, data: OnDiskBaselineFile): Promise<void>;
 export declare function buildSeed(violations: AccessibilityBaselineEntry[]): OnDiskBaselineFile;

package/lib/accessibility-baseline-file.js

@@ -51,8 +51,8 @@ function resetAccessibilityScanCounts(testInfo) {
  */
 function slugifyTitle(testInfo) {
     const segments = testInfo.titlePath?.slice(1) ?? [];
-    const raw = segments.length > 0 ? segments.join(' ') : testInfo.title;
-    let out = '';
+    const raw = segments.length > 0 ? segments.join(" ") : testInfo.title;
+    let out = "";
     let lastWasHyphen = true; // suppresses leading hyphen
     for (let i = 0; i < raw.length; i++) {
         const code = raw.charCodeAt(i);
@@ -68,12 +68,12 @@ function slugifyTitle(testInfo) {
             lastWasHyphen = false;
         }
         else if (!lastWasHyphen) {
-            out += '-';
+            out += "-";
             lastWasHyphen = true;
         }
     }
     // Trim trailing hyphen.
-    if (out.endsWith('-'))
+    if (out.endsWith("-"))
         out = out.slice(0, -1);
     return out;
 }
@@ -88,8 +88,8 @@ function slugifyTitle(testInfo) {
  */
 function playwrightSnapshotStem(testInfo) {
     const segments = testInfo.titlePath?.slice(1) ?? [];
-    const raw = segments.length > 0 ? segments.join(' ') : testInfo.title;
-    let out = '';
+    const raw = segments.length > 0 ? segments.join(" ") : testInfo.title;
+    let out = "";
     let lastWasReplaced = false;
     for (let i = 0; i < raw.length; i++) {
         const code = raw.charCodeAt(i);
@@ -100,7 +100,7 @@ function playwrightSnapshotStem(testInfo) {
             (code >= 0x7b && code <= 0x7f);
         if (replaced) {
             if (!lastWasReplaced)
-                out += '-';
+                out += "-";
             lastWasReplaced = true;
         }
         else {
@@ -126,7 +126,7 @@ function playwrightSnapshotStem(testInfo) {
  */
 function baselineFilePath(testInfo, scan, callCount) {
     const slug = slugifyTitle(testInfo);
-    const suffix = scan === 'wcag' ? 'a11y-baseline' : 'a11y-baseline-best-practice';
+    const suffix = scan === "wcag" ? "a11y-baseline" : "a11y-baseline-best-practice";
     return testInfo.snapshotPath(`${slug}-${callCount}.${suffix}.json`);
 }
 /**
@@ -136,13 +136,13 @@ function baselineFilePath(testInfo, scan, callCount) {
  * defaulting new (snapshotless) tests into on-disk baseline mode.
  */
 async function snapshotExists(testInfo) {
-    const dir = path_1.default.dirname(testInfo.snapshotPath('a11y-baseline-probe'));
+    const dir = path_1.default.dirname(testInfo.snapshotPath("a11y-baseline-probe"));
     let entries;
     try {
         entries = await fs_1.promises.readdir(dir);
     }
     catch (err) {
-        if (err?.code === 'ENOENT')
+        if (err?.code === "ENOENT")
             return false;
         throw err;
     }
@@ -150,56 +150,62 @@ async function snapshotExists(testInfo) {
     // Require the counter so a title that merely extends this one (e.g.
     // "Video" vs "Video Promo") is not mistaken for this test's snapshot.
     const prefix = `${playwrightSnapshotStem(testInfo)}-`;
-    return entries.some(name => {
-        if (!name.startsWith(prefix) || !name.endsWith('.txt'))
+    return entries.some((name) => {
+        if (!name.startsWith(prefix) || !name.endsWith(".txt"))
             return false;
         let i = prefix.length;
-        while (i < name.length && name.charCodeAt(i) >= 48 && name.charCodeAt(i) <= 57)
+        while (i < name.length &&
+            name.charCodeAt(i) >= 48 &&
+            name.charCodeAt(i) <= 57)
             i++;
-        return i > prefix.length && (name[i] === '-' || name[i] === '.');
+        return i > prefix.length && (name[i] === "-" || name[i] === ".");
     });
 }
 async function readBaselineFile(filePath) {
     let raw;
     try {
-        raw = await fs_1.promises.readFile(filePath, 'utf8');
+        raw = await fs_1.promises.readFile(filePath, "utf8");
     }
     catch (err) {
-        if (err?.code === 'ENOENT')
+        if (err?.code === "ENOENT")
             return null;
         throw err;
     }
     try {
         const parsed = JSON.parse(raw);
-        if (!parsed || typeof parsed !== 'object' || !Array.isArray(parsed.violations)) {
+        if (!parsed ||
+            typeof parsed !== "object" ||
+            !Array.isArray(parsed.violations)) {
             throw new Error('expected an object with a "violations" array');
         }
         return {
-            note: typeof parsed.note === 'string' ? parsed.note : '',
+            note: typeof parsed.note === "string" ? parsed.note : "",
             violations: parsed.violations,
         };
     }
     catch (err) {
-        throw new Error(`Malformed baseline file at ${filePath}: ${err.message}`);
+        throw new Error(`Malformed baseline file at ${filePath}: ${err.message}`, { cause: err });
     }
 }
 async function writeBaselineFile(filePath, data) {
     await fs_1.promises.mkdir(path_1.default.dirname(filePath), { recursive: true });
     try {
-        await fs_1.promises.writeFile(filePath, JSON.stringify(data, null, 2) + '\n', { flag: 'wx' });
+        await fs_1.promises.writeFile(filePath, JSON.stringify(data, null, 2) + "\n", {
+            flag: "wx",
+        });
     }
     catch (err) {
-        if (err?.code === 'EEXIST')
+        if (err?.code === "EEXIST")
             return;
         throw err;
     }
 }
 function buildSeed(violations) {
     if (violations.length === 0) {
-        return { note: 'No accessibility violations found', violations: [] };
+        return { note: "No accessibility violations found", violations: [] };
     }
     return {
-        note: 'TODO: fill in reason and willBeFixedIn for each entry before committing.',
+        note: "TODO: fill in reason and willBeFixedIn for each entry before committing.",
         violations,
     };
 }

package/lib/accessibility-baseline.js

@@ -18,13 +18,15 @@ function validateAccessibilityBaseline(entries) {
         if (!entry.rule.trim()) {
             throw new Error(`Accessibility baseline entry ${index + 1} requires a rule.`);
         }
-        if (entry.targets.length === 0 || entry.targets.some(target => !target.trim())) {
+        if (entry.targets.length === 0 ||
+            entry.targets.some((target) => !target.trim())) {
             throw new Error(`Accessibility baseline entry ${index + 1} requires at least one non-empty target.`);
         }
-        if (!entry.reason.trim() || entry.reason.trim().toUpperCase() === 'TODO') {
+        if (!entry.reason.trim() || entry.reason.trim().toUpperCase() === "TODO") {
             throw new Error(`Accessibility baseline entry ${index + 1} requires a reason.`);
         }
-        if (!entry.willBeFixedIn.trim() || entry.willBeFixedIn.trim().toUpperCase() === 'TODO') {
+        if (!entry.willBeFixedIn.trim() ||
+            entry.willBeFixedIn.trim().toUpperCase() === "TODO") {
             throw new Error(`Accessibility baseline entry ${index + 1} requires a willBeFixedIn tracking reference.`);
         }
         for (const target of new Set(entry.targets)) {

package/lib/accessible-screenshot.d.ts

@@ -1,9 +1,9 @@
 import { type Locator, type Page, type TestInfo } from "@playwright/test";
 import { type WaitForImagesOptions } from "./images.js";
 import { type WaitForVideosOptions } from "./videos.js";
-import { type ScreenshotInteractionState } from './interaction-states.js';
-import { type AccessibilityBaseline } from './accessibility-baseline.js';
-export type { InteractionState, ScreenshotInteractionState } from './interaction-states.js';
+import { type ScreenshotInteractionState } from "./interaction-states.js";
+import { type AccessibilityBaseline } from "./accessibility-baseline.js";
+export type { InteractionState, ScreenshotInteractionState, } from "./interaction-states.js";
 export interface ScreenshotStabilizationOptions {
     images?: WaitForImagesOptions;
     videos?: WaitForVideosOptions;
@@ -136,7 +136,7 @@ export interface AccessibilityOptions {
      * - 'hard': uses expect() — test fails immediately on violations
      * - 'off': skips best-practice scan entirely
      */
-    bestPracticeMode?: 'soft' | 'hard' | 'off';
+    bestPracticeMode?: "soft" | "hard" | "off";
     /** Additional axe rules to enable/disable. */
     rules?: Record<string, {
         enabled: boolean;