leostera/minttea

Map more UTF-8 key events

Open

#3 opened on Dec 14, 2023

View on GitHub
 (3 comments) (3 reactions) (0 assignees)OCaml (32 forks)github user discovery
enhancementgood first issuehelp wanted

Repository metrics

Stars
 (462 stars)
PR merge metrics
 (PR metrics pending)

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
  • ???

Contributor guide

Research direction
Look at the `translate` function in `minttea/io loop.ml` and extend pattern matching to handle missing key events like Shift, Ctrl, and Alt modifiers. Follow the implementation pattern of existing keys.
Tech stack
None
Domain
cli
Issue type
Feature
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
OCaml
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75