corejavascript/typeahead.js

Deduplication of common/utils

Open

#165 geöffnet am 10. Okt. 2017

Auf GitHub ansehen
 (2 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)JavaScript (956 Stars) (232 Forks)batch import
enhancementhelp wanted

Beschreibung

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
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
half day
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
stale
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
clear
Voraussetzungen
JavaScriptUnderstanding of UMD modulesFamiliarity with the repository structure
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
60
Research-Richtung
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.