fix: mark vtk.js as peer dependency #28
Merged
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
Collaborator
|
@floryst what do you think? |
Contributor
|
I think this makes sense. Chances are, if you are using react-vtk-js you will also have vtk.js as well. |
Collaborator
|
For me when I use |
Collaborator
|
🎉 This PR is included in version 1.6.1 🎉 The release is available on: Your semantic-release bot 📦🚀 |
Contributor
Author
It's not recommended to import from libraries that are not directly listed in your package.json, you lose the ability to lock its version and if for whatever reason the library that makes the transitive dependency available switches to a different one your app breaks. |
Closed
floryst
added a commit
to floryst/react-vtk-js
that referenced
this pull request
Aug 12, 2021
In reference to Kitware#28, we should not bundle `@kitware/vtk.js`. Additionally, this directly impacts `vtkMapper`, as setting global/static coincident topology parameters is done at a module level, and bundling vtk.js with react-vtk-js means it's impossible to set global parameters for react-vtk-js. This will mean all consumers must install `@kitware/vtk.js` alongside react-vtk-js. Should this be a breaking change, or are we okay having people realize this once npm/yarn complains about missing peer deps?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Having vtk.js as a dependency makes it extremely difficult to avoid double versions of the same library if vtk.js is also listed as dependency of the project itself.
Just like it happens with React, I think vtk.js should be a peerDependency so that the consumers can better control it.
Keep it mind 99% of the users using this library are likely going to also import from vtk.js directly to access utility modules and such, so they will need to add a vtk.js version to their package.json too.