Bicep Syntax Highlighting missing on docs.microsoft.com

[afscrome]

Bicep version
N/A

Describe the bug
Syntax highlighting isn't showing up on docs.microsoft.com for bicep code snippets

To Reproduce
https://docs.microsoft.com/en-us/azure/azure-resource-manager/templates/bicep-file#resource-and-module-decorators

I'd expect snippets such as the following to have syntax highlighting:

[alex-frankel]

It's planned and we actually already have the highlight.js grammar done.

Unfortunately, docs.microsoft.com is going through some architectural changes w.r.t. syntax highlighting that are blocking us from making progress.

Current ETA is end of this calendar year :(

[Jaykul]

Looks like there's some syntax highlighting now, but it's got some bugs. Keywords are being highlighted in the middle of strings?

[alex-frankel]

Closing this one since at least the first iteration is done. @Jaykul - the reason this is happening is due to the simplicities of TextMate grammars which power syntax highlighting on docs.microsoft.com and GitHub. The syntax highlighting in the VS code extension is powered by semantic highlighting which is much more robust. Unfortunately, unless we can switch to semantic highlighting there will be odd quirks like this going forward.

[Jaykul]

@alex-frankel I hear you, but ... not highlighting the things inside strings is definitely doable even in regex grammars. I mean, we've all been using regex-powered syntax highlighting for a couple decades (notepad++, scintilla, textmate, sublime, etc) and let's be honest, most of the languages being highlighted on docs.microsoft.com are more complex than this one 😉

[alex-frankel]

To the extent that we can fix it easily, I am all for it. I was mostly trying to provide context as to why there is a highlighting mismatch between docs and our tooling.

Can you file a separate issue for this one so we can track it? cc @anthony-c-martin as FYI

[anthony-c-martin]

I suspect this is happening because expression defined in the hightlight.js grammar is referencing KEYWORDS:

bicep/src/highlightjs/src/bicep.ts

Lines 63 to 68 in b0da574

	const expression: Mode = {
	keywords: KEYWORDS,
	variants: [
	/* placeholder filled later due to cycle*/
	],
	};