frintjs/frint

Support easier individual imports of modules

Open

#336 opened on Oct 12, 2017

View on GitHub
 (1 comment) (1 reaction) (0 assignees)JavaScript (746 stars) (37 forks)batch import
good first issuehelp wantedoptimization

Description

Currently

Everywhere, including documentation and examples, we ask developers to import modules from the package directly, like this:

import { Region } from 'frint-react';

// this import also brings `render` and `streamProps` for example

Some applications may need only one specific module from a given package, but they will still end up loading all the modules from that package in the runtime.

We can possibly get around this by tree-shaking during the bundling process, but the application on the server will not benefit from it in any way.

Area for improvement

Without breaking the API, allow developers to import only the modules they want individually, like this:

import Region from 'frint-react/Region';

To do this, we need to add files in the root directory of the packages according to the exported module names listed in their main index.js file.

Contributor guide

Tech stack
javascriptreactnodejs
Domain
frontendbackendfull stack
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.
1-3 hours
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.
clear
Prerequisites
JavaScript ES modulesfrint package structure
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
The issue requests adding individual module entry points under the package root. To implement, examine the main index.js files in each package (e.g., frint react) and create files like /Region/index.js or /Region.js that re export the respective module. Check existing file structure for reference. No linked PRs or comments provide additional guidance.