Documentation for Interactive Snapshot Update #5291

genintho · 2018-01-12T03:47:02Z

Update the documentation and the changelog for #3831 (review)

genintho · 2018-01-12T03:47:43Z

I could not find in the docs a section where the watch mode is describe. Should it be created?

codecov-io · 2018-01-12T03:57:11Z

Codecov Report

Merging #5291 into master will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master    #5291   +/-   ##
=======================================
  Coverage   61.32%   61.32%           
=======================================
  Files         205      205           
  Lines        6909     6909           
  Branches        3        3           
=======================================
  Hits         4237     4237           
  Misses       2671     2671           
  Partials        1        1

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update f040725...bedff40. Read the comment docs.

SimenB · 2018-01-12T07:19:50Z

I could not find in the docs a section where the watch mode is describe. Should it be created?

I think a separate section for the watch mode would be awesome. Especially now that it's pluggable and people can create their own

rickhanlonii · 2018-01-17T02:26:18Z

I think the changelog is unnecessary now @genintho since it has already landed in the current version

If creating the whole watch mode doc is too much to get this off the ground, you could consider adding interactive snapshot testing to the snapshots doc after the Updating Snapshots section

Something like this (which we can move to the Watch Mode page once it exists):

Interactive Updates

Snapshots can also be updated one at a time in the Jest watch mode:

[screenshot highlighting watch menu option "i"]

Once you enter the Interactive Snapshot Updates mode, Jest will walk you though the failed snapshots one at a time and give you an opportunity to review the failed output.

From here you can choose to update that snapshot or skip to the next:

[gif of updating and skipping]

genintho · 2018-01-17T18:10:48Z

I think the changelog is unnecessary now @genintho since it has already landed in the current version

I disagree with this. Not everybody update their libraries constantly and having the ability to read all the things that change in an efficient format is really valuable.

rickhanlonii · 2018-01-18T04:23:44Z

Sorry, I was wrong. I thought I saw this in the Changelog in the last update I made

We agree that it should be there, my mistake 😄

…ive-mode Conflicts: CHANGELOG.md

genintho · 2018-01-19T07:46:02Z

Updating Snapshots section has been updated with the proposed change

I decided to use 2 screenshots instead of a gif but I have made
if we think it is better

thymikee · 2018-01-19T07:48:54Z

How about 1 screenshot and 1 gif? 😃 This is looking really nice!

thymikee · 2018-01-19T07:52:46Z

docs/SnapshotTesting.md

@@ -121,6 +121,20 @@ You can try out this functionality by cloning the
 [snapshot example](https://github.com/facebook/jest/tree/master/examples/snapshot),
 modifying the `Link` component, and running Jest.

+#### Interactive Updates
+
+Snapshots can also be updated one at a time in the Jest watch mode:


This is not entirely true, as interaction with snapshots happens test file by test file, not test by test. Can you fix the description to be more accurate (including the paragraph below)?
We'd like to avoid issues about this feature not working as expected (but we'll get there eventually)

@thymikee good catch, this is my bad as it's in my copy above

Related to this, the skip option still says "Press s to skip the current snapshot"

…ive-mode Conflicts: CHANGELOG.md

genintho · 2018-02-03T05:09:24Z

Updated.
Please update or let me know what I should put for the description if it is not working out. I am not a native English speaker, so the grammar might be incorrect 😄

rickhanlonii · 2018-02-03T05:10:51Z

CHANGELOG.md

