Improve description line when assertion fails: part 2 #5512

pedrottimark · 2018-02-10T00:58:51Z

Delete paraphrased info from value labels which the description line can communicate by formatting.

Contrast: Format not as regular instead of dim when assertion fails.
Contrast: Instead of [.not] when arg validation throws an error, either format or omit not using new isNot option of matcherHint according to isNot property of matcher. Residue: ensureNoExpected and so on exported by jest-matcher-utils will wait until later because need another argument.
Contrast EDITED 2018-02-20 per Improve description line when assertion fails: part 2 #5512 (comment) format matcher name as regular instead of dim. For backward compatibility, format preceding period as dim, even if matcher name includes it.
Contrast: EDITED 2018-02-20 also format rejects or resolves as regular instead of dim via new prefix option of matcherHint function.
Alignment: Because Expected: and Received: have same length without paraphrased info, display values starting on same line instead of indented on following line.

The “developer experience” goal is know where to look for what purpose:

Look at description line to understand the assertion.
Look at values or diff to decide whether the change is progress or regression.

~~Next PR will continue in alphabetical order at toContain~~

Here are some samples [of original improved design with matcher name as dim]:

EDITED on 2018-02-20 samples of more improved design with matcher name as regular:

Test plan

EDIT: Updated snapshots for integration-tests:

3 for failures
1 for jasmine-async
2 for to_match_snapshot

Updated 179 snapshots for toBe… matchers:

18 for toBe
12 for toBeCloseTo
10 for toBeDefined
16 for toBeFalsy
14 for toBeGreaterThan
19 for toBeGreaterThanOrEqual
9 for toBeInstanceOf
14 for toBeLessThan
19 for toBeLessThanOrEqual
14 for toBeNaN
10 for toBeNull
16 for toBeTruthy
10 for toBeUndefined

EDITED on 2018-02-20 Updated more snapshots for other matchers:

24 for toContain and toContainEqual notice comments: strict equality versus deep equality
65 for toEqual notice comment deep equality
13 for toHaveLength
40 for toHaveProperty
17 for toMatch
53 for toMatchObject
11 for toThrow
11 for toThrowError
9 for rejects
17 for resolves

55 in spy_matchers

4 for toBeCalled
1 for toBeCalledWith
4 for toHaveBeenCalled
10 for toHaveBeenCalledTimes
12 for toHaveBeenCalledWith
12 for toHaveBeenLastCalledWith
12 for lastCalledWith

A few of the snapshots descriptions were a puzzle to me but the changes were consistent.

codecov-io · 2018-02-10T02:04:05Z

Codecov Report

Merging #5512 into master will not change coverage.
The diff coverage is 100%.

@@           Coverage Diff           @@
##           master    #5512   +/-   ##
=======================================
  Coverage   61.69%   61.69%           
=======================================
  Files         213      213           
  Lines        7077     7077           
  Branches        4        3    -1     
=======================================
  Hits         4366     4366           
  Misses       2710     2710           
  Partials        1        1

Impacted Files	Coverage Δ
packages/jest-matcher-utils/src/index.js	`100% <100%> (ø)`	⬆️

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 c5a2ea0...cdd7979. Read the comment docs.

thymikee · 2018-02-10T08:26:44Z

This is pretty controversial change :D but I kinda like the consistency of the output (at least when it's short).

Wouldn't it be better for readability, if we change the matcher name (e.g. .toBeDefined()) to have some more visible, neutral color, e.g. blue or even default non-dimmed color? I think it would be easier to read this way.

thymikee · 2018-02-10T08:15:12Z

packages/expect/src/matchers.js

+        secondArgument,
+      }) +
+      '\n\n' +
+      `Precision: ${printExpected(precision)}-digit\n` +


I'd move precision below received

See pictures for an alternative where to move precision.

thymikee · 2018-02-10T08:29:53Z

packages/expect/src/matchers.js

            received.constructor && received.constructor.name,
-          )}`;
+          )}\n` +
+          `Received value: ${printReceived(received)}`;


Shouldn't this matcher be collapsed too?

Do you mean display all three lines for not version of assertion?

If yes, then I agree and will change it to simplify code and make report more consistent.

Yup, can be a part of next PR

thymikee · 2018-02-10T08:39:57Z

packages/expect/src/matchers.js

