leostera/minttea

Map more UTF-8 key events

Open

#3 ouverte le 14 déc. 2023

Voir sur GitHub
 (3 commentaires) (3 réactions) (0 assignés)OCaml (32 forks)github user discovery
enhancementgood first issuehelp wanted

Métriques du dépôt

Stars
 (462 stars)
Métriques de merge PR
 (Métriques PR en attente)

Description

At the moment we are only handling the space " " and keys in a nice way, but it'd be nice to be able to match on KeyDown Enter or KeyDown "<enter>".

Using a variant for all the keys may be a stretch, since we're parsing UTF-8 grapheme clusters, so at least some common ones we want to handle in a way that lets you match over KeyDown easily.

This is currently happening in the minttea/io_loop.ml in the translate function:

https://github.com/leostera/minttea/blob/main/minttea/io_loop.ml#L18

Currently implemented keys:

  • Enter
  • Space
  • Backspace
  • Left / Down / Up / Right
  • Escape
  • Key (includes a string with the contents of the matched UTF-8 character)

Missing keys:

  • Shift-modifier
  • Ctrl-modifier
  • Alt-modifier
  • ???

Guide contributeur

Direction de recherche
Regardez la fonction `translate` dans `minttea/io loop.ml` et étendez le filtrage par motif pour traiter les événements clés manquants comme les modificateurs Shift, Ctrl et Alt. Suivez le modèle d'implémentation des clés existantes.
Stack technique
Aucun
Domaine
cli
Type d'issue
Fonctionnalité
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
OCaml
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
75