@quickpickle/playwright 0.9.4 → 0.9.6

package/dist/snapshotMatcher.mjs

@@ -0,0 +1,86 @@
+import { expect } from '@playwright/test';
+import { PNG } from 'pngjs';
+import { promises } from 'node:fs';
+import path from 'node:path';
+import pixelmatch from 'pixelmatch';
+import { defaultsDeep } from 'lodash-es';
+
+const defaultOptions = {
+    // Options for the comparison
+    maxDiffPercentage: 0,
+    // Options for the screenshot
+    fullPage: true,
+    omitBackground: false,
+    mask: [],
+    maskColor: 'rgb(255,255,255)',
+    timeout: 5000,
+    // Options for pixelmatch
+    threshold: 0.1,
+    alpha: 0.6,
+};
+async function compareImages(actual, expected, opts) {
+    const actualImage = PNG.sync.read(actual);
+    const expectedImage = PNG.sync.read(expected);
+    const { width, height } = actualImage;
+    const diffImage = new PNG({ width, height });
+    const mismatchedPixels = pixelmatch(actualImage.data, expectedImage.data, diffImage.data, width, height, opts);
+    const totalPixels = width * height;
+    const diffPercentage = (mismatchedPixels / totalPixels) * 100;
+    const pass = diffPercentage <= opts.maxDiffPercentage;
+    return { pass, diffPercentage, image: diffImage };
+}
+async function customToHaveScreenshot(pageOrLocator, snapshotPath, opts) {
+    const options = defaultsDeep(opts, defaultOptions);
+    const pathparts = snapshotPath.split('/');
+    const name = pathparts.pop();
+    const screenshotDir = pathparts.join('/');
+    const filepath = path.join(screenshotDir, name || '');
+    const actualScreenshot = await pageOrLocator.screenshot(options);
+    try {
+        let expectedScreenshot;
+        try {
+            expectedScreenshot = await promises.readFile(snapshotPath);
+        }
+        catch (error) {
+            // If the snapshot doesn't exist, save the current screenshot and pass the test
+            await promises.mkdir(screenshotDir, { recursive: true });
+            await promises.writeFile(snapshotPath, actualScreenshot);
+            return {
+                pass: true,
+                message: () => `Screenshot saved as new snapshot: ${snapshotPath}`,
+            };
+        }
+        const { pass, diffPercentage, image } = await compareImages(actualScreenshot, expectedScreenshot, options);
+        if (!pass) {
+            const filepath = path.join(screenshotDir, name || '');
+            await promises.mkdir(screenshotDir, { recursive: true });
+            await promises.writeFile(`${filepath}.diff.png`, PNG.sync.write(image));
+            await promises.writeFile(`${filepath}.actual.png`, actualScreenshot);
+            return {
+                pass: false,
+                message: () => `Screenshot does not match the snapshot.\nDiff percentage: ${diffPercentage.toFixed(2)}%\nDiff image saved at: ${filepath}.(diff|actual).png`,
+            };
+        }
+        return {
+            pass: true,
+            message: () => `Screenshot matches the snapshot: ${snapshotPath}`,
+        };
+    }
+    catch (error) {
+        await promises.mkdir(screenshotDir, { recursive: true });
+        await promises.writeFile(`${filepath}.actual.png`, actualScreenshot);
+        return {
+            pass: false,
+            message: () => `Failed to compare screenshots: ${error.message}`,
+        };
+    }
+}
+// Override the default implementation
+expect.extend({
+    async toMatchScreenshot(received, nameOrOptions, optOptions) {
+        const name = typeof nameOrOptions === 'string' ? nameOrOptions : 'screenshot';
+        const options = typeof nameOrOptions === 'object' ? nameOrOptions : optOptions;
+        return customToHaveScreenshot.call(this, received, name, options);
+    },
+});
+//# sourceMappingURL=snapshotMatcher.mjs.map

