PHPdoc

[piotrkwiecinski]

To support phpdoc blocks we have to use so called injections. This means delegating responsibility to other parsers.
it's a recommended way. JS tree-sitter has corresponding jsdoc too.

Based on a discussion in tree-sitter/tree-sitter-php#50

Here is an example from NVIM treesitter plugin:

https://github.com/nvim-treesitter/nvim-treesitter/blob/master/queries/php/injections.scm

We have to use https://github.com/claytonrcarter/tree-sitter-phpdoc

The same is going to apply if we would like to support SQL queries in strings

[piotrkwiecinski]

Early experiment

It requires creating additional parser and probably separate variables for phpdoc for highlights but tree sitter inspector detects additional nodes in comments.

(treesit-parser-create 'phpdoc)

(setq-local treesit-range-settings
              (treesit-range-rules
               :embed 'phpdoc
               :host 'php
               '((comment) @capture)))

I found useful information here: https://archive.casouri.cc/note/2023/tree-sitter-starter-guide/html-manual/Multiple-Languages.html

[piotrkwiecinski]

To support highlights in phpdoc we'll have to implement phpdoc-ts-mode and embed highlights.
The same applies to SQL and other nested languages.