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 on save autocmd BufWritePre *.go :call LanguageClient#textDocument_formatting_sync()
Use ale:
let g:ale_linters = { \ 'go': ['gopls'], \}
see this issue
Use prabirshrestha/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 natebosch/vim-lsc, with the following configuration:
let g:lsc_server_commands = { \ "go": { \ "command": "gopls serve", \ "log_level": -1, \ "suppress_stderr": v:true, \ }, \}
The log_level
and suppress_stderr
parts are needed to prevent breakage from logging. See issues #180 and #213.
Use coc.nvim, with the following coc-settings.json
configuration:
"languageserver": { "golang": { "command": "gopls", "rootPatterns": ["go.work", "go.mod", ".vim/", ".git/", ".hg/"], "filetypes": ["go"], "initializationOptions": { "usePlaceholders": true } } }
If you use go.work
files, you may want to set the workspace.workspaceFolderCheckCwd
option. This will force coc.nvim to search parent directories for go.work
files, even if the current open directory has a go.mod
file. See the coc.nvim documentation for more details.
Other settings can be added in initializationOptions
too.
The editor.action.organizeImport
code action will auto-format code and add missing imports. To run this automatically on save, add the following line to your init.vim
:
autocmd BufWritePre *.go :call CocAction('runCommand', 'editor.action.organizeImport')
In vim classic only, use the experimental govim
, simply follow the install steps.
To use the new native LSP client in Neovim, make sure you install Neovim v.0.5.0+, the nvim-lspconfig
configuration helper plugin, and check the gopls
configuration section there.
You can use Neovim's native plugin system. On a Unix system, you can do that by cloning the nvim-lspconfig
repository into the correct directory:
dir="${HOME}/.local/share/nvim/site/pack/nvim-lspconfig/opt/nvim-lspconfig/" mkdir -p "$dir" cd "$dir" git clone 'https://github.com/neovim/nvim-lspconfig.git' .
You can add custom configuration using Lua. Here is an example of enabling the unusedparams
check as well as staticcheck
:
lua <<EOF lspconfig = require "lspconfig" util = require "lspconfig/util" lspconfig.gopls.setup { cmd = {"gopls", "serve"}, filetypes = {"go", "gomod"}, root_dir = util.root_pattern("go.work", "go.mod", ".git"), settings = { gopls = { analyses = { unusedparams = true, }, staticcheck = true, }, }, } EOF
To get your imports ordered on save, like goimports
does, you can define a helper function in Lua:
lua <<EOF -- … function OrgImports(wait_ms) local params = vim.lsp.util.make_range_params() params.context = {only = {"source.organizeImports"}} local result = vim.lsp.buf_request_sync(0, "textDocument/codeAction", params, wait_ms) for _, res in pairs(result or {}) do for _, r in pairs(res.result or {}) do if r.edit then vim.lsp.util.apply_workspace_edit(r.edit) else vim.lsp.buf.execute_command(r.command) end end end end EOF autocmd BufWritePre *.go lua OrgImports(1000)
(Taken from the discussion on Neovim issue tracker.)
To make your Ctrl+x,Ctrl+o work, add this to your init.vim
:
autocmd FileType go setlocal omnifunc=v:lua.vim.lsp.omnifunc