From d0c6a31473f3d3c94be757713c65199a0ff3b908 Mon Sep 17 00:00:00 2001 From: Andrew Schwartzmeyer Date: Thu, 27 May 2021 11:09:09 -0700 Subject: [PATCH] Disable semantic highlighting by default This feature was not ready for full release, so we are disabling it by default until it has improved enough to re-release. --- docs/troubleshooting.md | 20 +++++++++++--------- package.json | 5 +++-- 2 files changed, 14 insertions(+), 11 deletions(-) diff --git a/docs/troubleshooting.md b/docs/troubleshooting.md index 96f55f76c3..7a75de0051 100644 --- a/docs/troubleshooting.md +++ b/docs/troubleshooting.md @@ -23,10 +23,12 @@ PowerShell syntax highlighting is performed in combintation by the [PowerShell E (semantic highlighting) and [Editor Syntax]. Syntax highlighting for VS Code, Atom, SublimeText and even GitHub is provided by the [Editor Syntax] repository on GitHub. -With the introduction of [Semantic Highlighting] in [v2021.2.2], the chosen colors may be -different because this is applied at a layer above [Editor Syntax]. To disable semantic -highlighting and so restore the colors as they were and rely solely on [Editor Syntax], -set: +We introducted [Semantic Highlighting] in [v2021.2.2], a feature that applies tokenized +colors at a layer above [Editor Syntax]. However, after [community feedback][#3221] and +multiple bug reports (including colors changing unexpectedly and [randomly][#3295]), we +have decided to disable it by default. + +To enable semantic highlighting and use this "experimental" feature, set: ```json "[powershell]": { @@ -34,11 +36,11 @@ set: } ``` -If you leave it enabled, you can customize the colors used for the various -tokens. See [#3221] for more info and to leave suggestions. +If you enable it, you can customize the colors used for the various tokens. See [#3221] +for more info and to leave suggestions. -If you disable it and your issue remains, then please open those [syntax highlighting -issues there]. +If it is disabled and your issue remains, then please open those syntax highlighting +issues there in [Editor Syntax]. ## Windows aren't appearing @@ -361,7 +363,6 @@ an issue on GitHub is appropriate. [open an issue there]: https://github.com/PowerShell/PSScriptAnalyzer/issues/new/choose [open an issue on us on GitHub]: https://github.com/PowerShell/vscode-powershell/issues/new/choose [Reporting Problems]: ../README.md#reporting-problems -[syntax highlighting issues there]: https://github.com/PowerShell/EditorSyntax/issues/new [semantic highlighting]: https://code.visualstudio.com/api/language-extensions/semantic-highlight-guide [tackling an issue]: ./development.md [v2021.2.2]: https://github.com/PowerShell/vscode-powershell/releases/tag/v2021.2.2 @@ -383,3 +384,4 @@ an issue on GitHub is appropriate. [#647]: https://github.com/PowerShell/vscode-powershell/issues/647 [#984]: https://github.com/PowerShell/vscode-powershell/issues/984 [#3221]: https://github.com/PowerShell/vscode-powershell/issues/3221#issuecomment-810563456 +[#3295]: https://github.com/PowerShell/vscode-powershell/issues/3295 diff --git a/package.json b/package.json index 876f4d8333..a56cd7969e 100644 --- a/package.json +++ b/package.json @@ -897,8 +897,9 @@ }, "configurationDefaults": { "[powershell]": { - "editor.wordSeparators": "`~!@#%^&*()=+[{]}\\|;:'\",.<>/?", - "debug.saveBeforeStart": "nonUntitledEditorsInActiveGroup" + "debug.saveBeforeStart": "nonUntitledEditorsInActiveGroup", + "editor.semanticHighlighting.enabled": false, + "editor.wordSeparators": "`~!@#%^&*()=+[{]}\\|;:'\",.<>/?" } }, "themes": [