Use overrides to fix reflux peerDependency resolution
#4704
Conversation
This file contains 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
"overrides": {
"reflux": { "react": "$react"}
},
This tells npm that Reflux should use our project-level version of React
to resolve its dependency on "react". This override applies even though
our project-level React (16) falls outside of the semver range that
Reflux wants (^15.0.2).
Alternatively, this would work:
"overrides": {
"react": "$react"
},
However, the next time we upgrade React, I'd like to see warnings from
other libraries (if applicable) so we can be sure to upgrade them.
We override this for Reflux because it's not likely to receive updates,
yet it tends to continue to work with newer versions of React without
any problem.
References:
overrides on npm
https://docs.npmjs.com/cli/v10/configuring-npm/package-json#overrides
Helpful comment on the Node breakage thread
npm/cli#4998 (comment)
The error you'd see when using npm >= 8.6.0 looked like:
npm ERR! code ERESOLVE
npm ERR! ERESOLVE could not resolve
npm ERR!
npm ERR! While resolving: [email protected]
npm ERR! Found: [email protected]
9 tasks
LMNTL
approved these changes
Nov 2, 2023
There was a problem hiding this comment.
This works well after some testing - none of the functionality that depends on Reflux appears to be affected. Looking through GitHub, it appears that others have successfully run Reflux in production doing versions of what you're doing - see reflux-react-16. Thank you!
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.
Description
Make reflux use the project-level version of React to resolve its peerDependency.
With this change,
--legacy-peer-depswill no longer be needed when installing with npm >= 8.6.0.Related issues
Part of #4703
Notes
Reflux specifies
"react": "^15.0.2"as apeerDependency. We use a newer major version of React. Starting with [email protected], this would start to breaknpm install. More information: npm/cli: npm ci validates package-lock.json and could fail to resolveThe error you'd see when using npm >= 8.6.0 looked like:
Using
overridesin package.json (added to npm in npm 8.3.0)tells npm that Reflux should use our project-level version of React to resolve its dependency on "react" — even though our project-level React (16) falls outside of the semver range that Reflux wants (^15.0.2).