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

docs: Update nvim-treesitter-highlights

Browse source 
- Fix misspellings, missing punctuation and capitalization.
- Clarify whether highlights apply to identifiers (e.g. `TSConstant`)
  or to literal values (e.g. `TSConstBuiltin`).
- Extend examples.

See #1767
This commit is contained in:
Sergio Alejandro Vargas 2021-08-29 14:43:37 -05:00 • committed by Stephan Seitz
parent 60a92e3b00
commit 1d8dd9665c
1 changed files with 67 additions and 61 deletions
Download patch file Download diff file Expand all files Collapse all files

128
doc/nvim-treesitter.txt
View file

@ -449,128 +449,133 @@ Note: This is highly experimental, and folding can break on some types of
============================================================================== ==============================================================================
HIGHLIGHTS *nvim-treesitter-highlights* HIGHLIGHTS *nvim-treesitter-highlights*
*hl-TSAnnotation* The following is a list of highlights groups, the syntactic elements they
`TSAnnotation` apply to, and some examples.
For C++/Dart attributes, annotations that can be attached to the code to
denote some kind of meta information.
*hl-TSAttribute* *hl-TSAttribute*
`TSAttribute` `TSAttribute`
(unstable) TODO: docs Annotations that can be attached to the code to denote some kind of meta
information. e.g. C++/Dart attributes.
*hl-TSBoolean* *hl-TSBoolean*
`TSBoolean` `TSBoolean`
For booleans. Boolean literals: `True` and `False` in Python.
*hl-TSCharacter* *hl-TSCharacter*
`TSCharacter` `TSCharacter`
For characters. Character literals: `'a'` in C.
*hl-TSComment* *hl-TSComment*
`TSComment` `TSComment`
For comment blocks. Line comments and block comments.
*hl-TSConditional* *hl-TSConditional*
`TSConditional` `TSConditional`
For keywords related to conditionnals. Keywords related to conditionals: `if`, `when`, `cond`, etc.
*hl-TSConstant* *hl-TSConstant*
`TSConstant` `TSConstant`
For constants Constants identifiers. These might not be semantically constant.
E.g. uppercase variables in Python.
*hl-TSConstBuiltin* *hl-TSConstBuiltin*
`TSConstBuiltin` `TSConstBuiltin`
For constant that are built in the language: `nil` in Lua. Built-in constant values: `nil` in Lua.
*hl-TSConstMacro* *hl-TSConstMacro*
`TSConstMacro` `TSConstMacro`
For constants that are defined by macros: `NULL` in C. Constants defined by macros: `NULL` in C.
*hl-TSConstructor* *hl-TSConstructor*
`TSConstructor` `TSConstructor`
For constructor calls and definitions: `{}` in Lua, and Java constructors. Constructor calls and definitions: `{}` in Lua, and Java constructors.
*hl-TSError* *hl-TSError*
`TSError` `TSError`
For syntax/parser errors. Syntax/parser errors. This might highlight large sections of code while the
user is typing still incomplete code, use a sensible highlight.
*hl-TSException* *hl-TSException*
`TSException` `TSException`
For exception related keywords. Exception related keywords: `try`, `except`, `finally` in Python.
*hl-TSField* *hl-TSField*
`TSField` `TSField`
For fields. Object and struct fields.
*hl-TSFloat* *hl-TSFloat*
`TSFloat` `TSFloat`
For floats. Floating-point number literals.
*hl-TSFunction* *hl-TSFunction*
`TSFunction` `TSFunction`
For function (calls and definitions). Function calls and definitions.
*hl-TSFuncBuiltin* *hl-TSFuncBuiltin*
`TSFuncBuiltin` `TSFuncBuiltin`
For builtin functions: `table.insert` in Lua. Built-in functions: `print` in Lua.
*hl-TSFuncMacro* *hl-TSFuncMacro*
`TSFuncMacro` `TSFuncMacro`
For macro defined fuctions (calls and definitions): each `macro_rules` in Macro defined functions (calls and definitions): each `macro_rules` in
Rust. Rust.
*hl-TSInclude* *hl-TSInclude*
`TSInclude` `TSInclude`
For includes: `#include` in C, `use` or `extern crate` in Rust, or `require` File or module inclusion keywords: `#include` in C, `use` or `extern crate` in
in Lua. Rust.
*hl-TSKeyword* *hl-TSKeyword*
`TSKeyword` `TSKeyword`
For keywords that don't fall in previous categories. Keywords that don't fit into other categories.
*hl-TSKeywordFunction* *hl-TSKeywordFunction*
`TSKeywordFunction` `TSKeywordFunction`
For keywords used to define a fuction. Keywords used to define a function: `function` in Lua, `def` and `lambda` in
Python.
*hl-TSKeywordOperator* *hl-TSKeywordOperator*
`TSKeywordOperator` `TSKeywordOperator`
for operators that are English words, e.g. `and`, `as`, `or`. Unary and binary operators that are English words: `and`, `or` in Python;
`sizeof` in C.
*hl-TSKeywordReturn* *hl-TSKeywordReturn*
`TSKeywordReturn` `TSKeywordReturn`
for the `return` and `yield` keywords. Keywords like `return` and `yield`.
*hl-TSLabel* *hl-TSLabel*
`TSLabel` `TSLabel`
For labels: `label:` in C and `:label:` in Lua. GOTO labels: `label:` in C, and `::label::` in Lua.
*hl-TSMethod* *hl-TSMethod*
`TSMethod` `TSMethod`
For method calls and definitions. Method calls and definitions.
*hl-TSNamespace* *hl-TSNamespace*
`TSNamespace` `TSNamespace`
For identifiers referring to modules and namespaces. Identifiers referring to modules and namespaces.
*hl-None* *hl-None*
`TSNone` `TSNone`
For no highlighting. No highlighting (sets all highlight arguments to `NONE`). this group is used
to clear certain ranges, for example, string interpolations. Don't change the
values of this highlight group.
*hl-TSNumber* *hl-TSNumber*
`TSNumber` `TSNumber`
For all numbers Numeric literals that don't fit into other categories.
*hl-TSOperator* *hl-TSOperator*
`TSOperator` `TSOperator`
For any operator: `+`, but also `->` and `*` in C. Binary or unary operators: `+`, and also `->` and `*` in C.
*hl-TSParameter* *hl-TSParameter*
`TSParameter` `TSParameter`
For parameters of a function. Parameters of a function.
*hl-TSParameterReference* *hl-TSParameterReference*
`TSParameterReference` `TSParameterReference`
For references to parameters of a function. References to parameters of a function.
*hl-TSProperty* *hl-TSProperty*
`TSProperty` `TSProperty`
@ -578,71 +583,71 @@ Same as `TSField`.
*hl-TSPunctDelimiter* *hl-TSPunctDelimiter*
`TSPunctDelimiter` `TSPunctDelimiter`
For delimiters ie: `.` Punctuation delimiters: Periods, commas, semicolons, etc.
*hl-TSPunctBracket* *hl-TSPunctBracket*
`TSPunctBracket` `TSPunctBracket`
For brackets and parens. Brackets, braces, parentheses, etc.
*hl-TSPunctSpecial* *hl-TSPunctSpecial*
`TSPunctSpecial` `TSPunctSpecial`
For special punctutation that does not fall in the catagories before. Special punctuation that doesn't fit into the previous categories.
*hl-TSRepeat* *hl-TSRepeat*
`TSRepeat` `TSRepeat`
For keywords related to loops. Keywords related to loops: `for`, `while`, etc.
*hl-TSString* *hl-TSString*
`TSString` `TSString`
For strings. String literals.
*hl-TSStringRegex* *hl-TSStringRegex*
`TSStringRegex` `TSStringRegex`
For regexes. Regular expression literals.
*hl-TSStringEscape* *hl-TSStringEscape*
`TSStringEscape` `TSStringEscape`
For escape characters within a string. Escape characters within a string: `\n`, `\t`, etc.
*hl-TSStringSpecial* *hl-TSStringSpecial*
`TSStringSpecial` `TSStringSpecial`
For strings with special meaning that don't fit into the above categories. Strings with special meaning that don't fit into the previous categories.
*hl-TSSymbol* *hl-TSSymbol*
`TSSymbol` `TSSymbol`
For identifiers referring to symbols or atoms. Identifiers referring to symbols or atoms.
*hl-TSTag* *hl-TSTag*
`TSTag` `TSTag`
Tags like html tag names. Tags like HTML tag names.
*hl-TSTagAttribute* *hl-TSTagAttribute*
`TSTagAttribute` `TSTagAttribute`
For html tag attributes. HTML tag attributes.
*hl-TSTagDelimiter* *hl-TSTagDelimiter*
`TSTagDelimiter` `TSTagDelimiter`
Tag delimiter like `<` `>` `/` Tag delimiters like `<` `>` `/`.
*hl-TSText* *hl-TSText*
`TSText` `TSText`
For strings considered text in a markup language. Non-structured text. Like text in a markup language.
*hl-TSSTrong* *hl-TSSTrong*
`TSStrong` `TSStrong`
For text to be represented in bold. Text to be represented in bold.
*hl-TSEmphasis* *hl-TSEmphasis*
`TSEmphasis` `TSEmphasis`
For text to be represented with emphasis. Text to be represented with emphasis.
*hl-TSUnderline* *hl-TSUnderline*
`TSUnderline` `TSUnderline`
For text to be represented with an underline. Text to be represented with an underline.
*hl-TSStrike* *hl-TSStrike*
`TSStrike` `TSStrike`
For strikethrough text. Strikethrough text.
*hl-TSTitle* *hl-TSTitle*
`TSTitle` `TSTitle`
@ -650,27 +655,28 @@ Text that is part of a title.
*hl-TSLiteral* *hl-TSLiteral*
`TSLiteral` `TSLiteral`
Literal text. Literal or verbatim text.
*hl-TSURI* *hl-TSURI*
`TSURI` `TSURI`
Any URI like a link or email. URIs like hyperlinks or email addresses.
*hl-TSMath* *hl-TSMath*
`TSMath` `TSMath`
For LaTex-like math environments. Math environments like LaTeX's `$ ... $`
*hl-TSTextReference* *hl-TSTextReference*
`TSTextReference` `TSTextReference`
For footnotes, text references, citations. Footnotes, text references, citations, etc.
*hl-TSEnvironment* *hl-TSEnvironment*
`TSEnvironment` `TSEnvironment`
For text environments of markup languages. Text environments of markup languages.
*hl-TSEnvironmentName* *hl-TSEnvironmentName*
`TSEnvironmentName` `TSEnvironmentName`
For the name/the string indicating the type of text environment. Text/string indicating the type of text environment. Like the name of a
`\begin` block in LaTeX.
*hl-TSNote* *hl-TSNote*
`TSNote` `TSNote`
@ -686,19 +692,19 @@ Text representation of a danger note.
*hl-TSType* *hl-TSType*
`TSType` `TSType`
For types. Type (and class) definitions and annotations.
*hl-TSTypeBuiltin* *hl-TSTypeBuiltin*
`TSTypeBuiltin` `TSTypeBuiltin`
For builtin types. Built-in types: `i32` in Rust.
*hl-TSVariable* *hl-TSVariable*
`TSVariable` `TSVariable`
Any variable name that does not have another highlight. Variable names that don't fit into other categories.
*hl-TSVariableBuiltin* *hl-TSVariableBuiltin*
`TSVariableBuiltin` `TSVariableBuiltin`
Variable names that are defined by the languages, like `this` or `self`. Variable names defined by the language: `this` or `self` in Javascript.
============================================================================== ==============================================================================
PERFORMANCE *nvim-treesitter-performance* PERFORMANCE *nvim-treesitter-performance*