pastelsky/bundlephobia

Allow to link a specific exported module

Open

#389 opened on Aug 18, 2020

View on GitHub
 (2 comments) (1 reaction) (0 assignees)JavaScript (8,477 stars) (250 forks)batch import
Improvementgood first issue

Description

Please describe the problem

In the documentation of Material-UI, we have a number of small modules exported from a large package (for convinience), for instance: https://material-ui.com/components/textarea-autosize/. We link our own bundle size report so developers can have an idea of the bundle size cost (and hopefully feel safe adding the dependency). However, I think that developers would have more trust in a third-party source, somebody that doesn't have conflicting incentives (as long as the data is accurate enough).

Describe the solution you'd like

We would like to link a specific exported module with BundlePhobia.

Describe any alternatives you've considered

We have tried text fragment but it's not reliable enough: https://github.com/mui-org/material-ui/pull/22210#discussion_r471125634

Contributor guide

Tech stack
javascriptnodejs
Domain
developer experiencetoolingperformance
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
familiarity with BundlePhobia codebaseJavaScript
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
45
Research direction
The issue requests the ability to link directly to a specific exported module of a package, similar to how Material UI wants to link to `@material ui/core/TextareaAutosize`. Investigate the current routing or URL structure in BundlePhobia. Look at how the app handles package names and versions, and consider adding a query parameter or path segment to specify a module path. Check the Material UI PR discussion (linked in issue) for context. There are no linked PRs or assignees, so the feature is available for implementation.