gopher.nvim

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.

Install (using lazy.nvim

Pre-dependency:

• go (tested on 1.17 and 1.18)
• Go treesitter parser, install by :TSInstall go

{
  "olexsmir/gopher.nvim",
  ft = "go",
  dependencies = {
    "nvim-lua/plenary.nvim",
    "nvim-treesitter/nvim-treesitter",
    "mfussenegger/nvim-dap", -- (optional) only if you use `gopher.dap`
  },
  -- (optional) update plugin's deps on every update
  build = function()
    vim.cmd.GoInstallDeps()
  end,
  ---@type gopher.Config
  opts = {},
}

Configuratoin

Important

If you need more info look :h gopher.nvim

require("gopher").setup {
  commands = {
    go = "go",
    gomodifytags = "gomodifytags",
    gotests = "~/go/bin/gotests", -- also you can set custom command path
  },
  gotests = {
    template = "default",
  },
  gotag = {
    transform = "pascalcase"
  }
}

Note

For named tests to work you have to install gotests from develop branch. Next code snippets could be placed into the build step in the Lazy plugin declaration

-- using mason-tool-installer
require("mason-tool-installer").setup {
  ensure_installed = {
    { "gotests", version = "develop" },
  }
}

-- using `vim.fn.jobstart`
vim.fn.jobstart("go install github.com/cweill/gotests/...@develop")

Features

Install plugin's go deps

:GoInstallDeps

This will install the following tools:

• gomodifytags
• impl
• gotests
• iferr
• dlv

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 only for exported functions/methods in the current file:
:GoTestsExp

--- or you can use lua api
require("gopher").test.add()

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 put a cursor on the struct and run
:GoImpl io.Reader

Generate boilerplate for doc comments

First set a cursor on public package/function/interface/struct and execute:

:GoCmt

Generate `if err != nil {` via iferr

Set the cursor on the line with err and execute

:GoIfErr

Setup nvim-dap for go in one line

Important

nvim-dap has to be installed

require("gopher.dap").setup()

Contributing

PRs are always welcome. See CONTRIBUTING.md

Thanks

• go.nvim
• nvim-dap-go
• iferr