search

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

`imagesPath` is not valid attribute #220

Closed mgubala-edge1s closed 1 year ago

mgubala-edge1s commented 1 year ago

Describe the bug Readme states that imagesPath is attribute which can be used to adjust storage path. It is not valid as in code there is imagesDir.

To Reproduce Steps to reproduce the behavior:

  1. Try using matchImage({ imagesPath: 'some-path/ }) and it will not do any change.
  2. Try using matchImage({ imagesDir: 'some-path/ }) and it will change where images are stored.

Expected behavior Readme should match codebase.

FRSgit commented 1 year ago

What version do you use? Currently in the codebase both imageDir and imagePath are supported. Also, imageDir is marked as deprecated and will be removed in version 4.

One note: to be able to use imagePath you cannot use imageDir anywhere in your environment.

FRSgit commented 1 year ago

Code where imagesPath is being used: https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/blob/f4d3ec946547d648d1ec8ea9ccf9369540255adf/src/commands.ts#L96-L99 https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/blob/f4d3ec946547d648d1ec8ea9ccf9369540255adf/src/commands.ts#L151

FRSgit commented 1 year ago

Closing as invalid