Prettier is used by toMatchInlineSnapshot, but it is not a dependency of jest

[suchipi]

🐛 Bug Report

Prettier is used by jest for toMatchInlineSnapshot, but since it's not a dependency of jest, toMatchInlineSnapshot only works if some other package depends on prettier (or it's in the user's package.json).

To Reproduce

Steps to reproduce the behavior:

• Make a new directory and run yarn init --yes inside it
• Run yarn add jest
• Create a test using the toMatchInlineSnapshot matcher, eg:

  expect(2 + 2).toMatchInlineSnapshot()
  

• Notice that the test fails with an error indicating that prettier cannot be found.

Expected behavior

Test passes with no issues

npx envinfo --preset jest

  System:
    OS: macOS 10.14.4
    CPU: x64 Intel(R) Core(TM) i7-4770HQ CPU @ 2.20GHz
  Binaries:
    Node: 12.1.0 - /usr/local/bin/node
    Yarn: 1.13.0 - /usr/local/bin/yarn
    npm: 6.9.0 - /usr/local/bin/npm
  npmPackages:
    jest: 24.8.0 => 24.8.0

[SimenB]

This is expected. @azz might remember the particulars

[SimenB]

Would you expect jest to bundle some version and defer to a local one? Related #7792

[suchipi]

Hmm. Not sure; thanks for the context.

Maybe it should be listed as a peerdep? A descriptive error message saying "you need to install prettier" might be good enough, too. It's unexpected to get a "could not find prettier" error the first time you use .toMatchInlineSnapshot.

Not sure if this makes sense for jest, but prettier could be replaced with babel + recast here, and it could use prettier for printing (instead of recast) as an optimization, when it's available.

[SimenB]

There's a bunch of discussion in the original PR #6380, especially #6380 (comment).

The main thing we wanna avoid is to completely butcher the styling of the test file creating churn. Using prettier assures we're consistent with the current styling, which is nice. Not sure how well using recast would work? It might work great without butchering existent styling at all for all I know 🙂

[suchipi]

Yup, that's what it's designed for 👍 recast keeps track of which AST nodes have been changed and only prints those ones using original styling. It uses the original source for all the other nodes. You can defer its parsing to another parser, so babel could be used to ensure all the necessary syntax and etc is supported.

[SimenB]

Oh, nice!

A descriptive error message saying "you need to install prettier" might be good enough, too

yeah, we should definitely to that as a first step regardless. #7744

[kevinbarabash]

I just ran into this as well.

[selfrefactor]

Still no progress?

[UziTech]

Maybe the error message should at least state that prettier must be installed to use toMatchInlineSnapshot. I just spent way too long wondering what was throwing the error. I definitely did not think jest was using a package without requiring it as a dependency. That seems like an obvious code smell.

[UziTech]

looks like it is supposed to throw a descriptive error message:

https://github.com/facebook/jest/blob/fa4cbbf87cb3c97fe44f1fee30663715a9dbba71/packages/jest-snapshot/src/inline_snapshots.ts#L33-L35

The error message that I get with [email protected] is:

Cannot find module 'prettier' from 'setup_jest_globals.js'

[jhunterkohler]

I am still getting this error:

    Cannot find module 'prettier' from 'node_modules/jest-jasmine2/build/setup_jest_globals.js'

      at Resolver.resolveModule (node_modules/jest-resolve/build/index.js:306:11)

Not sure why it has stopped working, because I did not uninstall prettier, yet this no longer works. Maybe a sub-dependency did, not-sure.

Edit: Crossed out test, error has been resolved in Jest v27 (#11400)

[UziTech]

@HunterKohler This should be fixed in Jest v27 (#11400) What version are you using?

[jhunterkohler]

@UziTech My bad! It is fixed, just had to update dependencies. Thank you.

[ali-target]

This issue hasn't been fixed, I still get an error.

"jest-cli": "^27.0.3",
"prettier": "^1.19.1",
"jest": "^27.0.3",

[SimenB]

I think this is fine now that prettier is optional, as mentioned a few times above. If people are still having issues please create a new issue.

[github-actions]

This issue 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.