You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: README.md
+158-58
Original file line number
Diff line number
Diff line change
@@ -4,123 +4,211 @@
4
4
5
5
<!--TODO: We should add a badge for the build status or link to the build dashboard.-->
6
6
7
-
[The VS Code Go extension](https://marketplace.visualstudio.com/items?itemName=golang.go) provides rich language support for the [Go programming language](https://golang.org/).
7
+
[The VS Code Go extension](https://marketplace.visualstudio.com/items?itemName=golang.go)
8
+
provides rich language support for the
9
+
[Go programming language](https://golang.org/).
8
10
9
-
> 📣 We will enable the language server ([`gopls`]) by default in the end of Jan 2021.
10
-
> We recommend switching to the language server now (`"go.useLanguageServer": true`) to confirm it works well for you.
11
-
> Please [file a new issue](https://github.com/golang/vscode-go/issues/new/choose) if you notice bugs or missing features.
11
+
> 📣 We will enable the language server ([`gopls`]) by default in the end of Jan
12
+
> 2021. We recommend switching to the language server now
13
+
> (`"go.useLanguageServer": true`) to confirm it works well for you. Please
14
+
> [file a new issue](https://github.com/golang/vscode-go/issues/new/choose) if
15
+
> you notice bugs or missing features.
12
16
13
17
## Quick Start
14
18
15
19
Welcome! 👋🏻<br/>
16
-
Whether you are new to Go or an experienced Go developer, we hope this extension fits your needs and enhances your development experience.
17
-
18
-
-**Step 1.** If you haven't done so already, install [Go](https://golang.org) and the [VS Code Go extension](https://marketplace.visualstudio.com/items?itemName=golang.go).
19
-
- [Go installation guide](https://golang.org/doc/install). This extension works best with Go 1.14+.
20
-
- [Manage extensions in VS Code](https://code.visualstudio.com/docs/editor/extension-gallery)
21
-
-**Step 2.** To activate the extension, open any directory or workspace containing Go code. Once activated, the [Go status bar](docs/ui.md) will appear in the bottom left corner of the window and show the recognized Go version.
22
-
-**Step 3.** The extension depends on [a set of extra command-line tools](#tools). If they are missing, the extension will show the "⚠️ Analysis Tools Missing" warning. Click the notification to complete the installation.
Whether you are new to Go or an experienced Go developer, we hope this
21
+
extension fits your needs and enhances your development experience.
22
+
23
+
***Step 1.** If you haven't done so already, install [Go](https://golang.org)
24
+
and the [VS Code Go extension].
25
+
*[Go installation guide]. This extension works best with Go 1.14+.
26
+
*[Manage extensions in VS Code].
27
+
***Step 2.** To activate the extension, open any directory or workspace
28
+
containing Go code. Once activated, the [Go status bar](docs/ui.md) will
29
+
appear in the bottom left corner of the window and show the recognized Go
30
+
version.
31
+
***Step 3.** The extension depends on [a set of extra command-line tools](#tools).
32
+
If they are missing, the extension will show the "⚠️ Analysis Tools Missing"
33
+
warning. Click the notification to complete the installation.
34
+
35
+
<palign="center">
36
+
<imgsrc="docs/images/installtools.gif"width=75%>
37
+
<br/>
38
+
<em>(Install Missing Tools)</em>
26
39
</p>
27
40
28
41
You are ready to Go :-) 🎉🎉🎉
29
42
30
-
Please be sure to learn more about many [features](#features) of this extension as well as how to [customize](#customization) them. Take a look at [Troubleshooting](docs/troubleshooting.md) and [Help](#ask-for-help) for further guidance.
43
+
Please be sure to learn more about many [features](#features) of this extension
44
+
as well as how to [customize](#customization) them. Take a look at
45
+
[Troubleshooting](docs/troubleshooting.md) and [Help](#ask-for-help) for further
46
+
guidance.
31
47
32
-
If you are new to Go, [this article](https://golang.org/doc/code.html) provides the overview on go code organization and basic `go` commands. The recent [Go open source live video](https://opensourcelive.withgoogle.com/events/go/watch?talk=session3) featured VS Code Go and demonstrated how other Gophers use the features to enhance their Go development workflow.
48
+
If you are new to Go, [this article](https://golang.org/doc/code.html) provides
49
+
the overview on go code organization and basic `go` commands. The recent
50
+
[Go open source live video] featured VS Code Go and demonstrated how other
51
+
Gophers use the features to enhance their Go development workflow.
33
52
34
53
## Features
35
54
36
-
This extension provides many features, including [IntelliSense](docs/features.md#intellisense), [code navigation](docs/features.md#code-navigation), and [code editing](docs/features.md#code-editing) support. It also shows [diagnostics](docs/features.md#diagnostics) as you work and provides enhanced support for [testing](docs/features.md##run-and-test-in-the-editor) and [debugging](#debugging) your programs. See the [full feature breakdown](docs/features.md) for more details and to learn how to tune the behavior.
55
+
This extension provides many features, including [IntelliSense],
56
+
[code navigation], [code editing] support. It also shows [diagnostics] as you
57
+
work and provides enhanced support for [testing] and [debugging] your programs.
58
+
See the [full feature breakdown] for more details and to learn how to tune the
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](docs/commands.md#detailed-list) provided by the extension.
67
+
In addition to integrated editing features, the extension provides several
68
+
commands for working with Go files. You can access any of these by opening the
69
+
Command Palette (`Ctrl+Shift+P` on Linux/Windows and `Cmd+Shift+P` on Mac), and
70
+
then typing in the command name. See the
71
+
[full list of commands](docs/commands.md#detailed-list) provided by the
**⚠️ Note**: the default syntax highlighting for Go files is provided by the [TextMate rule](https://github.com/jeff-hykin/better-go-syntax) embedded in VS Code, not by this extension.
78
+
**⚠️ Note**: the default syntax highlighting for Go files is provided by the
79
+
[TextMate rule](https://github.com/jeff-hykin/better-go-syntax) embedded in VS
80
+
Code, not by this extension.
48
81
49
82
## Tools
50
83
51
-
The extension uses a few command-line tools developed by the Go community. In particular, `go`, `gopls`, and `dlv` are used to implement build/test, language features, and debugging functionalities of this extension. See the [tools documentation](docs/tools.md) for a complete list of tools the extension depends on.
52
-
53
-
In order to locate the command-line tools, the extension searches `$GOPATH/bin` and directories specified in the `PATH` environment variable (or `Path` in Windows) with which the VS Code process has started. If the tools are not found, the extension will prompt you to install the missing tools and show the "⚠️ Analysis Tools Missing" warning in the bottom right corner. Please install them by responding to the warning notification, or by manually running the `Go: Install/Update Go Tools` command. The extension will run the [`go get`](https://golang.org/cmd/go) command to install them.
84
+
The extension uses a few command-line tools developed by the Go community. In
85
+
particular, `go`, `gopls`, and `dlv` are used to implement build/test, language
86
+
features, and debugging functionalities of this extension. See the
87
+
[tools documentation](docs/tools.md) for a complete list of tools the extension
88
+
depends on.
89
+
90
+
In order to locate the command-line tools, the extension searches `$GOPATH/bin`
91
+
and directories specified in the `PATH` environment variable (or `Path` in
92
+
Windows) with which the VS Code process has started. If the tools are not found,
93
+
the extension will prompt you to install the missing tools and show the "⚠️
94
+
Analysis Tools Missing" warning in the bottom right corner. Please install them
95
+
by responding to the warning notification, or by manually running the `Go:
96
+
Install/Update Go Tools` command. The extension will run the
97
+
[`go get`](https://golang.org/cmd/go) command to install them.
54
98
55
99
## Setting up your workspace
56
100
57
-
[Go modules](https://golang.org/ref/mod) are how Go manages 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+. While this extension continues to support both Go modules and `GOPATH`-mode, we highly recommend Go development in module mode. If you are working on existing projects, please consider migrating to modules.
58
-
59
-
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 so that the extension knows which code to load, so that features like references can work across modules. Please see the [workspace documentation](https://github.com/golang/tools/blob/master/gopls/doc/workspace.md) for information on supported workspace layouts.
101
+
[Go modules](https://golang.org/ref/mod) are how Go manages dependencies in
102
+
recent versions of Go. Modules replace the `GOPATH`-based approach to specifying
103
+
which source files are used in a given build, and they are the default build
104
+
mode in go1.16+. While this extension continues to support both Go modules and
105
+
`GOPATH` mode, we highly recommend Go development in module mode. If you are
106
+
working on existing projects, please consider migrating to modules.
107
+
108
+
Unlike the traditional `GOPATH` mode, module mode does not require the workspace
109
+
to be located under `GOPATH` nor to use a specific structure. A module is
110
+
defined by a directory tree of Go source files with a `go.mod` file in the
111
+
tree's root directory. Your project may involve one or more modules. If you are
112
+
working with multiple modules or uncommon project layouts, you will need to
113
+
configure your workspace so that the extension knows which code to load, so that
114
+
features like references can work across modules. Please see the
115
+
for information on supported workspace layouts.
60
116
61
117
## Customization
62
118
63
-
The extension needs no configuration and should work out of the box. However, you may wish to adjust settings to customize its behavior. Below are a few commonly used settings. Please see the [settings documentation](docs/settings.md) for a comprehensive list of settings.
119
+
The extension needs no configuration and should work out of the box. However,
120
+
you may wish to adjust settings to customize its behavior. Below are a few
121
+
commonly used settings. Please see the
122
+
[settings documentation](docs/settings.md) for a comprehensive list of settings.
64
123
65
124
### Choosing a different version of Go
66
125
67
-
The extension chooses the `go` command using the `PATH` (or `Path`) environment variable by default. You can configure the extension to choose a different version of `go` with one of the following options.
126
+
The extension chooses the `go` command using the `PATH` (or `Path`) environment
127
+
variable by default. You can configure the extension to choose a different
128
+
version of `go` with one of the following options.
129
+
130
+
* (Preferred) Adjust your `PATH` or `Path` environment variable, and *open VS
131
+
Code with the adjusted environment* variable, or
132
+
* Use the Go extension's `"Go: Choose Go Environment"` command that opens a
133
+
[menu](docs/ui.md) to change the `go` version, or
134
+
* Use the `"go.alternateTools"` settings and specify the absolute path to the
**note**: For historical reasons, some users configure the `"go.goroot"`
75
138
76
-
**note**: For historical reasons, some users configure the `"go.goroot"` settings or the `GOROOT` environment variable to select the Go SDK location. With recent versions of Go, that's unnecessary in most cases.
139
+
settings or the `GOROOT` environment variable to select the Go SDK location.
140
+
With recent versions of Go, that's unnecessary in most cases.
77
141
78
142
### Configuring the installation of command-line tools
79
143
80
-
The `Go: Install/Update Tools` command uses the `go get` command to download and install requested tools. By default, `go get` will install the compiled tools in one of the following directories.
81
-
- the directory the `GOBIN` environment variable specifies, or
82
-
- the `bin` directory under the first `GOPATH` (or `"go.gopath"`) directory, or
83
-
- the `$HOME/go/bin` (or `$USERPROFILE/go/bin`) directory.
144
+
The `Go: Install/Update Tools` command uses the `go get` command to download and
145
+
install requested tools. By default, `go get` will install the compiled tools in
146
+
one of the following directories.
147
+
148
+
* the directory the `GOBIN` environment variable specifies, or
149
+
* the `bin` directory under the first `GOPATH` (or `"go.gopath"`) directory, or
150
+
* the `$HOME/go/bin` (or `$USERPROFILE/go/bin`) directory.
84
151
85
-
Some users prefer to choose a different installation location. In that case, use the `"go.toolsGopath"` setting.
152
+
Some users prefer to choose a different installation location. In that case, use
153
+
the `"go.toolsGopath"` setting.
86
154
87
-
The extension finds the required tools by their names (`go`, `gopls`, `dlv`, etc.). The `"go.alternateTools"` setting provides a way to configure the extension to use different tool location, for example a wrapper with a different name.
155
+
The extension finds the required tools by their names (`go`, `gopls`, `dlv`,
156
+
etc.). The `"go.alternateTools"` setting provides a way to configure the
157
+
extension to use different tool location, for example a wrapper with a different
158
+
name.
88
159
89
160
### Using a custom linter
90
161
91
-
A commonly customized feature is the linter, which is the tool used to provide coding style feedback and suggestions.
92
-
This extension supports linters such as `staticcheck`, `golangci-lint`, and `revive`. You can choose one of them using the `"go.lintTool"` setting. For customization of the linter, please consult the linter's documentation.
162
+
A commonly customized feature is the linter, which is the tool used to provide
163
+
coding style feedback and suggestions. This extension supports linters such as
164
+
`staticcheck`, `golangci-lint`, and `revive`. You can choose one of them using
165
+
the `"go.lintTool"` setting. For customization of the linter, please consult the
166
+
linter's documentation.
93
167
94
-
Note that if you are using `staticcheck`, you can enable it to run within `gopls` by setting
95
-
```
96
-
"gopls": {
97
-
"ui.diagnostic.staticcheck": true
98
-
}
99
-
```
168
+
Note that if you are using `staticcheck`, you can enable it to run within
169
+
`gopls` by setting `"gopls": { "ui.diagnostic.staticcheck": true }`.
100
170
101
-
<!-- TODO: maybe have tips.md or settings.md to discuss more customization and setting tips (e.g. activating signature help after completion, disabling snippets to reduce the interference with gopls' suggestions, setting proxies, etc.) -->
171
+
<!-- TODO: maybe have tips.md or settings.md to discuss more customization and
172
+
setting tips (e.g. activating signature help after completion, disabling
173
+
snippets to reduce the interference with gopls' suggestions, setting proxies,
174
+
etc.)-->
102
175
103
176
### Working on the Go standard library and the Go tools
104
177
105
-
When you need to work on the [Go project](https://go.googlesource.com/go), please follow the instruction in the [Standard Library Development](docs/stdlib.md) documentation to adjust your settings.
178
+
When you need to work on the [Go project](https://go.googlesource.com/go),
179
+
please follow the instruction in the
180
+
[Standard Library Development](docs/stdlib.md) documentation to adjust your
181
+
settings.
106
182
107
183
## Ask for help
108
184
109
-
If you're having issues with this extension, please reach out to us by [filing an issue](https://github.com/golang/vscode-go/issues/new/choose) or asking a question on the [Gophers Slack]. We hang out in the `#vscode` channel!
185
+
If you're having issues with this extension, please reach out to us by
186
+
[filing an issue](https://github.com/golang/vscode-go/issues/new/choose) or
187
+
asking a question on the [Gophers Slack]. We hang out in the `#vscode` channel!
110
188
111
-
Take a look at [learn.go.dev](https://learn.go.dev) and [golang.org/help](https://golang.org/help) for more general guidance on using Go.
189
+
Take a look at [learn.go.dev](https://learn.go.dev) and
190
+
[golang.org/help](https://golang.org/help) for more general guidance on using
191
+
Go.
112
192
113
193
## Preview version
114
194
115
-
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](docs/nightly.md).
195
+
If you'd like to get early access to new features and bug fixes, you can use the
196
+
nightly build of this extension. Learn how to install it in by reading the
197
+
[Go Nightly documentation](docs/nightly.md).
116
198
117
199
## Contributing
118
200
119
-
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](docs/contributing.md). It explains how to build and run the extension locally, and describes the process of sending a contribution.
201
+
We welcome your contributions and thank you for working to improve the Go
202
+
development experience in VS Code. If you would like to help work on the VS Code
203
+
Go extension, please see our [contribution guide](docs/contributing.md). It
204
+
explains how to build and run the extension locally, and describes the process
205
+
of sending a contribution.
120
206
121
207
## Code of Conduct
122
208
123
-
This project follows the [Go Community Code of Conduct](https://golang.org/conduct). If you encounter a conduct-related issue, please mail conduct@golang.org.
209
+
This project follows the
210
+
[Go Community Code of Conduct](https://golang.org/conduct). If you encounter a
211
+
conduct-related issue, please mail conduct@golang.org.
124
212
125
213
## License
126
214
@@ -129,3 +217,15 @@ This project follows the [Go Community Code of Conduct](https://golang.org/condu
129
217
[Gophers Slack]: https://gophers.slack.com/
130
218
[`gopls`]: https://golang.org/s/gopls
131
219
[`go`]: https://golang.org/cmd/go
220
+
[Manage extensions in VS Code]: https://code.visualstudio.com/docs/editor/extension-gallery
221
+
[VS Code Go extension]: https://marketplace.visualstudio.com/items?itemName=golang.go
0 commit comments