cypress-compress-screenshot

A Cypress utility to specify compression levels while taking screenshots.

Installation

npm install cypress-compress-screenshot --save-dev

Setup

1. In your cypress.config.js:

const { defineConfig } = require("cypress");
const { compressImage } = require("cypress-compress-screenshot");

module.exports = defineConfig({
  e2e: {
    setupNodeEvents(on, config) {
      on('task', {
        compressImage
      });
      return config;
    },
  },
});

2. In your cypress/support/e2e.js:

import { registerCommands } from 'cypress-compress-screenshot';

registerCommands();

Usage

In your test files:

describe('Screenshot Test', () => {
  it('takes and compresses a screenshot', () => {
    cy.visit('your-url');
    cy.screenshot('example');
    cy.compressScreenshot('example', {
      level: 'medium', // 'low', 'medium', or 'high'
      format: 'jpeg'   // 'jpeg' or 'png'
    });
  });
});

Options

• level: Compression level
  • low: 40% quality
  • medium: 70% quality (default)
  • high: 90% quality
• format: Output format
  • jpeg (default)
  • png

License

ISC