mapbox / mapbox/shp-write

Address Bundle Size

Open
#119 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
321
Forks
195
PR merge metrics
No merged PRs in 30d

Description

My goal is to optimize my applications' performance and enhance UX. I was surprised to see that the bundle size of this dependency is so large relative to other dependencies with many more utilities and functions

Screen Shot 2023-12-23 at 1 43 51 PM

I believe the most immediate step to solving this is to deprecate/remove the download functionality as we can provide a simple migration snippet into using something like `downloadjs`. Which I am happy to contribute to.

Screen Shot 2023-12-23 at 2 00 12 PM
Screen Shot 2023-12-23 at 2 01 54 PM

This is nowhere near a top priority for me as this is not a severe limiter for performance, but it would be nice to learn about how to optimize bundle sizes and do it in an OS context with something I am somewhat familiar with.

CC: @sheindel , it was great working with you earlier on this repo, so I'd like to hear what you have to say about this.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

No files, tests, or entry points are identified. Begin by locating the package's download functionality and measuring its contribution to the bundle; done means an agreed deprecation or removal path, migration guidance, and evidence that the bundle is smaller.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
performance
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.