feat(semantic_tokens): link lsp comments, e.g. conditional C ifdefs that won't evaluate

[amaanq]

Before:

After:

Would be very useful for C/C++ devs

[amaanq]

reorganized lsp tokens list by alphabetical order

[clason]

That (comment) should be a default link in Neovim. (There may also be some modifiers that could usefully linked by default.)

[folke]

I'm not 100% convinced about this change, but it's fine by me.
Can you change it to link to @comment instead?

[amaanq]

It's nice for C/C++ macros to have inactive sections highlighted as comments, and it's quite common in most IDEs

Updated to link to @comment

[folke]

awesome, thanks!

[swarn]

Just FYI: The reason that @lsp.type.comment is not default-linked to Comment is that, for servers like luaLS, the @lsp.type.comment highlight will hide useful treesitter highlights. For example, TODO inside comments is highlighted with @text.todo.comment, which will be hidden by the semantic highlight.

Notably, clangd only uses the comment token for #if 0 style preprocessor blocks, and not for actual comments, so linking @lsp.type.comment.c and @lsp.type.comment.cpp to @comment will not hide useful treesitter highlighting.

[amaanq]

Just FYI: The reason that @lsp.type.comment is not default-linked to Comment is that, for servers like luaLS, the @lsp.type.comment highlight will hide useful treesitter highlights. For example, TODO inside comments is highlighted with @text.todo.comment, which will be hidden by the semantic highlight.

Notably, clangd only uses the comment token for #if 0 style preprocessor blocks, and not for actual comments, so linking @lsp.type.comment.c and @lsp.type.comment.cpp to @comment will not hide useful treesitter highlighting.

Thanks for the headsup, and I'm sorry about that! I don't use treesitter's comments so I hadn't noticed that. I would totally be open to changing this only for c/cpp files, I do think such a case should be somewhat separate from regular comments anyways which I'm glad clangd does by not producing comment tokens for actual comments.