Unable to move cursor in ruby REPL pry or irb #3536

Closed
opened 2026-01-30 23:23:30 +00:00 by claunia · 8 comments
Owner

Originally created by @jburns24 on GitHub (Aug 23, 2019).

Environment

Win32NT 10.0.18362.0 Microsoft Windows NT 10.0.18362.0

Windows Terminal Version: 0.3.2171.0

Other Software

ruby 2.6.3p62 (2019-04-16 revision 67580) [x64-mingw32]
gems
pry (0.12.2)
irb (1.0.0)
both ruby REPLs

Steps to reproduce

In windows terminal start the ruby REPL pry or irb

type fooar then press the left arrow key to move the cursor back.

Expected behavior

You should be able to use the arrow keys to move around.

Actual behavior

The cursor is stuck at the end of the line.

I tested this behavior in other REPLs such as node, and python and this was not an issue. I then tested this behavior in other shells cmd and powershell (not in windows terminal) and this behavior was not reproducible.

Did some further testing and noticed this issue is a problem both in powershell and command when I start them in windows terminal, but it is not an issue when I run wsl in windows terminal.

Originally created by @jburns24 on GitHub (Aug 23, 2019). <!-- 🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨 I ACKNOWLEDGE THE FOLLOWING BEFORE PROCEEDING: 1. If I delete this entire template and go my own path, the core team may close my issue without further explanation or engagement. 2. If I list multiple bugs/concerns in this one issue, the core team may close my issue without further explanation or engagement. 3. If I write an issue that has many duplicates, the core team may close my issue without further explanation or engagement (and without necessarily spending time to find the exact duplicate ID number). 4. If I leave the title incomplete when filing the issue, the core team may close my issue without further explanation or engagement. 5. If I file something completely blank in the body, the core team may close my issue without further explanation or engagement. All good? Then proceed! --> <!-- This bug tracker is monitored by Windows Terminal development team and other technical folks. **Important: When reporting BSODs or security issues, DO NOT attach memory dumps, logs, or traces to Github issues**. Instead, send dumps/traces to secure@microsoft.com, referencing this GitHub issue. If this is an application crash, please also provide a Feedback Hub submission link so we can find your diagnostic data on the backend. Use the category "Apps > Windows Terminal (Preview)" and choose "Share My Feedback" after submission to get the link. Please use this form and describe your issue, concisely but precisely, with as much detail as possible. --> # Environment Win32NT 10.0.18362.0 Microsoft Windows NT 10.0.18362.0 Windows Terminal Version: 0.3.2171.0 ### Other Software ruby 2.6.3p62 (2019-04-16 revision 67580) [x64-mingw32] gems pry (0.12.2) irb (1.0.0) both ruby REPLs # Steps to reproduce In windows terminal start the ruby REPL `pry` or `irb` type `fooar` then press the left arrow key to move the cursor back. <!-- A description of how to trigger this bug. --> # Expected behavior You should be able to use the arrow keys to move around. <!-- A description of what you're expecting, possibly containing screenshots or reference material. --> # Actual behavior The cursor is stuck at the end of the line. <!-- What's actually happening? --> I tested this behavior in other REPLs such as node, and python and this was not an issue. I then tested this behavior in other shells cmd and powershell (not in windows terminal) and this behavior was not reproducible. Did some further testing and noticed this issue is a problem both in powershell and command when I start them in windows terminal, but it is not an issue when I run wsl in windows terminal.
Author
Owner

@thomthom commented on GitHub (Aug 25, 2019):

I'm seeing the same thing. When I use classic cmd then irb works fine. But when I have a cmd tab in Windows Terminal then I'm unable to use Backspace to erase characters in irb, unable to move the cursor and unable to use up/down arrow to navigate the irb history.

@thomthom commented on GitHub (Aug 25, 2019): I'm seeing the same thing. When I use classic `cmd` then `irb` works fine. But when I have a `cmd` tab in Windows Terminal then I'm unable to use Backspace to erase characters in `irb`, unable to move the cursor and unable to use up/down arrow to navigate the `irb` history.
Author
Owner

@jimfoltz commented on GitHub (Sep 1, 2019):

Just FYI - you can use GNU Readline shortcuts.

https://www.gnu.org/software/bash/manual/html_node/Readline-Interaction.html#Readline-Interaction

@jimfoltz commented on GitHub (Sep 1, 2019): Just FYI - you can use GNU Readline shortcuts. https://www.gnu.org/software/bash/manual/html_node/Readline-Interaction.html#Readline-Interaction
Author
Owner

@ramsay-vibes commented on GitHub (Sep 1, 2019):

In mit-scheme REPL I have experienced the same (at least similar) issue, per the following screenshot where the following was typed: (cadr '1 '(2 3 4)) followed by left-arrow, right-arrow, up-arrow, down-arrow.

scheme

Unfortunately, the same issue occurs in the Ubuntu 18.04 LTS shell. So, not sure if this is a console issue or not.

Windows Version: [10.0.18362.295]
Terminal Version: [0.4.2382.0]

