Tidy up Neovim key mappings

Author: notahat

config/nvim/lua/key-mappings.lua

@@ -1,29 +1,45 @@
+local actions = require("actions")
+local bufdelete = require("bufdelete")
+local gitsigns = require("gitsigns")
+local refactoring = require("refactoring")
+local telescope = require("telescope.builtin")
+local treesj = require("treesj")
+local which_key = require("which-key")
+
 local map = vim.keymap.set
 
+-- The first parameter to map is the modes in which the mappings apply.
+--
+-- An empty string sets the mapping for:
+--
+-- * Normal (n)
+-- * Visual (x)
+-- * Select (s)
+-- * Operator (o)
+--
+-- Note that "v" means both visual (x) and select (s) modes.
+--
+-- See Neovim's help for map-modes
+
+-- Most of my keys are mapped in normal, visual, and operator modes, but not
+-- select mode. I don't want to map printable characters in select mode.
+local nxo = { "n", "x", "o" }
+
 -- Set up mappings available in all buffers.
 local function map_global_keys()
-    local actions = require("actions")
-    local bufdelete = require("bufdelete")
-    local gitsigns = require("gitsigns")
-    local refactoring = require("refactoring")
-    local repeatable_move = require("nvim-treesitter.textobjects.repeatable_move")
-    local telescope = require("telescope.builtin")
-    local treesj = require("treesj")
-    local which_key = require("which-key")
-
     -- Things I do often enough get a top-level mapping.
-    map("", "<leader><leader>", telescope.find_files, { desc = "find files" })
-    map("", "<leader>*", telescope.grep_string, { desc = "find word under cursor" })
-    map("", "<leader>/", vim.cmd.nohlsearch, { desc = "clear search" })
-    map("", "<leader>d", vim.diagnostic.open_float, { desc = "show diagnostics under cursor" })
-    map("", "<leader>e", actions.toggle_neo_tree, { desc = "toggle neo-tree explorer" })
-    map("", "<leader>f", actions.show_current_file_in_neo_tree, { desc = "show current file in neo-tree" })
-    map("", "<leader>Q", actions.write_all_and_quit, { desc = "save all files and quit" })
-    map("", "<leader>R", actions.restore_session, { desc = "restore previoius session" })
-    map("", "<leader>s", actions.write_all, { desc = "save all files" })
-    map("", "<leader>S", actions.save_session_and_quit, { desc = "Save session" })
-    map("", "<leader>W", vim.cmd.close, { desc = "close window" })
-    map("", "<leader>X", bufdelete.bufdelete, { desc = "close buffer" })
+    map(nxo, "<leader><leader>", telescope.find_files, { desc = "find files" })
+    map(nxo, "<leader>*", telescope.grep_string, { desc = "find word under cursor" })
+    map(nxo, "<leader>/", vim.cmd.nohlsearch, { desc = "clear search" })
+    map(nxo, "<leader>d", vim.diagnostic.open_float, { desc = "show diagnostics under cursor" })
+    map(nxo, "<leader>e", actions.toggle_neo_tree, { desc = "toggle neo-tree explorer" })
+    map(nxo, "<leader>f", actions.show_current_file_in_neo_tree, { desc = "show current file in neo-tree" })
+    map(nxo, "<leader>Q", actions.write_all_and_quit, { desc = "save all files and quit" })
+    map(nxo, "<leader>R", actions.restore_session, { desc = "restore previoius session" })
+    map(nxo, "<leader>s", actions.write_all, { desc = "save all files" })
+    map(nxo, "<leader>S", actions.save_session_and_quit, { desc = "Save session" })
+    map(nxo, "<leader>W", vim.cmd.close, { desc = "close window" })
+    map(nxo, "<leader>X", bufdelete.bufdelete, { desc = "close buffer" })
 
     -- Make command keys do sensible things. There some stuff in kitty.conf to
     -- tell Kitty to pass these through to Neovim.
@@ -36,39 +52,29 @@ local function map_global_keys()
     map("v", "<D-x>", '"*d', { desc = "cut to system clipboard" })
 
     which_key.register({ ["<leader>c"] = { name = "code changes" } })
-    map("", "<leader>cj", treesj.join, { desc = "join lines" })
-    map("", "<leader>cf", refactoring.select_refactor, { desc = "refactor" })
-    map("", "<leader>cs", treesj.split, { desc = "split lines" })
+    map(nxo, "<leader>cj", treesj.join, { desc = "join lines" })
+    map(nxo, "<leader>cf", refactoring.select_refactor, { desc = "refactor" })
+    map(nxo, "<leader>cs", treesj.split, { desc = "split lines" })
 
     which_key.register({ ["<leader>g"] = { name = "git" } })
-    map("", "<leader>gb", gitsigns.blame_line, { desc = "git blame" })
-    map("", "<leader>gc", actions.choose_git_base, { desc = "change git base" })
-    map("", "<leader>gh", actions.browse_on_github, { desc = "browse on github" })
-    map("", "<leader>gp", gitsigns.preview_hunk_inline, { desc = "preview hunk" })
+    map(nxo, "<leader>gb", gitsigns.blame_line, { desc = "git blame" })
+    map(nxo, "<leader>gc", actions.choose_git_base, { desc = "change git base" })
+    map(nxo, "<leader>gh", actions.browse_on_github, { desc = "browse on github" })
+    map(nxo, "<leader>gp", gitsigns.preview_hunk_inline, { desc = "preview hunk" })
 
     which_key.register({ ["<leader>t"] = { name = "telescope" } })
