Highlighting for strings with "$(...)" is inconsistent

[vors]

Moved from SublimeText/PowerShell#66

Environment

• Editor and Version (VS Code, Atom, Sublime): Sublime
• Your primary theme: Default

Issue Description

$(...) inside a string is an expression interpolation.
Ideally it should be highlighted exectly the same way as it's highlighted when put outside of the string context.
I'm not sure it's possible to achive with regex grammar.

Screenshots

Sublime -- difference between interpolated and non-interpolated

Expected Behavior

PowerShell_ISE -- both are the same

Code Samples

"blablabla $(invoke-foo baz $a.bar) blablabla"
invoke-foo baz $a.bar

[omniomi]

This would be easier with .sublime-syntax but I'll see what we can do within .tmLanguage.

[vors]

Yeah, sublime-syntax is more powerful then tmLanguage, but the benefits of having a common EditorSyntax (that we finally got) outweigh the benefits of more expressive grammar rules.

[msftrncs]

also see the images in this issue:

PowerShell/vscode-powershell#1401

It shows the static methods referenced in the first couple lines are colored wrong. Didn't realize it right away, as everything else looks pretty consistent.