adds missing tree-sitter-comment injection for js/ts

[farwyler]

this adds the injection for tree-sitter-comment to javascript. i am not sure if there is a reason for this missing. maybe it was supposed to interfere with the injection for "jsdoc" comments?

anyhow, it does seem to work to with both injections on "comment".

[the-mikedavis]

Yeah they fight with eachother a bit. Actually I can't reproduce the highlights you get:

Master	2763

[farwyler]

@the-mikedavis you are right, it is unstable and flip flops around while changing the document. i do consistently get the correct highlighting on first load tough. 😟

it seems to work as expected in neovim. i'll have a closer look.

[archseer]

You probably want to inject the comment grammar into the jsdoc grammar?

[farwyler]

You probably want to inject the comment grammar into the jsdoc grammar?

I am not sure how. The jsdoc injection is already attached to the (comment) node. How would i capture the root node of jsdoc then, to inject the comment parser there?

Doing this for javascript

((comment) @injection.content (#set! injection.language "comment"))
((comment) @injection.content (#set! injection.language "jsdoc"))

... actually works and is how the queries are defined in neovim. The ordering here is actually important.
I don't know if this is a valid approach given the current implementation though.

If it is, there seems to be a small issue here:

helix/helix-core/src/syntax.rs

Line 625 in ad15e7b

pub fn update(

When updating tree-sitter, the language layers for the injections are added in order as they are discovered in the document. In our case of comment fighting with jsdoc at the same node, it only produces the correct highlighting if the language layer for comment comes before jsdoc.

So is it technically and implemenation-wise valid to have two parsers capture the same node? And if so, shouldn't the ordering of layers for the injections be stable as it is defined in the queries?

Feedback much appreciated on this. I would really like to get a better grasp of the implementation here.

[the-mikedavis]

The root node for jsdoc is document but actually we can be more specific and inject comment into description which covers a bunch of text:

; runtime/queries/jsdoc/injections.scm
((description) @injection.content
 (#set! injection.language "comment"))

[farwyler]

The root node for jsdoc is document but actually we can be more specific and inject comment into description which covers a bunch of text:

; runtime/queries/jsdoc/injections.scm
((description) @injection.content
 (#set! injection.language "comment"))

jsdoc.document only captures multiline comments, so injecting comment via jsdoc will remove the comment highlighting from all inline comments.

sadly the javascript parser does not differentiate between single and multiline comments, as far as i can tell.

[the-mikedavis]

You can tell them apart using #match? in queries:

; runtime/queries/javascript/injections.scm

; block comment:
((comment) @injection.content
 (#set! injection.language "jsdoc")
 (#match? @injection.content "^/\\*.*\\*/$"))

; line comment:
((comment) @injection.content
 (#set! injection.language "comment")
 (#match? @injection.content "^//"))

[farwyler]

This works now in all kind of comment scenarios.

@the-mikedavis thanks for the support! fyi, i am using (document) instead of (description) because description seems to be specific to text following jsdoc @tags and not the whole comment.

/**
 * some description
 * FIXME: this is not (description)
 * @param {number} this counts as (description)
 * @returns
 */

[the-mikedavis]

Ah yeah good catch, let's use document 👍

[the-mikedavis]

Gave it a spin and this looks good. Thanks!