Add sideEffects
field to package.json
#10714
Merged
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.
As mentioned in #9212 (comment), the
sideEffects
field inpackage.json
is necessary to enable tree shaking in conservative build tools such as Webpack. CesiumJS has generally maintained a fairly agnosticpackage.json
file, but I think it's worth it to include such a field in this case since it's a dramatic optimization benefit for a popular build tool. While specific to bundlers like Webpack, it's common that libraries, such as three.js and BabylonJS, define it.This can be tested with a fairly minimal Webpack config, eg. https://github.com/CesiumGS/cesium-webpack-example. Without
sideEffects
defined, the default app is 17.2MB bundled. WithsideEffects
, the default app drops to 14.2MB bundled. If you have an even smaller example, say and app that only importsCartesian3
, it can drop to ~100KB.