Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Adding troubleshooting section on readme #19

Merged
merged 2 commits into from
Dec 19, 2023
Merged

Adding troubleshooting section on readme #19

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1b1b164
adding troubleshooting section on readme
caique-rd Dec 14, 2023
fbdaf34
windows alternative
caique-rd Dec 15, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -253,3 +253,25 @@ The result of this work is the present plugin called **cypress-visual-regression
| cypress-image-diff | 30.1% | :x: | :white_check_mark: | :white_check_mark:| :white_check_mark:| |
| micoocypress | 8.8518% | :white_check_mark: | :x: | :x: | :white_check_mark:| Requires Docker |
| cypress-visual-regression-diff | 14.7% |:white_check_mark: | ✅| ✅| :white_check_mark:| Requires a manual installation of "sharp" library on Linux |

## Troubleshooting
1. Error when installing the plugin: `ERR! install response status 404 Not Found on https://github.com/Automattic/node-canvas/releases/download/v2.9.0/canvas-v2.9.0-node-v108-darwin-unknown-arm64.tar.gz `

This is a [known issue](https://github.com/Automattic/node-canvas/issues/2306) on the Canvas dependency. In this case you need to install and update some subdependencies from Canvas with:

Mac Os
```
brew install pkg-config cairo pango libpng jpeg giflib librsvg pixman
```

Windows using MSYS2
```
pacman -S pkg-config
pacman -S mingw-w64-x86_64-cairo
pacman -S mingw-w64-x86_64-pango
pacman -S mingw-w64-x86_64-libpng
pacman -S mingw-w64-x86_64-libjpeg-turbo
pacman -S mingw-w64-x86_64-giflib
pacman -S mingw-w64-x86_64-librsvg
pacman -S mingw-w64-x86_64-pixman
```