Add react-dom to peerDependencies since requested by @mui/material, to resolve yarn warning #120
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Right now, if you use yarn 2+ to install the latest version of `material-ui-popup-state`, you get this warning: ``` ➤ YN0002: │ material-ui-popup-state@npm:5.0.8 [d9650] doesn't provide react-dom (p254f3), requested by @mui/material ``` for which the explanation is: ``` ❯ yarn explain peer-requirements p254f3 ➤ YN0000: material-ui-popup-state@npm:5.0.8 [d9650] doesn't provide react-dom, breaking the following requirements: ➤ YN0000: @mui/base@npm:5.0.0-alpha.128 [ce1f8] → ^17.0.0 || ^18.0.0 ✘ ➤ YN0000: @mui/material@npm:5.12.3 [5acc5] → ^17.0.0 || ^18.0.0 ✘ ➤ YN0000: react-transition-group@npm:4.4.5 [ce1f8] → >=16.6.0 ✘ ➤ YN0000: Note: these requirements start with @mui/material@npm:5.12.3 ``` In other words, since `@mui/material` requests `react-dom` as a peer dependency, `material-ui-popup-state` needs to either list it as a dependency or a peer dependency. Since `react-dom` is not being used directly within the source for this project, it's added as a peer dependency here to resolve the issue. (For additional context, see https://yarnpkg.com/advanced/error-codes#yn0002---missing_peer_dependency and the linked blog post https://dev.to/arcanis/implicit-transitive-peer-dependencies-ed0, and note the `peerDependencies` definition used for `@mui/material`: https://github.com/mui/material-ui/blob/9710ff34b16a0f271107a8619a28546ae3ca7c18/packages/mui-material/package.json#L48-L49).
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Right now, if you use yarn 2+ to install the latest version of
material-ui-popup-state, you get this warning:for which the explanation is:
In other words, since
@mui/materialrequestsreact-domas a peer dependency,material-ui-popup-stateneeds to either list it as a dependency or a peer dependency. Sincereact-domis not being used directly within the source for this project, it's added as a peer dependency here to resolve the issue. (Note that the above warning shows up even though the project wherematerial-ui-popup-stateis being installed listsreact-domitself. See below for more info.)Additional context
See
https://yarnpkg.com/advanced/error-codes#yn0002---missing_peer_dependency and the linked blog post, and note the
peerDependenciesdefinition used for@mui/materialhere.