Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork866
fix: Reorganize code for maximum tree-shakability#1125
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Open
steveluscher wants to merge1 commit intoimmerjs:mainChoose a base branch fromsteveluscher:tree-shakable-af
base:main
Could not load branches
Branch not found:{{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline, and old review comments may become outdated.
+312 −147
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
c07b0a2 toc33d4b4CompareSign up for freeto 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.
Problem
Because every method is bound up in a
Class, instantiated in the module factory, then exported, consumers will getevery method of Immer in their bundle, whether they use it or not.A slight reorganization of the code would allow their optimizing compilers to tree-shake away the method implementations that they don't need.
Summary
This PR reorganizes the code such that requiringone method of Immer doesn't force you to take a hard dependency onall the others. You can now do this:
…and have all of the other methods that you haven't used (
produceWithPatches,setAutoFreeze,setUseStrictShallowCopy,applyPatches,createDraft,finishDraft) be reaped by your optimizing compiler.Results
Consider this typical application that only uses
produce():When bundled with an optimizing compiler:
pnpm dlx esbuild --bundle --define:process.env.NODE_ENV='"production"' --tree-shaking index.tsThis PR (in combination with#1124) results in a bundle that's13% smaller, gzipped (diff)
Test plan