Markdown.@md_str breaks syntax highlighting

[joshday]

Every other string macro I've tried is fine, but md"text" breaks the syntax highlighting for the rest of the document.

[jeremiahpslewis]

This seems like it still is an issue and may need to be reopened, example here.

[jeremiahpslewis]

(Ref: github-linguist/linguist#5637)

[pfitzseb]

Yeah, turns out I only committed the changelog entry in that PR. Should actually be fixed with #252.

[jeremiahpslewis]

Hahaha, shame on me for believing the release notes ;) Can you tag a new version so I can annoy github about updating linguist? Just saw 0.22.0. Thanks!

[jeremiahpslewis]

PR is here for reference: github-linguist/linguist#5638

[Alhadis]

Pro-tip: When embedding third-party grammars (particularly those you have no control over), it's always prudent to use a fixed-size pattern rather than a begin/end pair; i.e., this…

name: "string.quoted.double.julia"
match: '(")((?:[^"\\\\]|\\\\.)*+)(")'
captures:
	1: name: "punctuation.definition.string.begin.julia"
	2: name: "text.embedded.md", patterns: [include: "text.md"]
	3: name: "punctuation.definition.string.end.julia"

… instead of this:

name:  "string.quoted.double.julia"
begin: '"'
end:   '"'
beginCaptures: 0: name: "punctuation.definition.string.begin.julia"
endCaptures:   0: name: "punctuation.definition.string.end.julia"
contentName: "text.embedded.md"
patterns: [include: "text.md"]

I call this technique "clamping", because patterns that would otherwise threaten to spill past the end pattern (and ruin the document's highlighting) are confined to an existing capture group. The trade-off is that it isn't possible to embed multiline patterns this way, but that's a pretty sane trade-off when the alternative is screwing with the entire document.

[pfitzseb]

Thanks, that's a great solution. Do you have any ideas for multi-line strings, short of removing those rules?

[Alhadis]

Do you have any ideas for multi-line strings, short of removing those rules?

Yes, though it's a little trickier:

name:  "string.quoted.double.julia"
begin: '"'
end:   '"'
beginCaptures: 0: name: "punctuation.definition.string.begin.julia"
endCaptures:   0: name: "punctuation.definition.string.end.julia"
patterns: [{
	name: "text.embedded.md"
	match: '(?:[^"\\\\]|\\\\.)*+'
	captures:
		0: patterns: [include: "text.md"]
}]