History

Bryan C. Mills c20fd7c261 internal/lsp/regtest: eliminate arbitrary timeouts We care that gopls operations complete within a reasonable time. However, what is “reasonable” depends strongly on the specifics of the user and the hardware they are running on: a timeout that would be perfectly reasonable on a high-powered user workstation with little other load may be far too short on an overloaded and/or underpowered CI builder. This change adjusts the regtest runner to use the test deadline instead of an arbitrary, flag-defined timeout; we expect the user or system running the test to scale the test timeout appropriately to the specific platform and system load. When the testing package gains support for per-test timeouts (golang/go#48157), this approach will automatically apply those timeouts too. If we decide that we also want to test specific performance and/or latency targets, we can set up specific configurations for that (as either aggressive per-test timeouts or benchmarks) in a followup change. For golang/go#50582 Change-Id: I1ab11b2049effb097aa620046fe11609269f91c4 Reviewed-on: https://go-review.googlesource.com/c/tools/+/380497 Trust: Bryan Mills <bcmills@google.com> Run-TryBot: Bryan Mills <bcmills@google.com> gopls-CI: kokoro <noreply+kokoro@google.com> TryBot-Result: Gopher Robot <gobot@golang.org> Reviewed-by: Robert Findley <rfindley@google.com>		2022-01-25 21:51:33 +00:00
..
api-diff	gopls/api-diff: fix api-diff command for Go 1.18	2021-10-27 16:48:55 +00:00
doc	gopls/doc: fix inconsistent rendering of enum newlines	2022-01-19 15:07:38 +00:00
integration/govim	gopls/integration: remove obsolete code	2021-03-19 20:57:45 +00:00
internal	internal/lsp/regtest: eliminate arbitrary timeouts	2022-01-25 21:51:33 +00:00
release	all: replace all usages of os/exec with golang.org/x/sys/execabs	2021-01-19 22:25:03 +00:00
test	gopls/test: it is safe to ignore json unmarshalling errors	2021-04-27 12:58:28 +00:00
README.md	gopls: remove obsoleted text from README	2022-01-06 15:23:01 +00:00
go.mod	gopls/doc: use improved code generator for API doc	2021-12-16 11:15:33 +00:00
go.sum	gopls/doc: use improved code generator for API doc	2021-12-16 11:15:33 +00:00
main.go	gopls: use standard command doc comment format	2021-01-08 18:12:31 +00:00

README.md

`gopls`, the Go language server

gopls (pronounced "Go please") is the official Go language server developed by the Go team. It provides IDE features to any LSP-compatible editor.

You should not need to interact with gopls directly--it will be automatically integrated into your editor. The specific features and settings vary slightly by editor, so we recommend that you proceed to the documentation for your editor below.

Editors

To get started with gopls, install an LSP plugin in your editor of choice.

If you use gopls with an editor that is not on this list, please let us know by filing an issue or modifying this documentation.

Installation

For the most part, you should not need to install or update gopls. Your editor should handle that step for you.

If you do want to get the latest stable version of gopls, change to any directory that is both outside of your GOPATH and outside of a module (a temp directory is fine), and run:

go install golang.org/x/tools/gopls@latest

Learn more in the advanced installation instructions.

Setting up your workspace

gopls supports both Go module and GOPATH modes, but if you are working with multiple modules or uncommon project layouts, you will need to specifically configure your workspace. See the Workspace document for information on supported workspace layouts.

Configuration

You can configure gopls to change your editor experience or view additional debugging information. Configuration options will be made available by your editor, so see your editor's instructions for specific details. A full list of gopls settings can be found in the Settings documentation.

Environment variables

gopls inherits your editor's environment, so be aware of any environment variables you configure. Some editors, such as VS Code, allow users to selectively override the values of some environment variables.

Troubleshooting

If you are having issues with gopls, please follow the steps described in the troubleshooting guide.

Supported Go versions and build systems

gopls follows the Go Release Policy, meaning that it officially supports the last 2 major Go releases. Per issue #39146, we attempt to maintain best-effort support for the last 4 major Go releases, but this support extends only to not breaking the build and avoiding easily fixable regressions.

Our extended support is enforced via continuous integration with older Go versions. This legacy Go CI may not block releases: test failures may be skipped rather than fixed. Furthermore, if a regression in an older Go version causes irreconcilable CI failures, we may drop support for that Go version in CI if it is 3 or 4 Go versions old.

gopls currently only supports the go command, so if you are using a different build system, gopls will not work well. Bazel is not officially supported, but Bazel support is in development (see bazelbuild/rules_go#512). You can follow these instructions to configure your gopls to work with Bazel.