Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add @types/testing-library__jest-dom as explicit dependency #185

Closed
leosuncin opened this issue Jan 17, 2020 · 7 comments · Fixed by #189
Closed

Add @types/testing-library__jest-dom as explicit dependency #185

leosuncin opened this issue Jan 17, 2020 · 7 comments · Fixed by #189
Labels

Comments

@leosuncin
Copy link

Describe the feature you'd like:

In the new release v5.0.0 said that the typings are now in @types/testing-library__jest-dom package, so, for a Typescript project to work is needed to install both as follows:

npm i -D testing-library/jest-dom @types/testing-library__jest-dom

@testing-library/cypress has also its typings in separate package but is not necessary to explicit install the types because is a dependency of same package.

Suggested implementation:

Add @types/testing-library__jest-dom as dependency in package.json so no need to worry about if you use Typescript.

Describe alternatives you've considered:

The other alternative is to update the documentation to describe the need to install @types/testing-library__jest-dom for Typescript projects.

Teachability, Documentation, Adoption, Migration Strategy:

I can do a pull request. Then it will be necessary a new release with a patch, maybe v5.0.1

@jgoz
Copy link
Collaborator

jgoz commented Jan 17, 2020

This is the plan, but it requires DefinitelyTyped/DefinitelyTyped#37792 to be merged. We had a chicken-and-egg scenario that unfortunately means 5.0.0 will not include typings but 5.0.1 will.

I would have added this to the release notes, but I don't know how to do that (haven't used semantic-release before). Sorry for the inconvenience — hopefully things will happen quickly.

@gnapse
Copy link
Member

gnapse commented Jan 17, 2020

I would have added this to the release notes, but I don't know how to do that (haven't used semantic-release before).

For the future: when you merged the PR that triggered the v5.0.0 release, you had the chance to edit the commit message. Whatever you include in the message (not just the first line but additional lines too) is included in the release notes.

We can also edit them after the fact here: https://github.com/testing-library/jest-dom/releases/edit/v5.0.0

(not sure if you have access, in which case let me know what to put there)

Update: I added something my self to the release notes, let me know if it's ok or needs some improvement: https://github.com/testing-library/jest-dom/releases/tag/v5.0.0

@jgoz
Copy link
Collaborator

jgoz commented Jan 17, 2020

Thanks @gnapse - looks great.

@gnapse
Copy link
Member

gnapse commented Jan 22, 2020

🎉 This issue has been resolved in version 5.0.1 🎉

The release is available on:

Your semantic-release bot 📦🚀

@coler-j
Copy link

coler-j commented Apr 27, 2021

Does this mean we do not need to explicitly install @types/testing-library__jest-dom for v greater than 5.0.1?

@gnapse
Copy link
Member

gnapse commented Apr 28, 2021

I think so. Have you tried that? Is it working or not for you?

@coler-j
Copy link

coler-j commented Apr 28, 2021

@gnapse I think it does work, yes.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants