Nvim: convert keymaps to vim.keymap.set and/or which-key.register

home/.config/nvim/init.lua

@@ -1,5 +1,4 @@
 require 'autocmd'
 require 'keybinds'
 require 'settings'
-require 'common'
 require 'plugins/init'

home/.config/nvim/lua/common.lua

@@ -1,5 +0,0 @@
-function MapKey(mode, keybind, command, opts)
-    local options = {noremap = true}
-    if opts then options = vim.tbl_extend('force', options, opts) end
-    vim.api.nvim_set_keymap(mode, keybind, command, options)
-end

home/.config/nvim/lua/keybinds.lua

@@ -1,26 +1,26 @@
-require 'common'
+local map = vim.keymap.set
 
 -- Open/close tree browser
-MapKey('n', '<C-T>', '<cmd>NvimTreeToggle<CR>')
+map('n', '<C-T>', '<cmd>NvimTreeToggle<CR>')
 
 -- Telescope
-MapKey('n', '<C-f>', '<cmd>Telescope find_files find_command=fd,-Ht,f<CR>')
-MapKey('n', '<C-g>', '<cmd>Telescope live_grep<CR>')
+map('n', '<C-f>', '<cmd>Telescope find_files find_command=fd,-Ht,f<CR>')
+map('n', '<C-g>', '<cmd>Telescope live_grep<CR>')
 
 -- Completion
 -- Navigate completions with tab and shift tab
-MapKey('i', '<S-Tab>', 'pumvisible() ? "\\<C-p>" : "\\<Tab>"', {expr = true})
-MapKey('i', '<Tab>', 'pumvisible() ? "\\<C-n>" : "\\<Tab>"', {expr = true})
+map('i', '<S-Tab>', 'pumvisible() ? "\\<C-p>" : "\\<Tab>"', {expr = true})
+map('i', '<Tab>', 'pumvisible() ? "\\<C-n>" : "\\<Tab>"', {expr = true})
 
 -- Navigate between buffers
-MapKey('n', '<C-N>', ':bn<CR>', {silent = true})
-MapKey('n', '<C-B>', ':bp<CR>', {silent = true})
+map('n', '<C-N>', ':bn<CR>', {silent = true})
+map('n', '<C-B>', ':bp<CR>', {silent = true})
 
 -- Navigate between splits
-MapKey('n', '<C-H>', '<C-W><C-H>')
-MapKey('n', '<C-J>', '<C-W><C-J>')
-MapKey('n', '<C-K>', '<C-W><C-K>')
-MapKey('n', '<C-L>', '<C-W><C-L>')
+map('n', '<C-H>', '<C-W><C-H>')
+map('n', '<C-J>', '<C-W><C-J>')
+map('n', '<C-K>', '<C-W><C-K>')
+map('n', '<C-L>', '<C-W><C-L>')
 
 -- Run Neoformat
-MapKey('n', '<M-f>', '<cmd>Neoformat<CR>')
+map('n', '<M-f>', '<cmd>Neoformat<CR>')

home/.config/nvim/lua/pager.lua

@@ -1,5 +1,2 @@
 -- Settings for pager mode
-require 'common'
-
-MapKey('n', 'q', '<cmd>q<CR>')
--- vim.cmd('set nomodifiable')
+vim.keymap.set('n', 'q', vim.cmd.q)

home/.config/nvim/lua/plugins/lspconfig.lua

