[Feature Request]Add tolerance threshold settings for screenshots

muhammadkhan0009 commented 1 year ago

Description

Fixes # (issue)

Added threshold tolerance functionality on screenshots to avoid tests from failing due to minor pixel changes.
I have already created the issue on this repo. Please read it for more details: https://github.com/FormidableLabs/react-native-owl/issues/140

Type of Change

[ ] Bug fix (non-breaking change which fixes an issue)
[x] New feature (non-breaking change which adds functionality)
[ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
[ ] Adding or updating CI (Actions)
[x] This change requires a documentation update

How Has This Been Tested?

The changes have been tested via doing monkey patch on our app repo and verified that tests are passing now after this change. As I added an optional prop named threshold, therefore custom jest matcher toMatchBaseline function would be called as follow:

 const result = toMatchBaseline(latestPath, { threshold: 0.2 });

Checklist: (Feel free to delete this section upon completion)

[x] I have performed a self-review of my own code
[ ] I have commented my code, particularly in hard-to-understand areas
[ ] I have made corresponding changes to the documentation
[ ] My code follows the style guidelines of this project (I have run yarn prettier:apply)
[ ] I have added tests that prove my fix is effective or that my feature works
[ ] New and existing unit tests pass locally with my changes (I have run yarn test)
[ ] My changes generate no new warnings
[ ] Any dependent changes have been merged and published in downstream modules

Screenshots (for visual changes):

robwalkerco commented 1 year ago

@muhammadkhan0009 Thanks so much for your PR. I've opened #142 which takes your changes, plus adds a default value, updates the types and updates the docs.

muhammadkhan0009 commented 1 year ago

@robwalkerco Thank you for adding the PR.

FormidableLabs / react-native-owl