Skip to content

Commit 95d6a45

Browse files
hyangahgopherbot
authored andcommitted
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]>
1 parent 0cd19c8 commit 95d6a45

File tree

10 files changed

+36
-22
lines changed

10 files changed

+36
-22
lines changed

README.md

Lines changed: 10 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -23,21 +23,17 @@ extension fits your needs and enhances your development experience.
2323

2424
1. Install the [VS Code Go extension].
2525

26-
1. Open any directory or workspace containing Go code to automatically activate
27-
the extension. The
26+
1. Open any Go file or go.mod file to automatically activate the extension. The
2827
[Go status bar](https://github.com/golang/vscode-go/wiki/ui) appears in the
29-
bottom left corner of the window and displays your Go version.
28+
bottom right corner of the window and displays your Go version.
3029

31-
1. The extension depends on `go`, `gopls`, `dlv` and other optional tools. If
32-
any of the dependencies are missing, the ⚠️ `Analysis Tools Missing` warning
33-
is displayed. Click on the warning to download dependencies.
34-
35-
See the
36-
[tools documentation](https://github.com/golang/vscode-go/wiki/tools) for a
37-
complete list of tools the extension depends on.
30+
1. The extension depends on `go`, `gopls` (the Go language server), and optional
31+
tools depending on your settings. If `gopls` is missing, the extension will
32+
try to install it. The :zap: sign next to the Go version indicates
33+
the language server is running, and you are ready to go.
3834

3935
<p align="center">
40-
<img src="docs/images/installtools.gif" width=75%>
36+
<img src="docs/images/gettingstarted.gif" width=75%>
4137
<br/>
4238
<em>(Install Missing Tools)</em>
4339
</p>
@@ -52,7 +48,8 @@ You are ready to Go :-) &nbsp;&nbsp; 🎉🎉🎉
5248
and [advanced topics](https://github.com/golang/vscode-go/wiki/advanced) to
5349
customize the extension.
5450
* View the [tools documentation](https://github.com/golang/vscode-go/wiki/tools)
55-
for a complete list of tools the VS Code Go extension depends on.
51+
for a complete list of tools the VS Code Go extension depends on. You can
52+
install additional tools and update them by using "Go: Install/Update Tools".
5653
* Solve issues with the
5754
[general troubleshooting](https://github.com/golang/vscode-go/wiki/troubleshooting)
5855
and [debugging troubleshooting](https://github.com/golang/vscode-go/wiki/debugging#troubleshooting)
@@ -138,7 +135,7 @@ nightly build of this extension. Learn how to install it in by reading the
138135

139136
VS Code Go extension relies on the [Go Telemetry](https://telemetry.go.dev) to
140137
learn insights about the performance and stability of the extension and the
141-
language server (`gopls``).
138+
language server (`gopls`).
142139
**Go Telemetry data uploading is disabled by default** and can be enabled
143140
with the following command:
144141

docs/images/gettingstarted.gif

3.72 MB
Loading

docs/images/goexplorer.png

170 KB
Loading

docs/images/gopls.png

-7.76 KB
Binary file not shown.

docs/images/gostatusbar.png

210 KB
Loading

docs/images/languagestatusbar.png

61.4 KB
Loading

docs/images/selectGoVersion.png

-253 KB
Binary file not shown.

docs/images/statusbarmenu.png

-185 KB
Binary file not shown.

docs/tools.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,13 @@ This extension uses Delve for its debug/test functionalities. The extension curr
3535

3636
For a comprehensive overview of how to debug your Go programs, please see the [debugging guide](./debugging.md).
3737

38+
### [`vscgo`](https://pkg.go.dev/github.com/golang/vscode-go/cmd/vscgo)
39+
40+
This tool provides utilities needed by this extension but do not belong to the language server
41+
or debug adapter server. Examples include dependency tools management, developer survey
42+
configuration, and [Go telemetry collection](https://github.com/golang/vscode-go/issues/3121).
43+
This tool is released with the extension and installed in the extension's directory.
44+
3845
### [`goplay`](https://pkg.go.dev/github.com/haya14busa/goplay?tab=overview)
3946

4047
This tool provides support for the [`Go: Run on Go Playground`](features.md#go-playground) command.

docs/ui.md

Lines changed: 19 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,15 @@
22

33
## Using The Go Status Bar
44

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.
66

7-
<div style="text-align: center;"><img src="images/statusbarmenu.png" alt="vscode extension after Go status bar item is clicked" style="width:75%" > </div>
7+
<div style="text-align: center;"><img src="images/gostatusbar.png" alt="vscode extension after Go status bar item is clicked" style="width:75%" > </div>
88

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+
<div style="text-align: center;"><img src="images/languagestatusbar.png" alt="Go language status bar" style="width:75%" > </div>
914
### Go Environment
1015

1116
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,
1419

1520
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`.
1621

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.
1823

19-
<div style="text-align: center;"><img src="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+
```
2029

30+
You will need to reload the window after updating this setting. We are working on improving the version switch workflow.
2131

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.
2333

2434
### Installing a New Go Version
2535

@@ -31,9 +41,7 @@ Once the download completes, VS Code Go will make use of this new Go version.
3141

3242
`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.
3343

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-
<div style="text-align: center;"><img src="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.
3745

3846
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.
3947

@@ -47,4 +55,6 @@ More information about [using Go modules](https://go.dev/blog/using-go-modules )
4755

4856
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.
4957

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+
<div style="text-align: center;"><img src="images/goexplorer.png" alt="Go explorer view" style="width:75%" > </div>

0 commit comments

Comments
 (0)