[@storybook/test] Move `@testing-library/dom` to a peerDependency about storybook HOT 6 OPEN

@MatanBobi Our setup is a bit complicated.

We prebundle testing-library with tsup:

But because tsup somehow messes the types up during prebundling, we have @testing-library/dom, @testing-library/jest-dom and @testing-library/user-event as a direct dependency, just for the types. But for the runtime of those packages we prebundle them.

We are considering 2 different scenario's.

1. We stop prebundling @testing-library/dom, @testing-library/jest-dom and @testing-library/user-event, and make it a peer dependency as you suggested.

In this case, should all of them be a peer dep?

2. We continue prebundling and try to find a workaround for the tsup issues, so that it will be an actual devDependency instead.

Will this also solve your issue?

from storybook.

AFAIR, @testing-library/jest-dom doesn't rely on @testing-library/dom at all so you can keep that there.
Regarding @testing-library/user-event, I think it can also remain there as it already has a peer dependency on @testing-library/dom and AFAIK it doesn't have any specific state that might conflict. So we can ask users to only install @testing-library/dom as a peer dependency :)

from storybook.

Thanks for the reply @MatanBobi

And if we completely pre-bundle all of them (so make them devDependencies instead), would that also solve your issue?

from storybook.

Hmmm, it's a good question. I'm not that much into the details of how the module resolution will work in that case. The problem we had was that inside RTL people who were using user-event sometimes received the DTL bundled with RTL and sometimes the one they've installed for user-event. Since I didn't experience this issue on my own but opened it due to a user commenting they're experiencing this issue I might not be the right person to say if it will work or not.
Here's the comment that raised the issue:
testing-library/react-testing-library#1216 (comment)

from storybook.

Okay, thanks for the context!

I think that issue is similar as this issue:
#27173

I just merged a PR, that at least uses the latest version of DTL, which I think will mitigate this issue a bit.

I do agree that we either should go for peerDeps or devDeps to fully resolve the issue.
I think that devDeps (prebundling) probably would be even more ideal, as it comes to this issue specifically.
Will keep you updated.

from storybook.

I think that issue is similar as this issue: #27173

Yes that definitely looks similar.
Thanks @kasperpeulen for the quick replies and attention :)

from storybook.