corejavascript/typeahead.js

Deduplication of common/utils

Open

#165 opened on Oct 10, 2017

View on GitHub
 (2 comments) (0 reactions) (0 assignees)JavaScript (956 stars) (232 forks)batch import
enhancementhelp wanted

Description

Up until version 0.10.x, common/utils was shared by Bloodhound & Typeahead.

From version 0.11.x onwards, Bloodhound & Typeahead are defined as UMD modules, and each module has its own copy of common/utils. This results in unnecessary redundancy / bloat.

There's several solutions for this. Personally, I lean towards one of these options :

  • Put common/utils into a third module that is used as a dependency by both Bloodhound & Typeahead
  • Replace common/utils by two distinct util classes that are no longer shared between Bloodhound & Typeahead

What do you guys think about this?

Contributor guide

Tech stack
javascript
Domain
frontend
Issue type
refactor
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.
clear
Prerequisites
JavaScriptUnderstanding of UMD modulesFamiliarity with the repository structure
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
The issue proposes deduplicating 'common/utils' which is currently copied in both Bloodhound and Typeahead modules. Investigate the 'common/utils' directory in the repository to understand the shared utilities. Then evaluate the two proposed solutions: creating a third shared module or splitting the utilities into distinct classes. Look at the existing module definitions in the codebase to see how dependencies are managed.