search

nushell / reedline

A feature-rich line editor - powering Nushell
https://docs.rs/reedline/
MIT License
545 stars 150 forks source link

Vi mode seems incomplete #621

Open txtyash opened 2 years ago

txtyash commented 2 years ago

Related problem

Many vim bindings don't work. I come from fish where setting vi mode enables most of the necessary vim shortcuts but seems like Shift+c & Shift+s don't work. I'm not sure what else doesn't work because switched to nu just a few minutes ago.

Describe the solution you'd like

Add Shift+c & Shift+s bindings. Also add a vim section in the documentation. Is there a way to modify vim bindings?

Also, I think Ctrl+f is a nice binding to accept entire completion but there should be a Ctrl+w binding to accept only a single word completion.

Describe alternatives you've considered

No response

Additional context and details

No response

fdncred commented 2 years ago

mabye these keybindings are common knowledge to most people but for me, it would be good to have a description of what you're requesting other than just having keybindings by name. what do you want them to do? Also, have you tried defining them yourself? keybindings are pretty powerful in nushell these days. https://www.nushell.sh/book/line_editor.html#default-keybindings

matiu3 commented 2 years ago

All these were working until I updated today, now I feel like I'm disabled without my shortcuts :p

Also thank you very much for this great product.

txtyash commented 2 years ago

mabye these keybindings are common knowledge to most people but for me, it would be good to have a description of what you're requesting other than just having keybindings by name. what do you want them to do? Also, have you tried defining them yourself? keybindings are pretty powerful in nushell these days. https://www.nushell.sh/book/line_editor.html#default-keybindings

u don't use vim?

txtyash commented 2 years ago

I haven't included any of @matiu3 's suggestions do avoid duplication but they are just as important.

Also, I'm not sure if it's possible to implement Shift+Backspace but it'd be nice too.

matiu3 commented 2 years ago

I think, as things are, one would need to manually add all these to reedline and there's a lot of work there.

Perhaps an easier solution would be to make it possible to swap out reedline with readline or zle, both of which already have the keybindings programmed ?

Or is it possible for us users to manually program these into the config file ? I get the feeling it's not that fine grained. If it is, please get us started and we can collaborate in filling it in.

txtyash commented 2 years ago

Or is it possible for us users to manually program these into the config file ? I get the feeling it's not that fine grained. If it is, please get us started and we can collaborate in filling it in.

Can you please tell me how to use multiple edits?

    {
      name: clear_line
      modifier: shift
      keycode: char_c
      mode: vi_normal
      event: {
        edit: cleartolineend
      }
    }

In the above keybinding I'm in normal mode and then I clear to the end of the line, now I want to switch to insert mode. How do I do that? Most of the bindings I need can be made if you just let me know how to switch between normal & insert modes while configuring a binding.

Or maybe paste the configuration for Shift+a which is already present and works fine although I couldn't find it anywhere in the source code of this repo.

fdncred commented 2 years ago

u don't use vim?

never.

... how to switch between ...

Have you tried adding multiple edit events like the documentation shows? https://www.nushell.sh/book/line_editor.html#keybindings. Maybe adding an insertchar or insertstring will switch the mode. I'm not sure. @elferherrera is the keybinding guru, maybe he knows.

if you do keybindings list you can see what events/etc are available in keybindings.

most all of the vi stuff is defined here https://github.com/nushell/reedline/tree/main/src/edit_mode/vi

txtyash commented 2 years ago

u don't use vim?

never.

... how to switch between ...

Have you tried adding multiple edit events like the documentation shows? https://www.nushell.sh/book/line_editor.html#keybindings. Maybe adding an insertchar or insertstring will switch the mode. I'm not sure. @elferherrera is the keybinding guru, maybe he knows.

if you do keybindings list you can see what events/etc are available in keybindings.

I've gone through the docs and also adding multiple edit statements including insert, insertstring... but there's no way I'm dropped to insert mode. I also tried sending event i(switch to insert mode) but helpless.

txtyash commented 2 years ago

Let's work on a single binding first as an example:

    {
      name: prepend
      modifier: shift
      keycode: char_i
      mode: vi_normal # Options: emacs vi_normal vi_insert
      event:[
          { edit: MoveToLineStart }
          { edit: InsertString,
            value: ""  }
        ]
      }
    }

Right now this only half works. It takes me to the start of the line but doesn't drop me into insert mode, not even keycode: insert. Also the examples mentioned in the docs are mostly for emacs so don't help much.

fdncred commented 2 years ago

@sholderbach also understands the vi configuation too. He may be able to help also.

sholderbach commented 2 years ago

The command parser for the typical vi sequences is hand built at the moment and not amenable to configurable keybindings yet. Only ctrl sequences are handled by the configurable keyparser used with emacs style mode. There is definitely work to be done on vi mode to get more of the commands and movements to parity. I don't know if parity in configurable keybindings for vi (a la "nmremap whatever") is a reasonable goal at the moment.

txtyash commented 2 years ago

Hey, @sholderbach I was just taking a look at the reedline's source code. I'm still a rust beginner but looking at the source code I wondered why some of the bindings are missing or why they haven't been implemented and maybe there's a way to quickly implement them. As an example I thought the since the behavior of shift+i is similar to that of shift+a, then a little copy pasting got me to this: https://github.com/zim0369/reedline/commit/5621bf829d969e38a72925aa1216c6bcb127a3b5 Would this commit successfully implement the vim's shift+i behavior?

sholderbach commented 2 years ago

I think there is one extra step, to make sure it switches into insert mode but I am happy to walk you through a PR. Thanks for giving it a shot!

txtyash commented 2 years ago

insert mode ctrl+w move right one word similar to ctrl+f except it "moves to the right, entire line"

Hey @fdncred , Is it possible to make this binding in config.nu without having to make any changes to "reedline"?

sholderbach commented 2 years ago

Ctrl bindings should be possible

txtyash commented 2 years ago

I will close this issue once 'x', 'w' & 's' are fixed and 'e', '?', 'S', 'r', 'R', 'y', 'around' & 'inside' are implemented.

jcjolley commented 2 years ago

Many vim users (myself included) rebind <ESC> or Ctrl+[ to a chord like "jk" or "jj". How difficult would it be to modify the keybindings keycode property to accept a list of keybinds?

fdncred commented 2 years ago

keyboard chords are not currently supported in reedline, although we'd love to support them.

crides commented 2 years ago

The vi editing modes are the last thing for me to more extensively try out nushell, otherwise the other parts feel very nice to me. Basically I would love to see the vi editing mode to be on par with zsh. Some of the problems/missing pieces have been listed above, but I'll add my observations:

I would love to make these changes myself or at least dig into what the problems are, but unfortunately I won't have much free time for quite a while :cry: