History

Shoshin Nikita d0768c9130 internal/lsp/source/completion: suggest only valid package names Before this change directory names were used "as is" for package completion. It could lead to invalid suggestions (for example, 'package 1abc' or package 'ab-cd'). This change adds a check whether a directory name can be used in a package path. If the directory name is invalid, only 'package main' will be suggested. Otherwise, the directory name will be normalized and will be used as a package name. Note: normalized directory names contain only lower case letters and digits. Fixes golang/go#44680 Change-Id: I4b710f90d1723c512e29dc3c248a1e681f1cd37f GitHub-Last-Rev: 8ae69f1c6fdf80831e5773bdb3507a8d51a4a0cf GitHub-Pull-Request: golang/tools#310 Reviewed-on: https://go-review.googlesource.com/c/tools/+/313092 Reviewed-by: Rebecca Stambler <rstambler@golang.org> Trust: Rebecca Stambler <rstambler@golang.org> Trust: Peter Weinberger <pjw@google.com> Run-TryBot: Rebecca Stambler <rstambler@golang.org> gopls-CI: kokoro <noreply+kokoro@google.com> TryBot-Result: Go Bot <gobot@golang.org>		2021-04-27 19:53:45 +00:00
..
doc	gopls/doc: fix broken link	2021-04-26 16:33:22 +00:00
integration/govim	gopls/integration: remove obsolete code	2021-03-19 20:57:45 +00:00
internal	internal/lsp/source/completion: suggest only valid package names	2021-04-27 19:53:45 +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: factor out advanced documentation from the README	2021-01-22 17:08:14 +00:00
go.mod	gopls/test: it is safe to ignore json unmarshalling errors	2021-04-27 12:58:28 +00:00
go.sum	gopls/test: it is safe to ignore json unmarshalling errors	2021-04-27 12:58:28 +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:

GO111MODULE=on go get golang.org/x/tools/gopls@latest

NOTE: Do not use the -u flag, as it will update your dependencies to incompatible versions.

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. Though we try not to break older versions, we do not prioritize issues only affecting legacy Go releases.

gopls currently only supports the go command, so if you are using a different build system, gopls will not work well. Bazel support is currently blocked on bazelbuild/rules_go#512.