|author||Suzy Mueller <firstname.lastname@example.org>||Wed Nov 08 10:37:07 2023 -0800|
|committer||Suzy Mueller <email@example.com>||Wed Nov 08 22:31:45 2023 +0000|
CHANGELOG.md: update planned release date Change-Id: Ic7d409ee6a2a1ef2ed15cbe62bb48d7cf8545912 Reviewed-on: https://go-review.googlesource.com/c/vscode-go/+/540836 Commit-Queue: Suzy Mueller <firstname.lastname@example.org> TryBot-Result: kokoro <email@example.com> Reviewed-by: Robert Findley <firstname.lastname@example.org> (cherry picked from commit ed92a0c250e8941abb9adab973c129a263ba1e41) Reviewed-on: https://go-review.googlesource.com/c/vscode-go/+/540838 TryBot-Bypass: Suzy Mueller <email@example.com> Reviewed-by: Alan Donovan <firstname.lastname@example.org>
Whether you are new to Go or an experienced Go developer, we hope this extension fits your needs and enhances your development experience.
Install Go 1.18 or newer if you haven't already.
Install the VS Code Go extension.
Open any directory or workspace containing Go code to automatically activate the extension. The Go status bar appears in the bottom left corner of the window and displays your Go version.
The extension depends on
dlv and other optional tools. If any of the dependencies are missing, the ⚠️
Analysis Tools Missing warning is displayed. Click on the warning to download dependencies.
See the tools documentation for a complete list of tools the extension depends on.
You are ready to Go :-) 🎉🎉🎉
If you are new to Go, this article provides the overview on Go code organization and basic
go commands. Watch “Getting started with VS Code Go” for an explanation of how to build your first Go application using VS Code Go.
See the full feature breakdown for more details.
In addition to integrated editing features, the extension provides several commands for working with Go files. You can access any of these by opening the Command Palette (
Ctrl+Shift+P on Linux/Windows and
Cmd+Shift+P on Mac), and then typing in the command name. See the full list of commands provided by this extension.
⚠️ Note: the default syntax highlighting for Go files is provided by a TextMate rule embedded in VS Code, not by this extension.
The VS Code Go extension supports both
GOPATH and Go modules modes.
Go modules are used to manage dependencies in recent versions of Go. Modules replace the
GOPATH-based approach to specifying which source files are used in a given build, and they are the default build mode in go1.16+. We highly recommend Go development in module mode. If you are working on existing projects, please consider migrating to modules.
Unlike the traditional
GOPATH mode, module mode does not require the workspace to be located under
GOPATH nor to use a specific structure. A module is defined by a directory tree of Go source files with a
go.mod file in the tree's root directory.
Your project may involve one or more modules. If you are working with multiple modules or uncommon project layouts, you will need to configure your workspace by using Workspace Folders. See the Supported workspace layouts documentation for more information.
If you'd like to get early access to new features and bug fixes, you can use the nightly build of this extension. Learn how to install it in by reading the Go Nightly documentation.
VS Code Go extension relies on the Go Telemetry to learn insights about the performance and stability of the extension and the language server (`gopls``). Go Telemetry data uploading is disabled by default and can be enabled with the following command:
go run golang.org/x/telemetry/cmd/gotelemetry@latest on
After telemetry is enabled, the language server will upload metrics and stack traces to telemetry.go.dev. You can inspect what data is collected and can be uploaded by running:
go run golang.org/x/telemetry/cmdgotelemetry@latest view
If we get enough adoption, this data can significantly advance the pace of the Go extension development, and help us meet a higher standard of reliability. For example:
These are just a few ways that telemetry can improve gopls. The telemetry blog post series contains many more.
Go telemetry is designed to be transparent and privacy-preserving. If you have concerns about enabling telemetry, you can learn more at https://telemetry.go.dev/privacy.
We welcome your contributions and thank you for working to improve the Go development experience in VS Code. If you would like to help work on the VS Code Go extension, see our contribution guide to learn how to build and run the VS Code Go extension locally and contribute to the project.