feat(treesitter): #trim! can trim all whitespace

This commit also implements more generic trimming, acting on all
whitespace (charwise) rather than just empty lines.

It will unblock
https://github.com/nvim-treesitter/nvim-treesitter/pull/3442 and allow
for properly concealing markdown bullet markers regardless of indent
width, e.g.
This commit is contained in:
Riley Bruins
2024-08-17 21:05:09 -07:00
parent 1077843b9b
commit b8c75a31e6
4 changed files with 160 additions and 19 deletions

View File

@@ -280,6 +280,8 @@ TREESITTER
• |LanguageTree:node_for_range()| gets anonymous and named nodes for a range
• |vim.treesitter.get_node()| now takes an option `include_anonymous`, default
false, which allows it to return anonymous nodes as well as named nodes.
• |treesitter-directive-trim!| can trim all whitespace (not just empty lines)
from both sides of a node.
TUI

View File

@@ -245,15 +245,32 @@ The following directives are built in:
(#gsub! @_node ".*%.(.*)" "%1")
<
`trim!` *treesitter-directive-trim!*
Trim blank lines from the end of the node. This will set a new
`metadata[capture_id].range`.
Trims whitespace from the node. Sets a new
`metadata[capture_id].range`. Takes a capture ID and, optionally, four
integers to customize trimming behavior (`1` meaning trim, `0` meaning
don't trim). When only given a capture ID, trims blank lines (lines
that contain only whitespace, or are empty) from the end of the node
(for backwards compatibility). Can trim all whitespace from both sides
of the node if parameters are given.
Examples: >query
; only trim blank lines from the end of the node
; (equivalent to (#trim! @fold 0 0 1 0))
(#trim! @fold)
; trim blank lines from both sides of the node
(#trim! @fold 1 0 1 0)
; trim all whitespace around the node
(#trim! @fold 1 1 1 1)
<
Parameters: ~
{capture_id}
{trim_start_linewise}
{trim_start_charwise}
{trim_end_linewise} (default `1` if only given {capture_id})
{trim_end_charwise}
Example: >query
(#trim! @fold)
<
Further directives can be added via |vim.treesitter.query.add_directive()|.
Use |vim.treesitter.query.list_directives()| to list all available directives.