Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

@gemini-testing/playwright-utils

Package Overview
Dependencies
Maintainers
10
Versions
3
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@gemini-testing/playwright-utils

Usefull playwright utilities

  • 1.2.0
  • latest
  • npm
  • Socket score

Version published
Maintainers
10
Created
Source

playwright-utils

Usefull playwright utilities, such as fixtures, custom commands and matchers.

Installation

npm install --save-dev @gemini-testing/playwright-utils

Contents

Matchers

ToMatchScreenshot

looks-same based visual comparison. It uses CIEDE2000 based tolerance instead of pixelmatch (which is used under the hood of toHaveScreenshot) YIQ NTSC transmission color space threshold, which has severe problems calculating the color difference in shades of blue.

Usage

Setup:

// playwright.ts
import { test as base, expect } from "@playwright/test";
import { createMatchersFixture, type PlaywrightUtilsOptions } from "@gemini-testing/playwright-utils";

const test = base.extend<PlaywrightTestOptions & PlaywrightUtilsOptions>({
    ...createMatchersFixture(expect)
});

export { test, expect };
// playwright.config.ts
import { defineConfig, type PlaywrightTestOptions } from "@playwright/test";
import type { PlaywrightUtilsOptions } from "@gemini-testing/playwright-utils";

export default defineConfig<PlaywrightTestOptions, PlaywrightUtilsOptions>({
    // ...
    use: {
        // ...
        toMatchScreenshot: {
            // Default project config
            tolerance: 2.3,
            antialiasingTolerance: 4,
            maxDiffPixels: 0,
            maxDiffPixelRatio: 0,
            stopOnFirstImageDiff: false,
            saveImageOnScreenshotMatch: true,
            animations: "disabled",
            caret: "hide",
            maskColor: "#FF00FF",
            scale: "css",
            timeout: 30000,
            fullPage: false,
        }
    }
});

Usage:

await expect(page.locator("body")).toMatchScreenshot("plain", {
    // Comparison options, have higher priority than project options
    maxDiffPixels: 3
});

Args:

  • snapshotName: string
  • opts?: Object
Migration from toHaveScreenshot:
  • If you have toHaveScreenshot calls without specified name, it is required to name them.
  • Move contents of your toHaveScreenshot options from expect section of playwright config to toMatchScreenshot at use section of playwright config, then remove threshold property (toMatchScreenshot uses tolerance instead. Preferred value is 2.3).

Note: Screenshot comparison errors, caused by toMatchScreenshot, won't stop test execution by default. You can configure it with stopOnFirstImageDiff option.

Keywords

FAQs

Package last updated on 30 Nov 2023

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc