VS Code seems to color parens incorrectly

[SCanzano]

I'm not an expert on the coloring in VS code but when I see red I think there is some form of an errors. Maybe that's a misunderstanding on my part but I also don't understand why I see the close parent in Red but no open Paren in Red,

[isc-bsaviano]

This is a duplicate of #1275 and intersystems/language-server#253.

TLDR: the bracket pair colorization is handled by VS Code core and it's a known issue that it can't handle Embedded SQL. You can try opening an issue on the VS Code GitHub to see if they can adjust their code to support this.

[NHS-juju]

Hey @isc-bsaviano - I was poking around this issue and wanted to run something by you as I hadn't seen this specific behaviour mentioned in the various instances of this issue being raised and closed, and wondered if this would change the current position of this being attributed to a fault with VSCode's bracket pair colourisation feature.

It seems that this issue only occurs when the curly bracket for the start of the method is on its own line (where it's placed on compile ¹ ).

For example:

• Method Test1() has the curly bracket on the same line as the method name etc, and the colourisation is as expected.
• Method Test2() has the curly bracket on a new line, and the colourisation is "broken".
• Method Test3() is the same as Test2 except for a leading space, and the colourisation is as expected.

Does this point to a conflict between the syntaxes for objectscript-class.tmLanguage.json and objectscript.tmLanguage.json or a different type of fault with the extensions?

Additionally, if the above doesn't change things, are you aware of this being raised on the VSCode Repo? I certainly couldn't find anything logged there.

Footnotes

1. In my screenshot, the curly brackets are in their various positions despite the class being saved/compiled, however closing and reopening the file does then have all 3 example methods with the curly brackets on their own line how as per how compiling formats methods. This varies slightly from how Studio would behave as the reformatting is presented immediately to the user on compile (presumably the opened class is refreshed on compile in Studio which is not happening in VSCode) ↩

[isc-bsaviano]

Thanks for the research @NHS-juju, it's very interesting. This bracket colorization is provided by VS Code. I'm pretty sure it works independently from our language grammars or the semantic tokens provided by the Language Server extension. I just checked and I have never reported this issue to the VS Code team. If you report this there, definitely provide this research. The VS Code team is much more likely to respond to detailed issues.

[NHS-juju]

Thanks @isc-bsaviano

Just went to raise an issue with the VSCode team, and the first question in their template was "Does this issue occur when all extensions are disabled?: Yes/No" so I thought I should try with all extensions disabled first as me answering no to this was a sure-fire way of the issue being closed off immediately.

Disabling everything means I can't connect to my server to open the class, so I have disabled everything first, and then selectively enabled only the 3 extensions contained within the extension pack. In this configuration, the colourisation is as before.

However, when disabling the Language Server extension I get the following:

Working colourisation!

I'm unable to then try this with the Language Server enabled and the InterSystems ObjectScript extension disabled as attempting this will then disable the Language Server due to its dependencies:

Unfortunately I'm very unfamiliar with how language servers are developed for VSCode (or any other IDEs for that matter) so would not be a good candidate for taking this further here or with the VSCode team, but I'm hopeful this is a small step in the right direction towards a resolution 🤞

ETA:

Correction - if I disable both the Language Server and core ObjectScript extension and then re-enable the Language Server which then auto-enables the ObjectScript extension, I get the below for the class that was open at the time these actions were completed.

Closing and reopening the class gives me the original "broken" colourisation.

I'm gonna go and stick to ObjectScript as this is giving me a headache 🤣

[isc-bsaviano]

Thanks for sharing all this info @NHS-juju! I can take it from here and open a VS Code issue. I will link it to this issue.

[isc-bsaviano]

@isc-bsaviano @NHS-juju With the help of a VS Code contributor I think I have a fix for this. If you want to try it out, please install the vsix contained in this zip archive:

vscode-objectscript-3.0.2-dev.1553.vsix.zip

[NHS-juju]

Hey @isc-bsaviano.

I have just tried this now, and I believe you have cracked it!