feat(config/nvim): add todo-comments.nvim

By folke the GOAT. Allows smooth navigation of todos comments in any
project files. Also comes with highlighting and easy navigation with
telescope integration. Really nice to things I always want to go back to
but never do.

TODO: Might now begin adding a hook in projects to prevent commit if there
contains 1 or more TODO comments. No pun intended!

Author: mbugva

.config/nvim/lazy-lock.json

@@ -19,6 +19,7 @@
   "plenary.nvim": { "branch": "master", "commit": "857c5ac632080dba10aae49dba902ce3abf91b35" },
   "snacks.nvim": { "branch": "main", "commit": "5eac729fa290248acfe10916d92a5ed5e5c0f9ed" },
   "telescope.nvim": { "branch": "master", "commit": "a0bbec21143c7bc5f8bb02e0005fa0b982edc026" },
+  "todo-comments.nvim": { "branch": "main", "commit": "ae0a2afb47cf7395dc400e5dc4e05274bf4fb9e0" },
   "toggleterm.nvim": { "branch": "main", "commit": "50ea089fc548917cc3cc16b46a8211833b9e3c7c" },
   "vim-wakatime": { "branch": "master", "commit": "cf51327a9e08935569614d1cb24e779ee9f45519" },
   "which-key.nvim": { "branch": "main", "commit": "fcbf4eea17cb299c02557d576f0d568878e354a4" }

.config/nvim/lua/config/keymaps.lua

@@ -88,7 +88,6 @@ end
 vim.keymap.set("n", "<C-p>", "<cmd> :lua PYTHON_TOGGLE()<CR> <cmd>")
 vim.keymap.set("i", "<C-p>", "<cmd> :lua PYTHON_TOGGLE()<CR> <cmd>")
 
-
 -- open mysql
 local mysql = Terminal:new({ cmd = "mysql -u root -p", hidden = true })
 
@@ -98,11 +97,11 @@ end
 vim.keymap.set("n", "<C-m>", "<cmd> :lua MYSQL_TOGGLE()<CR> <cmd>")
 vim.keymap.set("i", "<C-m>", "<cmd> :lua MYSQL_TOGGLE()<CR> <cmd>")
 
--- open htop
--- local htop = Terminal:new({ cmd = "htop", hidden = true })
---
--- function HTOP_TOGGLE()
--- 	htop:toggle()
--- end
--- vim.keymap.set("n", "<C-h>", "<cmd> :lua HTOP_TOGGLE()<CR> <cmd>")
--- vim.keymap.set("i", "<C-h>", "<cmd> :lua HTOP_TOGGLE()<CR> <cmd>")
+-- toggle todo comments easily
+vim.keymap.set("n", "]t", function()
+	require("todo-comments").jump_next()
+end, { desc = "[n]ext [t]odo comment" })
+
+vim.keymap.set("n", "[t", function()
+	require("todo-comments").jump_prev()
+end, { desc = "[p]revious [t]odo comment" })

.config/nvim/lua/config/options.lua

@@ -61,7 +61,7 @@ vim.opt.foldmethod = "expr"
 vim.opt.foldexpr = "nvim_treesitter#foldexpr()" -- use treesitter for code folding
 vim.opt.foldtext = "" -- you can see what is inside the fold
 vim.opt.foldlevel = 99
-vim.opt.foldlevelstart = 2 --top level is not folded. only nested folds
+vim.opt.foldlevelstart = 4 --top level is not folded. only nested folds
 vim.opt.foldnestmax = 5
 
 -- automatically re-read changes done on file.

.config/nvim/lua/config/plugins/telescope.lua

@@ -103,5 +103,9 @@ return {
 
 		-- resume previous search
 		vim.keymap.set("n", "<leader>fp", require("telescope.builtin").resume, { desc = "[f]ind [p]revious search" })
+
+		-- find todo comments easily
+		vim.keymap.set("n", "<leader>ft", "<cmd>:TodoTelescope<cr>", { desc = "[f]ind [t]odos" })
+
 	end,
 }

.config/nvim/lua/config/plugins/todo-comments.lua

@@ -0,0 +1,29 @@
+-- nice highlighting of todo comments
+
+return {
+	"folke/todo-comments.nvim",
+	version = "v1.4.0",
+	dependencies = { "nvim-lua/plenary.nvim" },
+	opts = {
+		-- keywords recognized as todo comments
+		keywords = {
+			TODO = { icon = " ", color = "info" },
+			NOTE = { icon = " ", color = "hint", alt = { "INFO" } },
+			WARN = { icon = " ", color = "warning", alt = { "WARNING", "XXX" } },
+			FIX = { icon = " ", color = "error", alt = { "BUGFIX", "FIXME", "BUG", "FIXIT", "ISSUE" } },
+			PERF = { icon = " ", alt = { "OPTIM", "PERFORMANCE", "OPTIMIZE", "REFACTOR" } },
+			TEST = { icon = "⏲ ", color = "test", alt = { "TESTING", "PASSED", "FAILED" } },
+		},
+		-- list of named colors where we try to extract the guifg from the
+		-- list of highlight groups or use the hex color if hl not found as a fallback
+		colors = {
+			error = { "DiagnosticError", "ErrorMsg", "#DC2626" },
+			warning = { "DiagnosticWarn", "WarningMsg", "#FBBF24" },
+			info = { "DiagnosticInfo", "#2563EB" },
+			hint = { "DiagnosticHint", "#10B981" },
+			default = { "Identifier", "#7C3AED" },
+			test = { "#38fa07" },
+			-- test = { "Identifier", "#38fa07" },
+		},
+	},
+}