https://github.com/govim/govim

govim is a Go development plugin for Vim8, written in Go
https://github.com/govim/govim

go golang govim vim vim8

Last synced: 4 days ago
JSON representation

govim is a Go development plugin for Vim8, written in Go

• Host: GitHub
• URL: https://github.com/govim/govim
• Owner: govim
• License: bsd-3-clause
• Created: 2019-03-10T20:28:00.000Z (almost 6 years ago)
• Default Branch: main
• Last Pushed: 2024-11-27T14:16:52.000Z (3 months ago)
• Last Synced: 2025-01-31T10:06:50.085Z (11 days ago)
• Topics: go, golang, govim, vim, vim8
• Language: Go
• Homepage:
• Size: 8.81 MB
• Stars: 876
• Watchers: 14
• Forks: 62
• Open Issues: 164
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

• awesome-golang-repositories - govim

README

        
## `govim` - Go development plugin for Vim8

Command `github.com/govim/govim/cmd/govim` (referred to simply as `govim`) is a Go development plugin for Vim8, much

like [`vim-go`](https://github.com/fatih/vim-go). But unlike `vim-go`, `govim` is written in Go, not VimScript. It has

features like code completion, format-on-save, hover details and go-to definition, all of which are driven by

[`gopls`](https://godoc.org/golang.org/x/tools/gopls), the Language Server Protocol (LSP) server for Go. See [the

wiki](https://github.com/govim/govim/wiki/govim-plugin-API) for more details. Installation instructions below.

Package [`github.com/govim/govim`](https://godoc.org/github.com/govim/govim) provides an API for plugin developers to

interface with Vim8 in Go. More details [here](PLUGIN_AUTHORS.md).

`govim` requires at least [`go1.12`](https://golang.org/dl/) and [Vim `v8.1.1711`](https://www.vim.org/download.php)

(`gvim` is also supported). [Neovim](https://neovim.io) is not (currently) supported. More details [in the

FAQ](https://github.com/govim/govim/wiki/FAQ#what-versions-of-vim-and-go-are-supported-with-govim).

Install `govim` via:

* [Vim 8 packages](http://vimhelp.appspot.com/repeat.txt.html#packages)

  * `git clone https://github.com/govim/govim.git ~/.vim/pack/plugins/start/govim`

* [Pathogen](https://github.com/tpope/vim-pathogen)

  * `git clone https://github.com/govim/govim.git ~/.vim/bundle/govim`

* [vim-plug](https://github.com/junegunn/vim-plug)

  * `Plug 'govim/govim'`

* [Vundle](https://github.com/VundleVim/Vundle.vim)

  * `Plugin 'govim/govim'`

You might need some `.vimrc`/`.gvimrc` settings to get all features working: see the minimal

[`.vimrc`](cmd/govim/config/minimal.vimrc) or [`.gvimrc`](cmd/govim/config/minimal.gvimrc) for a commented explanation

of the required settings. For more details on `.vimrc`/`.gvimrc` settings as well as some tips and tricks, see

[here](https://github.com/govim/govim/wiki/vimrc-tips).

### What can `govim` do?

See the [`govim` plugin API](https://github.com/govim/govim/wiki/govim-plugin-API) which also has links to some demo

screencasts.

### FAQ

Top of your list of questions is likely _"Why have you created govim? What is/was wrong with `vim-go`?"_ For answers

this and more see [FAQ](https://github.com/govim/govim/wiki/FAQ).

### Contributing

Contributions are very much welcome in the form of:

* feedback

* issues

* PRs

See [`govim` tests](https://github.com/govim/govim/wiki/govim-tests) for details on how the modules in this repository

are tested.