rastapasta/mapscii

vim keybinds

Open

#80 geöffnet am 4. März 2020

Auf GitHub ansehen
 (2 Kommentare) (6 Reaktionen) (0 zugewiesene Personen)JavaScript (6.790 Stars) (231 Forks)batch import
enhancementhelp wanted

Beschreibung

The problem

When I open this program my hands instinctively try to adjust the map using the vim keys. This is the natural mode of navigation for countless TUI programs.

Proposed solution

h,j,k, and l are the classic left, down, up, right controls. You could keep zooming as a and z, but I would love to use J and K.

Additional context

I don't believe these keybinds would interfere with any preexisting options, and non vim users could easily stick to the arrow keys.

This also provides a framework for more keybinds. For example if you implement a search feature, the / key is already most peoples go-to and it makes the program easy to learn.

Contributor Guide

Tech Stack
javascript
Domain
cli
Issue Type
feature
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
familiarity with JavaScriptbasic understanding of terminal input handling
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
65
Research-Richtung
Examine the main JavaScript files (likely in src/ or root) for current keyboard input handling, such as arrow key bindings. The issue requests adding vim style navigation (h,j,k,l) and possibly others. Look for how key events are captured (e.g., using the 'keypress' or 'keydown' events). A good starting point is to search for 'process.stdin' or 'keypress' in the codebase. Also review any existing configuration for key bindings. The maintainer has not responded, so consider designing a clean implementation that allows easy extension.