Merge pull request #7 from TodayTix/feature/set-customimage-snapshot-…

…options Feature/set customimage snapshot options
TodayTix · Sep 10, 2020 · 0e53f7f · 0e53f7f
2 parents ea0e3ec + a0f1a37
commit 0e53f7f
Show file tree

Hide file tree

Showing 3 changed files with 27 additions and 1 deletion.
diff --git a/dist/lib/react/ReactScreenshotTest.d.ts b/dist/lib/react/ReactScreenshotTest.d.ts
@@ -1,4 +1,5 @@
 /// <reference types="react" />
+import { MatchImageSnapshotOptions } from "jest-image-snapshot";
 import { Viewport } from "../screenshot-renderer/api";
 import { Page } from "puppeteer";
 /**
@@ -22,11 +23,16 @@ export declare class ReactScreenshotTest {
     private readonly _staticPaths;
     private readonly _onPageLoadedCallbacks;
     private ran;
+    private customImageSnapshotOptions;
     /**
      * Creates a screenshot test.
      */
     static create(componentName: string): ReactScreenshotTest;
     private constructor();
+    /**
+     * Set custom options for image snapshot testing.
+     */
+    setCustomImageSnapshotOptions(options: MatchImageSnapshotOptions): this;
     /**
      * Adds a set of viewports to the screenshot test.
      */

diff --git a/dist/lib/react/ReactScreenshotTest.js b/dist/lib/react/ReactScreenshotTest.js
@@ -36,6 +36,7 @@ class ReactScreenshotTest {
         this._staticPaths = {};
         this._onPageLoadedCallbacks = {};
         this.ran = false;
+        this.customImageSnapshotOptions = {};
         setImmediate(() => {
             if (!this.ran) {
                 throw new Error("Please call .run()");
@@ -48,6 +49,13 @@ class ReactScreenshotTest {
     static create(componentName) {
         return new this(componentName);
     }
+    /**
+     * Set custom options for image snapshot testing.
+     */
+    setCustomImageSnapshotOptions(options) {
+        this.customImageSnapshotOptions = { ...options };
+        return this;
+    }
     /**
      * Adds a set of viewports to the screenshot test.
      */
@@ -168,6 +176,7 @@ class ReactScreenshotTest {
                                     failureThresholdType: 'percent',
                                     customSnapshotsDir: path_1.join(snapshotsDir, "__screenshots__", this.componentName, subdirectory),
                                     customSnapshotIdentifier: `${filenamePrefix}${viewportName} - ${shotName}`,
+                                    ...this.customImageSnapshotOptions,
                                 });
                                 logDebug(`Screenshot compared.`);
                             }

diff --git a/src/lib/react/ReactScreenshotTest.ts b/src/lib/react/ReactScreenshotTest.ts
@@ -1,7 +1,7 @@
 import callsites from "callsites";
 import chalk from "chalk";
 import { existsSync } from "fs";
-import { toMatchImageSnapshot } from "jest-image-snapshot";
+import { MatchImageSnapshotOptions, toMatchImageSnapshot } from "jest-image-snapshot";
 import { dirname, join, sep } from "path";
 import { debugLogger } from "../logger";
 import { fetch } from "../network/fetch";
@@ -49,6 +49,8 @@ export class ReactScreenshotTest {
 
   private ran = false;
 
+  private customImageSnapshotOptions: MatchImageSnapshotOptions = {};
+
   /**
    * Creates a screenshot test.
    */
@@ -64,6 +66,14 @@ export class ReactScreenshotTest {
     });
   }
 
+  /**
+   * Set custom options for image snapshot testing.
+   */
+  setCustomImageSnapshotOptions(options: MatchImageSnapshotOptions) {
+    this.customImageSnapshotOptions = { ...options };
+    return this;
+  }
+
   /**
    * Adds a set of viewports to the screenshot test.
    */
@@ -212,6 +222,7 @@ export class ReactScreenshotTest {
                     subdirectory
                   ),
                   customSnapshotIdentifier: `${filenamePrefix}${viewportName} - ${shotName}`,
+                  ...this.customImageSnapshotOptions,
                 });
                 logDebug(`Screenshot compared.`);
               } else {