mirrors/neovim
1
0
Fork 0
mirror of https://github.com/neovim/neovim.git synced 2025-09-06 19:38:20 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: treesitter.add_directive, add_predicate #21206

Browse Source
This commit is contained in:
Ching Pei Yang
2023-01-16 13:39:19 +01:00
committed by GitHub
parent 9e1d2e2ca7
commit ef89f9fd46
3 changed files with 32 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
runtime/doc/treesitter.txt
View File

@@ -708,8 +708,15 @@ add_directive({name}, {handler}, {force})
Parameters: ~ Parameters: ~
• {name} (string) Name of the directive, without leading # • {name} (string) Name of the directive, without leading #
• {handler} function(match:string, pattern:string, bufnr:number, • {handler} function(match:table, pattern:string, bufnr:number,
predicate:function, metadata:table) predicate:string[], metadata:table)
• match: see |treesitter-query|
• node-level data are accessible via `match[capture_id]`
• pattern: see |treesitter-query|
• predicate: list of strings containing the full directive
being called, e.g. `(node (#set! conceal "-"))` would get
the predicate `{ "#set!", "conceal", "-" }`
*vim.treesitter.query.add_predicate()* *vim.treesitter.query.add_predicate()*
add_predicate({name}, {handler}, {force}) add_predicate({name}, {handler}, {force})
@@ -717,8 +724,10 @@ add_predicate({name}, {handler}, {force})
Parameters: ~ Parameters: ~
• {name} (string) Name of the predicate, without leading # • {name} (string) Name of the predicate, without leading #
• {handler} function(match:string, pattern:string, bufnr:number, • {handler} function(match:table, pattern:string, bufnr:number,
predicate:function) predicate:string[])
• see |vim.treesitter.query.add_directive()| for argument
meanings
*vim.treesitter.query.get_node_text()* *vim.treesitter.query.get_node_text()*
get_node_text({node}, {source}, {opts}) get_node_text({node}, {source}, {opts})

10
runtime/lua/vim/treesitter/query.lua
View File

@@ -419,7 +419,8 @@ local directive_handlers = {
--- Adds a new predicate to be used in queries --- Adds a new predicate to be used in queries
--- ---
---@param name string Name of the predicate, without leading # ---@param name string Name of the predicate, without leading #
---@param handler function(match:string, pattern:string, bufnr:number, predicate:function) ---@param handler function(match:table, pattern:string, bufnr:number, predicate:string[])
--- - see |vim.treesitter.query.add_directive()| for argument meanings
function M.add_predicate(name, handler, force) function M.add_predicate(name, handler, force)
if predicate_handlers[name] and not force then if predicate_handlers[name] and not force then
error(string.format('Overriding %s', name)) error(string.format('Overriding %s', name))
@@ -436,7 +437,12 @@ end
--- metadata table `metadata[capture_id].key = value` --- metadata table `metadata[capture_id].key = value`
--- ---
---@param name string Name of the directive, without leading # ---@param name string Name of the directive, without leading #
---@param handler function(match:string, pattern:string, bufnr:number, predicate:function, metadata:table) ---@param handler function(match:table, pattern:string, bufnr:number, predicate:string[], metadata:table)
--- - match: see |treesitter-query|
--- - node-level data are accessible via `match[capture_id]`
--- - pattern: see |treesitter-query|
--- - predicate: list of strings containing the full directive being called, e.g.
--- `(node (#set! conceal "-"))` would get the predicate `{ "#set!", "conceal", "-" }`
function M.add_directive(name, handler, force) function M.add_directive(name, handler, force)
if directive_handlers[name] and not force then if directive_handlers[name] and not force then
error(string.format('Overriding %s', name)) error(string.format('Overriding %s', name))

23
scripts/gen_help_html.lua
View File

@@ -60,19 +60,18 @@ local exclude_invalid = {
["'previewpopup'"] = "quickref.txt", ["'previewpopup'"] = "quickref.txt",
["'pvp'"] = "quickref.txt", ["'pvp'"] = "quickref.txt",
["'string'"] = "eval.txt", ["'string'"] = "eval.txt",
Query = "treesitter.txt", Query = 'treesitter.txt',
["eq?"] = "treesitter.txt", ['eq?'] = 'treesitter.txt',
["lsp-request"] = "lsp.txt", ['lsp-request'] = 'lsp.txt',
matchit = "vim_diff.txt", matchit = 'vim_diff.txt',
["matchit.txt"] = "help.txt", ['matchit.txt'] = 'help.txt',
["set!"] = "treesitter.txt", ["set!"] = "treesitter.txt",
["v:_null_blob"] = "builtin.txt", ['v:_null_blob'] = 'builtin.txt',
["v:_null_dict"] = "builtin.txt", ['v:_null_dict'] = 'builtin.txt',
["v:_null_list"] = "builtin.txt", ['v:_null_list'] = 'builtin.txt',
["v:_null_string"] = "builtin.txt", ['v:_null_string'] = 'builtin.txt',
["vim.lsp.buf_request()"] = "lsp.txt", ['vim.lsp.buf_request()'] = 'lsp.txt',
["vim.lsp.util.get_progress_messages()"] = "lsp.txt", ['vim.lsp.util.get_progress_messages()'] = 'lsp.txt',
["vim.treesitter.start()"] = "treesitter.txt",
} }
-- False-positive "invalid URLs". -- False-positive "invalid URLs".