README
¶
gopls documentation
gopls (pronounced: "go please") is the official language server for the Go language.
Status
It is currently in alpha, so it is not stable.
You can see more information about the status of gopls and its supported features here.
Roadmap
The current goal is a fully stable build with the existing feature set, aiming for the first half of 2020, with release candidates earlier in the year.
This will be the first build that we recommend people use, and will be tagged as the 1.0 version. You can see the set of things being worked on in the 1.0 milestone, in general we are focused on stability, specifically, making sure we have a reliable service that produces an experience in module mode that is not a retrograde step from the old tools in GOPATH mode.
There is also considerable effort being put into testing in order to make sure that we both have a stable service and also that we do not regress after launch.
While we may continue to accept contributions for new features, they may be turned off behind a configuration flag if they are not yet stable. See the gopls unplanned milestone for deprioritized features.
This is just a milestone for gopls itself. We work with editor integrators to make sure they can use the latest builds of gopls, and will help them use the 1.0 version as soon as it is ready, but that does not imply anything about the stability, supported features or version of the plugins.
Using
In general you should not need to know anything about gopls, it should be integrated into your editor for you.
To install for your specific editor you can follow the following instructions
See the user guide for more information, including the how to install gopls by hand if you need.
Issues
If you are having issues with gopls, please first check the known issues before following the troubleshooting guide. If that does not give you the information you need, reach out to us.
You can chat with us on:
- the golang-tools mailing list
- the #gopls slack channel on the gophers slack
If you think you have an issue that needs fixing, or a feature suggestion, then please make sure you follow the steps to file an issue with the right information to allow us to address it.
If you need to talk to us directly (for instance to file an issue with confidential information in it) you can reach out directly to @stamblerre or @ianthehat.
More information
If you want to know more about it, have an unusual use case, or want to contribute, please read the following documents
Documentation
¶
Overview ¶
The gopls command is an LSP server for Go. The Language Server Protocol allows any text editor to be extended with IDE-like features; see https://langserver.org/ for details.
See https://github.com/golang/tools/tree/master/gopls for the most up-to-date information on the gopls status.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Command generate updates settings.md from the UserOptions struct.
|
Command generate updates settings.md from the UserOptions struct. |
|
assets
Module
|
|
|
integration
|
|
|
parse
Package parse provides functions to parse LSP logs.
|
Package parse provides functions to parse LSP logs. |
|
replay
Replay logs.
|
Replay logs. |
|
internal
|
|
|
hooks
Package hooks adds all the standard gopls implementations.
|
Package hooks adds all the standard gopls implementations. |
|
regtest
Package regtest provides a framework for writing gopls regression tests.
|
Package regtest provides a framework for writing gopls regression tests. |