feat!: use queries for determining context

[lewis6991]

This plugin has been significantly rewritten to use Treesitter queries instead of patterns for determining context regions for languages.

The main benefits of this change are:

• it is a much simpler implementation since we can leverage core APIs.
• it fits in more generally with the Treesitter eco-system.
• it allows configuration of contexts to be provided from multiples sources.
• it allows more sophisticated configuration of contexts since queries (with directives and predicates) are much more powerful than patterns.
• the query format should be usable for other editors.

The major downside of this new implementation is that it requires each language to provide it's own query as opposed to using the general purpose patterns. This means that some languages which had contexts before may not have them now. If this is the case then please raise an issue. Adding queries for a specific language is fairly simple but too much work to implement for all 170+ parsers that exist.

This commits provides explicit support for:

• bash
• c
• cpp
• typescript
• rust
• json
• lua
• markdown
• python
• yaml
• php
• scala
• teal
• toml
• vim

Please see the README for instructions on how to add support for other languages.

This commit also drops explicit support for Nvim 0.7. If you still need support for this version then you can use the compat/0.7 release.

[syphar]

this is awesome :)

I'm happy to help testing / reviewing, if needed.

Could this also somehow handle the last_nodes logic through different queries?

( I only have basic knowledge of TS queries, so I'm not sure).

[lewis6991]

I hope so. I don't fully understand the last_nodes stuff, so need to get my head around it.

[lewis6991]

I'm happy to help testing / reviewing, if needed.

Yes please. Any help is welcome.

This is a huge breaking change so I'll just be daily driving this branch for a while.

[lewis6991]

Yeah, I don't really understand the last nodes stuff. Can you provide an example of what it does (or should do) and I'll just implement it with queries?

[syphar]

Yeah, I don't really understand the last nodes stuff. Can you provide an example of what it does (or should do) and I'll just implement it with queries?

I can look up some more details & examples later .

From memory:
when you have a multi-line node for a function it will extend the context up to the ( for example) return-types at the end of the function header.

[syphar]

Also the skip_leading_types logic was probably needed for PHP.

I remember by default the context shows the whole line, not only what is covered by the TS node. And in some cases it would skip over things at the start of the line.

Since this was only used for PHP I'm not sure if we should invest time into fixing this

[syphar]

while playing around with queries I saw that the current implementation will actually merge the whole TS node content into one line, which for the python function example (function_definition) will lead to the whole function body being added too.

[syphar]

reading longer, it could be that #make-range! ( from treesitter-textobjects ) would help here?

( while the problem where would be that the def at the beginning of the function definition wouldn't be included in context, assuming we're trying to write a query that includes only the definition of the function, not the body

[lewis6991]

I've got a rough idea to solve this by just adding a second capture (or reuse @context) to a match that will be used to control what gets displayed.

[lewis6991]

Just looked at the last_node stuff and can't seem to replicate the issue.

[syphar]

@lewis6991 after the last bugfix I started to use this branch in my day-to-day work,

here are some new queries:

• syphar@be095a3
• syphar@a8dcf15

I'm not sure if every user would like the expression_statement pieces in there, for me it belongs into the context.

For example in a multi line function call this would give me the first line of the call:

[lewis6991]

Updated both.

[lewis6991]

@romgrk I'm thinking of merging this fairly soon. Can you have a look?