Question 1

How do I change the highlight color in vim-illuminate?

Accepted Answer

Modify the highlight groups like IlluminatedWordText in your Vim/Neovim config. For example, use 'hi IlluminatedWordText gui=underline ctermfg=blue' to set the underline color to blue, as shown in the README's highlight groups section.

Question 2

vim-illuminate vs vim-interestingwords, which should I use?

Accepted Answer

vim-illuminate is better for accurate code symbol highlighting because it uses LSP or Tree-sitter, while vim-interestingwords relies on regex and is simpler but less precise for complex languages. Choose vim-illuminate if you need intelligent reference detection.

Question 3

How to disable vim-illuminate for specific file types like Markdown?

Accepted Answer

Add the filetype to filetypes_denylist in your configuration. In Lua, use require('illuminate').configure({ filetypes_denylist = {'markdown'} }), or for Vim, set g:Illuminate_ftblacklist as per the docs.

Question 4

Does vim-illuminate work with any LSP server?

Accepted Answer

Yes, it automatically uses LSP as a primary provider if available, prioritizing it over Tree-sitter and regex. Ensure your LSP server is correctly set up in Neovim; the plugin will detect and use it for reference matching.

Question 5

How to fix vim-illuminate not highlighting anything?

Accepted Answer

Check your providers configuration and ensure LSP or Tree-sitter is active. Also, verify that delay settings or syntax denylists aren't blocking highlights, and try toggling with :IlluminateResume if it's paused globally.

Question 6

Can I use custom keymaps instead of the default ones?

Accepted Answer

Yes, disable default keymaps by setting disable_keymaps = true in configuration, then define your own using Lua functions like require('illuminate').goto_next_reference() or Vim commands for navigation.

Question 7

How to integrate vim-illuminate with an existing Neovim config?

Accepted Answer

Install via a plugin manager, then add require('illuminate').configure() in your init.lua with any custom settings. It's designed to be lightweight and non-intrusive, so it should integrate smoothly without conflicts.

vim-illuminate

What is vim-illuminate?

Overview

Use Cases

Best For

Found a gem we're missing?

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions