diff options
Diffstat (limited to 'lua/ache/plugins/todo-comments.lua')
| -rw-r--r-- | lua/ache/plugins/todo-comments.lua | 50 |
1 files changed, 35 insertions, 15 deletions
diff --git a/lua/ache/plugins/todo-comments.lua b/lua/ache/plugins/todo-comments.lua index 6696bbf..f2b93f1 100644 --- a/lua/ache/plugins/todo-comments.lua +++ b/lua/ache/plugins/todo-comments.lua @@ -1,20 +1,40 @@ +--[ +-- 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", - event = { "BufReadPre", "BufNewFile" }, - dependencies = { - "nvim-lua/plenary.nvim" - }, - config = function() - local todo_comments = require("todo-comments") + "folke/todo-comments.nvim", + 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_next() + end, { desc = "Next todo comment" }) - vim.keymap.set("n", "td<", function() - todo_comments.jump_prev() - end, { desc = "Previous todo comment"}) + vim.keymap.set("n", "td<", function() + todo_comments.jump_prev() + end, { desc = "Previous todo comment" }) - todo_comments.setup() - end, + todo_comments.setup() + end, } |