[Bug] `nvim-remote` not working on Windows 11

[pidgeon777]

Describe the bug
When opening Lazygit inside Neovim and trying to edit a file with e, Lazygit hangs.

To Reproduce
Steps to reproduce the behavior:

1. Start Lazygit in Neovim.
2. Select a file in the Lazygit files list.
3. Press e.

As a result, the Lazygit terminal will hang.

Expected behavior

After running the e command, I would expect Lazygit to close and Neovim to open a new tab with the corresponding file to be edited.

Version info:
lazygit --version:

commit=3675570a391b1a49ddd198b4c7e71e17701d4404, build date=2024-03-23T09:09:11Z, build source=binaryRelease, version=0.41.0, os=windows, arch=amd64, git version=2.44.0.windows.1

git --version:

git version 2.44.0.windows.1

Additional context
The problem could be related to this code:

https://github.com/jesseduffield/lazygit/blob/master/pkg/config/editor_presets.go#L54-L61

It seems a command to be run in a Linux environment.

So, I suppose there would have to be a Windows equivalent command. Also, how and where should the NVIM variable be set?

[rpkwv8]

Also, how and where should the NVIM variable be set?

NVIM env var is set when Lazygit is run inside a terminal created within neovim: https://github.com/neovim/neovim/blob/4459e0cee8b6d043ab2b06cbd89545c45a76a612/runtime/doc/nvim_terminal_emulator.txt#L43
As the above line in the documentation describes, the terminal emulator used by neovim uses the same environment setup as neovim jobs (where NVIM is set):
https://github.com/neovim/neovim/blob/4459e0cee8b6d043ab2b06cbd89545c45a76a612/runtime/doc/builtin.txt#L3866

[woertsposzibllen4me]

I've encountered a similar issue with an error message direcly printed as I attempt to use "e". (Windows 11):

'[' is not recognized as an internal or external command, operable program or batch file.

Only with nvim-remote as an editPreset

[RZMNR]

For work I am forced to use windows and I noticed this as well. Lazygit uses CMD on windows and the preset uses bash syntax so that won't work. I tried to set the editTemplate manually in the config using CMD syntax but this won't work either because you have to use CMD syntax to check if the NVIM variable exists (with if not defined %NVIM% ....) but this won't work either because the percent signs are getting quoted by lazygit. I am not super familiar with the lazygit codebase but if none of the maintainers know a quick solution for this I am willing to try to work around this if this is something you want.

[mikavilpas]

In the lazygit configuration, you can override the commands that the preset sets. That should give you the ability to set commands that work on your system.

I don't know much about environment variables and how they work on Windows these days. If you're stuck and willing to try an alternative, I currently work on osx and use

• these lazygit settings
• I load a plugin called https://github.com/willothy/flatten.nvim which allows neovim to pretty much do the same thing as nvim-remote
  • https://github.com/mikavilpas/dotfiles/blob/ccd520277eb60212da0936eec7bab81317b83362/.config/nvim/lua/plugins/terminal-integration.lua?plain=1#L3

lazygit.mov

[RZMNR]

Thanks, I didn't know that plugin. I will try that out!

[l0ngvh]

I'm trying this edit template

if defined NVIM (nvim --server "%NVIM%" --remote-send "q" && nvim --server "%NVIM%" --remote-tab {{filename}}) else (nvim -- "{{filename}}")

But it doesn't work since "%" is escaped. It seems flatten.nvim is the only solution for now.

[l0ngvh]

OK thanks to #2427 (comment) I have found a way to make this work:

# config.yaml
...
os:
  edit: 'pwsh -NoProfile -File "$PathToScript\edit_nvim_remote.ps1" {{filename}} '
  editAtLine: 'pwsh -NoProfile -File "$PathToScript\edit_nvim_remote.ps1" {{filename}} {{line}} '
  openDirInEditor: 'pwsh -NoProfile -File "$PathToScript\edit_nvim_remote.ps1" {{dir}}'

# edit_nvim_remote.ps1
param(
    [Parameter(Mandatory=$true, Position=0)]
    [string]$FileName,

    [Parameter(Mandatory=$false, Position=1)]
    [int]$LineNumber
)

if (Test-Path Env:NVIM) {
    # close the floating terminal containing the lazygit instance
    nvim --server "$($env:NVIM)" --remote-send "<C-\><C-n>:q<CR>"

    nvim --server "$($env:NVIM)" --remote $FileName

    if ($LineNumber -gt 0) {
        nvim --server "$($env:NVIM)" --remote-send ":${LineNumber}<CR>"
    }
}
else {
    $nvimFileArgs = @()
    if ($LineNumber -gt 0) {
        $nvimFileArgs += "+$LineNumber"
    }
    $nvimFileArgs += $FileName

    nvim $nvimFileArgs
}