Minimalistic plugin for Go development in Neovim written in Lua.
It's NOT an LSP tool, the main goal of this plugin is to add go tooling support in Neovim.
If you want to use new and maybe undocumented, and unstable features you might use develop branch.
Install (using lazy.nvim)
Requirements:
- Neovim 0.10 or later
- Treesitter
goparser(:TSInstall goif you use nvim-treesitter) - Go installed (tested on 1.23)
{
"olexsmir/gopher.nvim",
ft = "go",
-- branch = "develop"
-- (optional) will update plugin's deps on every update
build = function()
vim.cmd.GoInstallDeps()
end,
---@type gopher.Config
opts = {},
}Important
If you need more info look :h gopher.nvim
Take a look at default options (might be a bit outdated, look :h gopher.nvim-config)
require("gopher").setup {
-- log level, you might consider using DEBUG or TRACE for debugging the plugin
log_level = vim.log.levels.INFO,
-- timeout for running internal commands
timeout = 2000,
commands = {
go = "go",
gomodifytags = "gomodifytags",
gotests = "gotests",
impl = "impl",
iferr = "iferr",
},
gotests = {
-- gotests doesn't have template named "default" so this plugin uses "default" to set the default template
template = "default",
-- path to a directory containing custom test code templates
template_dir = nil,
-- switch table tests from using slice to map (with test name for the key)
named = false,
},
gotag = {
transform = "snakecase",
-- default tags to add to struct fields
default_tag = "json",
},
iferr = {
-- choose a custom error message
message = nil,
},
}Install plugin's go deps
:GoInstallDepsThis will install the following tools:
Add and remove tags for structs via gomodifytags
By default json tag will be added/removed, if not set:
" add json tag
:GoTagAdd json
" remove yaml tag
:GoTagRm yaml-- or you can use lua api
require("gopher").tags.add "xml"
require("gopher").tags.rm "proto"Generating tests via gotests
" Generate one test for a specific function/method(one under cursor)
:GoTestAdd
" Generate all tests for all functions/methods in the current file
:GoTestsAll
" Generate tests for only exported functions/methods in the current file
:GoTestsExp-- or you can use lua api
require("gopher").test.add()
require("gopher").test.exported()
require("gopher").test.all()For named tests see :h gopher.nvim-gotests-named
Run commands like go mod/get/etc inside of nvim
:GoGet github.com/gorilla/mux
" Link can have an `http` or `https` prefix.
:GoGet https://github.com/lib/pq
" You can provide more than one package url
:GoGet github.com/jackc/pgx/v5 github.com/google/uuid/
" go mod commands
:GoMod tidy
:GoMod init new-shiny-project
" go work commands
:GoWork sync
" run go generate in cwd
:GoGenerate
" run go generate for the current file
:GoGenerate %Interface implementation via impl
Syntax of the command:
:GoImpl [receiver] [interface]
" also you can put a cursor on the struct and run
:GoImpl [interface]Usage examples:
:GoImpl r Read io.Reader
:GoImpl Write io.Writer
" or you can simply put a cursor on the struct and run
:GoImpl io.ReaderGenerate boilerplate for doc comments
First set a cursor on public package/function/interface/struct and execute:
:GoCmtPRs are always welcome. See CONTRIBUTING.md