comparadise-utils 1.24.3 → 1.25.0

package/dist/index.d.ts

@@ -1,4 +1,5 @@
 import { MatchScreenshotArgs } from './match-screenshot.js';
+import 'pixelmatch';
 
 declare function setupVisualTests(on: Cypress.PluginEvents, config: Cypress.PluginConfigOptions): Cypress.PluginConfigOptions;
 declare global {

package/dist/index.js

@@ -86,7 +86,7 @@ function alignImagesToSameSize(firstImage, secondImage) {
     fillSizeDifference(secondImageWidth, secondImageHeight)(resizedSecond)
   ];
 }
-function getDiffPixels(basePath, actualPath) {
+function getDiffPixels(basePath, actualPath, pixelMatchOptions = PIXELMATCH_OPTIONS) {
   const rawBase = import_pngjs.PNG.sync.read(fs.readFileSync(basePath));
   const rawActual = import_pngjs.PNG.sync.read(fs.readFileSync(actualPath));
   const hasSizeMismatch = rawBase.height !== rawActual.height || rawBase.width !== rawActual.width;
@@ -101,7 +101,7 @@ function getDiffPixels(basePath, actualPath) {
     diff.data,
     diff.width,
     diff.height,
-    PIXELMATCH_OPTIONS
+    pixelMatchOptions
   );
   return { diffPixels, diff };
 }
@@ -127,10 +127,15 @@ function baseExists(path) {
   }
   return exists;
 }
-function compareScreenshots(screenshotFolder) {
+function compareScreenshots(args) {
+  const { screenshotFolder, pixelMatchOptions } = args;
   const basePath = createImageFileName(screenshotFolder, "base");
   const actualPath = createImageFileName(screenshotFolder, "new");
-  const { diffPixels, diff } = getDiffPixels(basePath, actualPath);
+  const { diffPixels, diff } = getDiffPixels(
+    basePath,
+    actualPath,
+    pixelMatchOptions
+  );
   if (diffPixels) {
     fs2.writeFile(
       createImageFileName(screenshotFolder, "diff"),

package/dist/match-screenshot.d.ts

@@ -1,6 +1,12 @@
+import pixelmatch from 'pixelmatch';
+
+type PixelMatchOptions = Parameters<typeof pixelmatch>[5];
+
 type MatchScreenshotArgs = {
     rawName?: string;
-    options?: Partial<Cypress.ScreenshotOptions>;
+    options?: Partial<Cypress.ScreenshotOptions> & {
+        pixelMatchOptions?: PixelMatchOptions;
+    };
 };
 declare function matchScreenshot(subject: Cypress.JQueryWithSelector | Window | Document | void, args?: MatchScreenshotArgs): void;
 interface ExtendedCurrentRunnable extends Mocha.Runnable {

package/dist/match-screenshot.js

@@ -79,7 +79,7 @@ function verifyImages() {
   }
 }
 function matchScreenshot(subject, args) {
-  const { rawName, options = {} } = args || {};
+  const { rawName, options } = args || {};
   forceFont();
   verifyImages();
   const { name, screenshotsFolder } = getTestFolderPathFromScripts(rawName);
@@ -96,7 +96,9 @@ function matchScreenshot(subject, args) {
       );
       return null;
     }
-    cy.task("compareScreenshots", screenshotsFolder).then((diffPixels) => {
+    const pixelMatchOptions = options?.pixelMatchOptions;
+    const compareScreenshotsArg = { screenshotsFolder, pixelMatchOptions };
+    cy.task("compareScreenshots", compareScreenshotsArg).then((diffPixels) => {
       if (diffPixels === 0) {
         cy.log(`\u2705 Actual image of ${name} was the same as base`);
       } else {

package/package.json

@@ -27,7 +27,7 @@
   "peerDependencies": {
     "cypress": ">=12"
   },
-  "version": "1.24.3",
+  "version": "1.25.0",
   "scripts": {
     "build": "tsup",
     "postbuild": "echo \"require('./dist/match-screenshot');\" > commands.js",