gopher.nvim/README.md

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.

If you want to use new and maybe undocumented, and unstable features you might use develop branch.

Install (using lazy.nvim)

Pre-dependency:

• Go
• go treesitter parser, install by :TSInstall go

{
  "olexsmir/gopher.nvim",
  ft = "go",
  -- branch = "develop", -- if you want develop branch
                         -- keep in mind, it might break everything
  dependencies = {
    "nvim-lua/plenary.nvim",
    "nvim-treesitter/nvim-treesitter",
    "mfussenegger/nvim-dap", -- (optional) only if you use `gopher.dap`
  },
  -- (optional) will 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

Take a look at default options

require("gopher").setup {
  commands = {
    go = "go",
    gomodifytags = "gomodifytags",
    gotests = "gotests",
    impl = "impl",
    iferr = "iferr",
    dlv = "dlv",
  },
  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)
    -- works only with gotests installed from develop branch
    named = false,
  },
  gotag = {
    transform = "snakecase",
  },
}

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 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

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

THIS FEATURE WILL BE REMOVED IN 0.1.6

note 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