@@ -45,14 +45,13 @@ const matchers: MatchersObject = {

    const message = pass
      ? () =>
-          matcherHint('.not.toBe', undefined, undefined, {
+          matcherHint('.toBe', undefined, undefined, {


I wonder why this matcher has asymmetric toBe/not.toBe output – I don't see any reason we shouldn't suggest toEqual for not.toBe assertions, same with showing a diff.
It's not related to this PR, but why not fix it right away.

Let’s please wait for a future PR, because it’s a double negative when .not.toBe fails.

cpojer · 2018-02-10T10:51:55Z

I like it because it increases information density and uses less vertical space. It does look slightly less consistent overall but I think it works well for the matchers you are changing. I'm in favor.

pedrottimark · 2018-02-11T17:06:57Z

@thymikee Here are three pictures of alternatives based on your suggestions. What do you think?

Display matcher name in regular weight instead of dim.

Display precision argument value in description line.

thymikee · 2018-02-11T20:35:08Z

This is dope.

cpojer · 2018-02-23T09:59:04Z

Merging, feel free to send follow-ups to further improve printing :)

This Pull Request updates dependency [jest](https://github.com/facebook/jest) from `~22.4.0` to `~23.0.0` <details> <summary>Release Notes</summary> ### [`v23.0.0`](https://github.com/facebook/jest/blob/master/CHANGELOG.md#2300) [Compare Source](jestjs/jest@2745e3e...614f739) ##### Features * `[expect]` Expose `getObjectSubset`, `iterableEquality`, and `subsetEquality` ([#6210](`jestjs/jest#6210)) * `[jest-snapshot]` Add snapshot property matchers ([#6210](`jestjs/jest#6210)) * `[jest-config]` Support jest-preset.js files within Node modules ([#6185](`jestjs/jest#6185)) * `[jest-cli]` Add `--detectOpenHandles` flag which enables Jest to potentially track down handles keeping it open after tests are complete. ([#6130](`jestjs/jest#6130)) * `[jest-jasmine2]` Add data driven testing based on `jest-each` ([#6102](`jestjs/jest#6102)) * `[jest-matcher-utils]` Change "suggest to equal" message to be more advisory ([#6103](`jestjs/jest#6103)) * `[jest-message-util]` Don't ignore messages with `vendor` anymore ([#6117](`jestjs/jest#6117)) * `[jest-validate]` Get rid of `jest-config` dependency ([#6067](`jestjs/jest#6067)) * `[jest-validate]` Adds option to inject `deprecationEntries` ([#6067](`jestjs/jest#6067)) * `[jest-snapshot]` [**BREAKING**] Concatenate name of test, optional snapshot name and count ([#6015](`jestjs/jest#6015)) * `[jest-runtime]` Allow for transform plugins to skip the definition process method if createTransformer method was defined. ([#5999](`jestjs/jest#5999)) * `[expect]` Add stack trace for async errors ([#6008](`jestjs/jest#6008)) * `[jest-jasmine2]` Add stack trace for timeouts ([#6008](`jestjs/jest#6008)) * `[jest-jasmine2]` Add stack trace for thrown non-`Error`s ([#6008](`jestjs/jest#6008)) * `[jest-runtime]` Prevent modules from marking themselves as their own parent ([#5235](`jestjs/jest#5235)) * `[jest-mock]` Add support for auto-mocking generator functions ([#5983](`jestjs/jest#5983)) * `[expect]` Add support for async matchers ([#5919](`jestjs/jest#5919)) * `[expect]` Suggest toContainEqual ([#5948](`jestjs/jest#5953)) * `[jest-config]` Export Jest's default options ([#5948](`jestjs/jest#5948)) * `[jest-editor-support]` Move `coverage` to `ProjectWorkspace.collectCoverage` ([#5929](`jestjs/jest#5929)) * `[jest-editor-support]` Add `coverage` option to runner ([#5836](`jestjs/jest#5836)) * `[jest-haste-map]` Support extracting dynamic `import`s ([#5883](`jestjs/jest#5883)) * `[expect]` Improve output format for mismatchedArgs in mock/spy calls. ([#5846](`jestjs/jest#5846)) * `[jest-cli]` Add support for using `--coverage` in combination with watch mode, `--onlyChanged`, `--findRelatedTests` and more ([#5601](`jestjs/jest#5601)) * `[jest-jasmine2]` [**BREAKING**] Adds error throwing and descriptive errors to `it`/ `test` for invalid arguments. `[jest-circus]` Adds error throwing and descriptive errors to `it`/ `test` for invalid arguments ([#5558](`jestjs/jest#5558)) * `[jest-matcher-utils]` Add `isNot` option to `matcherHint` function ([#5512](`jestjs/jest#5512)) * `[jest-config]` Add `<rootDir>` to runtime files not found error report ([#5693](`jestjs/jest#5693)) * `[expect]` Make toThrow matcher pass only if Error object is returned from promises ([#5670](`jestjs/jest#5670)) * `[expect]` Add isError to utils ([#5670](`jestjs/jest#5670)) * `[expect]` Add inverse matchers (`expect.not.arrayContaining`, etc., [#5517](`jestjs/jest#5517)) * `[expect]` `expect.extend` now also extends asymmetric matchers ([#5503](`jestjs/jest#5503)) * `[jest-mock]` Update `spyOnProperty` to support spying on the prototype chain ([#5753](`jestjs/jest#5753)) * `[jest-mock]` Add tracking of return values in the `mock` property ([#5752](`jestjs/jest#5752)) * `[jest-mock]` Add tracking of thrown errors in the `mock` property ([#5764](`jestjs/jest#5764)) * `[expect]`Add nthCalledWith spy matcher ([#5605](`jestjs/jest#5605)) * `[jest-cli]` Add `isSerial` property that runners can expose to specify that they can not run in parallel ([#5706](`jestjs/jest#5706)) * `[expect]` Add `.toBeCalledTimes` and `toHaveBeenNthCalledWith` aliases ([#5826](`jestjs/jest#5826)) * `[jest-cli]` Interactive Snapshot Mode improvements ([#5864](`jestjs/jest#5864)) * `[jest-editor-support]` Add `no-color` option to runner ([#5909](`jestjs/jest#5909)) * `[jest-jasmine2]` Pretty-print non-Error object errors ([#5980](`jestjs/jest#5980)) * `[jest-message-util]` Include column in stack frames ([#5889](`jestjs/jest#5889)) * `[expect]` Introduce toStrictEqual ([#6032](`jestjs/jest#6032)) * `[expect]` Add return matchers ([#5879](`jestjs/jest#5879)) * `[jest-cli]` Improve snapshot summaries ([#6181](`jestjs/jest#6181)) * `[expect]` Include custom mock names in error messages ([#6199](`jestjs/jest#6199)) * `[jest-diff]` Support returning diff from oneline strings ([#6221](`jestjs/jest#6221)) * `[expect]` Improve return matchers ([#6172](`jestjs/jest#6172)) * `[jest-cli]` Overhaul watch plugin hooks names ([#6249](`jestjs/jest#6249)) * `[jest-mock]` Include tracked call results in serialized mock ([#6244](`jestjs/jest#6244)) ##### Fixes * `[jest-cli]` Fix stdin encoding to utf8 for watch plugins. ([#6253](`jestjs/jest#6253)) * `[expect]` Better detection of DOM Nodes for equality ([#6246](`jestjs/jest#6246)) * `[jest-cli]` Fix misleading action description for F key when in "only failed tests" mode. ([#6167](`jestjs/jest#6167)) * `[jest-worker]` Stick calls to workers before processing them ([#6073](`jestjs/jest#6073)) * `[babel-plugin-jest-hoist]` Allow using `console` global variable ([#6075](`jestjs/jest#6075)) * `[jest-jasmine2]` Always remove node core message from assert stack traces ([#6055](`jestjs/jest#6055)) * `[expect]` Add stack trace when `expect.assertions` and `expect.hasAssertions` causes test failures. ([#5997](`jestjs/jest#5997)) * `[jest-runtime]` Throw a more useful error when trying to require modules after the test environment is torn down ([#5888](`jestjs/jest#5888)) * `[jest-mock]` [**BREAKING**] Replace timestamps with `invocationCallOrder` ([#5867](`jestjs/jest#5867)) * `[jest-jasmine2]` Install `sourcemap-support` into normal runtime to catch runtime errors ([#5945](`jestjs/jest#5945)) * `[jest-jasmine2]` Added assertion error handling inside `afterAll hook` ([#5884](`jestjs/jest#5884)) * `[jest-cli]` Remove the notifier actions in case of failure when not in watch mode. ([#5861](`jestjs/jest#5861)) * `[jest-mock]` Extend .toHaveBeenCalled return message with outcome ([#5951](`jestjs/jest#5951)) * `[jest-runner]` Assign `process.env.JEST_WORKER_ID="1"` when in runInBand mode ([#5860](`jestjs/jest#5860)) * `[jest-cli]` Add descriptive error message when trying to use `globalSetup`/`globalTeardown` file that doesn't export a function. ([#5835](`jestjs/jest#5835)) * `[expect]` Do not rely on `instanceof RegExp`, since it will not work for RegExps created inside of a different VM ([#5729](`jestjs/jest#5729)) * `[jest-resolve]` Update node module resolution algorithm to correctly handle symlinked paths ([#5085](`jestjs/jest#5085)) * `[jest-editor-support]` Update `Settings` to use spawn in shell option ([#5658](`jestjs/jest#5658)) * `[jest-cli]` Improve the error message when 2 projects resolve to the same config ([#5674](`jestjs/jest#5674)) * `[jest-runtime]` remove retainLines from coverage instrumentation ([#5692](`jestjs/jest#5692)) * `[jest-cli]` Fix update snapshot issue when using watchAll ([#5696](`jestjs/jest#5696)) * `[expect]` Fix rejects.not matcher ([#5670](`jestjs/jest#5670)) * `[jest-runtime]` Prevent Babel warnings on large files ([#5702](`jestjs/jest#5702)) * `[jest-mock]` Prevent `mockRejectedValue` from causing unhandled rejection ([#5720](`jestjs/jest#5720)) * `[pretty-format]` Handle React fragments better ([#5816](`jestjs/jest#5816)) * `[pretty-format]` Handle formatting of `React.forwardRef` and `Context` components ([#6093](`jestjs/jest#6093)) * `[jest-cli]` Switch collectCoverageFrom back to a string ([#5914](`jestjs/jest#5914)) * `[jest-regex-util]` Fix handling regex symbols in tests path on Windows ([#5941](`jestjs/jest#5941)) * `[jest-util]` Fix handling of NaN/Infinity in mock timer delay ([#5966](`jestjs/jest#5966)) * `[jest-resolve]` Generalise test for package main entries equivalent to ".". ([#5968](`jestjs/jest#5968)) * `[jest-config]` Ensure that custom resolvers are used when resolving the configuration ([#5976](`jestjs/jest#5976)) * `[website]` Fix website docs ([#5853](`jestjs/jest#5853)) * `[expect]` Fix isEqual Set and Map to compare object values and keys regardless of order ([#6150](`jestjs/jest#6150)) * `[pretty-format]` [**BREAKING**] Remove undefined props from React elements ([#6162](`jestjs/jest#6162)) * `[jest-haste-map]` Properly resolve mocked node modules without package.json defined ([#6232](`jestjs/jest#6232)) ##### Chore & Maintenance * `[jest-runner]` Move sourcemap installation from `jest-jasmine2` to `jest-runner` ([#6176](`jestjs/jest#6176)) * `[jest-cli]` Use yargs's built-in `version` instead of rolling our own ([#6215](`jestjs/jest#6215)) * `[docs]` Add explanation on how to mock methods not implemented in JSDOM * `[jest-jasmine2]` Simplify `Env.execute` and TreeProcessor to setup and clean resources for the top suite the same way as for all of the children suites ([#5885](`jestjs/jest#5885)) * `[babel-jest]` [**BREAKING**] Always return object from transformer ([#5991](`jestjs/jest#5991)) * `[*]` Run Prettier on compiled output ([#5858](`jestjs/jest#3497)) * `[jest-cli]` Add fileChange hook for plugins ([#5708](`jestjs/jest#5708)) * `[docs]` Add docs on using `jest.mock(...)` ([#5648](`jestjs/jest#5648)) * `[docs]` Mention Jest Puppeteer Preset ([#5722](`jestjs/jest#5722)) * `[docs]` Add jest-community section to website ([#5675](`jestjs/jest#5675)) * `[docs]` Add versioned docs for v22.4 ([##5733](https://github.com/facebook/jest/pull/#5733)) * `[docs]` Improve Snapshot Testing Guide ([#5812](`jestjs/jest#5812)) * `[jest-runtime]` [**BREAKING**] Remove `jest.genMockFn` and `jest.genMockFunction` ([#6173](`jestjs/jest#6173)) * `[jest-message-util]` Avoid adding unnecessary indent to blank lines in stack traces ([#6211](`jestjs/jest#6211)) --- </details> --- This PR has been generated by [Renovate Bot](https://renovatebot.com).

This Pull Request updates dependency [jest](https://github.com/facebook/jest) from `~22.4.0` to `~23.0.0` <details> <summary>Release Notes</summary> ### [`v23.0.0`](https://github.com/facebook/jest/blob/master/CHANGELOG.md#2300) [Compare Source](jestjs/jest@2745e3e...v23.0.0) ##### Features * `[expect]` Expose `getObjectSubset`, `iterableEquality`, and `subsetEquality` ([#6210](`jestjs/jest#6210)) * `[jest-snapshot]` Add snapshot property matchers ([#6210](`jestjs/jest#6210)) * `[jest-config]` Support jest-preset.js files within Node modules ([#6185](`jestjs/jest#6185)) * `[jest-cli]` Add `--detectOpenHandles` flag which enables Jest to potentially track down handles keeping it open after tests are complete. ([#6130](`jestjs/jest#6130)) * `[jest-jasmine2]` Add data driven testing based on `jest-each` ([#6102](`jestjs/jest#6102)) * `[jest-matcher-utils]` Change "suggest to equal" message to be more advisory ([#6103](`jestjs/jest#6103)) * `[jest-message-util]` Don't ignore messages with `vendor` anymore ([#6117](`jestjs/jest#6117)) * `[jest-validate]` Get rid of `jest-config` dependency ([#6067](`jestjs/jest#6067)) * `[jest-validate]` Adds option to inject `deprecationEntries` ([#6067](`jestjs/jest#6067)) * `[jest-snapshot]` [**BREAKING**] Concatenate name of test, optional snapshot name and count ([#6015](`jestjs/jest#6015)) * `[jest-runtime]` Allow for transform plugins to skip the definition process method if createTransformer method was defined. ([#5999](`jestjs/jest#5999)) * `[expect]` Add stack trace for async errors ([#6008](`jestjs/jest#6008)) * `[jest-jasmine2]` Add stack trace for timeouts ([#6008](`jestjs/jest#6008)) * `[jest-jasmine2]` Add stack trace for thrown non-`Error`s ([#6008](`jestjs/jest#6008)) * `[jest-runtime]` Prevent modules from marking themselves as their own parent ([#5235](`jestjs/jest#5235)) * `[jest-mock]` Add support for auto-mocking generator functions ([#5983](`jestjs/jest#5983)) * `[expect]` Add support for async matchers ([#5919](`jestjs/jest#5919)) * `[expect]` Suggest toContainEqual ([#5948](`jestjs/jest#5953)) * `[jest-config]` Export Jest's default options ([#5948](`jestjs/jest#5948)) * `[jest-editor-support]` Move `coverage` to `ProjectWorkspace.collectCoverage` ([#5929](`jestjs/jest#5929)) * `[jest-editor-support]` Add `coverage` option to runner ([#5836](`jestjs/jest#5836)) * `[jest-haste-map]` Support extracting dynamic `import`s ([#5883](`jestjs/jest#5883)) * `[expect]` Improve output format for mismatchedArgs in mock/spy calls. ([#5846](`jestjs/jest#5846)) * `[jest-cli]` Add support for using `--coverage` in combination with watch mode, `--onlyChanged`, `--findRelatedTests` and more ([#5601](`jestjs/jest#5601)) * `[jest-jasmine2]` [**BREAKING**] Adds error throwing and descriptive errors to `it`/ `test` for invalid arguments. `[jest-circus]` Adds error throwing and descriptive errors to `it`/ `test` for invalid arguments ([#5558](`jestjs/jest#5558)) * `[jest-matcher-utils]` Add `isNot` option to `matcherHint` function ([#5512](`jestjs/jest#5512)) * `[jest-config]` Add `<rootDir>` to runtime files not found error report ([#5693](`jestjs/jest#5693)) * `[expect]` Make toThrow matcher pass only if Error object is returned from promises ([#5670](`jestjs/jest#5670)) * `[expect]` Add isError to utils ([#5670](`jestjs/jest#5670)) * `[expect]` Add inverse matchers (`expect.not.arrayContaining`, etc., [#5517](`jestjs/jest#5517)) * `[expect]` `expect.extend` now also extends asymmetric matchers ([#5503](`jestjs/jest#5503)) * `[jest-mock]` Update `spyOnProperty` to support spying on the prototype chain ([#5753](`jestjs/jest#5753)) * `[jest-mock]` Add tracking of return values in the `mock` property ([#5752](`jestjs/jest#5752)) * `[jest-mock]` Add tracking of thrown errors in the `mock` property ([#5764](`jestjs/jest#5764)) * `[expect]`Add nthCalledWith spy matcher ([#5605](`jestjs/jest#5605)) * `[jest-cli]` Add `isSerial` property that runners can expose to specify that they can not run in parallel ([#5706](`jestjs/jest#5706)) * `[expect]` Add `.toBeCalledTimes` and `toHaveBeenNthCalledWith` aliases ([#5826](`jestjs/jest#5826)) * `[jest-cli]` Interactive Snapshot Mode improvements ([#5864](`jestjs/jest#5864)) * `[jest-editor-support]` Add `no-color` option to runner ([#5909](`jestjs/jest#5909)) * `[jest-jasmine2]` Pretty-print non-Error object errors ([#5980](`jestjs/jest#5980)) * `[jest-message-util]` Include column in stack frames ([#5889](`jestjs/jest#5889)) * `[expect]` Introduce toStrictEqual ([#6032](`jestjs/jest#6032)) * `[expect]` Add return matchers ([#5879](`jestjs/jest#5879)) * `[jest-cli]` Improve snapshot summaries ([#6181](`jestjs/jest#6181)) * `[expect]` Include custom mock names in error messages ([#6199](`jestjs/jest#6199)) * `[jest-diff]` Support returning diff from oneline strings ([#6221](`jestjs/jest#6221)) * `[expect]` Improve return matchers ([#6172](`jestjs/jest#6172)) * `[jest-cli]` Overhaul watch plugin hooks names ([#6249](`jestjs/jest#6249)) * `[jest-mock]` Include tracked call results in serialized mock ([#6244](`jestjs/jest#6244)) ##### Fixes * `[jest-cli]` Fix stdin encoding to utf8 for watch plugins. ([#6253](`jestjs/jest#6253)) * `[expect]` Better detection of DOM Nodes for equality ([#6246](`jestjs/jest#6246)) * `[jest-cli]` Fix misleading action description for F key when in "only failed tests" mode. ([#6167](`jestjs/jest#6167)) * `[jest-worker]` Stick calls to workers before processing them ([#6073](`jestjs/jest#6073)) * `[babel-plugin-jest-hoist]` Allow using `console` global variable ([#6075](`jestjs/jest#6075)) * `[jest-jasmine2]` Always remove node core message from assert stack traces ([#6055](`jestjs/jest#6055)) * `[expect]` Add stack trace when `expect.assertions` and `expect.hasAssertions` causes test failures. ([#5997](`jestjs/jest#5997)) * `[jest-runtime]` Throw a more useful error when trying to require modules after the test environment is torn down ([#5888](`jestjs/jest#5888)) * `[jest-mock]` [**BREAKING**] Replace timestamps with `invocationCallOrder` ([#5867](`jestjs/jest#5867)) * `[jest-jasmine2]` Install `sourcemap-support` into normal runtime to catch runtime errors ([#5945](`jestjs/jest#5945)) * `[jest-jasmine2]` Added assertion error handling inside `afterAll hook` ([#5884](`jestjs/jest#5884)) * `[jest-cli]` Remove the notifier actions in case of failure when not in watch mode. ([#5861](`jestjs/jest#5861)) * `[jest-mock]` Extend .toHaveBeenCalled return message with outcome ([#5951](`jestjs/jest#5951)) * `[jest-runner]` Assign `process.env.JEST_WORKER_ID="1"` when in runInBand mode ([#5860](`jestjs/jest#5860)) * `[jest-cli]` Add descriptive error message when trying to use `globalSetup`/`globalTeardown` file that doesn't export a function. ([#5835](`jestjs/jest#5835)) * `[expect]` Do not rely on `instanceof RegExp`, since it will not work for RegExps created inside of a different VM ([#5729](`jestjs/jest#5729)) * `[jest-resolve]` Update node module resolution algorithm to correctly handle symlinked paths ([#5085](`jestjs/jest#5085)) * `[jest-editor-support]` Update `Settings` to use spawn in shell option ([#5658](`jestjs/jest#5658)) * `[jest-cli]` Improve the error message when 2 projects resolve to the same config ([#5674](`jestjs/jest#5674)) * `[jest-runtime]` remove retainLines from coverage instrumentation ([#5692](`jestjs/jest#5692)) * `[jest-cli]` Fix update snapshot issue when using watchAll ([#5696](`jestjs/jest#5696)) * `[expect]` Fix rejects.not matcher ([#5670](`jestjs/jest#5670)) * `[jest-runtime]` Prevent Babel warnings on large files ([#5702](`jestjs/jest#5702)) * `[jest-mock]` Prevent `mockRejectedValue` from causing unhandled rejection ([#5720](`jestjs/jest#5720)) * `[pretty-format]` Handle React fragments better ([#5816](`jestjs/jest#5816)) * `[pretty-format]` Handle formatting of `React.forwardRef` and `Context` components ([#6093](`jestjs/jest#6093)) * `[jest-cli]` Switch collectCoverageFrom back to a string ([#5914](`jestjs/jest#5914)) * `[jest-regex-util]` Fix handling regex symbols in tests path on Windows ([#5941](`jestjs/jest#5941)) * `[jest-util]` Fix handling of NaN/Infinity in mock timer delay ([#5966](`jestjs/jest#5966)) * `[jest-resolve]` Generalise test for package main entries equivalent to ".". ([#5968](`jestjs/jest#5968)) * `[jest-config]` Ensure that custom resolvers are used when resolving the configuration ([#5976](`jestjs/jest#5976)) * `[website]` Fix website docs ([#5853](`jestjs/jest#5853)) * `[expect]` Fix isEqual Set and Map to compare object values and keys regardless of order ([#6150](`jestjs/jest#6150)) * `[pretty-format]` [**BREAKING**] Remove undefined props from React elements ([#6162](`jestjs/jest#6162)) * `[jest-haste-map]` Properly resolve mocked node modules without package.json defined ([#6232](`jestjs/jest#6232)) ##### Chore & Maintenance * `[jest-runner]` Move sourcemap installation from `jest-jasmine2` to `jest-runner` ([#6176](`jestjs/jest#6176)) * `[jest-cli]` Use yargs's built-in `version` instead of rolling our own ([#6215](`jestjs/jest#6215)) * `[docs]` Add explanation on how to mock methods not implemented in JSDOM * `[jest-jasmine2]` Simplify `Env.execute` and TreeProcessor to setup and clean resources for the top suite the same way as for all of the children suites ([#5885](`jestjs/jest#5885)) * `[babel-jest]` [**BREAKING**] Always return object from transformer ([#5991](`jestjs/jest#5991)) * `[*]` Run Prettier on compiled output ([#5858](`jestjs/jest#3497)) * `[jest-cli]` Add fileChange hook for plugins ([#5708](`jestjs/jest#5708)) * `[docs]` Add docs on using `jest.mock(...)` ([#5648](`jestjs/jest#5648)) * `[docs]` Mention Jest Puppeteer Preset ([#5722](`jestjs/jest#5722)) * `[docs]` Add jest-community section to website ([#5675](`jestjs/jest#5675)) * `[docs]` Add versioned docs for v22.4 ([##5733](https://github.com/facebook/jest/pull/#5733)) * `[docs]` Improve Snapshot Testing Guide ([#5812](`jestjs/jest#5812)) * `[jest-runtime]` [**BREAKING**] Remove `jest.genMockFn` and `jest.genMockFunction` ([#6173](`jestjs/jest#6173)) * `[jest-message-util]` Avoid adding unnecessary indent to blank lines in stack traces ([#6211](`jestjs/jest#6211)) --- </details> --- This PR has been generated by [Renovate Bot](https://renovatebot.com).

This Pull Request updates dependency [jest](https://github.com/facebook/jest) from `v22.4.3` to `v23.0.1` <details> <summary>Release Notes</summary> ### [`v23.0.1`](https://github.com/facebook/jest/blob/master/CHANGELOG.md#2301) [Compare Source](jestjs/jest@v23.0.0...3a3b4e3) ##### Chore & Maintenance * `[jest-jasemine2]` Add dependency on jest-each ([#6308](`jestjs/jest#6308)) * `[jest-each]` Move jest-each into core Jest ([#6278](`jestjs/jest#6278)) * `[examples]` Update typescript example to using ts-jest ([#6260](`jestjs/jest#6260)) ##### Fixes * `[pretty-format]` Serialize inverse asymmetric matchers correctly ([#6272](`jestjs/jest#6272)) --- ### [`v23.0.0`](https://github.com/facebook/jest/blob/master/CHANGELOG.md#2300) [Compare Source](jestjs/jest@2745e3e...v23.0.0) ##### Features * `[expect]` Expose `getObjectSubset`, `iterableEquality`, and `subsetEquality` ([#6210](`jestjs/jest#6210)) * `[jest-snapshot]` Add snapshot property matchers ([#6210](`jestjs/jest#6210)) * `[jest-config]` Support jest-preset.js files within Node modules ([#6185](`jestjs/jest#6185)) * `[jest-cli]` Add `--detectOpenHandles` flag which enables Jest to potentially track down handles keeping it open after tests are complete. ([#6130](`jestjs/jest#6130)) * `[jest-jasmine2]` Add data driven testing based on `jest-each` ([#6102](`jestjs/jest#6102)) * `[jest-matcher-utils]` Change "suggest to equal" message to be more advisory ([#6103](`jestjs/jest#6103)) * `[jest-message-util]` Don't ignore messages with `vendor` anymore ([#6117](`jestjs/jest#6117)) * `[jest-validate]` Get rid of `jest-config` dependency ([#6067](`jestjs/jest#6067)) * `[jest-validate]` Adds option to inject `deprecationEntries` ([#6067](`jestjs/jest#6067)) * `[jest-snapshot]` [**BREAKING**] Concatenate name of test, optional snapshot name and count ([#6015](`jestjs/jest#6015)) * `[jest-runtime]` Allow for transform plugins to skip the definition process method if createTransformer method was defined. ([#5999](`jestjs/jest#5999)) * `[expect]` Add stack trace for async errors ([#6008](`jestjs/jest#6008)) * `[jest-jasmine2]` Add stack trace for timeouts ([#6008](`jestjs/jest#6008)) * `[jest-jasmine2]` Add stack trace for thrown non-`Error`s ([#6008](`jestjs/jest#6008)) * `[jest-runtime]` Prevent modules from marking themselves as their own parent ([#5235](`jestjs/jest#5235)) * `[jest-mock]` Add support for auto-mocking generator functions ([#5983](`jestjs/jest#5983)) * `[expect]` Add support for async matchers ([#5919](`jestjs/jest#5919)) * `[expect]` Suggest toContainEqual ([#5948](`jestjs/jest#5953)) * `[jest-config]` Export Jest's default options ([#5948](`jestjs/jest#5948)) * `[jest-editor-support]` Move `coverage` to `ProjectWorkspace.collectCoverage` ([#5929](`jestjs/jest#5929)) * `[jest-editor-support]` Add `coverage` option to runner ([#5836](`jestjs/jest#5836)) * `[jest-haste-map]` Support extracting dynamic `import`s ([#5883](`jestjs/jest#5883)) * `[expect]` Improve output format for mismatchedArgs in mock/spy calls. ([#5846](`jestjs/jest#5846)) * `[jest-cli]` Add support for using `--coverage` in combination with watch mode, `--onlyChanged`, `--findRelatedTests` and more ([#5601](`jestjs/jest#5601)) * `[jest-jasmine2]` [**BREAKING**] Adds error throwing and descriptive errors to `it`/ `test` for invalid arguments. `[jest-circus]` Adds error throwing and descriptive errors to `it`/ `test` for invalid arguments ([#5558](`jestjs/jest#5558)) * `[jest-matcher-utils]` Add `isNot` option to `matcherHint` function ([#5512](`jestjs/jest#5512)) * `[jest-config]` Add `<rootDir>` to runtime files not found error report ([#5693](`jestjs/jest#5693)) * `[expect]` Make toThrow matcher pass only if Error object is returned from promises ([#5670](`jestjs/jest#5670)) * `[expect]` Add isError to utils ([#5670](`jestjs/jest#5670)) * `[expect]` Add inverse matchers (`expect.not.arrayContaining`, etc., [#5517](`jestjs/jest#5517)) * `[expect]` `expect.extend` now also extends asymmetric matchers ([#5503](`jestjs/jest#5503)) * `[jest-mock]` Update `spyOnProperty` to support spying on the prototype chain ([#5753](`jestjs/jest#5753)) * `[jest-mock]` Add tracking of return values in the `mock` property ([#5752](`jestjs/jest#5752)) * `[jest-mock]` Add tracking of thrown errors in the `mock` property ([#5764](`jestjs/jest#5764)) * `[expect]`Add nthCalledWith spy matcher ([#5605](`jestjs/jest#5605)) * `[jest-cli]` Add `isSerial` property that runners can expose to specify that they can not run in parallel ([#5706](`jestjs/jest#5706)) * `[expect]` Add `.toBeCalledTimes` and `toHaveBeenNthCalledWith` aliases ([#5826](`jestjs/jest#5826)) * `[jest-cli]` Interactive Snapshot Mode improvements ([#5864](`jestjs/jest#5864)) * `[jest-editor-support]` Add `no-color` option to runner ([#5909](`jestjs/jest#5909)) * `[jest-jasmine2]` Pretty-print non-Error object errors ([#5980](`jestjs/jest#5980)) * `[jest-message-util]` Include column in stack frames ([#5889](`jestjs/jest#5889)) * `[expect]` Introduce toStrictEqual ([#6032](`jestjs/jest#6032)) * `[expect]` Add return matchers ([#5879](`jestjs/jest#5879)) * `[jest-cli]` Improve snapshot summaries ([#6181](`jestjs/jest#6181)) * `[expect]` Include custom mock names in error messages ([#6199](`jestjs/jest#6199)) * `[jest-diff]` Support returning diff from oneline strings ([#6221](`jestjs/jest#6221)) * `[expect]` Improve return matchers ([#6172](`jestjs/jest#6172)) * `[jest-cli]` Overhaul watch plugin hooks names ([#6249](`jestjs/jest#6249)) * `[jest-mock]` Include tracked call results in serialized mock ([#6244](`jestjs/jest#6244)) ##### Fixes * `[jest-cli]` Fix stdin encoding to utf8 for watch plugins. ([#6253](`jestjs/jest#6253)) * `[expect]` Better detection of DOM Nodes for equality ([#6246](`jestjs/jest#6246)) * `[jest-cli]` Fix misleading action description for F key when in "only failed tests" mode. ([#6167](`jestjs/jest#6167)) * `[jest-worker]` Stick calls to workers before processing them ([#6073](`jestjs/jest#6073)) * `[babel-plugin-jest-hoist]` Allow using `console` global variable ([#6075](`jestjs/jest#6075)) * `[jest-jasmine2]` Always remove node core message from assert stack traces ([#6055](`jestjs/jest#6055)) * `[expect]` Add stack trace when `expect.assertions` and `expect.hasAssertions` causes test failures. ([#5997](`jestjs/jest#5997)) * `[jest-runtime]` Throw a more useful error when trying to require modules after the test environment is torn down ([#5888](`jestjs/jest#5888)) * `[jest-mock]` [**BREAKING**] Replace timestamps with `invocationCallOrder` ([#5867](`jestjs/jest#5867)) * `[jest-jasmine2]` Install `sourcemap-support` into normal runtime to catch runtime errors ([#5945](`jestjs/jest#5945)) * `[jest-jasmine2]` Added assertion error handling inside `afterAll hook` ([#5884](`jestjs/jest#5884)) * `[jest-cli]` Remove the notifier actions in case of failure when not in watch mode. ([#5861](`jestjs/jest#5861)) * `[jest-mock]` Extend .toHaveBeenCalled return message with outcome ([#5951](`jestjs/jest#5951)) * `[jest-runner]` Assign `process.env.JEST_WORKER_ID="1"` when in runInBand mode ([#5860](`jestjs/jest#5860)) * `[jest-cli]` Add descriptive error message when trying to use `globalSetup`/`globalTeardown` file that doesn't export a function. ([#5835](`jestjs/jest#5835)) * `[expect]` Do not rely on `instanceof RegExp`, since it will not work for RegExps created inside of a different VM ([#5729](`jestjs/jest#5729)) * `[jest-resolve]` Update node module resolution algorithm to correctly handle symlinked paths ([#5085](`jestjs/jest#5085)) * `[jest-editor-support]` Update `Settings` to use spawn in shell option ([#5658](`jestjs/jest#5658)) * `[jest-cli]` Improve the error message when 2 projects resolve to the same config ([#5674](`jestjs/jest#5674)) * `[jest-runtime]` remove retainLines from coverage instrumentation ([#5692](`jestjs/jest#5692)) * `[jest-cli]` Fix update snapshot issue when using watchAll ([#5696](`jestjs/jest#5696)) * `[expect]` Fix rejects.not matcher ([#5670](`jestjs/jest#5670)) * `[jest-runtime]` Prevent Babel warnings on large files ([#5702](`jestjs/jest#5702)) * `[jest-mock]` Prevent `mockRejectedValue` from causing unhandled rejection ([#5720](`jestjs/jest#5720)) * `[pretty-format]` Handle React fragments better ([#5816](`jestjs/jest#5816)) * `[pretty-format]` Handle formatting of `React.forwardRef` and `Context` components ([#6093](`jestjs/jest#6093)) * `[jest-cli]` Switch collectCoverageFrom back to a string ([#5914](`jestjs/jest#5914)) * `[jest-regex-util]` Fix handling regex symbols in tests path on Windows ([#5941](`jestjs/jest#5941)) * `[jest-util]` Fix handling of NaN/Infinity in mock timer delay ([#5966](`jestjs/jest#5966)) * `[jest-resolve]` Generalise test for package main entries equivalent to ".". ([#5968](`jestjs/jest#5968)) * `[jest-config]` Ensure that custom resolvers are used when resolving the configuration ([#5976](`jestjs/jest#5976)) * `[website]` Fix website docs ([#5853](`jestjs/jest#5853)) * `[expect]` Fix isEqual Set and Map to compare object values and keys regardless of order ([#6150](`jestjs/jest#6150)) * `[pretty-format]` [**BREAKING**] Remove undefined props from React elements ([#6162](`jestjs/jest#6162)) * `[jest-haste-map]` Properly resolve mocked node modules without package.json defined ([#6232](`jestjs/jest#6232)) ##### Chore & Maintenance * `[jest-runner]` Move sourcemap installation from `jest-jasmine2` to `jest-runner` ([#6176](`jestjs/jest#6176)) * `[jest-cli]` Use yargs's built-in `version` instead of rolling our own ([#6215](`jestjs/jest#6215)) * `[docs]` Add explanation on how to mock methods not implemented in JSDOM * `[jest-jasmine2]` Simplify `Env.execute` and TreeProcessor to setup and clean resources for the top suite the same way as for all of the children suites ([#5885](`jestjs/jest#5885)) * `[babel-jest]` [**BREAKING**] Always return object from transformer ([#5991](`jestjs/jest#5991)) * `[*]` Run Prettier on compiled output ([#5858](`jestjs/jest#3497)) * `[jest-cli]` Add fileChange hook for plugins ([#5708](`jestjs/jest#5708)) * `[docs]` Add docs on using `jest.mock(...)` ([#5648](`jestjs/jest#5648)) * `[docs]` Mention Jest Puppeteer Preset ([#5722](`jestjs/jest#5722)) * `[docs]` Add jest-community section to website ([#5675](`jestjs/jest#5675)) * `[docs]` Add versioned docs for v22.4 ([#5733](`jestjs/jest#5733)) * `[docs]` Improve Snapshot Testing Guide ([#5812](`jestjs/jest#5812)) * `[jest-runtime]` [**BREAKING**] Remove `jest.genMockFn` and `jest.genMockFunction` ([#6173](`jestjs/jest#6173)) * `[jest-message-util]` Avoid adding unnecessary indent to blank lines in stack traces ([#6211](`jestjs/jest#6211)) --- ### [`v22.4.4`](jestjs/jest@6851d8b...v22.4.4) [Compare Source](jestjs/jest@6851d8b...v22.4.4) --- </details> --- This PR has been generated by [Renovate Bot](https://renovatebot.com).

github-actions · 2021-05-12T05:13:56Z

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.

Improve description line when assertion fails: part 2

9c95516

facebook-github-bot added the CLA Signed ✔️ label Feb 10, 2018

pedrottimark added 2 commits February 9, 2018 20:14

Update changelog and one more snapshot plus fix Windows test

55d9673

Update snapshot in failures integration test

cdd7979

thymikee reviewed Feb 10, 2018

View reviewed changes

Merge branch 'master' into improve-description-2

01482f3

cpojer merged commit 196d9b8 into jestjs:master Feb 23, 2018

dependencies bot mentioned this pull request Jun 1, 2018

Update babel-jest in / from 22.1.0 to 23.0.1 leonardofaria/leozera-ui#192

Closed

pedrottimark mentioned this pull request Oct 12, 2018

expect: Improve report when assertion fails, part 3 #7152

Merged

dependencies bot mentioned this pull request Nov 1, 2018

Update jest in / from 22.1.4 to 23.6.0 leonardofaria/leozera-ui#250

Closed

pedrottimark deleted the improve-description-2 branch December 22, 2018 02:27

pedrottimark mentioned this pull request Feb 13, 2019

expect: Improve report when matcher fails, part 8 #7876

Merged

snyk-bot mentioned this pull request Mar 17, 2020

[Snyk] Upgrade expect from 23.0.0 to 23.6.0 yowainwright/react-workshop#8

Merged

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

Improve description line when assertion fails: part 2 #5512

Improve description line when assertion fails: part 2 #5512

pedrottimark commented Feb 10, 2018 •

edited

codecov-io commented Feb 10, 2018

thymikee commented Feb 10, 2018

thymikee Feb 10, 2018

pedrottimark Feb 11, 2018

thymikee Feb 11, 2018

thymikee Feb 10, 2018

pedrottimark Feb 11, 2018

thymikee Feb 11, 2018

thymikee Feb 10, 2018

pedrottimark Feb 11, 2018

cpojer commented Feb 10, 2018

pedrottimark commented Feb 11, 2018 •

edited

thymikee commented Feb 11, 2018

cpojer commented Feb 23, 2018

github-actions bot commented May 12, 2021

Improve description line when assertion fails: part 2 #5512

Improve description line when assertion fails: part 2 #5512

Conversation

pedrottimark commented Feb 10, 2018 • edited

Test plan

codecov-io commented Feb 10, 2018

Codecov Report

thymikee commented Feb 10, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

cpojer commented Feb 10, 2018

pedrottimark commented Feb 11, 2018 • edited

thymikee commented Feb 11, 2018

cpojer commented Feb 23, 2018

github-actions bot commented May 12, 2021

pedrottimark commented Feb 10, 2018 •

edited

pedrottimark commented Feb 11, 2018 •

edited