satellite/dotfiles/neovim/lua/my/keymaps.lua

local helpers = require("my.helpers")

local M = {}

-- {{{ Helpers
---Performs a basic move operation
---Moves a keybind to a different set of keys.
---Useful for moving built in keybinds out of the way.
---@param from string
---@param to string
---@param opts table|nil
function M.move(from, to, opts)
  vim.keymap.set("n", to, from, opts)
  vim.keymap.set("n", from, "<Nop>")
end

---Create a textobject defined by some delimiters
---@param from string
---@param to string
---@param name string
---@param perhapsOpts table|nil
function M.delimitedTextobject(from, to, name, perhapsOpts)
  local opts = helpers.mergeTables(perhapsOpts or {}, { desc = name })

  vim.keymap.set({ "v", "o" }, "i" .. from, "i" .. to, opts)
  vim.keymap.set({ "v", "o" }, "a" .. from, "a" .. to, opts)
end

---Helper to create a normal mode mapping and give it some description.
---@param from string
---@param to string|function
---@param desc string
---@param silent boolean|nil
---@param isLocal boolean|nil
function M.nmap(from, to, desc, silent, isLocal)
  if silent == nil then
    silent = true
  end

  if isLocal == nil then
    isLocal = false
  end

  vim.keymap.set(
    "n",
    from,
    to,
    { desc = desc, silent = silent, buffer = isLocal }
  )
end

-- }}}

function M.setup()
  -- {{{ Free up q and Q
  M.move("q", "yq", { desc = "Record macro" })
  M.move("Q", "yQ")
  -- }}}
  -- {{{ Easier access to <C-^>
  M.move("<C-^>", "<Leader>a", { desc = "[A]lternate file" })
  -- }}}
  -- {{{ Quit all buffers
  M.nmap("Q", ":wqa<cr>", "Save all files and [q]uit")
  -- }}}
  -- {{{ Replace word in file
  M.nmap("<leader>rw", ":%s/<C-r><C-w>/", "[R]eplace [w]ord in file")
  -- }}}
  -- {{{ Text objects
  M.delimitedTextobject("q", '"', "[q]uotes")
  M.delimitedTextobject("a", "'", "[a]postrophes")
  M.delimitedTextobject("r", "[", "squa[r]e brackets")
  -- }}}
  -- {{{Diagnostic keymaps
  M.nmap("[d", vim.diagnostic.goto_prev, "Goto previous [d]iagnostic")
  M.nmap("]d", vim.diagnostic.goto_next, "Goto next [d]iagnostic")
  M.move("J", "qj")
  M.nmap("J", vim.diagnostic.open_float, "Open current diagnostic")
  M.nmap("<leader>D", vim.diagnostic.setloclist, "[D]iagnostic loclist")
  -- }}}
  -- {{{ Chords (save, clipboard)
  -- Different chords get mapped to f keys by a custom script of mine.
  -- In the future, I might get this on my keyboard firmware.
  vim.keymap.set({ "i", "v" }, "<f10>", "<Esc>", { desc = "Exit insert mode" }) -- Exit inset mode using *jk*
  vim.keymap.set({ "n", "v" }, "<f11>", '"+', { desc = "Use global clipboard" }) -- Use global clipboard with *cp*
  M.nmap("<f12>", ":silent write<cr>", "Save current file") -- Save using *ji*
  -- }}}
  -- {{{ Shift-Enter for not continuing the current comment
  -- This does not preserve intendation. Not sure what a better solution would look like.
  vim.keymap.set("i", "<S-CR>", function()
    vim.paste({ "", "" }, -1)
  end, { desc = "Insert newline without continuing the current comment" })
  -- }}}
  -- {{{ Allow quiting basic buffers with "qq"
  vim.api.nvim_create_autocmd("FileType", {
    pattern = { "help" },
    group = vim.api.nvim_create_augroup("BasicBufferQuitting", {}),
    callback = function(event)
      vim.keymap.set(
        "n",
        "qq",
        "<cmd>close<cr>",
        { buffer = event.buf, silent = true, desc = "[q]uit current buffer" }
      )
    end,
  })
  -- }}}

  -- {{{ Winblend
  vim.api.nvim_create_autocmd("FileType", {
    pattern = { "Telescope*" },
    group = vim.api.nvim_create_augroup("WinblendSettings", {}),
    callback = function()
      vim.opt.winblend = 0
    end,
  })
  -- }}}

  return M
end

return M