https://github.com/bahmutov/cypress-high-resolution
A plugin to increase the video resolution for cypress run
https://github.com/bahmutov/cypress-high-resolution
cypress-plugin
Last synced: 3 months ago
JSON representation
A plugin to increase the video resolution for cypress run
- Host: GitHub
- URL: https://github.com/bahmutov/cypress-high-resolution
- Owner: bahmutov
- Created: 2021-10-28T17:32:56.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-12-18T03:28:58.000Z (4 months ago)
- Last Synced: 2024-12-27T20:14:31.878Z (4 months ago)
- Topics: cypress-plugin
- Language: JavaScript
- Homepage: https://www.cypress.io/blog/2021/03/01/generate-high-resolution-videos-and-screenshots/
- Size: 174 KB
- Stars: 14
- Watchers: 1
- Forks: 0
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# cypress-high-resolution [![renovate-app badge][renovate-badge]][renovate-app]  [](https://dashboard.cypress.io/projects/e44x4z/runs) [](https://github.com/bahmutov/cypress-high-resolution/actions/workflows/ci.yml)
> A plugin to increase the video resolution for cypress run
Based on the blog post [Generate High-Resolution Videos and Screenshots](https://www.cypress.io/blog/2021/03/01/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](https://youtu.be/jAU4dLRXVIA).
## 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 v10+
Add this plugin to your Cypress config file
```js
// 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)
},
},
})
```
### Cypress v9
Add this plugin to your Cypress plugin file
```js
// cypress/plugins/index.js
module.exports = (on, config) => {
// https://github.com/bahmutov/cypress-high-resolution
require('cypress-high-resolution')(on, config)
}
```
## Use
When using non-interactive mode `cypress run`, you can specify the browser window size using the [Cypress environment variables](https://on.cypress.io/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 --env resolution=4k
# generate videos 1200x1000
$ npx cypress run --env resolution=1200x1000
# alternative way: use an array
$ npx cypress run --env resolution=[1200,1000]
# generate high resolution video 1920x1080
$ npx cypress run --env 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.json` file
```json
{
"env": {
"resolution": [1280, 720]
}
}
```
Or a high resolution
```json
{
"env": {
"resolution": "high"
}
}
```
**Tip:** when increasing the browser window size, it might make sense to increase the viewport used by the Cypress to use those pixels!
## Debugging
This plugin uses [debug](https://github.com/visionmedia/debug#readme) 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
```shell
$ DEBUG=cypress-high-resolution npx cypress run
```
## See also
- [Make Cypress Videos Look Old School](https://www.cypress.io/blog/2021/04/01/make-cypress-videos-look-old-school/)
## Small print
Author: Gleb Bahmutov <[email protected]> © 2021
- [@bahmutov](https://twitter.com/bahmutov)
- [glebbahmutov.com](https://glebbahmutov.com)
- [blog](https://glebbahmutov.com/blog)
- [videos](https://www.youtube.com/glebbahmutov)
- [presentations](https://slides.com/bahmutov)
- [cypress.tips](https://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](https://github.com/bahmutov/cypress-high-resolution/issues) 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.
[renovate-badge]: https://img.shields.io/badge/renovate-app-blue.svg
[renovate-app]: https://renovateapp.com/