aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorStephan Seitz <stephan.seitz@fau.de>2021-07-18 15:27:54 +0200
committerStephan Seitz <stephan.seitz@fau.de>2021-07-22 21:38:57 +0200
commit5ea6cc1d752bff196711f58d36b541e660fdcc1a (patch)
treedefa4a691604ca45742399336bc91e32175785d1
parent242608e6693f06c8e52ebf5813e697d28e96db52 (diff)
downloadrneovim-5ea6cc1d752bff196711f58d36b541e660fdcc1a.tar.gz
rneovim-5ea6cc1d752bff196711f58d36b541e660fdcc1a.tar.bz2
rneovim-5ea6cc1d752bff196711f58d36b541e660fdcc1a.zip
docs(tree-sitter): document highlight priority
-rw-r--r--runtime/doc/api.txt5
-rw-r--r--runtime/doc/treesitter.txt13
2 files changed, 16 insertions, 2 deletions
diff --git a/runtime/doc/api.txt b/runtime/doc/api.txt
index 4dcf5b7bbc..9b8259c2fb 100644
--- a/runtime/doc/api.txt
+++ b/runtime/doc/api.txt
@@ -2334,8 +2334,9 @@ nvim_buf_set_extmark({buffer}, {ns_id}, {line}, {col}, {opts})
inserted (true for right, false for left).
Defaults to false.
• priority: a priority value for the highlight
- group. For example treesitter highlighting
- uses a value of 100.
+ group. Default: 4096. For example, treesitter
+ highlighting uses a default value of 100 (see
+ |lua-treesitter-highlight-priority|).
Return: ~
Id of the created/updated extmark
diff --git a/runtime/doc/treesitter.txt b/runtime/doc/treesitter.txt
index 416ea3a08a..340db92ae3 100644
--- a/runtime/doc/treesitter.txt
+++ b/runtime/doc/treesitter.txt
@@ -294,6 +294,19 @@ identical identifiers, highlighting both as |hl-WarningMsg|: >
((binary_expression left: (identifier) @WarningMsg.left right: (identifier) @WarningMsg.right)
(eq? @WarningMsg.left @WarningMsg.right))
<
+Treesitter Highlighting Priority *lua-treesitter-highlight-priority*
+
+Tree-sitter uses |nvim_buf_set_extmark()| to set highlights with a default
+priority of 100. This enables plugins to set a highlighting priority lower or
+higher than tree-sitter. It is also possible to change the priority of an
+individual query pattern manually by setting its `"priority"` metadata attribute: >
+
+ (
+ (super_important_node) @ImportantHighlight
+ ; Give the whole query highlight priority higher than the default (100)
+ (set! "priority" 105)
+ )
+<
==============================================================================
Lua module: vim.treesitter *lua-treesitter-core*