package/dist/snapshotMatcher.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"snapshotMatcher.mjs","sources":["../src/snapshotMatcher.ts"],"sourcesContent":[null],"names":["fs","playwrightExpect"],"mappings":";;;;;;;AA4BA,MAAM,cAAc,GAAG;;AAErB,IAAA,iBAAiB,EAAE,CAAC;;AAGpB,IAAA,QAAQ,EAAE,IAAI;AACd,IAAA,cAAc,EAAE,KAAK;AACrB,IAAA,IAAI,EAAE,EAAE;AACR,IAAA,SAAS,EAAE,kBAAkB;AAC7B,IAAA,OAAO,EAAE,IAAI;;AAGb,IAAA,SAAS,EAAE,GAAG;AACd,IAAA,KAAK,EAAC,GAAG;CACV,CAAC;AAIF,eAAe,aAAa,CAAC,MAAc,EAAE,QAAgB,EAAE,IAA6B,EAAA;IAC1F,MAAM,WAAW,GAAG,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IAC1C,MAAM,aAAa,GAAG,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;AAC9C,IAAA,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,WAAW,CAAC;IACtC,MAAM,SAAS,GAAG,IAAI,GAAG,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC,CAAC;IAE7C,MAAM,gBAAgB,GAAG,UAAU,CAAC,WAAW,CAAC,IAAI,EAAE,aAAa,CAAC,IAAI,EAAE,SAAS,CAAC,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC;AAE/G,IAAA,MAAM,WAAW,GAAG,KAAK,GAAG,MAAM,CAAC;IACnC,MAAM,cAAc,GAAG,CAAC,gBAAgB,GAAG,WAAW,IAAI,GAAG,CAAC;AAC9D,IAAA,MAAM,IAAI,GAAG,cAAc,IAAI,IAAI,CAAC,iBAAiB,CAAC;IAEtD,OAAO,EAAE,IAAI,EAAE,cAAc,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC;AACpD,CAAC;AAED,eAAe,sBAAsB,CAEnC,aAA6B,EAC7B,YAAoB,EACpB,IAAuC,EAAA;IAEvC,MAAM,OAAO,GAAG,YAAY,CAAC,IAAI,EAAE,cAAc,CAAC,CAAC;IACnD,MAAM,SAAS,GAAG,YAAY,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;AAC1C,IAAA,MAAM,IAAI,GAAG,SAAS,CAAC,GAAG,EAAE,CAAC;IAC7B,MAAM,aAAa,GAAG,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAC1C,IAAA,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC;IAEtD,MAAM,gBAAgB,GAAG,MAAM,aAAa,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;AACjE,IAAA,IAAI;AACF,QAAA,IAAI,kBAA0B,CAAC;AAE/B,QAAA,IAAI;YACF,kBAAkB,GAAG,MAAMA,QAAE,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC;SACtD;QAAC,OAAO,KAAK,EAAE;;AAEd,YAAA,MAAMA,QAAE,CAAC,KAAK,CAAC,aAAa,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;YACnD,MAAMA,QAAE,CAAC,SAAS,CAAC,YAAY,EAAE,gBAAgB,CAAC,CAAC;YACnD,OAAO;AACL,gBAAA,IAAI,EAAE,IAAI;AACV,gBAAA,OAAO,EAAE,MAAM,CAAA,kCAAA,EAAqC,YAAY,CAAE,CAAA;aACnE,CAAC;SACH;AAED,QAAA,MAAM,EAAE,IAAI,EAAE,cAAc,EAAE,KAAK,EAAE,GAAG,MAAM,aAAa,CAAC,gBAAgB,EAAE,kBAAkB,EAAE,OAAO,CAAC,CAAC;QAE3G,IAAI,CAAC,IAAI,EAAE;AACT,YAAA,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC;AACtD,YAAA,MAAMA,QAAE,CAAC,KAAK,CAAC,aAAa,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;AACnD,YAAA,MAAMA,QAAE,CAAC,SAAS,CAAC,CAAA,EAAG,QAAQ,CAAW,SAAA,CAAA,EAAE,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC;YAClE,MAAMA,QAAE,CAAC,SAAS,CAAC,CAAA,EAAG,QAAQ,CAAa,WAAA,CAAA,EAAE,gBAAgB,CAAC,CAAA;YAC9D,OAAO;AACL,gBAAA,IAAI,EAAE,KAAK;AACX,gBAAA,OAAO,EAAE,MAAM,CAA6D,0DAAA,EAAA,cAAc,CAAC,OAAO,CAAC,CAAC,CAAC,CAAA,wBAAA,EAA2B,QAAQ,CAAoB,kBAAA,CAAA;aAC7J,CAAC;SACH;QAED,OAAO;AACL,YAAA,IAAI,EAAE,IAAI;AACV,YAAA,OAAO,EAAE,MAAM,CAAA,iCAAA,EAAoC,YAAY,CAAE,CAAA;SAClE,CAAC;KACH;IAAC,OAAO,KAAS,EAAE;AAClB,QAAA,MAAMA,QAAE,CAAC,KAAK,CAAC,aAAa,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QACnD,MAAMA,QAAE,CAAC,SAAS,CAAC,CAAA,EAAG,QAAQ,CAAa,WAAA,CAAA,EAAE,gBAAgB,CAAC,CAAA;QAC9D,OAAO;AACL,YAAA,IAAI,EAAE,KAAK;YACX,OAAO,EAAE,MAAM,kCAAkC,KAAK,CAAC,OAAO,CAAE,CAAA;SACjE,CAAC;KACH;AACH,CAAC;AAWD;AACAC,MAAgB,CAAC,MAAM,CAAC;AACtB,IAAA,MAAM,iBAAiB,CAAC,QAAwB,EAAE,aAAyD,EAAE,UAA6C,EAAA;AACxJ,QAAA,MAAM,IAAI,GAAG,OAAO,aAAa,KAAK,QAAQ,GAAG,aAAa,GAAG,YAAY,CAAC;AAC9E,QAAA,MAAM,OAAO,GAAG,OAAO,aAAa,KAAK,QAAQ,GAAG,aAAa,GAAG,UAAU,CAAC;AAC/E,QAAA,OAAO,sBAAsB,CAAC,IAAI,CAAC,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;KACnE;AACF,CAAA,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quickpickle/playwright",
-  "version": "0.9.4",
+  "version": "0.9.6",
   "description": "Support files for running tests with Playwright using QuickPickle (Gherkin in Vitest).",
   "keywords": [
     "BDD",
@@ -61,16 +61,23 @@
   "author": "David Hunt",
   "dependencies": {
     "@playwright/test": "^1.48.0",
+    "jest-image-snapshot": "^6.4.0",
     "lodash-es": "^4.17.21",
+    "pixelmatch": "^6.0.0",
     "playwright": "^1.48.0",
     "vite": "^5.0.11",
-    "quickpickle": "^1.2.2"
+    "quickpickle": "^1.2.3"
   },
   "devDependencies": {
     "@rollup/plugin-replace": "^6.0.1",
     "@rollup/plugin-typescript": "^12.1.0",
+    "@types/jest-image-snapshot": "^6.4.0",
     "@types/lodash-es": "^4.17.12",
+    "@types/pixelmatch": "^5.2.6",
+    "@types/pngjs": "^6.0.5",
     "fast-glob": "^3.3.2",
+    "playwright-core": "^1.48.0",
+    "pngjs": "^7.0.0",
     "rollup": "^3.20.7",
     "typescript": "^5.6.2",
     "vitest": "^2.1.2"