gopher.nvim

Minimalistic plugin for Go development in Neovim written in Lua.

It's NOT an LSP tool, the goal of this plugin is to add go tooling support in Neovim.

All development of new and maybe undocumented, and unstable features is happening on develop branch.

Table of content

• How to install
• Features
• Configuration
• Troubleshooting
• Contributing

Install (using lazy.nvim)

Requirements:

• Neovim 0.10 or later
• Treesitter parser for go(:TSInstall go if you use nvim-treesitter)
• Go installed

Important

If you prefer using other forges, this repository is also mirrored at:

• tangled.org: https://tangled.org/olexsmir.xyz/gopher.nvim
• codeberg.org: https://codeberg.org/olexsmir/gopher.nvim

-- NOTE: this plugin is already lazy-loaded and adds only about 1ms
-- of load time to your config
{
  "olexsmir/gopher.nvim",
  ft = "go",
  -- branch = "develop"
  -- (optional) updates the plugin's dependencies on each update
  build = function()
    vim.cmd.GoInstallDeps()
  end,
  ---@module "gopher"
  ---@type gopher.Config
  opts = {},
}

Features

Install plugin's go deps

:GoInstallDeps

This will install the following tools:

• gomodifytags
• impl
• gotests
• iferr
• json2go

Add and remove tags for structs via gomodifytags

By default json tag will be added/removed, if not set:

" add json tag
:GoTagAdd json

" add json tag with omitempty option
:GoTagAdd json=omitempty

" 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.Reader

Generate boilerplate for doc comments

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

:GoCmt

Convert json to Go types

:GoJson opens a temporary buffer where you can paste or write JSON. Saving the buffer (:w or :wq) automatically closes it and inserts the generated Go struct into the original buffer at the cursor position.

Alternatively, you can pass JSON directly as an argument:

:GoJson {"name": "Alice", "age": 30}

Additionally, gopher.json2go provides lua api, see :h gopher.nvim-json2go for details.

Generate if err != nil { via iferr

Set the cursor on the line with err and execute

:GoIfErr

Configuration

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,

  -- timeout for running installer commands(e.g :GoDepsInstall, :GoDepsInstallSync)
  installer_timeout = 999999,

  -- user specified paths to binaries
  commands = {
    go = "go",
    gomodifytags = "gomodifytags",
    gotests = "gotests",
    impl = "impl",
    iferr = "iferr",
  },
  gotests = {
    -- a default template that gotess will use.
    -- gotets doesn't have template named `default`, we use it to represent absence of the provided template.
    template = "default",

    -- path to a directory containing custom test code templates
    template_dir = nil,

    -- use named tests(map with test name as key) in table tests(slice of structs by default)
    named = false,
  },
  gotag = {
    transform = "snakecase",

    -- default tags to add to struct fields
    default_tag = "json",

    -- default tag option added struct fields, set to nil to disable
    -- e.g: `option = "json=omitempty,xml=omitempty`
    option = nil,
  },
  iferr = {
    -- choose a custom error message, nil to use default
    -- e.g: `message = 'fmt.Errorf("failed to %w", err)'`
    message = nil,
  },
  json2go = {
    -- command used to open interactive input.
    -- e.g: `split`, `botright split`, `tabnew`
    interactive_cmd = "vsplit",

    -- name of autogenerated struct
    -- e.g: "MySuperCoolName"
    type_name = nil,
  },
}

Troubleshooting

The most common issue with the plugin is missing dependencies. Run :checkhealth gopher to verify that the plugin is installed correctly. If any binaries are missing, install them using :GoInstallDeps.

If the issue persists, feel free to open a new issue.

Contributing

PRs are always welcome. See CONTRIBUTING.md