Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/olexsmir/gopher.nvim

Neovim plugin for make golang development easiest
https://github.com/olexsmir/gopher.nvim

go goimpl golang gomodifytags gotags gotests impl lua neovim neovim-plugin nvim nvim-go nvim-lua nvim-plugin nvim-treesitter treesitter vim

Last synced: 14 days ago
JSON representation

Neovim plugin for make golang development easiest

Awesome Lists containing this project

README 

        
# gopher.nvim



[![Stand With Ukraine](https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/banner-direct-single.svg)](https://stand-with-ukraine.pp.ua)



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](https://github.com/olexsmir/gopher.nvim/tree/develop) branch.



## Install (using [lazy.nvim](https://github.com/folke/lazy.nvim))



Pre-dependency:



- [Go](https://github.com/golang/go)

- `go` treesitter parser, install by `:TSInstall go`



```lua

{

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



```lua

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

  



  ```vim

  :GoInstallDeps

  ```



  This will install the following tools:



  - [gomodifytags](https://github.com/fatih/gomodifytags)

  - [impl](https://github.com/josharian/impl)

  - [gotests](https://github.com/cweill/gotests)

  - [iferr](https://github.com/koron/iferr)

  - [dlv](github.com/go-delve/delve/cmd/dlv)



  

    Add and remove tags for structs via gomodifytags

  



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



  ```vim

  " add json tag

  :GoTagAdd json



  " remove yaml tag

  :GoTagRm yaml

  ```



  ```lua

  -- or you can use lua api

  require("gopher").tags.add "xml"

  require("gopher").tags.rm "proto"

  ```



  

    Generating tests via gotests

  



  ```vim

  " 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

  ```



  ```lua

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

  



  ```vim

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

  ```vim

  :GoImpl [receiver] [interface]



  " also you can put a cursor on the struct and run

  :GoImpl [interface]

  ```



  Usage examples:

  ```vim

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



  ```vim

  :GoCmt

  ```



  

    Generate if err != nil { via iferr

  



  Set the cursor on the line with `err` and execute



  ```vim

  :GoIfErr

  ```



  

    Setup nvim-dap for go in one line

  



  THIS FEATURE WILL BE REMOVED IN `0.1.6`



  note [nvim-dap](https://github.com/mfussenegger/nvim-dap) has to be installed



  ```lua

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

  ```



## Contributing



PRs are always welcome. See [CONTRIBUTING.md](./CONTRIBUTING.md)



## Thanks



- [go.nvim](https://github.com/ray-x/go.nvim)

- [nvim-dap-go](https://github.com/leoluz/nvim-dap-go)

- [iferr](https://github.com/koron/iferr)