gopls is currently under active development by the Go team. The code is in the x/tools repository, in golang.org/x/tools/internal/lsp and golang.org/x/tools/cmd/gopls. Because we are actively working on gopls, it is not stable. If you choose to use it, be aware that things may regularly break or change. For more gopls discussion, join the #gopls channel in the Gopher Slack.

Troubleshooting

If you see a gopls error or crash, or gopls just stops working, please capture your gopls log and file an issue on the Go issue tracker. Please attach the log and any other relevant information, or if you have one, a case that reproduces the issue. For VSCode users, the gopls log can be found by going to “View: Debug Console” -> “Output” -> “Tasks” -> “gopls”.

If possible, it is helpful to mention an estimated timestamp for when the problem first occurred, or an approximate timestamp for when you reproduced the problem. It is also helpful to see your gopls editor configurations, such as a VSCode settings.json file.

You can then try to restart your gopls instance by restarting your editor, which, in most cases, should correct the problem.

Feel free to ask questions about gopls on the #gopls Gopher Slack channel.

Installation

First, install gopls by running go get -u golang.org/x/tools/cmd/gopls.

At the moment, we suggest using VSCode.

Integration with your text editor

VSCode

Use the VSCode-Go plugin, with the following configuration:

"go.useLanguageServer": true,
"go.languageServerExperimentalFeatures": {
        "diagnostics": true // for build and vet errors as you type
},
"[go]": {
    "editor.snippetSuggestions": "none",
    "editor.formatOnSave": true,
    "editor.codeActionsOnSave": {
        "source.organizeImports": true
    }
},
"gopls": {
    "usePlaceholders": true // add parameter placeholders when completing a function
},
"files.eol": "\n", // formatting only supports LF line endings

VSCode will complain about the "gopls" settings, but they will still work. Once we have a consistent set of settings, we will make the changes in the VSCode plugin necessary to remove the errors.

If you encounter problems with import organization, please try setting a higher code action timeout (any value greater than 750ms), for example:

"[go]": {
  "editor.codeActionsOnSaveTimeout": 3000
}

Vim / Neovim

Use vim-go ver 1.20+, with the following configuration:

let g:go_def_mode='gopls'
let g:go_info_mode='gopls'

Use LanguageClient-neovim, with the following configuration:

" Launch gopls when Go files are in use
let g:LanguageClient_serverCommands = {
       \ 'go': ['gopls']
       \ }
" Run gofmt and goimports on save
autocmd BufWritePre *.go :call LanguageClient#textDocument_formatting_sync()

Use ale:

let g:ale_linters = {
	\ 'go': ['gopls'],
	\}

see this issue

Use vim-lsp, with the following configuration:

augroup LspGo
  au!
  autocmd User lsp_setup call lsp#register_server({
      \ 'name': 'go-lang',
      \ 'cmd': {server_info->['gopls']},
      \ 'whitelist': ['go'],
      \ })
  autocmd FileType go setlocal omnifunc=lsp#complete
  "autocmd FileType go nmap <buffer> gd <plug>(lsp-definition)
  "autocmd FileType go nmap <buffer> ,n <plug>(lsp-next-error)
  "autocmd FileType go nmap <buffer> ,p <plug>(lsp-previous-error)
augroup END

Use coc.nvim, with the following coc-settings.json configuration:

  "languageserver": {
    "golang": {
      "command": "gopls",
      "rootPatterns": ["go.mod", ".vim/", ".git/", ".hg/"],
      "filetypes": ["go"]
    }
  }

Vim (classic only)

Use the experimental govim, simply follow the install steps.

Emacs

Use lsp-mode. gopls is built in now as a client, so no special config is necessary. Here is an example (assuming you are using use-package) to get you started:

(use-package lsp-mode
  :commands lsp)

(add-hook 'go-mode-hook #'lsp)

;; optional - provides fancier overlays
(use-package lsp-ui
  :commands lsp-ui-mode)

;; if you use company-mode for completion (otherwise, complete-at-point works out of the box):
(use-package company-lsp
  :commands company-lsp)

On OSX, Emacs.app may need to get the same PATH and GOPATH as the shell. Move the definitions of PATH and GOPATH into .zshenv (or .bashenv if you use bash) from .zshrc (.bashrc).

Acme

Use the experimental acme-lsp, simply follow the install steps.

Sublime Text

Use the LSP package. Once that is installed:

Open the Command Palette
Find and run the command LSP: Enable Language Server Globally
Find the gopls item and select it. Be careful not to select the similarly named golsp by mistake.

After doing the above, you might want to take a look at the LSP package's settings files for reference. You can view them by selecting the menu item Preferences > Package Settings > LSP > Settings.

Known Issues

Cursor resets to the beginning or end of file on format: #31937.
“no room in queue” error: #32467.

Contributing

Contributions are welcome, but since development is so active, we request that you file an issue and claim it before starting to work on something. Otherwise, it is likely that we might already be working on a fix for your issue.

Please see all available issues under the gopls label on the Go issue tracker. Any issue without an assignee and with the label “Suggested” is fair game - just assign yourself or comment on the issue before you begin working!

FAQ

Why is it called gopls? Since gopls works both as a language server and as a command line tool, we wanted a name that could be used as a verb. For example, gopls check should read as “go please check.” See: golang.org/cl/158197.

Integrator FAQ

What follows is a list of questions/ideas/suggestions for folks looking to integrate gopls within an editor/similar.

A good starting point for any integrator is the Language Service Protocol Specification. golang.org/x/tools/internal/lsp/protocol represents a Go definition of the spec.

What does `gopls` support?

The most accurate answer to this question is to examine the InitializeResult response to Initialize, specifically the capabilities field of type ServerCapabilities

UTF-8, UTF-16 and position information

As an example, the Hover method takes TextDocumentPositionParams which has a position field of type Position. The key point to note from that last link is the following:

A position inside a document (see Position definition below) is expressed as a zero-based line and character offset. The offsets are based on a UTF-16 string representation. So a string of the form a𐐀b the character offset of the character a is 0, the character offset of 𐐀 is 1 and the character offset of b is 3 since 𐐀 is represented using two code units in UTF-16.

i.e. integrators will need to calculate UTF-16 based column offsets. For Go-based integrators, the golang.org/x/tools/internal/span will be of use. #31080 tracks making span and other useful packages non-internal.

`textDocument/formatting` response

At the time of writing (2019-03-28) the []TextEdit response to textDocument/formatting comprises range-based deltas. The spec is not explicit about how these deltas should be applied, instead simply stating:

If multiple inserts have the same position, the order in the array defines the order in which the inserted strings appear in the resulting text.

i.e. it specifies only the resulting state of the document.

Applying the array of deltas received in reverse order achieves the desired result that holds with the spec.

RPC response errors

https://go-review.googlesource.com/c/tools/+/170958 and related discussions are looking to help shape what it means for a server method to return an error. i.e.

Under what conditions would the Format method return an error?
On a syntax error, or just for low-level LSP/transport issues?
What should editors do in response to such errors?

This answer is therefore a WIP.

Files that change “outside the editor”

For example, files that are created/modified/removed as a result of go generate. Per @ianthehat:

The plan is to have the client do all the work for us. Specifically we are going to start using workspace/didChangeWatchedFiles to monitor all the files we are caching AST's for

This is currently not implemented (2019-04-15).

Additional Information

Questions can be directed toward @stamblerre or @ianthehat. For consistent updates on the development progress of gopls, see the notes from the golang-tools meetings (https://github.com/golang/go/wiki/golang-tools).

Table of Contents

Status

Troubleshooting

Installation

Integration with your text editor

VSCode

Vim / Neovim

Vim (classic only)

Emacs

Acme

Sublime Text

Known Issues

Contributing

FAQ

Integrator FAQ

What does `gopls` support?

UTF-8, UTF-16 and position information

`textDocument/formatting` response

RPC response errors

Files that change “outside the editor”

Additional Information

Table of Contents

Status

Troubleshooting

Installation

Integration with your text editor

VSCode

Vim / Neovim

Vim (classic only)

Emacs

Acme

Sublime Text

Known Issues

Contributing

FAQ

Integrator FAQ

What does gopls support?

UTF-8, UTF-16 and position information

textDocument/formatting response

RPC response errors

Files that change “outside the editor”

Additional Information

What does `gopls` support?

`textDocument/formatting` response