cypress-high-resolution

A plugin to increase the video resolution for cypress run

Based on the blog post Generate High-Resolution Videos and Screenshots and watch how to use this plugin in the video Create High Resolution Videos And Screenshots In Cypress Using This Plugin.

Install

Add this plugin to your project as a dev dependency

# install using NPM
$ npm i -D cypress-high-resolution
# or install using Yarn
$ yarn add -D cypress-high-resolution

Cypress v15+

Add this plugin to your Cypress config file

// cypress.config.js
const { defineConfig } = require('cypress')

module.exports = defineConfig({
  e2e: {
    setupNodeEvents(on, config) {
      // https://github.com/bahmutov/cypress-high-resolution
      return require('cypress-high-resolution')(on, config)
    },
  },
})

Note: older Cypress versions no longer supported, please use an older plugin version.

Use

When using non-interactive mode cypress run, you can specify the browser window size using the Cypress public environment variables which can be passed via system OS environment variables, via cypress.json config file, via cypress.env.json file, or via command line arguments. For example, here is how to specify the video resolution using the command line arguments:

# generate ultra-high resolution 3840x2160 videos
$ npx cypress run --expose resolution=4k
# generate videos 1200x1000
$ npx cypress run --expose resolution=1200x1000
# alternative way: use an array
$ npx cypress run --expose resolution=[1200,1000]
# generate high resolution video 1920x1080
$ npx cypress run --expose resolution=high

Specifying the output resolution using the system OS variables

# 1920x1080 videos
CYPRESS_resolution=high npx cypress run
# small videos
CYPRESS_resolution=600x300 npx cypress run

You can set the video resolution in the Cypress config file

{
  "expose": {
    "resolution": [1280, 720]
  }
}

Or a high resolution

{
  "expose": {
    "resolution": "high"
  }
}

Use on CI for example via Cypress GitHub Action

- name: Run tests in high resolution 🧪
  # https://github.com/cypress-io/github-action
  uses: cypress-io/github-action@v7
  with:
    record: true
    group: '1. Resolution is high'
    expose: resolution=high
    config: viewportWidth=1920,viewportHeight=1080
    browser: chrome
  env:
    DEBUG: cypress-high-resolution
    CYPRESS_RECORD_KEY: ${{ secrets.CYPRESS_RECORD_KEY }}

Tip: when increasing the browser window size, it might make sense to increase the viewport used by the Cypress to use those pixels!

Hiding scrollbars

It is sometimes useful to hide the browser scrollbars on the window element. You can import the support files that add commands cy.hideScrollbars and cy.showScrollbars.

// in your specs
import 'cypress-high-resolution/src/support'

cy.hideScrollbars()
// take a screenshot
cy.showScrollbars()

Debugging

This plugin uses debug module to output verbose messages. Start Cypress with the environment variable DEBUG=cypress-high-resolution to see them. How to set an environment variable depends on the operating system. From a Linux terminal we can use

$ DEBUG=cypress-high-resolution npx cypress run

See also

• Make Cypress Videos Look Old School

Small print

Author: Gleb Bahmutov <[email protected]> © 2021

• @bahmutov
• glebbahmutov.com
• blog
• videos
• presentations
• cypress.tips

License: MIT - do anything with the code, but don't blame me if it does not work.

Support: if you find any problems with this module, email / tweet / open issue on Github

MIT License

Copyright (c) 2021 Gleb Bahmutov <[email protected]>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.