feat: Configurable keymaps. (closes #9)

Author: sindrets

README.md

@@ -18,7 +18,7 @@ or vertically respectively.
 
 ## Requirements
 
-- Neovim >=0.5.0
+- Neovim ≥ 0.5.0
 
 ## Installation
 
@@ -49,6 +49,27 @@ require("winshift").setup({
     cursorcolumn = false,
     colorcolumn = "",
   },
+  keymaps = {
+    disable_defaults = false, -- Disable the default keymaps
+    win_move_mode = {
+      ["h"] = "left",
+      ["j"] = "down",
+      ["k"] = "up",
+      ["l"] = "right",
+      ["H"] = "far_left",
+      ["J"] = "far_down",
+      ["K"] = "far_up",
+      ["L"] = "far_right",
+      ["<left>"] = "left",
+      ["<down>"] = "down",
+      ["<up>"] = "up",
+      ["<right>"] = "right",
+      ["<S-left>"] = "far_left",
+      ["<S-down>"] = "far_down",
+      ["<S-up>"] = "far_up",
+      ["<S-right>"] = "far_right",
+    },
+  },
   -- The window picker is used to select a window while swapping windows with
   -- ':WinShift swap'.
   -- A string of chars used as identifiers by the window picker.

doc/winshift.txt

@@ -34,7 +34,28 @@ Example configuration with default settings:
         cursorline = false,
         cursorcolumn = false,
         colorcolumn = "",
-      }
+      },
+      keymaps = {
+        disable_defaults = false, -- Disable the default keymaps
+        win_move_mode = {
+          ["h"] = "left",
+          ["j"] = "down",
+          ["k"] = "up",
+          ["l"] = "right",
+          ["H"] = "far_left",
+          ["J"] = "far_down",
+          ["K"] = "far_up",
+          ["L"] = "far_right",
+          ["<left>"] = "left",
+          ["<down>"] = "down",
+          ["<up>"] = "up",
+          ["<right>"] = "right",
+          ["<S-left>"] = "far_left",
+          ["<S-down>"] = "far_down",
+          ["<S-up>"] = "far_up",
+          ["<S-right>"] = "far_right",
+        },
+      },
     })
 <
 

lua/winshift/config.lua

@@ -11,6 +11,27 @@ M.defaults = {
     cursorcolumn = false,
     colorcolumn = "",
   },
+  keymaps = {
+    disable_defaults = false,
+    win_move_mode = {
+      ["h"] = "left",
+      ["j"] = "down",
+      ["k"] = "up",
+      ["l"] = "right",
+      ["H"] = "far_left",
+      ["J"] = "far_down",
+      ["K"] = "far_up",
+      ["L"] = "far_right",
+      ["<left>"] = "left",
+      ["<down>"] = "down",
+      ["<up>"] = "up",
+      ["<right>"] = "right",
+      ["<S-left>"] = "far_left",
+      ["<S-down>"] = "far_down",
+      ["<S-up>"] = "far_up",
+      ["<S-right>"] = "far_right",
+    },
+  },
   window_picker_chars = "ABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890",
   window_picker_ignore = {
     filetype = {},
@@ -22,6 +43,16 @@ M.defaults = {
 
 M._config = M.defaults
 
+function M.get_key_dir_map()
+  local t = {}
+
+  for lhs, rhs in pairs(M._config.keymaps.win_move_mode) do
+    t[utils.raw_key(lhs)] = rhs
+  end
+
+  return t
+end
+
 function M.get_config()
   return M._config
 end
@@ -34,6 +65,14 @@ function M.setup(user_config)
 
   M._config.moving_win_options = user_config.moving_win_options or M._config.moving_win_options
 
+  if M._config.keymaps.disable_defaults then
+    for name, _ in pairs(M._config.keymaps) do
+      if name ~= "disable_defaults" then
+        M._config.keymaps[name] = vim.tbl_get(user_config, "keymaps", name) or {}
+      end
+    end
+  end
+
   require("winshift.colors").setup()
 end
 

lua/winshift/lib.lua

@@ -17,25 +17,6 @@ local win_option_store = {}
 ---@alias VDirection '"up"'|'"down"'
 ---@alias Direction HDirection|VDirection|'"far_left"'|'"far_right"'|'"far_up"'|'"far_down"'
 
-M.key_dir_map = {
-  h = "left",
-  j = "down",
-  k = "up",
-  l = "right",
-  H = "far_left",
-  J = "far_down",
-  K = "far_up",
-  L = "far_right",
-  [utils.raw_key("<left>")] = "left",
-  [utils.raw_key("<down>")] = "down",
-  [utils.raw_key("<up>")] = "up",
-  [utils.raw_key("<right>")] = "right",
-  [utils.raw_key("<S-left>")] = "far_left",
-  [utils.raw_key("<S-down>")] = "far_down",
-  [utils.raw_key("<S-up>")] = "far_up",
-  [utils.raw_key("<S-right>")] = "far_right",
-}
-
 M.dir_move_map = {
   far_left = "H",
   far_down = "J",
@@ -540,6 +521,7 @@ function M.start_move_mode()
   local cur_win = api.nvim_get_current_win()
   local lasthl = vim.wo[cur_win].winhl
   local conf = config.get_config()
+  local key_dir_map = config.get_key_dir_map()
   M.save_win_options(cur_win)
 
   if conf.highlight_moving_win then
@@ -552,7 +534,7 @@ function M.start_move_mode()
     while not (char == "q" or raw == esc) do
       api.nvim_echo({ { "-- WIN MOVE MODE -- press 'q' to exit", "ModeMsg" } }, false, {})
       char, raw = utils.input_char(nil, { clear_prompt = false, allow_non_ascii = true })
-      local dir = M.key_dir_map[char or raw]
+      local dir = key_dir_map[char or raw]
       if dir then
         M.move_win(cur_win, dir)
       end