fix: Disable updating peer dependencies when updatePeerDependencies is false. #2270
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
kinyoklion
commented
Apr 16, 2024
| \t\t"foo": "~0.1.0" | ||
| \t}, | ||
| \t"peerDependencies": { | ||
| \t\t"bar": ">= 1.0.0" |
There was a problem hiding this comment.
Test that validates the peer dependency is not updated.
kinyoklion
commented
Apr 16, 2024
| const packageJson = new PackageJson({ | ||
| version: Version.parse('14.0.0'), | ||
| versionsMap, | ||
| updatePeerDependencies: true, |
There was a problem hiding this comment.
This test implicitly dependended on the updater always updating the peer dependencies. So it was updated and produces the same output.
kinyoklion
commented
Apr 16, 2024
| snapshot(newContent.replace(/\r\n/g, '\n')); | ||
| }); | ||
|
|
||
| it('does not update peer dependencies by default', async () => { |
There was a problem hiding this comment.
New test which does not update peer dependencies.
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.
The "updatePeerDependencies" option currently operates as a "considerPeerDependencies" option. What this means is that if a package only has a peer dependency on another, then that will not be considered and no update will be made (as if there was no dependency). If a package has a peer dependency as well as another dependency, for instance a dev dependency, then the peer dependency is updated regardless.
This propagates the "updatePeerDependencies" option to the PackageJson updater so that it can omit updates to the peer dependencies.
It isn't completely clear what the intended behavior here is. This update behavior matches my current use-case, but it is possible it could be a problem for others. In which case there could be two different options (but the current name does seem like it would impact peer dependency updates.)
Thank you for opening a Pull Request! Before submitting your PR, there are a few things you can do to make sure it goes smoothly:
Fixes #2269
🦕