Improve nvim-remote mode (#3508)

- If _not_ inside a neovim session, treat as a normal nvim invocation
and suspend lazygit.

- If inside a neovim session:
  - Do not try to suspend lazygit.
  - Send `q` keystroke to neovim session to quit lazygit.
  - Send filename/line/etc. to neovim session.

- **Please check if the PR fulfills these requirements**

* [x] Cheatsheets are up-to-date (run `go generate ./...`)
* [x] Code has been formatted (see
[here](https://github.com/jesseduffield/lazygit/blob/master/CONTRIBUTING.md#code-formatting))
* [ ] Tests have been added/updated (see
[here](https://github.com/jesseduffield/lazygit/blob/master/pkg/integration/README.md)
for the integration test guide)
* [ ] Text is internationalised (see
[here](https://github.com/jesseduffield/lazygit/blob/master/CONTRIBUTING.md#internationalisation))
* [ ] Docs (specifically `docs/Config.md`) have been updated if
necessary
* [x] You've read through your own file changes for silly mistakes etc

<!--
Be sure to name your PR with an imperative e.g. 'Add worktrees view'
see https://github.com/jesseduffield/lazygit/releases/tag/v0.40.0 for
examples
-->

pkg/config/editor_presets.go

@@ -1,5 +1,7 @@
 package config
 
+import "os"
+
 func GetEditTemplate(osConfig *OSConfig, guessDefaultEditor func() string) (string, bool) {
 	preset := getPreset(osConfig, guessDefaultEditor)
 	template := osConfig.Edit
@@ -42,22 +44,27 @@ type editPreset struct {
 	editAtLineTemplate        string
 	editAtLineAndWaitTemplate string
 	openDirInEditorTemplate   string
-	suspend                   bool
+	suspend                   func() bool
 }
 
+func returnBool(a bool) func() bool { return (func() bool { return a }) }
+
 // IF YOU ADD A PRESET TO THIS FUNCTION YOU MUST UPDATE THE `Supported presets` SECTION OF docs/Config.md
 func getPreset(osConfig *OSConfig, guessDefaultEditor func() string) *editPreset {
 	presets := map[string]*editPreset{
 		"vi":   standardTerminalEditorPreset("vi"),
 		"vim":  standardTerminalEditorPreset("vim"),
 		"nvim": standardTerminalEditorPreset("nvim"),
 		"nvim-remote": {
-			editTemplate:       `nvim --server "$NVIM" --remote-tab {{filename}}`,
-			editAtLineTemplate: `nvim --server "$NVIM" --remote-tab {{filename}}; [ -z "$NVIM" ] || nvim --server "$NVIM" --remote-send ":{{line}}<CR>"`,
+			editTemplate:       `[ -z "$NVIM" ] && (nvim -- {{filename}}) || (nvim --server "$NVIM" --remote-send "q" && nvim --server "$NVIM" --remote-tab {{filename}})`,
+			editAtLineTemplate: `[ -z "$NVIM" ] && (nvim +{{line}} -- {{filename}}) || (nvim --server "$NVIM" --remote-send "q" &&  nvim --server "$NVIM" --remote-tab {{filename}} && nvim --server "$NVIM" --remote-send ":{{line}}<CR>")`,
 			// No remote-wait support yet. See https://github.com/neovim/neovim/pull/17856
 			editAtLineAndWaitTemplate: `nvim +{{line}} {{filename}}`,
-			openDirInEditorTemplate:   `nvim --server "$NVIM" --remote-tab {{dir}}`,
-			suspend:                   false,
+			openDirInEditorTemplate:   `[ -z "$NVIM" ] && (nvim -- {{dir}}) || (nvim --server "$NVIM" --remote-send "q" && nvim --server "$NVIM" --remote-tab {{dir}})`,
+			suspend: func() bool {
+				_, ok := os.LookupEnv("NVIM")
+				return !ok
+			},
 		},
 		"lvim":    standardTerminalEditorPreset("lvim"),
 		"emacs":   standardTerminalEditorPreset("emacs"),
@@ -69,42 +76,42 @@ func getPreset(osConfig *OSConfig, guessDefaultEditor func() string) *editPreset
 			editAtLineTemplate:        "helix -- {{filename}}:{{line}}",
 			editAtLineAndWaitTemplate: "helix -- {{filename}}:{{line}}",
 			openDirInEditorTemplate:   "helix -- {{dir}}",
-			suspend:                   true,
+			suspend:                   returnBool(true),
 		},
 		"helix (hx)": {
 			editTemplate:              "hx -- {{filename}}",
 			editAtLineTemplate:        "hx -- {{filename}}:{{line}}",
 			editAtLineAndWaitTemplate: "hx -- {{filename}}:{{line}}",
 			openDirInEditorTemplate:   "hx -- {{dir}}",
-			suspend:                   true,
+			suspend:                   returnBool(true),
 		},
 		"vscode": {
 			editTemplate:              "code --reuse-window -- {{filename}}",
 			editAtLineTemplate:        "code --reuse-window --goto -- {{filename}}:{{line}}",
 			editAtLineAndWaitTemplate: "code --reuse-window --goto --wait -- {{filename}}:{{line}}",
 			openDirInEditorTemplate:   "code -- {{dir}}",
-			suspend:                   false,
+			suspend:                   returnBool(false),
 		},
 		"sublime": {
 			editTemplate:              "subl -- {{filename}}",
 			editAtLineTemplate:        "subl -- {{filename}}:{{line}}",
 			editAtLineAndWaitTemplate: "subl --wait -- {{filename}}:{{line}}",
 			openDirInEditorTemplate:   "subl -- {{dir}}",
-			suspend:                   false,
+			suspend:                   returnBool(false),
 		},
 		"bbedit": {
 			editTemplate:              "bbedit -- {{filename}}",
 			editAtLineTemplate:        "bbedit +{{line}} -- {{filename}}",
 			editAtLineAndWaitTemplate: "bbedit +{{line}} --wait -- {{filename}}",
 			openDirInEditorTemplate:   "bbedit -- {{dir}}",
-			suspend:                   false,
+			suspend:                   returnBool(false),
 		},
 		"xcode": {
 			editTemplate:              "xed -- {{filename}}",
 			editAtLineTemplate:        "xed --line {{line}} -- {{filename}}",
 			editAtLineAndWaitTemplate: "xed --line {{line}} --wait -- {{filename}}",
 			openDirInEditorTemplate:   "xed -- {{dir}}",
-			suspend:                   false,
+			suspend:                   returnBool(false),
 		},
 	}
 
@@ -141,13 +148,13 @@ func standardTerminalEditorPreset(editor string) *editPreset {
 		editAtLineTemplate:        editor + " +{{line}} -- {{filename}}",
 		editAtLineAndWaitTemplate: editor + " +{{line}} -- {{filename}}",
 		openDirInEditorTemplate:   editor + " -- {{dir}}",
-		suspend:                   true,
+		suspend:                   returnBool(true),
 	}
 }
 
 func getEditInTerminal(osConfig *OSConfig, preset *editPreset) bool {
 	if osConfig.SuspendOnEdit != nil {
 		return *osConfig.SuspendOnEdit
 	}
-	return preset.suspend
+	return preset.suspend()
 }