nvim_runtime_lua

TSQuery

supers: userdata

Reference to an object held by the treesitter library that is used as a component of the |vim.treesitter.Query| for language feature support. See |treesitter-query| for more about queries or |vim.treesitter.query.parse()| for an example of how to obtain a query object.

Methods3 

function TSQuery.inspect() -> TSQueryInfo

Get information about the query's patterns and captures.

@nodoc

function TSQuery.disable_capture(capture_name: string)

Disable a specific capture in this query; once disabled the capture cannot be re-enabled. {capture_name} should not include a leading "@".

Example: To disable the @variable.parameter capture from the vimdoc highlights query:

local query = vim.treesitter.query.get('vimdoc', 'highlights')
query.query:disable_capture("variable.parameter")
vim.treesitter.get_parser():parse()

function TSQuery.disable_pattern(pattern_index: integer)

Disable a specific pattern in this query; once disabled the pattern cannot be re-enabled. The {pattern_index} for a particular match can be obtained with |:Inspect!|, or by reading the source of the query (i.e. from |vim.treesitter.query.get_files()|).

Example: To disable | links in vimdoc but keep other @markup.links highlighted:

local link_pattern = 9 -- from :Inspect!
local query = vim.treesitter.query.get('vimdoc', 'highlights')
query.query:disable_pattern(link_pattern)
local tree = vim.treesitter.get_parser():parse()[1]