benbot/nvim-treesitter
1
0
Fork 0
mirror of https://github.com/nvim-treesitter/nvim-treesitter.git synced 2026-07-01 19:17:02 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

Add documentation for cond setting

Browse source 
Ref: #1994
This commit is contained in:
patrick96 2021-11-13 12:55:21 +01:00 • committed by Stephan Seitz
parent 50314758ee
commit be1c93f848
1 changed files with 8 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

9
doc/nvim-treesitter.txt
View file

@ -74,9 +74,13 @@ Each module corresponds to an entry in the dictionary passed to the
EOF EOF
< <
All modules share some common options, like `enable` and `disable`. All modules share some common options, like `enable`, `disable`, and `cond`.
When `enable` is `true` this will enable the module for all supported languages, When `enable` is `true` this will enable the module for all supported languages,
if you want to disable the module for some languages you can pass a list to the `disable` option. if you want to disable the module for some languages you can pass a list to the `disable` option.
For more fine-grained control, `cond` takes a function and whenever it returns
`false` the module is disabled for that buffer.
The `cond` function is called once when a module starts in a buffer and
received the language and the buffer number as arguments.
> >
lua <<EOF lua <<EOF
@ -84,6 +88,9 @@ if you want to disable the module for some languages you can pass a list to the
highlight = { highlight = {
enable = true, enable = true,
disable = { "cpp", "lua" }, disable = { "cpp", "lua" },
cond = function(lang, bufnr) -- Disable in large C++ buffers
return not (lang == "cpp" and api.nvim_buf_line_count(bufnr) > 50000)
end,
}, },
} }
EOF EOF