[Bug]: Readme not up to date - Githubissues

FRSOURCE / cypress-plugin-visual-regression-diff

Perform visual regression test with a nice GUI as help. 💅 Only for Cypress!

MIT License

168 stars 22 forks source link

[Bug]: Readme not up to date #293

Closed FrederikG closed 1 year ago

FrederikG commented 1 year ago

Describe the Bug

In the examples, the command matchImage is added in the commands.ts file https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/blob/main/examples/webpack/cypress/support/commands.ts. But this step is missing in the official Readme: https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff

If you just follow the steps in the Readme, cypress will throw an error, that matchImage is not a function.

Steps to reproduce

No response

Expected behavior

The Installation steps in the readme also mentions the adding of the command in the command.ts.

Additional context

No response

Package version

3.3.10

Device

PC

OS and version

Windows 11

Browser and version

Chrome

Node version

16.0

I can work on it by myself

[ ] Yes
[X] No

Code of Conduct

[X] I agree to follow this project's Code of Conduct

FRSgit commented 1 year ago

Hey @FrederikG!

Thanks for raising this issue. However, if you follow official documentation you'll end up with import "@frsource/cypress-plugin-visual-regression-diff"; in cypress/support/index.js and that should be enough as /support is a default entry point of this package.

I'm closing the issue as I think everything works as expected - if you believe that it does not or should work differently: please reopen this issue or raise the PR with changes, thanks!