Skip to content

Commit 211b2bc

Browse files
committed
Add semantic highlighting note to troubleshooting doc
1 parent 44d8f40 commit 211b2bc

File tree

1 file changed

+19
-3
lines changed

1 file changed

+19
-3
lines changed

docs/troubleshooting.md

+19-3
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,20 @@ Instead syntax highlighting for VSCode, Atom, SublimeText and even GitHub is
1616
provided by the [Editor Syntax] repository on GitHub. Please open any
1717
[syntax highlighting issues there].
1818

19+
However, with the introduction of [Semantic Highlighting] in [v2021.2.2], the
20+
chosen colors may be different because this is applied at a layer above [Editor
21+
Syntax]. To disable semantic highlighting and so restore the colors as they
22+
were, set:
23+
24+
```json
25+
"[powershell]": {
26+
"editor.semanticHighlighting.enabled": false
27+
}
28+
```
29+
30+
If you leave it enabled, you can customize the colors used for the various
31+
tokens. See [#3221] for more info and to leave suggestions.
32+
1933
## VSCode is not working like the ISE
2034

2135
The PowerShell extension does not aim to perfectly recreate
@@ -31,7 +45,6 @@ VSCode itself and can't be changed by the extension.
3145
The VSCode maintainers are quite reasonable though,
3246
and you can ask for new features [in their repository](https://github.com/Microsoft/vscode).
3347

34-
3548
## Known Issues in the Extension
3649

3750
- If you are running the Preview version "PowerShell Preview" side-by-side with the stable version "PowerShell"
@@ -47,7 +60,7 @@ and you can ask for new features [in their repository](https://github.com/Micros
4760
Please give the privilege management software feedback.
4861
For some,
4962
[updating to the latest version has fixed the issue](https://github.com/PowerShell/vscode-powershell/issues/2526#issuecomment-638329157).
50-
- Intellisense is slow
63+
- IntelliSense is slow
5164
- This is a known issue that we've been chipping away at. There doesn't seem
5265
to be any one performance drain, but we've been trying to incrementally
5366
improve performance bit-by-bit everywhere. Currently we are focusing on [this issue](https://github.com/PowerShell/PowerShellEditorServices/issues/1295).
@@ -332,7 +345,9 @@ an issue on GitHub is appropriate.
332345
[open an issue on us on GitHub]: https://github.com/PowerShell/vscode-powershell/issues/new/choose
333346
[Reporting Problems]: ../README.md#reporting-problems
334347
[syntax highlighting issues there]: https://github.com/PowerShell/EditorSyntax/issues/new
335-
[tackling an issue]:./development.md
348+
[semantic highlighting]: https://code.visualstudio.com/api/language-extensions/semantic-highlight-guide
349+
[tackling an issue]: ./development.md
350+
[v2021.2.2]: https://github.com/PowerShell/vscode-powershell/releases/tag/v2021.2.2
336351
[VSCode issue]: https://github.com/Microsoft/vscode/issues/42356
337352
[VSCode Settings]: https://code.visualstudio.com/docs/getstarted/settings
338353
[will break this compatibility]: https://github.com/PowerShell/vscode-powershell/issues/1310
@@ -350,3 +365,4 @@ an issue on GitHub is appropriate.
350365
[#550]: https://github.com/PowerShell/vscode-powershell/issues/550
351366
[#647]: https://github.com/PowerShell/vscode-powershell/issues/647
352367
[#984]: https://github.com/PowerShell/vscode-powershell/issues/984
368+
[#3221]: https://github.com/PowerShell/vscode-powershell/issues/3221#issuecomment-810563456

0 commit comments

Comments
 (0)