Syntax highlighting for embedded brs in scenegraph

[TwitchBronBron]

This adds syntax highlighting support for embedded brightscript/brighterscript code in CDATA tags within scenegraph xml files.

Before:

After:

NOTE: this might prevent xml formatters from working properly.

[TwitchBronBron]

@rokucommunity/core-team What are your thoughts on merging this? I think it has the potential to take over any other xml language stuff. Should we hold off until we add xml formatting support?

[georgejecook]

NOTE: this might prevent xml formatters from working properly. is a big no no for me.

most folks I know have coding standards that prohibit embedded brs.
most folks I know also use xml formatters.

[chrisdp]

Do we know if this would break tools like the Redhat xml tools? This is used by developers to get completion support for custom components in their xml.

If there is a chance it could break xml tools I would hold off as developing in this style is definitely not the community norm. If anything a quick fix action or command in xml files with cdata to pull it into its own file might be more interesting to most 🤔

[TwitchBronBron]

I definitely don't want to break existing workflows or plugins, so I'll do some more investigation to determine what the full impacts are.

[elsassph]

I concur with: do not break XML coding experience.

[rokucommunity-bot]

Hey there! I just built a new version of the vscode extension based on 2ca89c3. You can downloaded the .vsix here and then follow these installation instructions.

[chrisdp]

Looping back to this, what was the reason this could break other tools? Did this effectively change the file type in the editor?

[TwitchBronBron]

Looping back to this, what was the reason this could break other tools? Did this effectively change the file type in the editor?

The problem is that we need to define our own "language" type for SceneGraph files. I believe file formatters are done based on the langauge type, not the file extension. So if you have an XML formatter, this may not work anymore.

I haven't tested it in a while though, perhaps that was wrong.

If it does break formatting, then we will need to add our own xml formatting logic into the project before this can land.