From fe57357337c5330e2157125470a24a5780c8884c Mon Sep 17 00:00:00 2001 From: "Hana (Hyang-Ah) Kim" Date: Wed, 1 May 2024 09:58:14 -0400 Subject: [PATCH] docs/faq.md: update the vscode default text mate rule project VS Code changed its TextMate rule source to worlpaker/go-syntax. Change-Id: I5c59ac851731c388a2a8a317ed5a3c5ca0946a69 Reviewed-on: https://go-review.googlesource.com/c/vscode-go/+/582675 Reviewed-by: Peter Weinberger Commit-Queue: Hyang-Ah Hana Kim kokoro-CI: kokoro --- README.md | 2 +- docs/faq.md | 9 +++++++-- 2 files changed, 8 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index fc1e3fc379..3aafedb87d 100644 --- a/README.md +++ b/README.md @@ -95,7 +95,7 @@ extension.
(Toggle Test File)

**⚠️ Note**: the default syntax highlighting for Go files is provided by a -[TextMate rule](https://github.com/jeff-hykin/better-go-syntax) embedded in VS +[TextMate rule](https://github.com/worlpaker/go-syntax) embedded in VS Code, not by this extension. For better syntax highlighting, we recommend enabling diff --git a/docs/faq.md b/docs/faq.md index 85bd464457..f9aecce365 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -5,10 +5,10 @@ ## Syntax highlighting doesn't seem to work. The default syntax highlighting for Go files is provided by a -[TextMate rule](https://github.com/jeff-hykin/better-go-syntax) embedded in VS Code, +[TextMate rule](https://github.com/worlpaker/go-syntax) embedded in VS Code, not by this extension. -For better syntax highlighting (including generics support), we recommend enabling +For accurate syntax highlighting (including generics support), we recommend enabling [semantic highlighting](https://code.visualstudio.com/api/language-extensions/semantic-highlight-guide) by turning on [Gopls' `ui.semanticTokens` setting](settings.md#uisemantictokens). @@ -16,6 +16,11 @@ by turning on [Gopls' `ui.semanticTokens` setting](settings.md#uisemantictokens) "gopls": { "ui.semanticTokens": true } ``` +If you are experiencing issues with syntax highlighting, first check if you +are using semantic highlighting. In case you did not enable semantic highlighting, +report the issues to the [go-syntax](https://github.com/worlpaker/go-syntax) +project directly. + ## Code formatting by this extension doesn't seem to work. When you have multiple formatter extensions, be sure to set this