corejavascript/typeahead.js

Deduplication of common/utils

Open

#165 opened on Oct 10, 2017

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

Repository metrics

Stars
 (956 stars)
PR merge metrics
 (No merged PRs in 30d)

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

Research direction
Examine the current `common/utils` usage in both Bloodhound and Typeahead modules, then propose a refactoring that either extracts the shared utilities into a separate module or duplicates and customizes the utility functions for each module.
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.
2
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.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
JavaScriptmodule systems
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70