feat: define multiple keybindings for the same action (better for def…

…aults)
folke · Apr 24, 2021 · bf8e8ee · bf8e8ee
1 parent ecb9c09
commit bf8e8ee
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 13 deletions.
diff --git a/README.md b/README.md
@@ -75,14 +75,14 @@ Trouble comes with the following defaults:
     fold_closed = "", -- icon used for closed folds
     action_keys = { -- key mappings for actions in the trouble list
         close = "q", -- close the list
+        cancel = "<esc>", -- cancel the preview and get back to your last window / buffer / cursor
         refresh = "r", -- manually refresh
-        jump = "<cr>", -- jump to the diagnostic or open / close folds
+        jump = {"<cr>", "<tab>"}, -- jump to the diagnostic or open / close folds
         toggle_mode = "m", -- toggle between "workspace" and "document" mode
         toggle_preview = "P", -- toggle auto_preview
         preview = "p", -- preview the diagnostic location
-        close_folds = "zM", -- close all folds
-        cancel = "<esc>", -- cancel the preview and get back to your last window / buffer / cursor
-        open_folds = "zR", -- open all folds
+        close_folds = {"zM", "zm"}, -- close all folds
+        open_folds = {"zR", "zr"}, -- open all folds
         previous = "k", -- preview item
         next = "j" -- next item
     },

diff --git a/lua/trouble/config.lua b/lua/trouble/config.lua
@@ -11,14 +11,14 @@ local defaults = {
     fold_closed = "", -- icon used for closed folds
     action_keys = { -- key mappings for actions in the trouble list
         close = "q", -- close the list
+        cancel = "<esc>", -- cancel the preview and get back to your last window / buffer / cursor
         refresh = "r", -- manually refresh
-        jump = "<cr>", -- jump to the diagnostic or open / close folds
+        jump = {"<cr>", "<tab>"}, -- jump to the diagnostic or open / close folds
         toggle_mode = "m", -- toggle between "workspace" and "document" mode
         toggle_preview = "P", -- toggle auto_preview
         preview = "p", -- preview the diagnostic location
-        close_folds = "zM", -- close all folds
-        cancel = "<esc>", -- cancel the preview and get back to your last window / buffer / cursor
-        open_folds = "zR", -- open all folds
+        close_folds = {"zM", "zm"}, -- close all folds
+        open_folds = {"zR", "zr"}, -- open all folds
         previous = "k", -- preview item
         next = "j" -- next item
     },

diff --git a/lua/trouble/view.lua b/lua/trouble/view.lua
@@ -133,11 +133,14 @@ function View:setup(opts)
     self:set_option("foldenable", false, true)
     self:set_option("winhighlight", "Normal:LspTroubleNormal", true)
 
-    for action, key in pairs(config.options.action_keys) do
-        vim.api.nvim_buf_set_keymap(self.buf, "n", key,
-                                    [[<cmd>lua require("trouble").action("]] ..
-                                        action .. [[")<cr>]],
-                                    {silent = true, noremap = true})
+    for action, keys in pairs(config.options.action_keys) do
+        if type(keys) == "string" then keys = {keys} end
+        for _, key in pairs(keys) do
+            vim.api.nvim_buf_set_keymap(self.buf, "n", key,
+                                        [[<cmd>lua require("trouble").action("]] ..
+                                            action .. [[")<cr>]],
+                                        {silent = true, noremap = true})
+        end
     end
 
     vim.api.nvim_win_set_height(self.win, config.options.height)