From 5b2d3652ba1519baeda75070924aba0fc6fc45a0 Mon Sep 17 00:00:00 2001
From: Lucas Barbieri <lucasbarbieri.c@gmail.com>
Date: Wed, 2 Aug 2023 15:18:04 -0300
Subject: [PATCH] add some descriptions for keybindings

---
 lua/jabuxas/remap.lua | 40 +++++++++++++++++-----------------------
 1 file changed, 17 insertions(+), 23 deletions(-)

diff --git a/lua/jabuxas/remap.lua b/lua/jabuxas/remap.lua
index 8b0e1e9..cdefd62 100644
--- a/lua/jabuxas/remap.lua
+++ b/lua/jabuxas/remap.lua
@@ -1,7 +1,7 @@
 local keymap = vim.keymap
 
-keymap.set("n", "<leader>pv", vim.cmd.Ex)
-keymap.set("n", "sf", vim.cmd.Ex)
+keymap.set("n", "<leader>pv", vim.cmd.Ex, { desc = "Start netrw" })
+keymap.set("n", "sf", vim.cmd.Ex, { desc = "Start netrw" })
 
 keymap.set("v", "J", ":m '>+1<CR>gv=gv")
 keymap.set("v", "K", ":m '<-2<CR>gv=gv")
@@ -13,42 +13,36 @@ keymap.set("n", "n", "nzzzv")
 keymap.set("n", "N", "Nzzzv")
 
 keymap.set("x", "<leader>p", [["_dP]])
-keymap.set({ "n", "v" }, "<leader>yy", [["+y]])
+keymap.set({ "n", "v" }, "<leader>yy", [["+y]], { desc = "copy to clipboard" })
 keymap.set("n", "<leader>Y", [["+Y]])
-keymap.set({ "n", "v" }, "<leader>dd", [["_d]])
+keymap.set({ "n", "v" }, "<leader>dd", [["_d]], { desc = "delete" })
 keymap.set("i", "<C-c>", "<Esc>")
 
 keymap.set("n", "Q", "<nop>")
 keymap.set("n", "<C-f>", "<cmd>silent !tmux neww tmux-sessionizer<CR>")
-keymap.set("n", "<leader>f", vim.lsp.buf.format)
+keymap.set("n", "<leader>f", vim.lsp.buf.format, { desc = "format current buffer" })
 
 keymap.set("n", "<A-k>", "<cmd>cnext<CR>zz")
 keymap.set("n", "<A-j>", "<cmd>cprev<CR>zz")
 keymap.set("n", "<leader>k", "<cmd>lnext<CR>zz")
 keymap.set("n", "<leader>j", "<cmd>lprev<CR>zz")
 
-keymap.set("n", "<leader>rr", [[:%s/\<<C-r><C-w>\>/<C-r><C-w>/gI<Left><Left><Left>]])
-keymap.set("n", "<leader>x", "<cmd>!chmod +x %<CR>", { silent = true })
+keymap.set("n", "<leader>rr", [[:%s/\<<C-r><C-w>\>/<C-r><C-w>/gI<Left><Left><Left>]], { desc = "replace current word" })
+keymap.set("n", "<leader>x", "<cmd>!chmod +x %<CR>", { silent = true, desc = "chmod +x current file" })
 
-keymap.set("t", "<leader><Esc>", [[<C-\><C-n>]])
+keymap.set("t", "<leader><Esc>", [[<C-\><C-n>]], { desc = "exit insert mode on builtin terminal" })
 
-keymap.set("n", "<leader>Sv", "<C-w>v")
-keymap.set("n", "<leader>Sh", "<C-w>s")
-keymap.set("n", "<leader>Se", "<C-w>=")
-keymap.set("n", "<leader>Sx", ":close<CR>")
-keymap.set("n", "<leader>S=", "<C-w>+")
-keymap.set("n", "<leader>S-", "<C-w>-")
+keymap.set("n", "<leader>Sv", "<C-w>v", { desc = "create split vertically" })
+keymap.set("n", "<leader>Sh", "<C-w>s", { desc = "create split horizontally" })
+keymap.set("n", "<leader>Se", "<C-w>=", { desc = "even out buffers" })
+keymap.set("n", "<leader>Sx", ":close<CR>", { desc = "close current split" })
 
--- keymap.set("n", "<C-h>", nvim_tmux_nav.NvimTmuxNavigateLeft)
--- keymap.set("n", "<C-j>", nvim_tmux_nav.NvimTmuxNavigateDown)
--- keymap.set("n", "<C-k>", nvim_tmux_nav.NvimTmuxNavigateUp)
--- keymap.set("n", "<C-l>", nvim_tmux_nav.NvimTmuxNavigateRight)
--- keymap.set("n", "<C-\\>", nvim_tmux_nav.NvimTmuxNavigateLastActive)
--- keymap.set("n", "<C-Space>", nvim_tmux_nav.NvimTmuxNavigateNext)
-keymap.set("n", "<leader>sm", "<Cmd>lua require('maximize').toggle()<CR>")
+keymap.set("n", "<leader>sm", "<Cmd>lua require('maximize').toggle()<CR>", { desc = "maximize current buffer" })
 
-keymap.set("n", "+", "<C-a>")
-keymap.set("n", "-", "<C-x>")
+keymap.set("n", "+", "<C-a>", { desc = "increment number on cursor" })
+keymap.set("n", "-", "<C-x>", { desc = "decrease number on cursor" })
+
+-- move splits around
 keymap.set("n", "<left>", "<C-w><")
 keymap.set("n", "<right>", "<C-w>>")
 keymap.set("n", "<up>", "<C-w>+")