From 6d5fa385d24399852dfdfd5d555e5c73dbe75c22 Mon Sep 17 00:00:00 2001
From: David JULIEN <swytch@mailo.com>
Date: Mon, 2 Jan 2023 19:47:28 +0100
Subject: [PATCH 1/4] [nvim] feat: add descriptions to mappings

---
 .config/nvim/lua/maps.lua | 69 ++++++++++++++++++++++++++++++---------
 1 file changed, 54 insertions(+), 15 deletions(-)

diff --git a/.config/nvim/lua/maps.lua b/.config/nvim/lua/maps.lua
index d0bcbd8..c0414ab 100644
--- a/.config/nvim/lua/maps.lua
+++ b/.config/nvim/lua/maps.lua
@@ -3,35 +3,74 @@
 -- License       : GPLv3
 -- Description   : neovim mappings file
 
-vim.keymap.set({ "n", "v" }, "<space>", "<Nop>", { silent = true })
+vim.keymap.set({ "n", "v" }, "<space>",
+    "<Nop>",
+    {
+        silent = true,
+        desc = "leader key"
+    })
 vim.g.mapleader = " "
 
 -- Dealing with word wrap
-vim.keymap.set("n", "k", "v:count == 0 ? 'gk' : 'k'",
-    { expr = true, silent = true })
-vim.keymap.set("n", "j", "v:count == 0 ? 'gj' : 'j'",
-    { expr = true, silent = true })
+vim.keymap.set("n", "k",
+    "v:count == 0 ? 'gk' : 'k'",
+    {
+        expr = true,
+        silent = true,
+        desc = "Smart up motion"
+    })
+vim.keymap.set("n", "j",
+    "v:count == 0 ? 'gj' : 'j'",
+    {
+        expr = true,
+        silent = true,
+        desc = "Smart down motion"
+    })
 
-vim.keymap.set("n", "<leader>y", "\"+y")
-vim.keymap.set("n", "<leader>p", "\"+P")
-vim.keymap.set("n", "<leader><enter>", "<cmd>w! | !compiler %<CR>")
-vim.keymap.set("n", "<leader>u", function() require("packer").sync() end)
+vim.keymap.set("n", "<leader>y",
+    "\"+y",
+    { desc = "Yank to clipboard"}
+)
+vim.keymap.set("n", "<leader>p",
+    "\"+P",
+    { desc = "Copy from clipboard"}
+)
+vim.keymap.set("n", "<leader><enter>",
+    "<cmd>w! | !compiler %<CR>",
+    { desc = "Compile current file using ~/.local/bin/compiler"}
+)
+vim.keymap.set("n", "<leader>u",
+    function() require("packer").sync() end,
+    { desc = "Sync packer config and update plugins"}
+)
 
 -- telescope
 vim.keymap.set("n", "<leader>tf",
-    function() require("telescope.builtin").find_files() end)
+    function() require("telescope.builtin").find_files() end,
+    { desc = "Fuzzy find files" }
+)
 vim.keymap.set("n", "<leader>tef",
-    function() require("telescope").extensions.file_browser.file_browser() end)
+    function() require("telescope").extensions.file_browser.file_browser() end,
+    { desc = "Open file browser" }
+)
 vim.keymap.set("n", "<leader>tb",
-    function() require("telescope.builtin").buffers() end)
+    function() require("telescope.builtin").buffers() end,
+    { desc = "Grep through buffers" }
+)
 vim.keymap.set("n", "<leader>tg",
-    function() require("telescope.builtin").grep_string() end)
+    function() require("telescope.builtin").grep_string() end,
+    { desc = "Grep current word" }
+)
 vim.keymap.set("n", "<leader>tl",
-    function() require("telescope.builtin").live_grep() end)
+    function() require("telescope.builtin").live_grep() end,
+    { desc = "Grep interactively" }
+)
 
 -- colorscheme
 vim.keymap.set("n", "<C-s>",
-    function() require("astronomy").toggle_variant() end)
+    function() require("astronomy").toggle_variant() end,
+    { desc = "Switch between dark and light colorscheme" }
+)
 
 -- snippets
 vim.keymap.set({ "i", "s" }, "<C-E>", "<Plug>luasnip-next-choice")

From 4ad4d956745ec6aac50acc42f7be19d0cbfecffd Mon Sep 17 00:00:00 2001
From: David JULIEN <swytch@mailo.com>
Date: Mon, 2 Jan 2023 19:56:23 +0100
Subject: [PATCH 2/4] [nvim] feat: remap telescope functionalities

---
 .config/nvim/lua/maps.lua | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/.config/nvim/lua/maps.lua b/.config/nvim/lua/maps.lua
index c0414ab..68de4d6 100644
--- a/.config/nvim/lua/maps.lua
+++ b/.config/nvim/lua/maps.lua
@@ -49,11 +49,11 @@ vim.keymap.set("n", "<leader>tf",
     function() require("telescope.builtin").find_files() end,
     { desc = "Fuzzy find files" }
 )
-vim.keymap.set("n", "<leader>tef",
+vim.keymap.set("n", "<leader>tb",
     function() require("telescope").extensions.file_browser.file_browser() end,
     { desc = "Open file browser" }
 )
-vim.keymap.set("n", "<leader>tb",
+vim.keymap.set("n", "<leader>t/",
     function() require("telescope.builtin").buffers() end,
     { desc = "Grep through buffers" }
 )

From 2445f4dc23d238b4ac0d6038745722f7bb6cecbe Mon Sep 17 00:00:00 2001
From: David JULIEN <swytch@mailo.com>
Date: Mon, 2 Jan 2023 19:56:45 +0100
Subject: [PATCH 3/4] [nvim] feat: add telescope.help_tags() mapping

---
 .config/nvim/lua/maps.lua | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/.config/nvim/lua/maps.lua b/.config/nvim/lua/maps.lua
index 68de4d6..0c8e12a 100644
--- a/.config/nvim/lua/maps.lua
+++ b/.config/nvim/lua/maps.lua
@@ -61,6 +61,10 @@ vim.keymap.set("n", "<leader>tg",
     function() require("telescope.builtin").grep_string() end,
     { desc = "Grep current word" }
 )
+vim.keymap.set("n", "<leader>th",
+    function() require("telescope.builtin").help_tags() end,
+    { desc = "Search through help" }
+)
 vim.keymap.set("n", "<leader>tl",
     function() require("telescope.builtin").live_grep() end,
     { desc = "Grep interactively" }

From 13ddf74c92af8577071519d4f970bd2a3c62a3f3 Mon Sep 17 00:00:00 2001
From: David JULIEN <swytch@mailo.com>
Date: Mon, 2 Jan 2023 20:17:56 +0100
Subject: [PATCH 4/4] [nvim] fix: use <leader> as prefix to switch colorscheme

---
 .config/nvim/lua/maps.lua | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/.config/nvim/lua/maps.lua b/.config/nvim/lua/maps.lua
index 0c8e12a..a6afe95 100644
--- a/.config/nvim/lua/maps.lua
+++ b/.config/nvim/lua/maps.lua
@@ -71,7 +71,7 @@ vim.keymap.set("n", "<leader>tl",
 )
 
 -- colorscheme
-vim.keymap.set("n", "<C-s>",
+vim.keymap.set("n", "<leader>s",
     function() require("astronomy").toggle_variant() end,
     { desc = "Switch between dark and light colorscheme" }
 )