docs: runnable example of the for Each test #13428

Jeroendevr · 2022-10-11T10:45:39Z

Hi, Perhaps the documentation is written for (more) experienced programmers or for readers who nicely walked through the tutorial but for past me It would have been helpful to have a runnable example. Therefore my suggested improvements so that one can copy paste it to their editor.

mrazauskas

Thanks. That is good idea.

Please fix docs for all versions and the Next version too.

Also run yarn lint (;

website/versioned_docs/version-29.1/MockFunctions.md

facebook-github-bot · 2022-12-14T20:12:10Z

Hi @Jeroendevr!

Thank you for your pull request and welcome to our community.

Action Required

In order to merge any pull request (code, docs, etc.), we require contributors to sign our Contributor License Agreement, and we don't seem to have one on file for you.

Process

In order for us to review and merge your suggested changes, please sign at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need to sign the corporate CLA.

Once the CLA is signed, our tooling will perform checks and validations. Afterwards, the pull request will be tagged with CLA signed. The tagging process may take up to 1 hour after signing. Please give it that time before contacting us about it.

If you have received this in error or have any questions, please contact us at cla@meta.com. Thanks!

Jeroendevr · 2022-12-14T20:49:27Z

I will try to adjust to your suggestions, thanks for the heads up about linting. I am no experienced GitHub user so after my edited PR, you should guide me how to apply this to all versions.
As a reminder for myself

Merge suggestions

facebook-github-bot · 2022-12-14T22:01:28Z

Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Meta Open Source project. Thanks!

facebook-github-bot · 2022-12-14T22:01:31Z

Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Meta Open Source project. Thanks!

Co-authored-by: Tom Mrazauskas <tom@mrazauskas.de>

mrazauskas · 2022-12-15T11:26:53Z

Thanks. The changes look good, but you have to run Prettier (through lint command).

No sure why you added a note about new PR. All versioned docs can be updated in one go (one PR). Just make the same change in all files from website/versioned_docs. Right now you have pushed only v29.1. Also the same change should be made in docs directory, this is Next version docs.

Jeroendevr · 2022-12-15T21:08:04Z

Thanks for pointing out the different docs locations, and the linting, and the fact that is should be within one PR.
The linting had some errors in the e2e tests but these are for someone else as I haven't touched it.
Thank you for providing constructive feedback as I am completely unfamiliar with the node/TS ecosystem.
Had some challenges to run the Jest package locally already 😎

mrazauskas

Thanks. I left few more comments.

Some how I was sure that yarn lint runs Prettier as well, but it doesn’t. You should run yarn lint:prettier additionally. It will add one missing space.

By the way, docs/MockFunctions.md file is missing. Same changes should be made there too. The rest you found (;

website/versioned_docs/version-25.x/MockFunctions.md

mrazauskas · 2022-12-16T11:22:10Z

website/versioned_docs/version-25.x/MockFunctions.md

+// The function was called with a certain `this` context: the `element` object.
+expect(someMockFunction.mock.contexts[0]).toBe(element);
+


Hm.. I guess these are accidental changes. Jest v25 does not have mock.contexts it was introduced recently. That is why it appears only in the docs of later versions.

Ah my bad. Glad you paid good attention to it.

mrazauskas · 2022-12-16T11:33:07Z

website/versioned_docs/version-25.x/MockFunctions.md

@@ -17,41 +17,49 @@ function forEach(items, callback) {
    callback(items[index]);
  }
 }
+module.exports = forEach;


One more thought. What about using ESM syntax here? The examples below written in ESM: https://jestjs.io/docs/next/mock-functions#mocking-modules

ESM syntax is then export forEach; ?

It is:

export function forEach(items, callback) { // etc ...

And instead of const forEach = require('./foreach');:

import {forEach} from './forEach';

Ah I thought there were two ways to export a module.
One as you describe it. Add export before the function declaration and one where you can group all the functions, classes you want to export together (for example at the bottom)

Ok if v25 is acceptable I'll change the others as well. Thanks for learning on the job.

Co-authored-by: Tom Mrazauskas <tom@mrazauskas.de>

website/versioned_docs/version-25.x/MockFunctions.md

website/versioned_docs/version-26.x/MockFunctions.md

website/versioned_docs/version-25.x/MockFunctions.md

Jeroendevr · 2022-12-19T10:44:29Z

Ok thanks for the feedback, added the two empty lines. Also updated along all the versions. Hopefully done it well. 🫣🤗

docs/MockFunctions.md

mrazauskas · 2022-12-21T17:55:11Z

Thanks. All looks good to me.

Now we have to wait for the maintainer to take a look.

SimenB

great stuff, thanks!

github-actions · 2023-02-01T00:09:34Z

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.

mrazauskas reviewed Oct 11, 2022

View reviewed changes

website/versioned_docs/version-29.1/MockFunctions.md Outdated Show resolved Hide resolved

website/versioned_docs/version-29.1/MockFunctions.md Outdated Show resolved Hide resolved

Merge branch 'facebook:main' into patch-1

6f43205

facebook-github-bot added the cla signed label Dec 14, 2022

Jeroendevr and others added 4 commits December 15, 2022 11:02

Update website/versioned_docs/version-29.1/MockFunctions.md

3a88b69

Co-authored-by: Tom Mrazauskas <tom@mrazauskas.de>

Update website/versioned_docs/version-29.1/MockFunctions.md

38afc48

Co-authored-by: Tom Mrazauskas <tom@mrazauskas.de>

Changed docs around all the versions for mockFunc

8ef4867

single quotes

9398746

Jeroen de Vries added 2 commits December 15, 2022 14:38

basic working example

4753f97

.toHaveLength()

01bf339

mrazauskas reviewed Dec 16, 2022

View reviewed changes

Jeroendevr and others added 4 commits December 16, 2022 14:55

Update website/versioned_docs/version-25.x/MockFunctions.md

5ae1f95

Co-authored-by: Tom Mrazauskas <tom@mrazauskas.de>

also update docs main dir + prettier lint

ebc6112

Calls.length -> toHaveLength()

544a9c7

ESM Syntax

05cca48

mrazauskas reviewed Dec 16, 2022

View reviewed changes

website/versioned_docs/version-25.x/MockFunctions.md Outdated Show resolved Hide resolved

mrazauskas reviewed Dec 16, 2022

View reviewed changes

website/versioned_docs/version-25.x/MockFunctions.md Outdated Show resolved Hide resolved

mrazauskas reviewed Dec 16, 2022

View reviewed changes

website/versioned_docs/version-26.x/MockFunctions.md Outdated Show resolved Hide resolved

Jeroen de Vries added 4 commits December 16, 2022 20:15

change title to forEach

5bd950f

undo unmeant doc changes to v25

c98ed64

remove mymock1

1222c5d

space

988db29

mrazauskas reviewed Dec 19, 2022

View reviewed changes

website/versioned_docs/version-25.x/MockFunctions.md Outdated Show resolved Hide resolved

Jeroen de Vries added 13 commits December 19, 2022 11:02

Empty lines undov25

2414a55

/docs adjustment

2f7efae

V28 mockFunctions

f467915

mockfunction v26

9aaa5dd

mockFunction v29

6cf4e4a

mockfunction v29.1

f1cae77

mockFunctions 29.2

b1eac2c

mockFunctions v29.3

817d3cd

docs type foEach

11aed76

context mock functions

9b893b2

seperate line filter test

408dc62

mockcontext 29.0

f75b8a4

mockcontext v29.1

e01bb92

mrazauskas reviewed Dec 19, 2022

View reviewed changes

docs/MockFunctions.md Outdated Show resolved Hide resolved

Jeroen de Vries added 6 commits December 21, 2022 15:03

mock.bind revert from v28 onwards

25dbb66

.mock prop

3658f8c

remove space

77be83a

enter and close function block

b0d31c1

close function block

737fb4d

v28 cloase block

0d91ee2

SimenB approved these changes Jan 1, 2023

View reviewed changes

SimenB changed the title ~~Runnable example of the for Each test~~ docs: runnable example of the for Each test Jan 1, 2023

SimenB merged commit 24d5d04 into jestjs:main Jan 1, 2023

github-actions bot locked as resolved and limited conversation to collaborators Feb 1, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: runnable example of the for Each test #13428

docs: runnable example of the for Each test #13428

Jeroendevr commented Oct 11, 2022

mrazauskas left a comment •

edited

Loading

facebook-github-bot commented Dec 14, 2022

Jeroendevr commented Dec 14, 2022 •

edited

Loading

facebook-github-bot commented Dec 14, 2022

facebook-github-bot commented Dec 14, 2022

mrazauskas commented Dec 15, 2022

Jeroendevr commented Dec 15, 2022

mrazauskas left a comment

mrazauskas Dec 16, 2022 •

edited

Loading

Jeroendevr Dec 16, 2022

mrazauskas Dec 16, 2022

Jeroendevr Dec 16, 2022 •

edited

Loading

mrazauskas Dec 16, 2022

Jeroendevr Dec 16, 2022

Jeroendevr Dec 16, 2022

Jeroendevr commented Dec 19, 2022

mrazauskas commented Dec 21, 2022

SimenB left a comment

github-actions bot commented Feb 1, 2023

		// The function was called with a certain `this` context: the `element` object.
		expect(someMockFunction.mock.contexts[0]).toBe(element);

docs: runnable example of the for Each test #13428

docs: runnable example of the for Each test #13428

Conversation

Jeroendevr commented Oct 11, 2022

mrazauskas left a comment • edited Loading

Choose a reason for hiding this comment

facebook-github-bot commented Dec 14, 2022

Action Required

Process

Jeroendevr commented Dec 14, 2022 • edited Loading

facebook-github-bot commented Dec 14, 2022

facebook-github-bot commented Dec 14, 2022

mrazauskas commented Dec 15, 2022

Jeroendevr commented Dec 15, 2022

mrazauskas left a comment

Choose a reason for hiding this comment

mrazauskas Dec 16, 2022 • edited Loading

Choose a reason for hiding this comment

Jeroendevr Dec 16, 2022

Choose a reason for hiding this comment

mrazauskas Dec 16, 2022

Choose a reason for hiding this comment

Jeroendevr Dec 16, 2022 • edited Loading

Choose a reason for hiding this comment

mrazauskas Dec 16, 2022

Choose a reason for hiding this comment

Jeroendevr Dec 16, 2022

Choose a reason for hiding this comment

Jeroendevr Dec 16, 2022

Choose a reason for hiding this comment

Jeroendevr commented Dec 19, 2022

mrazauskas commented Dec 21, 2022

SimenB left a comment

Choose a reason for hiding this comment

github-actions bot commented Feb 1, 2023

mrazauskas left a comment •

edited

Loading

Jeroendevr commented Dec 14, 2022 •

edited

Loading

mrazauskas Dec 16, 2022 •

edited

Loading

Jeroendevr Dec 16, 2022 •

edited

Loading