corejavascript/typeahead.js

Deduplication of common/utils

Open

#165 ouverte le 10 oct. 2017

Voir sur GitHub
 (2 commentaires) (0 réactions) (0 assignés)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?

Guide contributeur

Stack technique
javascript
Domaine
frontend
Type d'issue
refactor
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
3
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
half day
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
stale
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
clear
Prérequis
JavaScriptUnderstanding of UMD modulesFamiliarity with the repository structure
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
60
Direction de recherche
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.