GetJobber / atlantis

🔱 Atlantis
https://atlantis.getjobber.com
MIT License
27 stars 30 forks source link

fix(components): Enabled Tree Shaking properly in Atlantis. #2117

Open scotttjob opened 1 week ago

scotttjob commented 1 week ago

Motivations

We had a report that we weren't tree shaking properly, and users were getting reduced bundle sizes by using our legacy/compatibility bundles which was not intended (they are there to support legacy usages only).

This PR adds the required configuration to tell Rollup/Vite to properly tree shake our components.

We added sideEffects: false to our package.json. This tells bundlers that your code does not 'do' anything when loading the package. It has no side effects from loading the base entry point. Earlier this year we were forcibly injecting styles when loading our components, but we no longer do that (you have to import our styles manually via css) so this is now true!

This PR also resulted in a few deep dives into Atlantis. We did two dives, one to see what it would look like to get a pure ESM build with no compatibility layers. The other was a dive to see what it would look like for us to replace rollup with vite in library mode.

In the wake of those dives, we have a list of tasks that can bring down our package size even further. The pure ESM build of Atlantis for instance is 60kb before tree shaking with room for further improvement via bundler configuration.

Screen Shots

These screenshots come from a 'clean' project that I created with Vite. I wanted the absolute bare minimum project to show the difference in sizes for built Atlantis with and without sideEffects on. Note gzip is not enabled, so sizes shown are uncompressed.

Legacy Imports

CJS Imports

ESM Imports as of Today

ESM Imports - As It Is Today

This PR

ESM Imports - With Changes THIS PR

Build for Prod with existing approach (in sample repo)

image

Build for Prod with this PR + Prerelease (in sample repo)

image

Changes can be tested via Pre-release


In Atlantis we use Github's built in pull request reviews.

Random photo of Atlantis

cloudflare-workers-and-pages[bot] commented 1 week ago

Deploying atlantis with  Cloudflare Pages  Cloudflare Pages

Latest commit: aebf930
Status: ✅  Deploy successful!
Preview URL: https://712048d2.atlantis.pages.dev
Branch Preview URL: https://scott-t-tree-shaking-atlanti.atlantis.pages.dev

View logs

github-actions[bot] commented 1 week ago

Published Pre-release for 7fa03551faa19458f8fa1b9ceebff1c5791a191c with versions:

  - @jobber/components@5.47.2-scottttr-7fa0355.9+7fa03551

To install the new version(s) for Web run:

npm install @jobber/components@5.47.2-scottttr-7fa0355.9+7fa03551