Feature: Add `runtimeHooksPath` options with `onBeforeWriteToDiscPath` in it

Ayc0 commented 1 year ago

Description

Add a new top level option runtimeHooksPath that contains a potential path to a JS file. This file can contain multiple hooks when diffSnapshot is called, like onBeforeWriteToDiscPath (to be able to inject EXIF data to PNGs without building this feature into this library).

The reason why I exposed that via a path to a JS file instead of exposing a function, is because diffSnapshot is sometimes called from a worker, and we cannot serialize properly functions.

For now there is only onBeforeWriteToDiscPath but I made that generic enough to be able to add more features to it in the future.

Motivation and Context

Fixes: https://github.com/americanexpress/jest-image-snapshot/issues/332

How Has This Been Tested?

I added unit tests for this feature

Types of Changes

[ ] 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)
[x] Documentation (adding or updating documentation)
[ ] Dependency update

Checklist:

[x] My change requires a change to the documentation and I have updated the documentation accordingly.
[x] My changes are in sync with the code style of this project.
[x] There aren't any other open Pull Requests for the same issue/update.
[x] These changes should be applied to a maintenance branch.
[x] I have added the Apache 2.0 license header to any new files created.

What is the Impact to Developers Using Jest-Image-Snapshot?

It shouldn't impact them at all as long as they don't use this new feature

Ayc0 commented 1 year ago

@code-forger what do you think about this new feature?

Ayc0 commented 10 months ago

FYI, due to bade294, the command npm run test:git-history seems to be failing:

oneamexbot commented 10 months ago

:tada: This PR is included in version 6.3.0 :tada:

The release is available on:

Your semantic-release bot :package::rocket:

americanexpress / jest-image-snapshot