Declare lowlight as a peerDependency in @tiptap/extension-code-block-lowlight
#2625
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
❌ Deploy Preview for tiptap-embed failed.
|
enriquecastl
force-pushed
the
declare-lowlight-as-a-peer-dependency
branch
2 times, most recently
from
50beee6
to
fe83b6b
Compare
|
Thanks @enriquecastl! Do you think we should include this change in some kind of documentation for the extension or should we just keep it with the console.warning you implemented? |
enriquecastl
force-pushed
the
declare-lowlight-as-a-peer-dependency
branch
2 times, most recently
from
e0904cd
to
f59bfb6
Compare
Declare lowlight as a peerDependency to delegate the control of which version of lowlight is used to the client application
enriquecastl
force-pushed
the
declare-lowlight-as-a-peer-dependency
branch
from
f59bfb6
to
f0c85b9
Compare
Hi @bdbch! Thanks for the great suggestion. There’s value in documenting how this dependency depends and interact with lowlight. I’ve pushed a documentation update. What do you think? |
|
Great @enriquecastl thanks a lot! 👍 |
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.
This PR declares the
lowlightpackage as a peerDependency and removes the direct import statement in the@tiptap/extension-code-block-lowlightpackage.Why is this change necessary?
The client application can’t control which version of
lowlightis bundled into the final product even when the client application provides its own lowlight instance. A consequence of this situation is that using a newer major version of lowlight ends up forcing the client application to bundle two versions of lowlight/highlight.js/fault in the final distribution build. That‘s a lot of dead JavaScript code.The main purpose of this change is reducing the bundle size of this extension by removing the duplication of lowlight versions in the codebase.