Define keymappings using a mapping table (#753)

:rocket:

lua/keymappings.lua

@@ -1,83 +1,106 @@
--- better window movement
-vim.api.nvim_set_keymap("n", "<C-h>", "<C-w>h", { silent = true })
-vim.api.nvim_set_keymap("n", "<C-j>", "<C-w>j", { silent = true })
-vim.api.nvim_set_keymap("n", "<C-k>", "<C-w>k", { silent = true })
-vim.api.nvim_set_keymap("n", "<C-l>", "<C-w>l", { silent = true })
+local function register_mappings(mappings, default_options)
+  for mode, mode_mappings in pairs(mappings) do
+    for _, mapping in pairs(mode_mappings) do
+      local options = #mapping == 3 and table.remove(mapping) or default_options
+      local prefix, cmd = unpack(mapping)
+      pcall(vim.api.nvim_set_keymap, mode, prefix, cmd, options)
+    end
+  end
+end
 
--- Terminal window navigation
-vim.api.nvim_set_keymap("t", "<C-h>", "<C-\\><C-N><C-w>h", { silent = true, noremap = true })
-vim.api.nvim_set_keymap("t", "<C-j>", "<C-\\><C-N><C-w>j", { silent = true, noremap = true })
-vim.api.nvim_set_keymap("t", "<C-k>", "<C-\\><C-N><C-w>k", { silent = true, noremap = true })
-vim.api.nvim_set_keymap("t", "<C-l>", "<C-\\><C-N><C-w>l", { silent = true, noremap = true })
-vim.api.nvim_set_keymap("i", "<C-h>", "<C-\\><C-N><C-w>h", { silent = true, noremap = true })
-vim.api.nvim_set_keymap("i", "<C-j>", "<C-\\><C-N><C-w>j", { silent = true, noremap = true })
-vim.api.nvim_set_keymap("i", "<C-k>", "<C-\\><C-N><C-w>k", { silent = true, noremap = true })
-vim.api.nvim_set_keymap("i", "<C-l>", "<C-\\><C-N><C-w>l", { silent = true, noremap = true })
+local mappings = {
+  i = { -- Insert mode
+    -- I hate escape
+    { "jk", "<ESC>" },
+    { "kj", "<ESC>" },
+    { "jj", "<ESC>" },
 
--- TODO: fix this
--- resize with arrows
-if vim.fn.has "mac" == 1 then
-  vim.api.nvim_set_keymap("n", "<C-Up>", ":resize -2<CR>", { silent = true })
-  vim.api.nvim_set_keymap("n", "<C-Down>", ":resize +2<CR>", { silent = true })
-  vim.api.nvim_set_keymap("n", "<C-Left>", ":vertical resize -2<CR>", { silent = true })
-  vim.api.nvim_set_keymap("n", "<C-Right>", ":vertical resize +2<CR>", { silent = true })
-else
-  vim.api.nvim_set_keymap("n", "<C-Up>", ":resize -2<CR>", { silent = true })
-  vim.api.nvim_set_keymap("n", "<C-Down>", ":resize +2<CR>", { silent = true })
-  vim.api.nvim_set_keymap("n", "<C-Left>", ":vertical resize -2<CR>", { silent = true })
-  vim.api.nvim_set_keymap("n", "<C-Right>", ":vertical resize +2<CR>", { silent = true })
-end
+    -- Move current line / block with Alt-j/k ala vscode.
+    { "<A-j>", "<Esc>:m .+1<CR>==gi" },
+    { "<A-k>", "<Esc>:m .-2<CR>==gi" },
 
--- better indenting
-vim.api.nvim_set_keymap("v", "<", "<gv", { noremap = true, silent = true })
-vim.api.nvim_set_keymap("v", ">", ">gv", { noremap = true, silent = true })
+    -- Terminal window navigation
+    { "<C-h>", "<C-\\><C-N><C-w>h" },
+    { "<C-j>", "<C-\\><C-N><C-w>j" },
+    { "<C-k>", "<C-\\><C-N><C-w>k" },
+    { "<C-l>", "<C-\\><C-N><C-w>l" },
+  },
+  n = { -- Normal mode
+    -- Better window movement
+    { "<C-h>", "<C-w>h", { silent = true } },
+    { "<C-j>", "<C-w>j", { silent = true } },
+    { "<C-k>", "<C-w>k", { silent = true } },
+    { "<C-l>", "<C-w>l", { silent = true } },
 
--- I hate escape
-vim.api.nvim_set_keymap("i", "jk", "<ESC>", { noremap = true, silent = true })
-vim.api.nvim_set_keymap("i", "kj", "<ESC>", { noremap = true, silent = true })
-vim.api.nvim_set_keymap("i", "jj", "<ESC>", { noremap = true, silent = true })
+    -- Resize with arrows
+    { "<C-Up>", ":resize -2<CR>", { silent = true } },
+    { "<C-Down>", ":resize +2<CR>", { silent = true } },
+    { "<C-Left>", ":vertical resize -2<CR>", { silent = true } },
+    { "<C-Right>", ":vertical resize +2<CR>", { silent = true } },
 
--- Tab switch buffer
--- vim.api.nvim_set_keymap("n", "<TAB>", ":bnext<CR>", { noremap = true, silent = true })
--- vim.api.nvim_set_keymap("n", "<S-TAB>", ":bprevious<CR>", { noremap = true, silent = true })
+    -- Tab switch buffer
+    -- { "<TAB>", ":bnext<CR>" },
+    -- { "<S-TAB>", ":bprevious<CR>" },
 
--- Move selected line / block of text in visual mode
-vim.api.nvim_set_keymap("x", "K", ":move '<-2<CR>gv-gv", { noremap = true, silent = true })
-vim.api.nvim_set_keymap("x", "J", ":move '>+1<CR>gv-gv", { noremap = true, silent = true })
+    -- Move current line / block with Alt-j/k a la vscode.
+    { "<A-j>", ":m .+1<CR>==" },
+    { "<A-k>", ":m .-2<CR>==" },
 
--- Move current line / block with Alt-j/k ala vscode.
-vim.api.nvim_set_keymap("n", "<A-j>", ":m .+1<CR>==", { noremap = true, silent = true })
-vim.api.nvim_set_keymap("n", "<A-k>", ":m .-2<CR>==", { noremap = true, silent = true })
-vim.api.nvim_set_keymap("i", "<A-j>", "<Esc>:m .+1<CR>==gi", { noremap = true, silent = true })
-vim.api.nvim_set_keymap("i", "<A-k>", "<Esc>:m .-2<CR>==gi", { noremap = true, silent = true })
-vim.api.nvim_set_keymap("x", "<A-j>", ":m '>+1<CR>gv-gv", { noremap = true, silent = true })
-vim.api.nvim_set_keymap("x", "<A-k>", ":m '<-2<CR>gv-gv", { noremap = true, silent = true })
+    -- QuickFix
+    { "]q", ":cnext<CR>" },
+    { "[q", ":cprev<CR>" },
 
--- QuickFix
-vim.api.nvim_set_keymap("n", "]q", ":cnext<CR>", { noremap = true, silent = true })
-vim.api.nvim_set_keymap("n", "[q", ":cprev<CR>", { noremap = true, silent = true })
+    -- {'<C-TAB>', 'compe#complete()', {noremap = true, silent = true, expr = true}},
+  },
+  t = { -- Terminal mode
+    -- Terminal window navigation
+    { "<C-h>", "<C-\\><C-N><C-w>h" },
+    { "<C-j>", "<C-\\><C-N><C-w>j" },
+    { "<C-k>", "<C-\\><C-N><C-w>k" },
+    { "<C-l>", "<C-\\><C-N><C-w>l" },
+  },
+  v = { -- Visual/Select mode
+    -- Better indenting
+    { "<", "<gv" },
+    { ">", ">gv" },
 
--- Better nav for omnicomplete
-vim.cmd 'inoremap <expr> <c-j> ("\\<C-n>")'
-vim.cmd 'inoremap <expr> <c-k> ("\\<C-p>")'
+    { "p", '"0p', { silent = true } },
+    { "P", '"0P', { silent = true } },
+  },
+  x = { -- Visual mode
+    -- Move selected line / block of text in visual mode
+    { "K", ":move '<-2<CR>gv-gv" },
+    { "J", ":move '>+1<CR>gv-gv" },
 
-vim.cmd 'vnoremap p "0p'
-vim.cmd 'vnoremap P "0P'
+    -- Move current line / block with Alt-j/k ala vscode.
+    { "<A-j>", ":m '>+1<CR>gv-gv" },
+    { "<A-k>", ":m '<-2<CR>gv-gv" },
+  },
+  [""] = {
+    -- Toggle the QuickFix window
+    { "<C-q>", ":call QuickFixToggle()<CR>" },
+  },
+}
 
--- vim.api.nvim_set_keymap('v', 'p', '"0p', {silent = true})
--- vim.api.nvim_set_keymap('v', 'P', '"0P', {silent = true})
+-- TODO: fix this
+if vim.fn.has "mac" == 1 then
+  mappings["n"][5][1] = "<A-Up>"
+  mappings["n"][6][1] = "<A-Down>"
+  mappings["n"][7][1] = "<A-Left>"
+  mappings["n"][8][1] = "<A-Right>"
+end
+
+register_mappings(mappings, { silent = true, noremap = true })
+
+vim.cmd 'inoremap <expr> <c-j> ("\\<C-n>")'
+vim.cmd 'inoremap <expr> <c-k> ("\\<C-p>")'
 
 -- vim.cmd('inoremap <expr> <TAB> (\"\\<C-n>\")')
 -- vim.cmd('inoremap <expr> <S-TAB> (\"\\<C-p>\")')
 
--- vim.api.nvim_set_keymap('i', '<C-TAB>', 'compe#complete()', {noremap = true, silent = true, expr = true})
-
 -- vim.cmd([[
 -- map p <Plug>(miniyank-autoput)
 -- map P <Plug>(miniyank-autoPut)
 -- map <leader>n <Plug>(miniyank-cycle)
 -- map <leader>N <Plug>(miniyank-cycleback)
 -- ]])
-
--- Toggle the QuickFix window
-vim.api.nvim_set_keymap("", "<C-q>", ":call QuickFixToggle()<CR>", { noremap = true, silent = true })