@@ -34,6 +34,8 @@
  not generate additional (invalid) paths by prepending each ancestor of `cwd`
  to the absolute path. Additionally, this fixes functionality in Windows OS.
  ([#5398](https://github.com/facebook/jest/pull/5398))
+* `[doc]` Add information about Interactive Snapshot update


nit - this is [docs] everywhere else

rickhanlonii · 2018-02-03T05:13:22Z

docs/SnapshotTesting.md

+![](/jest/img/content/interactiveSnapshot.png)
+
+Once you enter the Interactive Snapshot Updates mode, Jest will walk you though
+the failed snapshots of one test file at a time and give you an opportunity to


I think there's an extra "of" here - should be:

Jest will walk you through the failed snapshots one test file at a time...

Also though is a typo, should be through

genintho · 2018-02-03T05:23:14Z

updated again. Finger cross!

genintho · 2018-02-07T20:06:56Z

small bump 😄

SimenB · 2018-02-07T20:11:00Z

@rickhanlonii mind making sure this lands?

@genintho could you try a rebase on master? If we're lucky it'll fix CI

…ive-mode

genintho · 2018-02-10T03:44:29Z

Rebased twice, and the tests are still broken with the same circle CI internal error.

…ive-mode

rickhanlonii

LGTM, I made a few minor wording updates

github-actions · 2021-05-12T13:15:07Z

This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.
Please note this issue tracker is not a help forum. We recommend using StackOverflow or our discord channel for questions.

add changelog record for #3831

158d258

facebook-github-bot added the CLA Signed ✔️ label Jan 12, 2018

genintho added 5 commits January 18, 2018 22:48

Merge remote-tracking branch 'upstream/master' into 3831-doc-interact…

0dd8861

…ive-mode Conflicts: CHANGELOG.md

nicer description

66db760

new section in snapshot doc about interactive mode

c18f238

optimized screen shot

8610515

document itself in changelog

bedff40

thymikee reviewed Jan 19, 2018

View reviewed changes

genintho added 3 commits February 2, 2018 20:56

Merge remote-tracking branch 'upstream/master' into 3831-doc-interact…

254c9a3

…ive-mode Conflicts: CHANGELOG.md

replace png by gif

1b0ef55

fix description

c5fe774

rickhanlonii reviewed Feb 3, 2018

View reviewed changes

typos

86c9617

Thomas Genin and others added 2 commits February 8, 2018 10:09

Merge remote-tracking branch 'upstream/master' into 3831-doc-interact…

1869e6d

…ive-mode

Merge remote-tracking branch 'upstream/master' into 3831-doc-interact…

c6ad4ce

…ive-mode

Merge remote-tracking branch 'upstream/master' into 3831-doc-interact…

d03d59f

…ive-mode

rickhanlonii added 5 commits February 10, 2018 07:24

Move changelog update to master

094c2fc

Updates to changelog language

f79b9f5

Minor language updates

c3e6289

rm "the"

c08e0a2

s/file/suite

6bb5999

rickhanlonii approved these changes Feb 10, 2018

View reviewed changes

rickhanlonii merged commit af19110 into jestjs:master Feb 10, 2018

renovate bot mentioned this pull request Feb 14, 2018

fix(deps): update dependency jest to ^22.0.0 manekinekko/devoxx-assistant#3

Open

genintho deleted the 3831-doc-interactive-mode branch June 2, 2018 03:42

github-actions bot locked as resolved and limited conversation to collaborators May 12, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Documentation for Interactive Snapshot Update #5291

Documentation for Interactive Snapshot Update #5291

genintho commented Jan 12, 2018

genintho commented Jan 12, 2018

codecov-io commented Jan 12, 2018 •

edited

Loading

SimenB commented Jan 12, 2018

rickhanlonii commented Jan 17, 2018

genintho commented Jan 17, 2018

rickhanlonii commented Jan 18, 2018

genintho commented Jan 19, 2018

thymikee commented Jan 19, 2018

thymikee Jan 19, 2018

rickhanlonii Jan 19, 2018

genintho commented Feb 3, 2018

rickhanlonii Feb 3, 2018

rickhanlonii Feb 3, 2018

genintho commented Feb 3, 2018

genintho commented Feb 7, 2018

SimenB commented Feb 7, 2018

genintho commented Feb 10, 2018

rickhanlonii left a comment

github-actions bot commented May 12, 2021

Documentation for Interactive Snapshot Update #5291

Documentation for Interactive Snapshot Update #5291

Conversation

genintho commented Jan 12, 2018

genintho commented Jan 12, 2018

codecov-io commented Jan 12, 2018 • edited Loading

Codecov Report

SimenB commented Jan 12, 2018

rickhanlonii commented Jan 17, 2018

Interactive Updates

genintho commented Jan 17, 2018

rickhanlonii commented Jan 18, 2018

genintho commented Jan 19, 2018

thymikee commented Jan 19, 2018

thymikee Jan 19, 2018

Choose a reason for hiding this comment

rickhanlonii Jan 19, 2018

Choose a reason for hiding this comment

genintho commented Feb 3, 2018

rickhanlonii Feb 3, 2018

Choose a reason for hiding this comment

rickhanlonii Feb 3, 2018

Choose a reason for hiding this comment

genintho commented Feb 3, 2018

genintho commented Feb 7, 2018

SimenB commented Feb 7, 2018

genintho commented Feb 10, 2018

rickhanlonii left a comment

Choose a reason for hiding this comment

github-actions bot commented May 12, 2021

codecov-io commented Jan 12, 2018 •

edited

Loading