Add tab completion for neovim #9543
Conversation
share/completions/nvim.fish
Outdated
| complete -c nvim -l serverlist -d 'List all Vim servers that can be found' | ||
| complete -c nvim -l servername -d 'Set server name' | ||
|
|
||
| # Options not included in vim.fish, also available in vim |
There was a problem hiding this comment.
... not included in vim.fish ...
After this PR, aren't these in vim.fish as well? So this comment is obsolete.
There was a problem hiding this comment.
Yes, that's right. I will remove them if everything else is okay.
I wasn't sure how to structure the nvim.fish file since it shares a lot of code with the vim.fish file, so I decided to add a few maybe unnecessary comments so it's more comprehensible for the reviewers where the respective entries came from. (Forgot to mention that in the original post.)
share/completions/nvim.fish
Outdated
| complete -c nvim -l remote -d 'Edit files on NVim server' | ||
| complete -c nvim -l remote-expr -d 'Evaluate expr on NVim server' | ||
| complete -c nvim -l remote-send -d 'Send keys to NVim server' | ||
| complete -c nvim -l remote-silent -d 'Edit files on NVim server' | ||
| complete -c nvim -l remote-wait -d 'Edit files on NVim server' | ||
| complete -c nvim -l remote-wait-silent -d 'Edit files on Vim server' | ||
| complete -c nvim -l serverlist -d 'List all Vim servers that can be found' | ||
| complete -c nvim -l servername -d 'Set server name' |
There was a problem hiding this comment.
Let's remove the options that aren't yet supported by any official neovim release. e.g. nvim --serverlist returns the singularly unhelpful message nvim: Garbage after option argument: "--serverlist" and would mislead a user into thinking they aren't using it right (instead of printing a "not implemented" message).
There was a problem hiding this comment.
okay. I think it's helpful to leave them in (but commented out) so it's easy to add them once they're supported and so the next person looking at this understands why they were omitted in the first place.
There was a problem hiding this comment.
Commenting them out and leaving a note is fine.
…ges are often confusing
share/completions/nvim.fish
Outdated
| complete -c nvim -s o -r -d 'Open horizontally split windows for each file' | ||
| complete -c nvim -s O -r -d 'Open vertically split windows for each file' | ||
| complete -c nvim -s p -r -d 'Open tab pages for each file' |
There was a problem hiding this comment.
These completions are not exactly correct (for both vim and neovim).
-o[N] Open N windows (default: one per file)
-O[N] Open N vertical windows (default: one per file)
-p[N] Open N tab pages (default: one per file)
complete -r means the current switch requires an argument. -[oOp] don't take any arguments, but they (say that they) require that vim/nvim be executed with at least one file argument (except in practice they don't because not supplying an argument just opens N windows/tabs). So using -r here is wrong because it will suppress another option afterwards (or at least it's supposed to).
Aside from that, I don't know if there's any meaningful way for us to complete the -[oOp]N version of the switches. One option would be to add a second complete line with (maybe!) an old-style completion like -o2 and a description "open two horizontally-split windows" and the user can take that as a hint to modify the 2 for themselves as needed.
There was a problem hiding this comment.
I like the -o2 thing, implemented.
| complete -c nvim -s p -r -d 'Open tab pages for each file' | ||
| complete -c nvim -s q -r -d 'Start in quickFix mode' | ||
| complete -c nvim -s r -r -d 'Use swap files for recovery' | ||
| complete -c nvim -s t -xa '(__fish_vim_tags)' -d 'Set the cursor to tag' |
There was a problem hiding this comment.
You can't use __fish_vim_tags here because there is no guarantee the function is loaded (and it probably is not). A function is automatically loaded from a file if the file name matches the function name (and the file containing the function is in the function search path). But __fish_vim_tags is written in vim.fish.
You would need to either move __fish_vim_tags to its own file, copy it (with a new name) to this file, or (best option, imho) add the following at the top of nvim.fish:
type -q __fish_vim_tags || source (status dirname)/vim.fishto load the functions defined in vim.fish before running the completion script (if the vim completions script hasn't yet been loaded because the user tried to complete vim).
share/completions/nvim.fish
Outdated
| complete -c nvim -l remote -d 'Edit files on NVim server' | ||
| complete -c nvim -l remote-expr -d 'Evaluate expr on NVim server' | ||
| complete -c nvim -l remote-send -d 'Send keys to NVim server' | ||
| complete -c nvim -l remote-silent -d 'Edit files on NVim server' |
There was a problem hiding this comment.
Please change "on NVim server" to "on server specified with --server" as it is required to use --server <server> with these commands or an error message will be printed to the terminal (and not visible because a new neovim instance will launch in the alternate buffer).
Also, please do not capitalize nvim as NVim anywhere. It is either Neovim to refer to it as a proper noun or neovim colloquially (preferred as this is how the name is stylized on the official neovim website) or nvim to refer to the executable.
Group the completions by category and give an example for `--listen` which has a poor error message.
|
@bagohart thanks for putting in all the hard work and research on these! I've merged it. |
|
Nice! Thanks for your improvements, too. tbh didn't anticipate getting that much feedback for a bunch of mundane tab completions :) |
|
We try! |
Separate the neovim completions from the vim ones, as their supported options have diverged considerably. Some documented options are not yet implemented, these are added but commented out. Closes #9535. --------- Co-authored-by: Mahmoud Al-Qudsi <mqudsi@neosmart.net> (cherry picked from commit ef07e21)
Description
Added tab completion for neovim, mostly based on the existing vim completions.
In the process of reading the docs, I noticed that two options (startuptime and clean) are also available for vim, so I added them there, too.
Fixes issue #9535
TODOs: