From d02deeefd87b67e352adb8df57b76c86bf4c62e7 Mon Sep 17 00:00:00 2001
From: Karim Khaleel <code.karim@gmail.com>
Date: Mon, 9 Oct 2023 22:06:32 +0300
Subject: [PATCH 1/2] Add disabled compat for user config (#2833)

Treat <disabled> setting as equivalent to "null"
in keybindings user configs.
---
 docs/Config.md                                |  6 ++---
 pkg/config/user_config.go                     |  2 +-
 pkg/gui/keybindings/keybindings.go            |  4 ++-
 .../tests/misc/disabled_keybindings.go        | 26 +++++++++++++++++++
 pkg/integration/tests/test_list.go            |  1 +
 5 files changed, 34 insertions(+), 5 deletions(-)
 create mode 100644 pkg/integration/tests/misc/disabled_keybindings.go

diff --git a/docs/Config.md b/docs/Config.md
index 5bdcaed9806..b37745b446b 100644
--- a/docs/Config.md
+++ b/docs/Config.md
@@ -163,7 +163,7 @@ keybinding:
     jumpToBlock: ['1', '2', '3', '4', '5'] # goto the Nth block / panel
     nextMatch: 'n'
     prevMatch: 'N'
-    optionMenu: null # show help menu
+    optionMenu: <disabled> # show help menu
     optionMenu-alt1: '?' # show help menu
     select: '<space>'
     goInto: '<enter>'
@@ -462,12 +462,12 @@ Supported versions are "2" and "3". The deprecated config `showIcons` sets the v
 
 For all possible keybinding options, check [Custom_Keybindings.md](https://github.com/jesseduffield/lazygit/blob/master/docs/keybindings/Custom_Keybindings.md)
 
-You can disable certain key bindings by specifying `null`.
+You can disable certain key bindings by specifying `<disabled>`.
 
 ```yaml
 keybinding:
   universal:
-    edit: null # disable 'edit file'
+    edit: <disabled> # disable 'edit file'
 ```
 
 ### Example Keybindings For Colemak Users
diff --git a/pkg/config/user_config.go b/pkg/config/user_config.go
index d3d77b6664a..de0495466f5 100644
--- a/pkg/config/user_config.go
+++ b/pkg/config/user_config.go
@@ -691,7 +691,7 @@ func GetDefaultConfig() *UserConfig {
 				NextMatch:                    "n",
 				PrevMatch:                    "N",
 				StartSearch:                  "/",
-				OptionMenu:                   "",
+				OptionMenu:                   "<disabled>",
 				OptionMenuAlt1:               "?",
 				Select:                       "<space>",
 				GoInto:                       "<enter>",
diff --git a/pkg/gui/keybindings/keybindings.go b/pkg/gui/keybindings/keybindings.go
index 4204dc4e17e..fd8c694cfd4 100644
--- a/pkg/gui/keybindings/keybindings.go
+++ b/pkg/gui/keybindings/keybindings.go
@@ -100,7 +100,9 @@ func LabelFromKey(key types.Key) string {
 
 func GetKey(key string) types.Key {
 	runeCount := utf8.RuneCountInString(key)
-	if runeCount > 1 {
+	if key == "<disabled>" {
+		return nil
+	} else if runeCount > 1 {
 		binding, ok := keyByLabel[strings.ToLower(key)]
 		if !ok {
 			log.Fatalf("Unrecognized key %s for keybinding. For permitted values see %s", strings.ToLower(key), constants.Links.Docs.CustomKeybindings)
diff --git a/pkg/integration/tests/misc/disabled_keybindings.go b/pkg/integration/tests/misc/disabled_keybindings.go
new file mode 100644
index 00000000000..0d024b47e34
--- /dev/null
+++ b/pkg/integration/tests/misc/disabled_keybindings.go
@@ -0,0 +1,26 @@
+package misc
+
+import (
+	"github.com/jesseduffield/lazygit/pkg/config"
+	. "github.com/jesseduffield/lazygit/pkg/integration/components"
+)
+
+var DisabledKeybindings = NewIntegrationTest(NewIntegrationTestArgs{
+	Description:  "Confirms You can set keybindings to blank to disable them",
+	ExtraCmdArgs: []string{},
+	Skip:         false,
+	SetupConfig: func(config *config.AppConfig) {
+		config.UserConfig.Keybinding.Universal.PrevItem = "<disabled>"
+		config.UserConfig.Keybinding.Universal.NextItem = "<disabled>"
+		config.UserConfig.Keybinding.Universal.NextTab = "<up>"
+		config.UserConfig.Keybinding.Universal.PrevTab = "<down>"
+	},
+	SetupRepo: func(shell *Shell) {},
+	Run: func(t *TestDriver, keys config.KeybindingConfig) {
+		t.Views().Files().
+			IsFocused().
+			Press("<up>")
+
+		t.Views().Worktrees().IsFocused()
+	},
+})
diff --git a/pkg/integration/tests/test_list.go b/pkg/integration/tests/test_list.go
index 89019719a1e..7759dcda72b 100644
--- a/pkg/integration/tests/test_list.go
+++ b/pkg/integration/tests/test_list.go
@@ -170,6 +170,7 @@ var tests = []*components.IntegrationTest{
 	interactive_rebase.SwapWithConflict,
 	misc.ConfirmOnQuit,
 	misc.CopyToClipboard,
+	misc.DisabledKeybindings,
 	misc.InitialOpen,
 	misc.RecentReposOnLaunch,
 	patch_building.Apply,

From 421c6565f9340bba2e30c1f87ff333bbea48cf31 Mon Sep 17 00:00:00 2001
From: Karim Khaleel <code.karim@gmail.com>
Date: Tue, 10 Oct 2023 08:38:15 +0300
Subject: [PATCH 2/2] Update wording in disable keybindings test

Co-authored-by: Jesse Duffield <jessedduffield@gmail.com>
---
 pkg/integration/tests/misc/disabled_keybindings.go | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/pkg/integration/tests/misc/disabled_keybindings.go b/pkg/integration/tests/misc/disabled_keybindings.go
index 0d024b47e34..55e07034d72 100644
--- a/pkg/integration/tests/misc/disabled_keybindings.go
+++ b/pkg/integration/tests/misc/disabled_keybindings.go
@@ -6,7 +6,7 @@ import (
 )
 
 var DisabledKeybindings = NewIntegrationTest(NewIntegrationTestArgs{
-	Description:  "Confirms You can set keybindings to blank to disable them",
+	Description:  "Confirms you can disable keybindings by setting them to <disabled>",
 	ExtraCmdArgs: []string{},
 	Skip:         false,
 	SetupConfig: func(config *config.AppConfig) {