A Neovim plugin for setting the commentstring
option based on the cursor
location in the file. The location is checked via treesitter queries.
This is useful when there are embedded languages in certain types of files. For example, Vue files can have many different sections, each of which can have a different style for comments.
Note that this plugin only changes the commentstring
setting. It does not
add any mappings for commenting. It is recommended to use a commenting plugin
like Comment.nvim
alongside this
plugin.
Requirements:
- Neovim version 0.9.4
- Tree-sitter parsers (e.g. installed with nvim-treesitter)
Installation:
Use your favorite plugin manager. For example, here's how it would look like with lazy.nvim:
require('lazy').setup {
'JoosepAlviste/nvim-ts-context-commentstring',
}
Setup:
Defaults work out of the box.
Set vim.g.skip_ts_context_commentstring_module = true
somewhere in your configuration to skip backwards compatibility routines and speed up loading.
If you want to change the configuration, call the setup
function of this plugin, e.g.:
require('ts_context_commentstring').setup {
enable_autocmd = false,
}
Note
There is a minimal configuration file available at
utils/minimal_init.lua
for reference.
Note
Don't forget to use
:h lua-heredoc
if you're usinginit.vim
.
It is recommended to use a commenting plugin that has an integration available
with this plugin. Then, the commentstring
calculation can be triggered only
when commenting. The available integrations are listed in the
wiki.
The following plugins have an integration available:
b3nj5m1n/kommentary
terrortylor/nvim-comment
numToStr/Comment.nvim
echasnovski/mini.nvim/mini-comment
tpope/vim-commentary
However, if an integration is not set up, then the default behavior is to
calculate the commentstring
on the CursorHold
autocmd, meaning that the
:h updatetime
should be set to a smaller value than the default of 4s:
vim.opt.updatetime = 100
Note
For more advanced configuration options, see
:h ts-context-commentstring
.
React:
Svelte:
HTML:
Nesting:
I injected HTML into JavaScript strings and created multiple levels of nesting with language tree. This sort of nesting of languages works without any extra configuration in the plugin.