History

Robert Findley eeaf4eb24c internal/lsp/fake: add rename file support for testing This CL implements the fake.Editor.RenameFile method, which mimic's the behavior of VS Code when renaming files. Specifically: - open buffers affected by the renaming are closed, and then reopened with new URIs - files are moved on disk - didChangeWatchedFile notifications are sent Along the way, add missing comments and fix one place where the editor mutex was held while sending notifications (in Editor.CreateBuffer). Generally, the editor should not hold any mutex while making a remote call. For golang/go#41567 Change-Id: I2abfa846e923de566a21c096502a68f125e7e671 Reviewed-on: https://go-review.googlesource.com/c/tools/+/427903 Auto-Submit: Robert Findley <rfindley@google.com> Reviewed-by: Alan Donovan <adonovan@google.com> Run-TryBot: Robert Findley <rfindley@google.com> TryBot-Result: Gopher Robot <gobot@golang.org>		2022-09-09 15:30:36 +00:00
..
api-diff	gopls: migrate internal/lsp to gopls/internal/lsp	2022-09-07 16:44:44 +00:00
doc	gopls/doc: update stale documentation and improve link names	2022-09-07 18:17:13 +00:00
integration/govim	gopls/integration/govim: build gopls using go1.18rc1	2022-02-28 21:15:24 +00:00
internal	internal/lsp/fake: add rename file support for testing	2022-09-09 15:30:36 +00:00
release	gopls: migrate internal/lsp to gopls/internal/lsp	2022-09-07 16:44:44 +00:00
test	gopls: migrate internal/lsp to gopls/internal/lsp	2022-09-07 16:44:44 +00:00
README.md	gopls: document that v0.7.5 is the final version to support Go 1.12	2022-01-31 21:11:00 +00:00
go.mod	gopls/internal/govulncheck: sync x/vuln@62b0186	2022-09-02 15:10:33 +00:00
go.sum	gopls/internal/govulncheck: sync x/vuln@62b0186	2022-09-02 15:10:33 +00:00
main.go	gopls: migrate internal/lsp to gopls/internal/lsp	2022-09-07 16:44:44 +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.

The following table shows the final gopls version that supports being built at a given Go Version. Any more recent Go versions missing from this table can still be built with the latest version of gopls.

Go Version	Final gopls Version With Support
Go 1.12	gopls@v0.7.5

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.