You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs: update images and docs to reflect changes in v0.41.0
README - update the setup instruction. The "Analysis Tools Missing"
notification was removed and important tools are installed
automatically.
UI - Go status bar was moved to right, Language status bar is added.
Add the screenshot for Go explorer view. Rephrase the go version
management section to direct users to use GOTOOLCHAIN env var. But
we still need to rethink/rewrite this workflow.
Tools - mention the vscgo binary.
For #3167
Change-Id: Iad5528fdfcd9f9b282e6a873259e2c8cecdec227
Reviewed-on: https://go-review.googlesource.com/c/vscode-go/+/562681
Commit-Queue: Hyang-Ah Hana Kim <[email protected]>
Auto-Submit: Hyang-Ah Hana Kim <[email protected]>
Reviewed-by: Suzy Mueller <[email protected]>
TryBot-Result: kokoro <[email protected]>
Copy file name to clipboardExpand all lines: docs/ui.md
+19-9Lines changed: 19 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,10 +2,15 @@
2
2
3
3
## Using The Go Status Bar
4
4
5
-
The Go status bar appears in the lower left of the extension window. Clicking the Go status bar brings up a menu that provides easy access to see and update important information about your Go project. This includes information about the Go environment, the current Go version, the `gopls` trace, and about the current module.
5
+
The Go status bar appears in the lower right of the extension window, next to the Editor Language status bar item. Clicking the Go status bar brings up a menu that provides easy access to see and update important information about your Go project. This includes information about the Go environment, the current Go version, the `gopls` trace, and about the current module.
6
6
7
-
<divstyle="text-align: center;"><imgsrc="images/statusbarmenu.png"alt="vscode extension after Go status bar item is clicked"style="width:75%" > </div>
7
+
<divstyle="text-align: center;"><imgsrc="images/gostatusbar.png"alt="vscode extension after Go status bar item is clicked"style="width:75%" > </div>
8
8
9
+
## Using The Language Status Bar
10
+
11
+
The Language status bar shows status of dependency tools installation or availability of newly released Go versions.
12
+
13
+
<divstyle="text-align: center;"><imgsrc="images/languagestatusbar.png"alt="Go language status bar"style="width:75%" > </div>
9
14
### Go Environment
10
15
11
16
The `Go Locate Configured Go Tools` command will display the configured GOPATH, GOROOT, tool locations and the results of `go env` in the output window.
@@ -14,12 +19,17 @@ The `Go Locate Configured Go Tools` command will display the configured GOPATH,
14
19
15
20
You can view the current Go version by looking at the status bar item in the bottom left corner of VS Code. Clicking this button and selecting `Choose Go Environment` will present you with a menu from which you can select any version of Go that exists in your $HOME/sdk directory or on <https://golang.org/dl>. This command is also available through the command pallette using `Go: Choose Go Environment`.
16
21
17
-
Previously, the `go.goroot` and `go.alternateTools` settings controlled the Go version used by VS Code Go. If you have configured these settings, they are no longer needed and should be deleted.
22
+
If you are using go1.21 or newer, you can control your Go version using the `GOTOOLCHAIN` environment variable. See https://go.dev/doc/toolchain for more information. To tell the extension to use a different `GOTOOLCHAIN`, use the `go.toolsEnvVars` setting or the Go explorer view.
18
23
19
-
<divstyle="text-align: center;"><imgsrc="images/selectGoVersion.png"alt="command pallete menu for selecting a new Go version"style="width:75%" > </div>
24
+
```
25
+
"go.toolsEnvVars": {
26
+
"GOTOOLCHAIN": "go1.21.0+auto"
27
+
}
28
+
```
20
29
30
+
You will need to reload the window after updating this setting. We are working on improving the version switch workflow.
21
31
22
-
The "Clear Selection" option resets your Go version to the one found first in either `go.alternateTools`, `go.goroot` or your PATH.
32
+
Previously, the `go.goroot` and `go.alternateTools` settings controlled the Go version used by VS Code Go. If you have configured these settings, they are no longer needed and should be deleted.
23
33
24
34
### Installing a New Go Version
25
35
@@ -31,9 +41,7 @@ Once the download completes, VS Code Go will make use of this new Go version.
31
41
32
42
`gopls` is the official Go [language server](https://langserver.org/) developed by the Go team. It was developed in response to the release of Go modules, and it is the recommended approach when working with Go modules in VS Code.
33
43
34
-
When `gopls` is enabled, :zap: is displayed next to the Go version in the status bar and the `gopls` version is displayed in the menu.
35
-
36
-
<divstyle="text-align: center;"><imgsrc="images/gopls.png"alt="command pallete menu for selecting a new Go version"style="width:100px" > </div>
44
+
When `gopls` is enabled, :zap: is displayed next to the Go version in the Go status bar and the `gopls` version is displayed in the menu.
37
45
38
46
Selecting `Open 'gopls' trace` will open the trace of the `gopls` server in the output window. Please include this trace when filing an issue related to the extension and `gopls` is enabled.
39
47
@@ -47,4 +55,6 @@ More information about [using Go modules](https://go.dev/blog/using-go-modules )
47
55
48
56
The view displays the go environment variables (`go env`) that are applied to the file open in the editor. You can customize the list by "Go: Edit Workspace" command (pencil icon), and update modifiable environment variables through this view.
49
57
50
-
It displays required [tools](tools.md) and their location/version info, too.
58
+
It displays required [tools](tools.md) and their location/version info, too.
59
+
60
+
<divstyle="text-align: center;"><imgsrc="images/goexplorer.png"alt="Go explorer view"style="width:75%" > </div>
0 commit comments