rastapasta/mapscii

vim keybinds

Open

#80 opened on Mar 4, 2020

View on GitHub
 (2 comments) (6 reactions) (0 assignees)JavaScript (6,790 stars) (231 forks)batch import
enhancementhelp wanted

Description

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
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
familiarity with JavaScriptbasic understanding of terminal input handling
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65
Research direction
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.