[vscode-graphql-syntax] description comments are incorrectly highlighted

Description

In schema files, Markdown blocks / field descriptions seem to have incorrectly highlighted syntax. Neither single-quoted nor triple-quoted blocks feature a properly highlighted Markdown. Moreover, the color may be misleading as it is the same one that is used for the # comments.

This bug is really annoying so I will do my best to help you fix this issue.

Below you can find a simple reproduction / code example when this bug occurs.

Example

My setup

GraphQL.vscode-graphql v0.7.5
GraphQL.vscode-graphql-syntax v1.0.4

[mpieczaba]

Update: Thanks to safety_jon#5076 we concluded that the bug occurs only with some themes from the Community Material Theme extension. I would suggest keeping the issue open until we find the fix and share it here in the comments with others.

[jonathanawesome]

@acao thank you for the reminder! I did a search and can’t find duplicates for this one, so I’ll add my notes from Discord here and close.

Dear future reader, This issue isn’t a bug, it’s a symptom of certain VSCode themes’ implementation of token scopes (both Community Material Themes and Nord Theme have been identified with this issue, but there are likely more in the wild).

Here’s a screenshot of a working theme where you’ll see the foreground token is comment:

And here’s a non-working theme where the foreground token is punctuation:

To remedy in your local install, follow @FrankySnow’s comments above to set a tighter scope for the offending token. Even better, open a pull request at your theme’s repository!