fix: Add `@types/react-dom` as a direct dependency #1001

fmeum · 2021-12-03T09:00:13Z

@types/react-dom is used in types/index.d.ts, which is an external interface, and thus needs to be declared as a regular rather than a dev dependency so that it is picked up by users of @testing-library/react.

What:

This fixes #1000.

Why:

@types/react-dom is used in types/index.d.ts, which is an external interface, and thus needs to be declared as a regular rather than a dev dependency so that it is picked up by users of @testing-library/react.

How:

Declare @types/react-dom as a regular rather than a dev dependency.

Checklist:

Documentation added to the
docs site N/A
Tests N/A
TypeScript definitions updated N/A
Ready to be merged

`@types/react-dom` is used in `types/index.d.ts`, which is an external interface, and thus needs to be declared as a regular rather than a dev dependency so that it is picked up by users of `@testing-library/react`.

codesandbox-ci · 2021-12-03T09:01:30Z

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

Latest deployment of this branch, based on commit 23e641f:

Sandbox	Source
React	Configuration
react-testing-library-examples	Configuration

MatanBobi · 2021-12-05T10:15:12Z

Hi @fmeum! Thanks for taking the time to work on this one.
I'm not sure how and if we should tackle this one.
The reason is that we don't want to add 3rd party types into our bundle since not all of our users are using TypeScript.
The second reason is that having versioned types isn't good for us because we support multiple React versions (same as we have peer deps defined as react: * and react-dom: *)
I think that once people do have React and React-DOM and are using TypeScript, they will also have the types installed.
I'm not too familiar with the build system that you're using, but do you have @types/react-dom installed and it still gives you the error?

fmeum · 2021-12-05T10:31:23Z

I'm not very familiar with the resolution mechanism for dependencies, but yarn (see e.g. yarnpkg/yarn#3951) seems to recommend a peer dependency on * or a suitable version range for @types. Would that help address your second point? I could adapt the PR to use that.

Regarding the build system: Yes, @types/react-dom is installed, but the build system ensures that only packages that declare a (non-dev) dependeny on it in their package.json get to see it. I don't want to break or complicate the build with the popular build systems though, so if there is no good solution to this, I will use a manual workaround.

package.json

codecov · 2021-12-06T11:37:21Z

Codecov Report

Merging #1001 (5a88092) into main (8f17a2b) will not change coverage.
The diff coverage is n/a.

❗ Current head 5a88092 differs from pull request most recent head 33e2803. Consider uploading reports for the commit 33e2803 to get more accurate results

@@            Coverage Diff            @@
##              main     #1001   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            4         4           
  Lines          140       142    +2     
  Branches        26        28    +2     
=========================================
+ Hits           140       142    +2

Impacted Files	Coverage Δ
src/pure.js	`100.00% <0.00%> (ø)`
src/act-compat.js	`100.00% <0.00%> (ø)`

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 8f17a2b...33e2803. Read the comment docs.

Co-authored-by: Sebastian Silbermann <silbermann.sebastian@gmail.com>

fmeum · 2021-12-06T13:42:16Z

@eps1lon Accepted your suggestion, thanks.

fmeum · 2022-02-12T20:09:13Z

@eps1lon Friendly ping

eps1lon · 2022-02-15T21:25:15Z

@eps1lon Friendly ping

Could you give permissions to maintainers to edit this PR (should be on th right side next to labels, etc)? Otherwise I can't force GH actions to run on this PR.

fmeum · 2022-02-15T21:26:27Z

@eps1lon Friendly ping

Could you give permissions to maintainers to edit this PR (should be on th right side next to labels, etc)? Otherwise I can't force GH actions to run on this PR.

I had it enabled. Just disabled and reenabled it to make sure it works.

eps1lon · 2022-02-15T22:43:45Z

@eps1lon Friendly ping

Could you give permissions to maintainers to edit this PR (should be on th right side next to labels, etc)? Otherwise I can't force GH actions to run on this PR.

I had it enabled. Just disabled and reenabled it to make sure it works.

Mkay. I guess it's GitHub codespaces being useless and not allowing me to push.

eps1lon · 2022-02-15T22:50:54Z

@all-contributors add @fmeum for code, bug

allcontributors · 2022-02-15T22:51:02Z

@eps1lon

I've put up a pull request to add @fmeum! 🎉

github-actions · 2022-02-15T22:56:12Z

🎉 This PR is included in version 12.1.3 🎉

The release is available on:

Your semantic-release bot 📦🚀

github-actions · 2022-03-30T15:11:11Z

🎉 This PR is included in version 13.0.0-alpha.7 🎉

The release is available on:

Your semantic-release bot 📦🚀

Make @types/react-dom a regular dependency

5a88092

`@types/react-dom` is used in `types/index.d.ts`, which is an external interface, and thus needs to be declared as a regular rather than a dev dependency so that it is picked up by users of `@testing-library/react`.

eps1lon reviewed Dec 6, 2021

View reviewed changes

package.json Outdated Show resolved Hide resolved

eps1lon changed the title ~~Make @types/react-dom a regular dependency~~ fix: Add @types/react-dom as a direct dependency Dec 6, 2021

eps1lon added the bug Something isn't working label Dec 6, 2021

Update package.json

23e641f

Co-authored-by: Sebastian Silbermann <silbermann.sebastian@gmail.com>

Poke gh actions

33e2803

eps1lon merged commit 149d9a9 into testing-library:main Feb 15, 2022

allcontributors bot mentioned this pull request Feb 15, 2022

docs: add fmeum as a contributor for code, bug #1016

Merged

github-actions bot added the released label Feb 15, 2022

github-actions bot added the released on @alpha label Mar 30, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: Add `@types/react-dom` as a direct dependency #1001

fix: Add `@types/react-dom` as a direct dependency #1001

fmeum commented Dec 3, 2021

codesandbox-ci bot commented Dec 3, 2021 •

edited

MatanBobi commented Dec 5, 2021 •

edited

fmeum commented Dec 5, 2021 •

edited

codecov bot commented Dec 6, 2021 •

edited

fmeum commented Dec 6, 2021

fmeum commented Feb 12, 2022

eps1lon commented Feb 15, 2022

fmeum commented Feb 15, 2022

eps1lon commented Feb 15, 2022

eps1lon commented Feb 15, 2022

allcontributors bot commented Feb 15, 2022

github-actions bot commented Feb 15, 2022

github-actions bot commented Mar 30, 2022

fix: Add @types/react-dom as a direct dependency #1001

fix: Add @types/react-dom as a direct dependency #1001

Conversation

fmeum commented Dec 3, 2021

codesandbox-ci bot commented Dec 3, 2021 • edited

MatanBobi commented Dec 5, 2021 • edited

fmeum commented Dec 5, 2021 • edited

codecov bot commented Dec 6, 2021 • edited

Codecov Report

fmeum commented Dec 6, 2021

fmeum commented Feb 12, 2022

eps1lon commented Feb 15, 2022

fmeum commented Feb 15, 2022

eps1lon commented Feb 15, 2022

eps1lon commented Feb 15, 2022

allcontributors bot commented Feb 15, 2022

github-actions bot commented Feb 15, 2022

github-actions bot commented Mar 30, 2022

fix: Add `@types/react-dom` as a direct dependency #1001

fix: Add `@types/react-dom` as a direct dependency #1001

codesandbox-ci bot commented Dec 3, 2021 •

edited

MatanBobi commented Dec 5, 2021 •

edited

fmeum commented Dec 5, 2021 •

edited

codecov bot commented Dec 6, 2021 •

edited