testing-library-docs
testing-library-docs copied to clipboard
testing-library
Revert "Add peer dependency to User Event docs"
Reverts #888
user-event's recommendation for installing dom appears to be outdated, as package managers (except npm 3-6 and Yarn) automatically install dependencies anyway.
Deploy Preview for testing-library ready!
| Name | Link |
|---|---|
| Latest commit | dc939364a68eda58e6c5c166ca46afa9faca6c67 |
| Latest deploy log | https://app.netlify.com/sites/testing-library/deploys/654d85be1f9bb10008b69995 |
| Deploy Preview | https://deploy-preview-1329--testing-library.netlify.app |
| Preview on mobile | Toggle QR Code...Use your smartphone camera to open QR code link. |
To edit notification comments on pull requests, go to your Netlify site configuration.
![netlify[bot] avatar](https://avatars.githubusercontent.com/in/13473?v=4 "Published by a pub.dev verified publisher"){kind=small}
AFAIU from the code, @testing-library/dom is still a peer dependency, doesn't that mean we still need that? I understand that if a user installs @testing-library/react for example they'll have it installed but if a user only installs user-event, this might still be needed don't you think?
Not likely since npm 7 installs peer dependencies automatically (again).
Context: I just checked blame and this was apparently my fault. 😅 At the time npm 7 was new so I couldn't depend on peer dependencies being installed automatically. Now npm 7 has been included with Node for 3 years and support for older releases ended 6 months ago, so I'm not as concerned about compatibility. If a user has a package manager that doesn't install peer dependencies (including npm 3-6 and Yarn), it will still warn by default.
Since people don't really care about the warnings from the npm i script, maybe we can add a note about that for old users?
A note about what? Can you give an example?
That explicitly installing @testing-library/dom is still needed if you're using npm < 7. Since user-event doesn't have an engines definition and @testing-library/react for example still support node 14 which originally was bundled with npm 6.
That's just an idea, you can ignore it if you don't think it's needed :)
Our engines are out of date because Node 16 support was recently dropped, but I'll make sure this is fixed soon and users should have already upgraded Node for security reasons anyway.
I'd really prefer to keep the original revert of my change (the first commit in this pull ignoring formatting changes) as it's now outdated advice and it's not even consistent with User Event's readme. If you have any strong opinions against this please say so, preferably with explicit examples of potentially problematic use cases.
Our
enginesare out of date because Node 16 support was recently dropped, but I'll make sure this is fixed soon and users should have already upgraded Node for security reasons anyway.I'd really prefer to keep the original revert of my change (the first commit in this pull ignoring formatting changes) as it's now outdated advice and it's not even consistent with User Event's readme. If you have any strong opinions against this please say so, preferably with explicit examples of potentially problematic use cases.
We'll probably update those once the major version for DTL will merged. I understand, I'm good with that :)