Question 1

How do I install todo-comments.nvim with lazy.nvim?

Accepted Answer

Add it to your lazy.nvim configuration with dependencies like plenary.nvim, and set the opts table for customization—ensure Neovim version is >=0.8.0, as specified in the README installation section.

Question 2

Does todo-comments.nvim work with standard Vim?

Accepted Answer

No, it's designed specifically for Neovim due to its reliance on Lua APIs and features like TreeSitter. For older Neovim versions, use the 'neovim-pre-0.8.0' branch, but it won't function in Vim.

Question 3

What's the difference between todo-comments.nvim and other Neovim todo plugins like vim-todo?

Accepted Answer

todo-comments.nvim offers deeper integration with Telescope and Trouble, plus customizable highlighting and TreeSitter support, but it may be heavier due to dependencies. Choose based on whether you prefer a more ecosystem-integrated tool.

Question 4

How can I add a custom keyword like REVIEW in todo-comments.nvim?

Accepted Answer

In the configuration, add a new entry in the keywords table with properties like icon, color, and alt spellings, referencing the default setup in the README. Set merge_keywords to true to combine with defaults.

Question 5

Can I use todo-comments.nvim without installing Telescope or Trouble?

Accepted Answer

Yes, basic features like highlighting and jump commands work independently, but advanced functions like :TodoTelescope or :Trouble todo require those plugins, limiting search and listing capabilities.

Question 6

Why are my todo comments not highlighting in certain file types?

Accepted Answer

Check the exclude list in the highlight configuration and ensure TreeSitter is enabled if comments_only is true. Also, verify that the pattern matches your comment syntax, as some file types might need adjustments.

todo-comments.nvim

What is todo-comments.nvim?

Overview

Use Cases

Best For

Related Projects

Found a gem we're missing?

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions