|author||Hana (Hyang-Ah) Kim <email@example.com>||Fri Oct 28 10:18:40 2022 -0400|
|committer||Hyang-Ah Hana Kim <firstname.lastname@example.org>||Thu Nov 10 19:46:08 2022 +0000|
docs/settings: make the custom formatter support more visible Custom formatter support was added in golang/vscode-go#1238. But due to the limitation in the VS Code setting UI (which assumes the acceptable values list is static) and the setting validation logic (VS Code thinks it's an error to use a value outside of the supplied enum list is invalid), this is not visible to users. Instead, this change introduces an extra enum 'custom' for the "go.formatTool" setting. If this is chosen, the extension uses the tool specified as `customFormatter` in the "go.alternateTools" setting section for formatting. The extension expects the custom formatter to accept input as STDIN and output the result as STDOUT. Users can also supply "go.formatFlags". Changed the descriptions to use markdown - which allows to reference other settings ("`#...#`"). The document generation tool does not handle this special syntax nicely but I hope this isn't too confusing. I wish we could add an extra validation on the allowed value for "go.formatTool" in favor of this new 'custom' option. I am not adding the validation in this CL because there could be users who depend on this behavior. For golang/vscode-go#1238 For golang/vscode-go#1603 For golang/vscode-go#2503 Change-Id: I5d9564f331845b6b07f0b54148834118404f3553 Reviewed-on: https://go-review.googlesource.com/c/vscode-go/+/446298 Reviewed-by: Jamal Carvalho <email@example.com> Run-TryBot: Hyang-Ah Hana Kim <firstname.lastname@example.org> TryBot-Result: kokoro <email@example.com>
📣 Remote attach debugging is now available via Delve's native DAP implementation with Delve v1.7.3 or newer. It enchances remote debugging with the same debugging features that are already in use for local debugging. It is now the default with the Go Nightly build of the extension and will become the default for the stable releases in mid 2022. We recommend switching your remote attach configurations in
launch.json to use
"debugAdapter":"dlv-dap" now to verify that this works for you. Please file a new issue if you encounter any problems.
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.14 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.
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.