Skip to content
Go development plugin for Vim
Branch: master
Clone or download
Latest commit 2033665 Apr 18, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github reorder ISSUE_TEMPLATE.md info Apr 5, 2018
assets Remove unused screenshot.png (#1635) Jan 4, 2018
autoload start gopls silently Apr 18, 2019
compiler don't spam users when Vim is started with Vi compatibility mode Nov 16, 2018
doc Merge pull request #2231 from velovix/deoplete-gopls-docs Apr 15, 2019
ftdetect
ftplugin synchronize buffers with gopls Apr 1, 2019
gosnippets snippet: Add table testing boilerplate snippet Sep 11, 2018
indent Restore &cpo even when finishing early Dec 11, 2018
plugin register files with gopls when FileType is set Apr 1, 2019
rplugin/python3/denite/source Add support for denite.nvim about :GoDecls / :GoDeclsDir (#1604) Dec 10, 2017
scripts complete vendored packages and modules Apr 9, 2019
syntax
templates Use a different template for test files Jun 6, 2017
test don't spam users when Vim is started with Vi compatibility mode Nov 16, 2018
.codecov.yml do not report patch codecoverage Sep 2, 2018
.coveragerc update coverage data file location Jul 22, 2018
.dockerignore test using Go 1.12 Mar 23, 2019
.editorconfig
.gitignore Add support for denite.nvim about :GoDecls / :GoDeclsDir (#1604) Dec 10, 2017
.travis.yml
.vintrc.yaml Add some VimScript lint tools (#1558) Nov 16, 2017
CHANGELOG.md update CHANGELOG.md for #2227 Apr 13, 2019
Dockerfile test using Go 1.12 Mar 23, 2019
LICENSE Fix whitespace and typo (#1201) Feb 17, 2017
Makefile lint before running tests Feb 27, 2019
README.md update README.md to notify code completion support via gopls Mar 18, 2019
addon-info.json vim-go: remove misc/vim notes Sep 8, 2014

README.md

vim-go Build Status

Vim-go logo

Features

This plugin adds Go language support for Vim, with the following main features:

  • Compile your package with :GoBuild, install it with :GoInstall or test it with :GoTest. Run a single test with :GoTestFunc).
  • Quickly execute your current file(s) with :GoRun.
  • Improved syntax highlighting and folding.
  • Debug programs with integrated delve support with :GoDebugStart.
  • Completion support via gocode and gopls.
  • gofmt or goimports on save keeps the cursor position and undo history.
  • Go to symbol/declaration with :GoDef.
  • Look up documentation with :GoDoc or :GoDocBrowser.
  • Easily import packages via :GoImport, remove them via :GoDrop.
  • Precise type-safe renaming of identifiers with :GoRename.
  • See which code is covered by tests with :GoCoverage.
  • Add or remove tags on struct fields with :GoAddTags and :GoRemoveTags.
  • Call gometalinter with :GoMetaLinter to invoke all possible linters (golint, vet, errcheck, deadcode, etc.) and put the result in the quickfix or location list.
  • Lint your code with :GoLint, run your code through :GoVet to catch static errors, or make sure errors are checked with :GoErrCheck.
  • Advanced source analysis tools utilizing guru, such as :GoImplements, :GoCallees, and :GoReferrers.
  • ... and many more! Please see doc/vim-go.txt for more information.

Install

vim-go requires at least Vim 7.4.2009 or Neovim 0.3.1.

The latest stable release is the recommended version to use. If you choose to use the master branch instead, please do so with caution; it is a development branch.

vim-go follows the standard runtime path structure. Below are some helper lines for popular package managers:

  • Vim 8 packages
    • git clone https://github.com/fatih/vim-go.git ~/.vim/pack/plugins/start/vim-go
  • Pathogen
    • git clone https://github.com/fatih/vim-go.git ~/.vim/bundle/vim-go
  • vim-plug
    • Plug 'fatih/vim-go', { 'do': ':GoUpdateBinaries' }
  • Vundle
    • Plugin 'fatih/vim-go'

You will also need to install all the necessary binaries. vim-go makes it easy to install all of them by providing a command, :GoInstallBinaries, which will go get all the required binaries.

Check out the Install section in the documentation for more detailed instructions (:help go-install).

Usage

The full documentation can be found at doc/vim-go.txt. You can display it from within Vim with :help vim-go.

Depending on your installation method, you may have to generate the plugin's help tags manually (e.g. :helptags ALL).

We also have an official vim-go tutorial.

License

The BSD 3-Clause License - see LICENSE for more details

You can’t perform that action at this time.