1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
|
-- NORMAL: lorem ipsum
-- TODO: lorem ipsum
-- FIX: lorem ipsum
-- OPTIMIZE: lorem ipsum
-- WARN: lorem ipsum
-- PERF: lorem ipsum
-- HACK: lorem ipsum
-- NOTE: lorem ipsum
-- TEST: lorem ipsum
-- UNSAFE: lorem ipsum
-- TODO(kyren223): lorem ipsum
-- NOTE:(broken) lorem ipsum
-- todo!(a);
-- todo!(aaa);
return {
'folke/todo-comments.nvim',
dependencies = { 'nvim-lua/plenary.nvim' },
event = 'VeryLazy',
keys = {
{
'<leader>st',
function()
Snacks.picker.todo_comments({
layout = 'telescope',
keywords = { 'TODO', 'FIX', 'FIXME', 'BUG', 'ISSUE', 'OPTIMIZE' },
})
end,
desc = '[S]earch [T]odos',
},
{
'<leader>sn',
function()
Snacks.picker.todo_comments({ layout = 'telescope' })
end,
desc = '[S]earch [N]otes',
},
},
config = function()
require('todo-comments').setup({
signs = false, -- show icons in the signs column
sign_priority = 8, -- sign priority
keywords = {
-- NOTE: These are "todos"
TODO = { icon = ' ', color = 'info', alt = { 'todo' } },
FIX = { icon = ' ', color = 'error', alt = { 'FIXME', 'BUG', 'ISSUE' } },
OPTIMIZE = { icon = ' ', color = 'performance' },
-- NOTE: These are "notes"
WARN = { icon = ' ', color = 'warning', alt = { 'WARNING' } },
PERF = { icon = ' ', color = 'performance', alt = { 'PERFORMANCE' } },
HACK = { icon = ' ', color = 'warning', alt = { 'SMELL', 'CODE SMELL', 'BAD', 'BAD PRACTICE' } },
NOTE = { icon = ' ', color = 'hint', alt = { 'INFO' } },
TEST = { icon = ' ', color = 'test', alt = { 'TESTING', 'PASSED', 'FAILED' } },
UNSAFE = { icon = ' ', color = 'error', alt = { 'SAFETY' } },
},
gui_style = {
fg = 'NONE',
bg = 'BOLD',
},
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,
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)%(\(.{-1,}\))?):]],
[[((KEYWORDS)!%(\(.{-}\))?)]],
}, -- pattern or table of patterns, used for highlighting (vim regex)
comments_only = false,
max_line_len = 400,
exclude = {}, -- list of excluded filetypes
},
-- list of named colors where we try to extract the gui fg from the
-- list of highlight groups or use the hex color if hl not found as a fallback
colors = {
default = { 'Identifier', '#7C3AED' },
error = { 'DiagnosticError', 'ErrorMsg', '#DC2626' },
warning = { 'DiagnosticWarn', 'WarningMsg', '#FBBF24' },
info = { 'DiagnosticInfo', '#2563EB' },
hint = { '#10B981' },
test = { 'Identifier', '#FF00FF' },
performance = { '#7C3AED' },
},
search = {
command = 'rg',
args = {
'--color=never',
'--no-heading',
'--with-filename',
'--line-number',
'--column',
'--hidden', -- show todos in hidden directories and files
'--follow', -- follow symlinks
},
},
})
end,
}
|
