Google Git
Sign in
go / vscode-go / refs/tags/v0.41.0-rc.1
commit96111a5f1916fcaa3e5d081b234175c798acd9ba[log] [tgz]
authorHana (Hyang-Ah) Kim <hyangah@gmail.com>Fri Feb 09 19:54:55 2024 -0500
committerHana (Hyang-Ah) Kim <hyangah@gmail.com>Fri Feb 09 19:54:55 2024 -0500
tree1d09be00d36c7c572c812e1dcd8e21674fe72d51
parentb72c071d683bcd4e3480cea3794e5b41e7e548e6 [diff]
parent5b0d6db961e2b0a346d2984b0d10d8137cc5aba5 [diff]
[release] prepare v0.41.0 release

5b0d6db9 docs: update the debugging doc about remote mode default adapter
95d6a45b docs: update images and docs to reflect changes in v0.41.0
0cd19c81 extension/CHANGELOG.md: draft release note for v0.41.0
6bb2321e extension/src/goInstallTools: run updateImportantToolsStatus always
5382d03d extension/package.json: update the gopls setting @ v0.15.0-pre.2
4711dfab extension: move the Go statusbar item to right
a671ba3d extension: replace src/goLogging with vscode LogOutputChannel API
66a896ff all: convert the "Go" output channel to 'log' type
a8b52c17 launch.json: specify outFiles for integration tests
c21ee599 extension: recognize IDX as a web ide and auto-install gopls
8d10f634 package.json: update vscode type and vsce dependencies
c97d82d7 extension: consolidate documentSelector
89b02f46 src/goDeveloperSurvey: fix the prompt text
e6d1e92f .github/workflows: fix wiki.yml
5557e746 extension/CHANGELOG.md: add v0.40.2 entry
4b04b258 go.mod: update x/telemetry dependency
c5607ecb docs: update contribution instruction
bd87b3a9 extension/tools/release: uncomment vsce package and fix README handling
15be937e build: fix nightly release to include README
16c44c57 src/goDeveloperSurvey: prepare for 2024 dev survey
dbc9084f build/release-nightly.yaml: delete invalid format comment
557f09fa .github/workflows: fix github CI long test
690cf2e3 extension: move extension code to a separate module
b01b0b75 package.json: sync gopls settings (gopls@v0.15.0-pre.1)
932df9c2 .github/workflow: remove release.yml
481f2b5d build: add GCB release workflow
4d53cdc6 docs: update fill struct feature documentation
445a800c build: finish migration of nightly release to gcb
bb6f0ead src/goInstallTools,goTelemetry: add TelemetryReporter
0f48c2f6 vscgo: add a little helper program for vscode-go
db2b4c52 build: run tests and build golang.go-nightly
60c8ec9f src/goDebugConfiguration: change remote/attach default to dlv-dap
e54c9300 package.json: replace deprecated web-request with node-fetch@v2

Change-Id: Ic3f59b3a9f58f3f38a0d424ee8c0acd4592aff2b
tree: 1d09be00d36c7c572c812e1dcd8e21674fe72d51
  1. .github/
  2. .vscode/
  3. build/
  4. docs/
  5. extension/
  6. internal/
  7. vscgo/
  8. .editorconfig
  9. .gitignore
  10. CODE_OF_CONDUCT.md
  11. codereview.cfg
  12. doc.go
  13. go.mod
  14. go.sum
  15. LICENSE
  16. README.md
  17. SECURITY.md
README.md

Go for Visual Studio Code

Slack

The VS Code Go extension provides rich language support for the Go programming language.

Requirements

  • Visual Studio Code 1.75 or newer (or editors compatible with VS Code 1.75+ APIs)
  • Go 1.18 or newer

Quick Start

Welcome! 👋🏻
Whether you are new to Go or an experienced Go developer, we hope this extension fits your needs and enhances your development experience.

  1. Install Go 1.18 or newer if you haven't already.

  2. Install the VS Code Go extension.

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

  4. 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 :-)    🎉🎉🎉

What's next

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.

Feature highlights

  • IntelliSense - Results appear for symbols as you type.
  • Code navigation - Jump to or peek at a symbol's declaration.
  • Code editing - Support for saved snippets, formatting and code organization, and automatic organization of imports.
  • Diagnostics - Build, vet, and lint errors shown as you type or on save.
  • Enhanced support for testing and debugging

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 }

Setting up your workspace

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.

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.

Telemetry

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:

  • Even with semi-automated crash reports in VS Code, we've seen several crashers go unreported for weeks or months.
  • Even with a suite of benchmarks, some performance regressions don't show up in our benchmark environment (such as the completion bug mentioned below!).
  • Even with lots of great ideas for how to improve gopls, we have limited resources. Telemetry can help us identify which new features are most important, and which existing features aren‘t being used or aren’t working well.

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.

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, see our contribution guide to learn how to build and run the VS Code Go extension locally and contribute to the project.

Code of Conduct

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

License

MIT