publiclab / community-toolbox

Tools to understand and welcome people into a contributor community
https://code.publiclab.org
MIT License
142 stars 196 forks source link

Bump jest-when from 2.6.0 to 3.1.0 #421

Closed dependabot-preview[bot] closed 3 years ago

dependabot-preview[bot] commented 3 years ago

Bumps jest-when from 2.6.0 to 3.1.0.

Release notes

Sourced from jest-when's releases.

v3.0.1

  • Merge pull request #55 from tjenkinson/fix-matching-exact-args d4f496f
  • elaborate tests a bit more 88f5e2b
  • fix matching exact args fa68b7f

https://github.com/timkindberg/jest-when/compare/v3.0.0...v3.0.1

v3.0.0

Breaking Changes

WhenMocks will no longer pass if you don't explicitly provide every argument to calledWith.

const fn = jest.fn()
when(fn).calledWith(1, 2).mockReturnValue(true)
const returnValue = fn(1, 2, 3, 4)
expect(returnValue).toBe(true)  // Passed in v2, Fails in v3

In v3 pass matchers for every argument:

when(fn).calledWith(1, 2, 3, 4).mockReturnValue(true)

Or, remember you can use expect.anything() if you want flexibility:

when(fn).calledWith(1, 2, expect.anything(), expect.anything()).mockReturnValue(true)

Or, make your own handy util:

const restAnything = num => Array(num).fill(expect.anything())

when(fn).calledWith(1, 2, ...restAnything(2)).mockReturnValue(true)

Full Explanation

Contributor @tjenkinson found an inconsistency with jest-when's behavior compared to jest. I've always stated that the goal of this lib is to feel like a missing feature of jest and I try to stay as consistent as possible with the precedences set by jest's APIs.

In regular jest if you write this test it will fail.

const spy = jest.fn();
spy(1, 2, 3);
expect(spy).toHaveBeenCalledWith(1, 2);
Commits


Dependabot compatibility score

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.


Dependabot commands and options
You can trigger Dependabot actions by commenting on this PR: - `@dependabot rebase` will rebase this PR - `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it - `@dependabot merge` will merge this PR after your CI passes on it - `@dependabot squash and merge` will squash and merge this PR after your CI passes on it - `@dependabot cancel merge` will cancel a previously requested merge and block automerging - `@dependabot reopen` will reopen this PR if it is closed - `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually - `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself) - `@dependabot use these labels` will set the current labels as the default for future PRs for this repo and language - `@dependabot use these reviewers` will set the current reviewers as the default for future PRs for this repo and language - `@dependabot use these assignees` will set the current assignees as the default for future PRs for this repo and language - `@dependabot use this milestone` will set the current milestone as the default for future PRs for this repo and language - `@dependabot badge me` will comment on this PR with code to add a "Dependabot enabled" badge to your readme Additionally, you can set the following in your Dependabot [dashboard](https://app.dependabot.com): - Update frequency (including time of day and day of week) - Pull request limits (per update run and/or open at any time) - Automerge options (never/patch/minor, and dev/runtime dependencies) - Out-of-range updates (receive only lockfile updates, if desired) - Security updates (receive only security updates, if desired)
dependabot-preview[bot] commented 3 years ago

Superseded by #426.