Use rollup to generate bundles for UMD, ESM and CJS #63
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
bmullan91
previously approved these changes
Feb 27, 2019
There was a problem hiding this comment.
@Joezo / @jackdclark LGTM - One question about async/await.
Joezo
force-pushed
the
rollup
branch
2 times, most recently
from
62cb4d3 to
c7f7cfa
Compare
bmullan91
suggested changes
Feb 27, 2019
| "contributors:generate": "all-contributors generate" | ||
| "contributors:generate": "all-contributors generate", | ||
| "build": "rollup -c", | ||
| "prepublishOnly": "npm run build" |
There was a problem hiding this comment.
We need to run npm run build in prepack also.
There was a problem hiding this comment.
If we add it in prepack I believe it will run twice when we run npm publish. Are we using npm pack?
There was a problem hiding this comment.
I think npm pack might be an edge case and if people want to use it they could do npm run build first?
Co-authored-by: Jack Clark <jack.clark@nearform.com>
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.
Co-authored-by: Jack Clark
What does this PR do?
Generates bundles for UMD, ESM and CommonJS. This brings with it support for browsers >= IE11.
Whilst working on this we published a few version to
npmwith thetesttag so that it could be tested. This codepen has been created which uses theUMDbuild. We spun up a quick Create react app to test outESMwhich worked great. The nextjs example app has also been updated locally to use the commonjs version.Our rollup config was heavily influenced by the one in redux.
Bundle size has slightly increased but we now have increased browser support and our module is now tree shakeable, meaning potentially reduced size for end users.
Important
We now use Promises to write this library as transpiling from async/await is usually avoided in libraries as it's expensive. We opted instead to use untranspiled Promises and then inform the user they should provide an environment that includes Promises.
Related issues
Resolves #11
Checklist