nushell / nushell/reedline

Allow ESC to be binded to custom action, when not in tab complete, at least when nothing being inputed

Open
#990 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Rust
Stars
818
Forks
249
Avg merge
4d 14h
Merged PRs (30d)
30

Description

I am using reedline in my rfm file manager, to let user manipulate files shown in GUI with commands in terminal emulator. But i cannot keybind ESC to my custom code, it's said that ESC is used by reedline. I see that when i use tab completion and menu, ESC can cancel the menu. But at least when i start a new readline call and nothing has being inputted, i see nothing happens with ESC. I just need ESC for my custom action here: I want to use ESC to cancel the file selection in file manager GUI. Without this, i have to switch focus to the GUI window, ESC to cancel file selection and switch focus back. Currently, i am using ALT+E keybinding as an alternative, but it's not easy to remember as ESC.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by tracing how reedline handles ESC, especially the existing tab-completion and menu cancellation paths. Verify the behavior for an empty input outside completion or menus, then make completion cancellation continue to work while allowing the configured custom action to run in that case.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
cli
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.