feat: inline images support (dumpDiffToConsole='inline') #244
Conversation
|
|
README.md
Outdated
| @@ -117,7 +117,9 @@ See [the examples](./examples/README.md) for more detailed usage or read about a | |||
| * `updatePassedSnapshot`: (default `false`) Updates a snapshot even if it passed the threshold against the existing one. | |||
| * `blur`: (default `0`) Applies Gaussian Blur on compared images, accepts radius in pixels as value. Useful when you have noise after scaling images per different resolutions on your target website, usually setting its value to 1-2 should be enough to solve that problem. | |||
| * `runInProcess`: (default `false`) Runs the diff in process without spawning a child process. | |||
| * `dumpDiffToConsole`: (default `false`) Will output base64 string of a diff image to console in case of failed tests (in addition to creating a diff image). This string can be copy-pasted to a browser address string to preview the diff for a failed test. | |||
| * `dumpDiffToConsole`: (default `false`) | |||
There was a problem hiding this comment.
It seems odd to have the options be true, false,inline doesn't it? Since there is both a boolean and a string mixed in.
Can we instead detect if running in iTerm and if so display the image inline if dumpDiffToConsole is true?
Or does this bloat the output too much? Can you share screenshots of what it would look like?
There was a problem hiding this comment.
Hey Andres,
Here's what it looks like in iTerm,
In Terminal.app it looks like this:
With regards to mixing boolean and inline, I mostly just wanted to have an explicit option that re-used the exiting glue code. As for the relative oddness of the type itself, I guess that's up to you to decide, but the type is representable in the TypeScript definitions without any problems.
Detection
It might be possible to detect support for the Inline Images Protocol, but I'd prefer to do it based on the feature itself rather than the just checking if the Terminal is iTerm. This is so that the feature still works for other Terminals that support it (the options are slim at the moment).
This might add a lot of code that's full of OSC escape sequences and would likely be a bit of a maintenance burden. It might also not be possible to do reliably...
Thoughts?
There was a problem hiding this comment.
What about a new option, enableInlineConsoleDiff or something to that effect?
There was a problem hiding this comment.
Hmm, yeah I think either a new option like @igetgames is suggesting (there are so many now!) might work!
@americanexpress/one what do you all think? New flag or mix booleans with string in the existing option?
There was a problem hiding this comment.
Hey folks,
I've updated the MR to add a new option: dumpInlineDiffToConsole, the existing dumpDiffToConsole is left as-is.
In addition if the terminal isn't supported (or ENABLE_INLINE_DIFF is in the env), we fallback to dumpDiffToConsole.
@anescobar1991 @igetgames
LukeChannings
force-pushed
the
master
branch
2 times, most recently
from
902b984
to
dd64ba6
Compare
|
@anescobar1991 I've just simplified the code a little bit and fixed an issue with iTerm. Do you mind ticking again? |
|
@igetgames do you mind reviewing so we can get this in hopefully today? |
LukeChannings
force-pushed
the
master
branch
from
56534d5
to
19562b7
Compare
|
@anescobar1991 Ok this one should actually work 😅 |
|
@LukeChannings can you squash your commits? |
LukeChannings
dismissed stale reviews from marcusrbrown and anescobar1991
via
be05d69
LukeChannings
force-pushed
the
master
branch
from
729e0af
to
be05d69
Compare
LukeChannings
force-pushed
the
master
branch
from
be05d69
to
e562b35
Compare
|
@igetgames Done! |
|
@igetgames Can you tick please? |
# [4.3.0](v4.2.0...v4.3.0) (2020-12-16) ### Features * inline images support ([#244](#244)) ([b82b068](b82b068))
|
🎉 This PR is included in version 4.3.0 🎉 The release is available on: Your semantic-release bot 📦🚀 |
Co-authored-by: Marcus R. Brown <[email protected]>
# [4.3.0](americanexpress/jest-image-snapshot@v4.2.0...v4.3.0) (2020-12-16) ### Features * inline images support ([americanexpress#244](americanexpress#244)) ([b82b068](americanexpress@b82b068))
This MR implements support for iTerm's Inline Images Protocol when the
dumpDiffToConsoleflag is set to'inline'.The scope of this is admittedly narrow, but it may be useful to a wider audience.