Feature: Add runtimeHooksPath options with onBeforeWriteToDiscPath in it
#337
Conversation
code-forger
added
the
Contribution
|
@code-forger what do you think about this new feature? |
src/diff-snapshot.js
Outdated
| } = options; | ||
|
|
||
| const writeFileSync = (pathToFile, content) => { |
There was a problem hiding this comment.
Stylistically i'd prefer moving this function out of diffImageToSnapshot and renaming to something like writeFileWithHooks and have it take runtimeHooksPath as a third argument. that way it more clearly differentiates the custom writeFileSync from fs.writeFileSync
as an example:
| const writeFileSync = (pathToFile, content) => { | |
| const writeFileWithHooks = (pathToFile, content, runtimeHooksPath) => { |
There was a problem hiding this comment.
I won't have time to do this modification right now, but I'll do it in the next few days!
Thanks for the review 🙇♂️
There was a problem hiding this comment.
FYI: I'd need 5 arguments as testPath & currentTestName are also used inside of this writeFileSync
There was a problem hiding this comment.
This is now updated
@JAdshead you can re-review if you want 👌
|
FYI, due to bade294, the command 
|
Ayc0
force-pushed
the
Ayc0/on-before-save
branch
from
3817d04 to
15a46c7
Compare
# [6.3.0](v6.2.0...v6.3.0) (2023-11-28) ### Features * Add `runtimeHooksPath` options ([#337](#337)) ([57741a2](57741a2))
|
🎉 This PR is included in version 6.3.0 🎉 The release is available on: Your semantic-release bot 📦🚀 |
Description
Add a new top level option
runtimeHooksPaththat contains a potential path to a JS file.This file can contain multiple hooks when
diffSnapshotis called, likeonBeforeWriteToDiscPath(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
diffSnapshotis sometimes called from a worker, and we cannot serialize properly functions.For now there is only
onBeforeWriteToDiscPathbut I made that generic enough to be able to add more features to it in the future.Motivation and Context
Fixes: #332
How Has This Been Tested?
I added unit tests for this feature
Types of Changes
Checklist:
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