vim-go

Go development plugin for Vim

Github stars Tracking Chart

vim-go Build Status

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 golangci-lint 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 8.0.1453 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.

FAQ and troubleshooting

The FAQ and troubleshooting tips are in the documentation and can be quickly
accessed using :help go-troubleshooting. If you believe you've found a bug or
shortcoming in vim-go that is neither addressed by help nor in existing
issues
, please open an issue with
clear reproduction steps. :GoReportGitHubIssue can be used pre-populate a lot
of the information needed when creating a new issue.

Contributing

All PRs are welcome. If you are planning to contribute a large patch or to
integrate a new tool, please create an issue first to get any upfront questions
or design decisions out of the way first.

You can run the tests locally by running make. It will lint the VimL for you,
lint the documentation, and run the tests against the minimum required version
of Vim, other versions of Vim that may be critical to support, and Neovim.

License

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

Main metrics

Overview
Name With Ownerfatih/vim-go
Primary LanguageVim Script
Program languageShell (Language Count: 7)
Platform
License:Other
所有者活动
Created At2014-03-24 13:12:26
Pushed At2025-05-31 19:59:25
Last Commit At2025-05-31 12:58:56
Release Count44
Last Release Namev1.29 (Posted on 2025-04-19 17:18:03)
First Release Namev1.0 (Posted on )
用户参与
Stargazers Count16.1k
Watchers Count261
Fork Count1.4k
Commits Count4.6k
Has Issues Enabled
Issues Count2014
Issue Open Count24
Pull Requests Count1405
Pull Requests Open Count15
Pull Requests Close Count278
项目设置
Has Wiki Enabled
Is Archived
Is Fork
Is Locked
Is Mirror
Is Private