aboutsummaryrefslogtreecommitdiff
path: root/neovim/.config/nvim/lua/plugins/todocomments.lua
diff options
context:
space:
mode:
Diffstat (limited to 'neovim/.config/nvim/lua/plugins/todocomments.lua')
-rw-r--r--neovim/.config/nvim/lua/plugins/todocomments.lua66
1 files changed, 66 insertions, 0 deletions
diff --git a/neovim/.config/nvim/lua/plugins/todocomments.lua b/neovim/.config/nvim/lua/plugins/todocomments.lua
new file mode 100644
index 0000000..a0c75a3
--- /dev/null
+++ b/neovim/.config/nvim/lua/plugins/todocomments.lua
@@ -0,0 +1,66 @@
+local todocomments = require("todo-comments")
+
+todocomments.setup({
+ signs = true, -- show icons in the signs column
+ sign_priority = 8, -- sign priority
+ -- keywords recognized as todo comments
+ keywords = {
+ FIX = {
+ icon = " ", -- icon used for the sign, and in search results
+ color = "error", -- can be a hex color, or a named color (see below)
+ alt = { "FIXME", "BUG", "FIXIT", "ISSUE" }, -- a set of other keywords that all map to this FIX keywords
+ signs = false, -- configure signs for some keywords individually
+ },
+ TODO = { icon = " ", color = "info", signs = false },
+ HACK = { icon = " ", color = "warning", signs = false },
+ WARN = { icon = " ", color = "warning", alt = { "WARNING", "XXX" }, signs = false },
+ PERF = { icon = " ", alt = { "OPTIM", "PERFORMANCE", "OPTIMIZE" }, signs = false },
+ NOTE = { icon = " ", color = "hint", alt = { "INFO" }, signs = false },
+ TEST = { icon = "⏲ ", color = "test", alt = { "TESTING", "PASSED", "FAILED" }, signs = false },
+ },
+ gui_style = {
+ fg = "NONE", -- The gui style to use for the fg highlight group.
+ bg = "BOLD", -- The gui style to use for the bg highlight group.
+ },
+ merge_keywords = true, -- when true, custom keywords will be merged with the defaults
+ -- highlighting of the line containing the todo comment
+ -- * before: highlights before the keyword (typically comment characters)
+ -- * keyword: highlights of the keyword
+ -- * after: highlights after the keyword (todo text)
+ highlight = {
+ multiline = true, -- enable multine todo comments
+ multiline_pattern = "^.", -- lua pattern to match the next multiline from the start of the matched keyword
+ multiline_context = 10, -- extra lines that will be re-evaluated when changing a line
+ before = "", -- "fg" or "bg" or empty
+ keyword = "wide", -- "fg", "bg", "wide", "wide_bg", "wide_fg" or empty. (wide and wide_bg is the same as bg, but will also highlight surrounding characters, wide_fg acts accordingly but with fg)
+ after = "fg", -- "fg" or "bg" or empty
+ pattern = [[.*<(KEYWORDS)\s*:]], -- pattern or table of patterns, used for highlightng (vim regex)
+ comments_only = true, -- uses treesitter to match keywords in comments only
+ max_line_len = 400, -- ignore lines longer than this
+ exclude = {}, -- list of file types to exclude highlighting
+ },
+ -- 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 = { "Identifier", "#FF00FF" }
+ },
+ search = {
+ command = "rg",
+ args = {
+ "--color=never",
+ "--no-heading",
+ "--with-filename",
+ "--line-number",
+ "--column",
+ },
+ -- regex that will be used to match keywords.
+ -- don't replace the (KEYWORDS) placeholder
+ pattern = [[\b(KEYWORDS):]], -- ripgrep regex
+ -- pattern = [[\b(KEYWORDS)\b]], -- match without the extra colon. You'll likely get false positives
+ },
+})