Galooshi/import-js

Ranking unresolved imports with better relevance

Open

#340 opened on Aug 19, 2016

View on GitHub
 (8 comments) (0 reactions) (0 assignees)JavaScript (519 stars) (70 forks)batch import
enhancementhelp wanted

Description

There is a requirement that we want to find enough modules to import from. But it also brings up noise and brings down performance.

An idea to optimize performance: scan through the all the node_modules, but skip all its sub node_modules. It's rare to import anything from node_modules of a node_modules module, while those files are the most costy and noisy.

Ideas to rank the possible imports:

  1. Look at current file's sibling files. Imported modules referred by those files are likely more interested for current file
  2. To extend idea 1, we can use a daemon to construct a tree of import histograms. It will be a mirror of the workspace folder structure but the leaves will be the imported objects. When a file request a import keyword, then query through the tree to find all import leaves that has the matching name. Then use some algorithm to properly add weight or reduce weight based on number of usages and distance of those usages from current file.

I don't have specific algorithm in mind yet but it can be some heuristic approach.

@lencioni

Contributor guide

Tech stack
javascriptnodejs
Domain
toolingdeveloper experienceperformance
Issue type
research
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
4
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
3-5 days
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
JavaScriptNode.jsmodule resolutionalgorithm design
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
35
Research direction
Examine the current import resolution logic in import js to understand how modules are scanned. Test the approach of skipping nested node modules to improve performance. Design and implement a ranking algorithm using import histograms, optionally with a daemon to build a tree structure. Consider existing patterns in tools like eslint plugin import for inspiration.