@ramsay-vibes commented on GitHub (Sep 1, 2019): In mit-scheme REPL I have experienced the same (at least similar) issue, per the following screenshot where the following was typed: `(cadr '1 '(2 3 4))` followed by `left-arrow`, `right-arrow`, `up-arrow`, `down-arrow`. ![scheme](https://user-images.githubusercontent.com/8571098/64075418-ef70c900-ccaf-11e9-80ae-b58fb541a667.jpg) Unfortunately, the same issue occurs in the **Ubuntu 18.04 LTS** shell. So, not sure if this is a console issue or not. Windows Version: [10.0.18362.295] Terminal Version: [0.4.2382.0]
Author
Owner

@zadjii-msft commented on GitHub (Sep 4, 2019):

This feels like it might be related to #2642

@zadjii-msft commented on GitHub (Sep 4, 2019): This feels like it might be related to #2642
Author
Owner

@DHowett-MSFT commented on GitHub (Sep 14, 2019):

It looks like other REPLs are susceptible to this as well. I wonder what common library they're using!

When fixed, validate:

  • R
  • irb
  • pry
@DHowett-MSFT commented on GitHub (Sep 14, 2019): It looks like other REPLs are susceptible to this as well. I wonder what common library they're using! When fixed, validate: * [ ] R * [ ] irb * [ ] pry
Author
Owner

@zanecodes commented on GitHub (Jan 22, 2020):

This appears to be related to https://github.com/rprichard/winpty/issues/99, which suffers from the same problem, for what appears to be the same reason.

After digging into the rb-readline gem's source, I was able to confirm this by running the following code, once in PowerShell:

PS C:\Users\Zane> irb
irb(main):001:0> RbReadline.rl_read_key # following this, I press the left arrow key
=> "\xE0K"

and once in Windows Terminal Preview:

PS C:\Users\Zane> irb
irb(main):001:0> RbReadline.rl_read_key # following this, I press the left arrow key
=> "\x00K"

We can see that rb-readline only binds the arrow key handlers to the scancode sequences with the ENHANCED_KEY flag set ("\xE0" in hex, or "\340" in octal), so it simply doesn't handle these key sequences when they're missing the ENHANCED_KEY flag (as they seem to be when dispatched by winpty, or in this case, Windows Terminal Preview).

This could be considered a bug in rb-readline, but it doesn't seem to be under very active development, and since it also appears to be an issue in a number of other REPLs that do not use rb-readline, the solution for Windows Terminal Preview would seem to be to dispatch these key events with the ENHANCED_KEY flag set.

For those wanting to work around this in irb right now, you can do so by adding the following to your ~\.irbrc file:

# Workaround for https://github.com/microsoft/terminal/issues/2520
{
  "\000H" => :rl_get_previous_history, # Up
  "\000P" => :rl_get_next_history, # Down
  "\000M" => :rl_forward_char,  # Right
  "\000K" => :rl_backward_char, # Left
  "\000G" => :rl_beg_of_line,   # Home
  "\000O" => :rl_end_of_line,   # End
  "\000s" => :rl_backward_word, # Ctrl-Left
  "\000t" => :rl_forward_word, # Ctrl-Right
  "\000S" => :rl_delete, # Delete
  "\000R" => :rl_overwrite_mode # Insert
}.each do |keyseq, method|
  RbReadline.rl_bind_keyseq_if_unbound(keyseq, method)
end
@zanecodes commented on GitHub (Jan 22, 2020): This appears to be related to https://github.com/rprichard/winpty/issues/99, which suffers from the same problem, for what appears to be the same reason. After digging into the [rb-readline gem's source](https://github.com/ConnorAtherton/rb-readline), I was able to confirm this by running the following code, once in PowerShell: ``` PS C:\Users\Zane> irb irb(main):001:0> RbReadline.rl_read_key # following this, I press the left arrow key => "\xE0K" ``` and once in Windows Terminal Preview: ``` PS C:\Users\Zane> irb irb(main):001:0> RbReadline.rl_read_key # following this, I press the left arrow key => "\x00K" ``` We can see that [rb-readline only binds the arrow key handlers to the scancode sequences with the `ENHANCED_KEY` flag set](https://github.com/ConnorAtherton/rb-readline/blob/master/lib/rbreadline.rb#L2516-L2525) (`"\xE0"` in hex, or `"\340"` in octal), so it simply doesn't handle these key sequences when they're missing the `ENHANCED_KEY` flag (as they seem to be when dispatched by winpty, or in this case, Windows Terminal Preview). This could be considered a bug in `rb-readline`, but it doesn't seem to be under very active development, and since it also appears to be an issue in a number of other REPLs that do not use `rb-readline`, the solution for Windows Terminal Preview would seem to be to dispatch these key events with the `ENHANCED_KEY` flag set. For those wanting to work around this in `irb` right now, you can do so by adding the following to your `~\.irbrc` file: ``` # Workaround for https://github.com/microsoft/terminal/issues/2520 { "\000H" => :rl_get_previous_history, # Up "\000P" => :rl_get_next_history, # Down "\000M" => :rl_forward_char, # Right "\000K" => :rl_backward_char, # Left "\000G" => :rl_beg_of_line, # Home "\000O" => :rl_end_of_line, # End "\000s" => :rl_backward_word, # Ctrl-Left "\000t" => :rl_forward_word, # Ctrl-Right "\000S" => :rl_delete, # Delete "\000R" => :rl_overwrite_mode # Insert }.each do |keyseq, method| RbReadline.rl_bind_keyseq_if_unbound(keyseq, method) end ```
Author
Owner

@DHowett-MSFT commented on GitHub (Jan 22, 2020):

Ah! Thanks for looking into this. That makes this a /dupe of #2397.

@DHowett-MSFT commented on GitHub (Jan 22, 2020): Ah! Thanks for looking into this. That makes this a /dupe of #2397.
Author
Owner

@ghost commented on GitHub (Jan 22, 2020):

Hi! We've identified this issue as a duplicate of another one that already exists on this Issue Tracker. This specific instance is being closed in favor of tracking the concern over on the referenced thread. Thanks for your report!

@ghost commented on GitHub (Jan 22, 2020): Hi! We've identified this issue as a duplicate of another one that already exists on this Issue Tracker. This specific instance is being closed in favor of tracking the concern over on the referenced thread. Thanks for your report!
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/terminal#3536