| commit | c233889958fbcd056b49b13e075b2c6856e60b51 | [log] [tgz] |
|---|---|---|
| author | Hana (Hyang-Ah) Kim <hyangah@gmail.com> | Mon Sep 16 14:09:30 2024 -0400 |
| committer | Hyang-Ah Hana Kim <hyangah@gmail.com> | Wed Sep 18 13:52:14 2024 +0000 |
| tree | 43fa113f1b721faded1d08d071f8efa6505c1d9f | |
| parent | 1c7cd8ffb1850218f25a4889971b9b8cc076e665 [diff] |
all: remove reference to the nightly extension The nightly is deprecated in favor of the new pre-release versions. Clean up docs and references. Use "Pre-release" instead of "Preview" in user-facing doc. (We also use "insiders" or "preview" to refer to VS Code Pre-release inside our code or project to distinguish from semver's prerelease, but outside our project, "Pre-release extension" is the term to use) For golang/vscode-go#1953 Change-Id: Id9e5cc53fb1f459e69e7aa264ef76799b069c676 Reviewed-on: https://go-review.googlesource.com/c/vscode-go/+/613178 kokoro-CI: kokoro <noreply+kokoro@google.com> Reviewed-by: Robert Findley <rfindley@google.com> Commit-Queue: Hyang-Ah Hana Kim <hyangah@gmail.com>
The VS Code Go extension provides rich language support for the Go programming language.
Welcome! 👋🏻
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.19 or newer if you haven't already.
Install the VS Code Go extension.
Open any Go file or go.mod file to automatically activate the extension. The Go status bar appears in the bottom right corner of the window and displays your Go version.
The extension depends on go, gopls (the Go language server), and optional tools depending on your settings. If gopls is missing, the extension will try to install it. The :zap: sign next to the Go version indicates the language server is running, and you are ready to go.
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.
For better syntax highlighting, we recommend enabling semantic highlighting by turning on Gopls' ui.semanticTokens setting. "gopls": { "ui.semanticTokens": true }
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 pre-release extension. Following the vscode’s convention, we use the minor version of the extension version number to distinguish stable and pre-release versions (0.ODD_NUMBER.patch for pre-release, 0.EVEN_NUMBER.patch for stable release).
To install the pre-release version, use the drop-down list to select “Install Pre-Release Version”, or if already installed the Go extension, use the “Switch to Pre-Release Version” option in the Visual Studio Code extension management page. For more details about this mechanism, see the Visual Studio Code's 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/cmd/gotelemetry@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. Learn more at https://go.dev/doc/telemetry.
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.
This project follows the Go Community Code of Conduct. If you encounter a conduct-related issue, please mail conduct@golang.org.