--[
-- This plugin highlights some block code like TODO and WARNING, ...
-- It also helps navigate between them.
--
-- Here are the keywords:
--
--  FIX (ISSUE, FIXIT, BUG, FIXME)
--  TODO
--  HACK
--  WARN (WARNING, XXX)
--  PERF (OPTIM, PERFORMANCE, OPTIMIZE)
--  NOTE (INFO)
--  TEST (TESTING, PASSED, FAILED)
--
--
-- NOTE: I should add a new category like AWESOME to explains AWESOME part of the code.
-- Like that:
-- AWESOME: This code does that and it's AWESOME
--]

return {
	"folke/todo-comments.nvim",
	enabled = true,
	event = { "BufReadPre", "BufNewFile" },
	dependencies = {
		"nvim-lua/plenary.nvim",
	},
	config = function()
		local todo_comments = require("todo-comments")

		vim.keymap.set("n", "td>", function()
			todo_comments.jump_next()
		end, { desc = "Next todo comment" })

		vim.keymap.set("n", "td<", function()
			todo_comments.jump_prev()
		end, { desc = "Previous todo comment" })

		todo_comments.setup()
	end,
}