@@ -12,9 +12,7 @@ Servers = {
         Lua = {
             runtime = {
                 -- Tell the language server which version of Lua you're using (most likely LuaJIT in the case of Neovim)
-                version = 'LuaJIT',
-                -- Setup your lua path
-                path = vim.split(package.path, ';')
+                version = 'LuaJIT'
             },
             diagnostics = {
                 -- Get the language server to recognize the `vim` global
@@ -32,67 +30,65 @@ Servers = {
 
 M = {}
 
-function M.map_keys(server, bufnr)
-    local function map_key(...)
-        -- Map to buffer if buffer number is supplied,
-        -- globally otherwise
-        if bufnr == nil then
-            vim.api.nvim_set_keymap(...)
-        else
-            vim.api.nvim_buf_set_keymap(bufnr, ...)
-        end
-    end
+function M.map_keys()
+    -- Register keybindings via which-key
+    -- to get documentation in which-key
+    local wk = require('which-key')
+    wk.register({
+        g = {
+            name = "Go to",
+            d = {vim.lsp.buf.definition, "Definition"},
+            D = {vim.lsp.buf.declaration, "Declaration"},
+            i = {vim.lsp.buf.implementation, "Implementation"},
+            r = {vim.lsp.buf.references, "References"}
+        },
+        ['<leader>'] = {
+            name = "Leader",
+            w = {
+                name = "Workspace",
+                a = {vim.lsp.buf.add_workspace_folder, "Add folder"},
+                r = {vim.lsp.buf.remove_workspace_folder, "Remove folder"},
+                l = {
+                    function()
+                        print(vim.inspect(vim.lsp.buf.list_workspace_folders()))
+                    end, "List folders"
+                }
+            },
+            D = {vim.lsp.buf.type_definition, "Type definition"},
+            rn = {vim.lsp.buf.rename, "Rename symbol"},
+            ca = {vim.lsp.buf.code_action, "Code action"},
+            e = {vim.diagnostic.open_float, "Open diagnostics"},
+            f = {vim.lsp.buf.format, "Format"}
+        },
+        K = {vim.lsp.buf.hover, "Hover"},
+        ['['] = {d = {vim.diagnostic.goto_prev, "Previous diagnostic"}},
+        [']'] = {d = {vim.diagnostic.goto_next, "Next diagnostic"}}
 
-    local keymapOpts = {noremap = true, silent = true}
-    map_key('n', 'gD', '<cmd>lua vim.lsp.buf.declaration()<CR>', keymapOpts)
-    map_key('n', 'gd', '<cmd>lua vim.lsp.buf.definition()<CR>', keymapOpts)
-    map_key('n', 'K', '<cmd>lua vim.lsp.buf.hover()<CR>', keymapOpts)
-    map_key('n', 'gi', '<cmd>lua vim.lsp.buf.implementation()<CR>', keymapOpts)
-    map_key('n', '<C-k>', '<cmd>lua vim.lsp.buf.signature_help()<CR>',
-            keymapOpts)
-    map_key('n', '<leader>wa', '<cmd>lua vim.lsp.buf.add_workspace_folder()<CR>',
-            keymapOpts)
-    map_key('n', '<leader>wr',
-            '<cmd>lua vim.lsp.buf.remove_workspace_folder()<CR>', keymapOpts)
-    map_key('n', '<leader>wl',
-            '<cmd>lua print(vim.inspect(vim.lsp.buf.list_workspace_folders()))<CR>',
-            keymapOpts)
-    map_key('n', '<leader>D', '<cmd>lua vim.lsp.buf.type_definition()<CR>',
-            keymapOpts)
-    map_key('n', '<leader>rn', '<cmd>lua vim.lsp.buf.rename()<CR>', keymapOpts)
-    map_key('n', '<leader>ca', '<cmd>lua vim.lsp.buf.code_action()<CR>',
-            keymapOpts)
-    map_key('n', 'gr', '<cmd>lua vim.lsp.buf.references()<CR>', keymapOpts)
-    map_key('n', '<leader>e',
-            '<cmd>lua vim.lsp.diagnostic.show_line_diagnostics()<CR>',
-            keymapOpts)
-    map_key('n', '[d', '<cmd>lua vim.diagnostic.goto_prev()<CR>', keymapOpts)
-    map_key('n', ']d', '<cmd>lua vim.diagnostic.goto_next()<CR>', keymapOpts)
-    map_key('n', '<leader>q', '<cmd>lua vim.diagnostic.set_loclist()<CR>',
-            keymapOpts)
-    map_key('n', '<leader>f', '<cmd>lua vim.lsp.buf.format()<CR>', keymapOpts)
+    })
 end
 
 function M.setup()
 
-    local function on_attach(server, bufnr)
+    local function on_attach()
         -- Setup lsp signature plugin
         require('lsp_signature').setup {}
 
         -- Setup keybinds
-        M.map_keys(server, bufnr)
+        M.map_keys()
     end
 
+    -- Update capabilities
+    local capabilities = vim.lsp.protocol.make_client_capabilities()
+    capabilities = require('cmp_nvim_lsp').update_capabilities(capabilities)
+
     -- Setup every defined server
     for server, settings in pairs(Servers) do
         require('lspconfig')[server].setup {
             on_attach = on_attach,
             settings = settings,
-            -- Updates capabilities to cmp.nvim and
-            -- informs the server about the client capabilities
-            capabilities = require('cmp_nvim_lsp').update_capabilities(vim.lsp
-                                                                           .protocol
-                                                                           .make_client_capabilities())
+            -- Inform lsp server about client
+            -- capabilities
+            capabilities = capabilities
         }
     end
 end