Commit bc694d6

authored

Disable semantic highlighting by default (#3377)

This feature was not ready for full release, so we are disabling it by default until it has improved enough to re-release.

1 parent a28df58 commit bc694d6Copy full SHA for bc694d6

File tree

2 files changed

+14

-11

lines changed

docs
- troubleshooting.md
package.json

2 files changed

+14

-11

lines changed

`‎docs/troubleshooting.md‎`

Lines changed: 11 additions & 9 deletions

Original file line number	Diff line number	Diff line change
`@@ -23,22 +23,24 @@ PowerShell syntax highlighting is performed in combintation by the [PowerShell E`
`23`	`23`	`(semantic highlighting) and [Editor Syntax]. Syntax highlighting for VS Code, Atom,`
`24`	`24`	`SublimeText and even GitHub is provided by the [Editor Syntax] repository on GitHub.`
`25`	`25`
`26`		`-With the introduction of [Semantic Highlighting] in [v2021.2.2], the chosen colors may be`
`27`		`-different because this is applied at a layer above [Editor Syntax]. To disable semantic`
`28`		`-highlighting and so restore the colors as they were and rely solely on [Editor Syntax],`
`29`		`-set:`
	`26`	`+We introducted [Semantic Highlighting] in [v2021.2.2], a feature that applies tokenized`
	`27`	`+colors at a layer above [Editor Syntax]. However, after [community feedback][#3221] and`
	`28`	`+multiple bug reports (including colors changing unexpectedly and [randomly][#3295]), we`
	`29`	`+have decided to disable it by default.`
	`30`	`+`
	`31`	`+To enable semantic highlighting and use this "experimental" feature, set:`
`30`	`32`
`31`	`33`	```json
`32`	`34`	`"[powershell]": {`
`33`	`35`	`"editor.semanticHighlighting.enabled": false`
`34`	`36`	`}`
`35`	`37`	```
`36`	`38`
`37`		`-If you leave it enabled, you can customize the colors used for the various`
`38`		`-tokens. See [#3221]for more info and to leave suggestions.`
	`39`	`+If you enable it, you can customize the colors used for the various tokens. See [#3221]`
	`40`	`+for more info and to leave suggestions.`
`39`	`41`
`40`		`-If you disable it and your issue remains, then please open those [syntax highlighting`
`41`		`-issues there].`
	`42`	`+If it is disabled and your issue remains, then please open those syntax highlighting`
	`43`	`+issues there in [Editor Syntax].`
`42`	`44`
`43`	`45`	`## Windows aren't appearing`
`44`	`46`
`@@ -361,7 +363,6 @@ an issue on GitHub is appropriate.`
`361`	`363`	`[open an issue there]: https://github.com/PowerShell/PSScriptAnalyzer/issues/new/choose`
`362`	`364`	`[open an issue on us on GitHub]: https://github.com/PowerShell/vscode-powershell/issues/new/choose`
`363`	`365`	`[Reporting Problems]: ../README.md#reporting-problems`
`364`		`-[syntax highlighting issues there]: https://github.com/PowerShell/EditorSyntax/issues/new`
`365`	`366`	`[semantic highlighting]: https://code.visualstudio.com/api/language-extensions/semantic-highlight-guide`
`366`	`367`	`[tackling an issue]: ./development.md`
`367`	`368`	`[v2021.2.2]: https://github.com/PowerShell/vscode-powershell/releases/tag/v2021.2.2`
`@@ -383,3 +384,4 @@ an issue on GitHub is appropriate.`
`383`	`384`	`[#647]: https://github.com/PowerShell/vscode-powershell/issues/647`
`384`	`385`	`[#984]: https://github.com/PowerShell/vscode-powershell/issues/984`
`385`	`386`	`[#3221]: https://github.com/PowerShell/vscode-powershell/issues/3221#issuecomment-810563456`
	`387`	`+[#3295]: https://github.com/PowerShell/vscode-powershell/issues/3295`

`‎package.json‎`

Lines changed: 3 additions & 2 deletions

Original file line number	Diff line number	Diff line change
`@@ -897,8 +897,9 @@`
`897`	`897`	`},`
`898`	`898`	`"configurationDefaults": {`
`899`	`899`	`"[powershell]": {`
`900`		- "editor.wordSeparators": "`~!@#%^&*()=+[{]}\\\|;:'\",.<>/?",
`901`		`- "debug.saveBeforeStart": "nonUntitledEditorsInActiveGroup"`
	`900`	`+ "debug.saveBeforeStart": "nonUntitledEditorsInActiveGroup",`
	`901`	`+ "editor.semanticHighlighting.enabled": false,`
	`902`	+ "editor.wordSeparators": "`~!@#%^&*()=+[{]}\\\|;:'\",.<>/?"
`902`	`903`	`}`
`903`	`904`	`},`
`904`	`905`	`"themes": [`

0 commit comments

Comments

(0)

Navigation Menu

Search code, repositories, users, issues, pull requests...

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Commit bc694d6

File tree

2 files changed

2 files changed

`‎docs/troubleshooting.md‎`

`‎package.json‎`

0 commit comments