summaryrefslogtreecommitdiff
path: root/.config/nvim/lua/plugins/todo.lua
blob: 98dfdc3d58394331f274229a17357e40303ff236 (plain)
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
return {
    'folke/todo-comments.nvim',
    dependencies = { 'nvim-lua/plenary.nvim' },
    opts = {
        signs = false, -- show icons in the signs column
        sign_priority = 8, -- sign priority

        keywords = {
            FIX = { icon = ' ', color = 'error', alt = { 'FIXME', 'BUG', 'ISSUE' } },
            TODO = { icon = ' ', color = 'info' },
            HACK = { icon = ' ', color = 'warning', alt = { 'SMELL', 'CODE SMELL', 'BAD', 'BAD PRACTICE' } },
            WARN = { icon = ' ', color = 'warning', alt = { 'WARNING' } },
            PERF = { icon = ' ', color = 'performance', alt = { 'PERFORMANCE', 'OPTIMIZE' } },
            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)\s*:]], -- pattern or table of patterns, used for highlighting (vim regex)
            -- pattern = [[.*<(KEYWORDS)\s*]], -- pattern or table of patterns, used for highlighting (vim regex)
            comments_only = true,
            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 = { 'DiagnosticHint', '#10B981' },
            test = { 'Identifier', '#FF00FF' },
            performance = { 'Identifier', '#FF00FF' },
        },

        search = {
            command = 'rg',
            args = {
                '--color=never',
                '--no-heading',
                '--with-filename',
                '--line-number',
                '--column',
                -- "--hidden", -- show todos in hidden directories and files
                '--follow', -- follow symlinks
            },

            -- regex that will be used to match keywords.
            -- don't replace the (KEYWORDS) placeholder
            pattern = [[\b(KEYWORDS):]],
            -- pattern = [[\b(KEYWORDS)\b]],
        },
    },
}