svart

Neovim jump navigation plugin.

Features

• Bidirectional search
• Multi-window navigation
• Smartcase support
• "Steady" deterministic labels
• Search by regular expression

Installation

Install plugin and add keymaps:

-- begin exact search
vim.keymap.set({ "n", "x", "o" }, "s", "<Cmd>Svart<CR>")
-- begin regex search
vim.keymap.set({ "n", "x", "o" }, "S", "<Cmd>SvartRegex<CR>")
-- repeat with last accepted query
vim.keymap.set({ "n", "x", "o" }, "gs", "<Cmd>SvartRepeat<CR>")

Usage

1. Initiate search with s or S
2. Start typing search query
3. Type highlighted label to jump to corresponding location at any time or press C-N or C-P to select location
4. Press Enter to jump to the selected location and continue with regular (/) search
5. Use Backspace, C-W, C-U to edit search query

Configuration

NOTE: There's no need to call svart.configure if you don't want to change configuration defaults.

local svart = require("svart")

svart.configure({
    key_cancel = "<Esc>",       -- cancel search
    key_delete_char = "<BS>",   -- delete query char
    key_delete_word = "<C-W>",  -- delete query word
    key_delete_query = "<C-U>", -- delete whole query
    key_best_match = "<CR>",    -- jump to the best match
    key_next_match = "<C-N>",   -- select next match
    key_prev_match = "<C-P>",   -- select prev match

    label_atoms = "jfkdlsahgnuvrbytmiceoxwpqz", -- allowed label chars

    label_location = -1,            -- label location relative to the match
                                    -- positive: relative to the start of the
                                    -- match
                                    -- 0 or negative: relative to the end of the
                                    -- match

    label_max_len = 2,              -- max label length

    label_min_query_len = 1,        -- min query length required
                                    -- to show labels

    label_hide_irrelevant = true,   -- hide irrelevant labels
                                    -- after start typing label to go to

    label_conflict_foresight = 2,   -- number of chars from the
                                    -- start of the match to
                                    -- discard from labels pool

    search_update_register = true,  -- update search (/) register with last
                                    -- used query after accepting match

    search_wrap_around = true,      -- wrap around when navigating to
                                    -- next/prev match

    search_multi_window = true,     -- search in multiple windows

    ui_dim_content = true,          -- dim buffer content during search
})

Highlight groups

SvartDimmedContent = { default = true, link = "Comment" },
SvartMatch = { default = true, link = "Search" },
SvartMatchCursor = { default = true, link = "Cursor" },
SvartDimmedCursor = { default = true, link = "TermCursorNC" },
SvartLabel = { default = true, link = "IncSearch" },
SvartPrompt = { default = true, link = "MoreMsg" },
SvartErrorPrompt = { default = true, link = "ErrorMsg" },

Contributing

1. Add new tests to the lua/svart/tests.lua
2. Run tests with :SvartTest command