|author||Rebecca Stambler <firstname.lastname@example.org>||Mon Jun 08 15:37:21 2020 -0400|
|committer||Hyang-Ah Hana Kim <email@example.com>||Tue Jun 09 16:07:27 2020 +0000|
[release] docs: automatically generate documentation for settings Write a script to automatically generate settings and command documentation using the package.json. Also, delete the smoke-test.md file in the project root. Not sure how it got there - probably I messed something up while renaming it. Change-Id: I229f322d6c45bc81a456f5deb534f6591f3917d9 Reviewed-on: https://go-review.googlesource.com/c/vscode-go/+/236963 Reviewed-by: Hyang-Ah Hana Kim <firstname.lastname@example.org> (cherry picked from commit 8a697eea0f74f502ec4f223a94bb9dbc124c113e) Reviewed-on: https://go-review.googlesource.com/c/vscode-go/+/237159
This extension provides rich language support for the Go programming language in VS Code.
Take a look at the Changelog to learn about new features.
This is the new home for the VS Code Go extension. We just migrated from Microsoft/vscode-go. Learn more our move on the Go blog.
Welcome! Whether you are new to Go or an experienced Go developer, we hope this extension will fit your needs and enhance your development experience.
Before you start coding, make sure that you have already installed Go, as explained in the Go installation guide.
If you are unsure whether you have installed Go, open the Command Palette in VS Code (Ctrl+Shift+P) and run the
Go: Locate Configured Go Tools command. If the
GOROOT output is empty, you are missing a Go installation. For help installing Go, ask a question on the
#newbies Gophers Slack channel.
Read about Go code organization to learn how to configure your environment. This extension works in both GOPATH and module modes. We suggest using modules, as they are quickly becoming the new standard in the Go community.
Here are some additional resources for learning about how to set up your Go project:
NOTE: If you are using modules, we recommend using the Go language server, which is explained below.
More advanced users may be interested in using different
GOPATHs or Go versions per-project. You can learn about the different
GOPATH manipulation options in the
GOPATH documentation. Take a look at the other customization options as well.
If you haven't already done so, install and open Visual Studio Code. Navigate to the Extensions pane (Ctrl+Shift+X). Search for “Go” and install this extension (the publisher ID is
To activate the extension, open any directory or workspace containing Go code.
You should immediately see a prompt in the bottom-right corner of your screen titled
Analysis Tools Missing. This extension relies on a suite of command-line tools, which must be installed separately. Accept the prompt, or use the
Go: Install/Update Tools command to pick which tools you would like to install.
If you see an error that looks like
command Go: Install/Update Tools not found, it means that the extension has failed to activate and register its commands. Please uninstall and then reinstall the extension.
You're ready to Go!
Be sure to learn more about the many features of this extension, as well as how to customize them. Take a look at Troubleshooting and Help for further guidance.
Go modules have added a lot of complexity to the way that most tools and features are built for Go. Some, but not all, features of this extension have been updated to work with Go modules. Some features may also be slower in module mode. The features documentation contains more specific details.
In general, we recommend using
gopls, the official Go language server, if you are using modules. Read more below and in the
This extension has a wide range of features, including Intellisense, code navigation, and code editing support. It also shows build, vet, and lint diagnostics as you work and provides enhanced support for testing and debugging your programs. For more detail, see the full feature breakdown.
In addition to integrated editing features, the extension also provides several commands for working with Go files. You can access any of these by opening the Command Palette (Ctrl+Shift+P) and typing in the name of the command. See the full list of commands provided by the extension.
The majority of the extension‘s functionality comes from command-line tools. If you’re experiencing an issue with a specific feature, you may want to investigate the underlying tool. You can do this by taking a look at the full list of tools used by this extension.
Debugging is a major feature offered by this extension. For a comprehensive overview of how to debug your Go programs, please see the debugging guide.
This extension needs no configuration; it works out of the box. However, you may wish to modify settings to adjust your experience.
Many of the features are configurable to your preference. A few common modifications are mentioned below, but take a look at the full list of settings for an overview.
A commonly customized feature is the linter, which is a tool used to provide coding style feedback and suggestions. By default, this extension uses the official
However, you are welcome to use more advanced options like
revive. This can be configured via the
"go.lintTool" setting, and the different options are explained more thoroughly in the list of diagnostic tools.
Advanced users may want to set different
GOPATHs for different projects or install the Go tools to a different
GOPATH. This is possible and explained in the
In the default mode, the Go extension relies upon a suite of command-line tools. A new alternative is to use a single language server, which provides language features through the Language Server Protocol.
The Go team at Google has developed
gopls, which is the official Go language server. It is currently in an alpha state and under active development.
gopls is recommended for projects that use Go modules.
To opt-in to the language server, set
true in your settings. You should then be prompted to install
gopls. If you are not prompted, you can install
gopls manually by running the
Go: Install/Update Tools command and selecting
For more information, see the
If you're having issues with this extension, please reach out to us by filing an issue or asking a question on the Gophers Slack. We hang out in the
Take a look at learn.go.dev and golang.org/help for additional guidance.
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.
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, please see our contribution cuide. It explains how to build and run the extension locally, and it describes the process of sending a contribution.
This project follows the Go Community Code of Conduct. If you encounter an issue, please mail email@example.com.