-    map("", "<leader>t.", telescope.resume, { desc = "repeat last find" })
-    map("", "<leader>t/", telescope.live_grep, { desc = "live grep" })
-    map("", "<leader>tb", telescope.buffers, { desc = "find buffers" })
-    map("", "<leader>td", telescope.diagnostics, { desc = "find diagnostics" })
-    map("", "<leader>tg", telescope.git_status, { desc = "find git status" })
-    map("", "<leader>th", telescope.help_tags, { desc = "find help" })
-    map("", "<leader>tj", telescope.jumplist, { desc = "find in jumplist" })
-    map("", "<leader>tt", telescope.builtin, { desc = "find telescope builtins" })
+    map(nxo, "<leader>t.", telescope.resume, { desc = "repeat last find" })
+    map(nxo, "<leader>t/", telescope.live_grep, { desc = "live grep" })
+    map(nxo, "<leader>tb", telescope.buffers, { desc = "find buffers" })
+    map(nxo, "<leader>td", telescope.diagnostics, { desc = "find diagnostics" })
+    map(nxo, "<leader>tg", telescope.git_status, { desc = "find git status" })
+    map(nxo, "<leader>th", telescope.help_tags, { desc = "find help" })
+    map(nxo, "<leader>tj", telescope.jumplist, { desc = "find in jumplist" })
+    map(nxo, "<leader>tt", telescope.builtin, { desc = "find telescope builtins" })
 
     -- Move around in the buffer
-    map({ "n", "x", "o" }, "[g", gitsigns.prev_hunk, { desc = "previous git hunk in buffer" })
-    map({ "n", "x", "o" }, "]g", gitsigns.next_hunk, { desc = "next git hunk in buffer" })
-
-    -- Make , and ; repeat the last move.
-    map({ "n", "x", "o" }, ";", repeatable_move.repeat_last_move_next)
-    map({ "n", "x", "o" }, ",", repeatable_move.repeat_last_move_previous)
-
-    -- Make repeating the builtins work properly too.
-    map({ "n", "x", "o" }, "f", repeatable_move.builtin_f)
-    map({ "n", "x", "o" }, "F", repeatable_move.builtin_F)
-    map({ "n", "x", "o" }, "t", repeatable_move.builtin_t)
-    map({ "n", "x", "o" }, "T", repeatable_move.builtin_T)
+    map(nxo, "[g", gitsigns.prev_hunk, { desc = "previous git hunk in buffer" })
+    map(nxo, "]g", gitsigns.next_hunk, { desc = "next git hunk in buffer" })
 
     -- Navigate between windows
     map("", "<c-h>", "<c-w>h")
@@ -77,23 +83,21 @@ local function map_global_keys()
     map("", "<c-l>", "<c-w>l")
 
     -- Reselect the visual area when changing indenting in visual mode
-    map("v", "<", "<gv")
-    map("v", ">", ">gv")
+    map("x", "<", "<gv")
+    map("x", ">", ">gv")
 end
 
 -- Set up mappings for buffers with a language server attached.
 local function map_lsp_keys(args)
     local buffer = args.buf
 
-    local telescope = require("telescope.builtin")
-
-    map({ "n", "x", "o" }, "gd", telescope.lsp_definitions, { buffer = buffer, desc = "Go to defintion" })
-    map({ "n", "x", "o" }, "gr", telescope.lsp_references, { buffer = buffer, desc = "Go to references" })
+    map(nxo, "gd", telescope.lsp_definitions, { buffer = buffer, desc = "Go to defintion" })
+    map(nxo, "gr", telescope.lsp_references, { buffer = buffer, desc = "Go to references" })
 
-    map("", "<leader>ca", vim.lsp.buf.code_action, { buffer = buffer, desc = "code actions" })
-    map("", "<leader>cr", vim.lsp.buf.rename, { buffer = buffer, desc = "rename symbol under cursor" })
+    map(nxo, "<leader>ca", vim.lsp.buf.code_action, { buffer = buffer, desc = "code actions" })
+    map(nxo, "<leader>cr", vim.lsp.buf.rename, { buffer = buffer, desc = "rename symbol under cursor" })
 
-    map("", "<leader>ts", telescope.lsp_document_symbols, { buffer = buffer, desc = "find document symbols" })
+    map(nxo, "<leader>ts", telescope.lsp_document_symbols, { buffer = buffer, desc = "find document symbols" })
 end
 
 -- This sets things up so we tell Kitty when Neovim is open, so it can pass

config/nvim/lua/plugin-specs/treesitter.lua

@@ -50,6 +50,25 @@ local treesitter_spec = {
             highlight = { enable = true },
             textobjects = treesitter_textobjects,
         })
+
+        -- Make Treesitter movements are repeatable.
+        --
+        -- Taken from:
+        -- https://github.com/nvim-treesitter/nvim-treesitter-textobjects?tab=readme-ov-file#text-objects-move
+
+        local repeatable_move = require("nvim-treesitter.textobjects.repeatable_move")
+        local map = vim.keymap.set
+        local nxo = { "n", "x", "o" }
+
+        -- Make , and ; repeat the last Treesitter move.
+        map(nxo, ";", repeatable_move.repeat_last_move_next)
+        map(nxo, ",", repeatable_move.repeat_last_move_previous)
+
+        -- Make repeating the builtins work properly too.
+        map(nxo, "f", repeatable_move.builtin_f)
+        map(nxo, "F", repeatable_move.builtin_F)
+        map(nxo, "t", repeatable_move.builtin_t)
+        map(nxo, "T", repeatable_move.builtin_T)
     end,
 }