[release] README.md: change links to be rendered correctly in vscode

When this is used for extension's Details page inside the vscode,
these links don't render properly. Maybe the markdown renderer used
for the extension info page has a bug. I observed the issue only in this
line where multiple such links are used.

Use the inlined form instead.

Change-Id: I003ac344cb3449453277335d953e640c8b1f13b4
Reviewed-on: https://go-review.googlesource.com/c/vscode-go/+/237077
Reviewed-by: Rebecca Stambler <rstambler@golang.org>
(cherry picked from commit 9f328b7cbe80a1be66f37faf71f31678fa1d9d62)
Reviewed-on: https://go-review.googlesource.com/c/vscode-go/+/236965
1 file changed
tree: e003dad89b118633e2bbd10502165add4d6d015e
  1. .editorconfig
  2. .github/
  3. .gitignore
  4. .prettierrc.json
  5. .travis.yml
  6. .vscode/
  7. .vscodeignore
  8. CHANGELOG.md
  9. CODE_OF_CONDUCT.md
  10. CONTRIBUTING.md
  11. LICENSE
  12. README.md
  13. build/
  14. docs/
  15. images/
  16. languages/
  17. package-lock.json
  18. package.json
  19. smoke-test.md
  20. snippets/
  21. src/
  22. syntaxes/
  23. test/
  24. thirdpartynotices.txt
  25. tsconfig.json
  26. tslint.json
  27. typings/
README.md

Go for Visual Studio Code

Slack

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 future home for the VS Code Go extension. We are currently migrating from the original repository. Read the announcement to learn about the transition and subscribe to Microsoft/vscode-go#3247 for updates.

Overview

Getting started

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.

Install Go

Before you start coding, make sure that you have already installed Go, as explained on the Go installation guide. If you are unsure, 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.

Set up your environment

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.

Install the extension

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 “golang.Go”).

Activate the Go extension

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 from the extension. Accept the prompt, or use the Go: Install/Update Tools command to pick which tools you would like to install. Note that you must have git installed.

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.

Start coding

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 Resources for further guidance.

Support for Go modules

Go modules have added a lot of complexity to the way most tools and features are built for Go. This has also added a lot of latency to most of the features. Some, but not all, features of this extension have been updated to work with Go modules. Some features may 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 gopls documentation.

Features

This extension has a wide range of features, including Intellisense, code navigation, and code editing support, as well as build, vet, and lint diagnostics as you work. The VS Code Go extension also 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 features are provided by command-line tools written in Go. If you’re having 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 the tools this extension depends on.

Debugging

Debugging is a major feature offered by this extension. For information on how to debug your Go program, please see the Debugging Guide. It includes information about debugging on Windows Subsystem for Linux (WSL) and remote debugging.

Customization

This extension needs no configuration; it works out of the box. However, you may wish to modify your experience.

Many of the features are configurable to your preference. The list of settings can be found in Settings and Commands documentation.

Linter

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

However, you are welcome to use more advanced options like staticcheck, golangci-lint, or revive. This can be configured via the "go.lintTool" setting, and the different options are explained more thoroughly in the list of diagnostic tools.

GOPATH

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 GOPATH documentation.

Language Server

The Go extension uses a suite of command-line tools to provide language features. A new alternative is to use a single language server, which provides the same features using 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, as it provides much better support.

To opt-in to the language server, set "go.useLanguageServer" to 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 gopls.

For more information, see the gopls documentation.

Ask for help

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 #vscode channel!

Take a look at learn.go.dev and golang.org/help for additional guidance.

Preview version

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.

Contributing

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 guide. It explains how to build and run the extension locally, as well as the process of sending a contribution.

Code of Conduct

This project follows the Go Community Code of Conduct. If you encounter an issue, please mail conduct@golang.org.

License

MIT