ultimate-vim/sources_non_forked/vim-go/README.md

vim-go

Go (golang) support for Vim. It comes with pre-defined sensible settings (like auto gofmt on save), has autocomplete, snippet support, improved syntax highlighting, go toolchain commands, etc... If needed vim-go installs all necessary binaries for providing seamless Vim integration with current commands. It's highly customizable and each individual feature can be disabled/enabled easily.

Features

• Improved Syntax highlighting, such as Functions, Operators, Methods..
• Auto completion support via gocode
• Better gofmt on save, keeps cursor position and doesn't break your undo history
• Go to symbol/declaration with :GoDef
• Look up documentation with :GoDoc inside Vim or open it in browser.
• Automatically import packages via :GoImport or plug it into autosave
• Compile your package with :GoBuild , install it with :GoInstall
• :GoRun quickly your current file/files
• Run :GoTest and see any errors in quickfix window
• Automatic GOPATH detection based on the directory structure (i.e: godep vendored projects)
• Change or display GOPATH with :GoPath
• Create a coverage profile and display annotated source code in browser to see which functions are covered with :GoCoverage
• Lint your code with :GoLint
• Run your code through :GoVet to catch static errors.
• Advanced source analysis tool with oracle, such as :GoImplements, :GoCallees, :GoReferrers
• Precise type-safe renaming of identifiers with :GoRename
• List all source files and dependencies
• Checking with :GoErrCheck for unchecked errors.
• Integrated and improved snippets. Supports ultisnips or neosnippet
• Share your current code to play.golang.org with :GoPlay
• On-the-fly type information about the word under the cursor. Plug it into your custom vim function.
• Tagbar support to show tags of the source code in a sidebar with gotags
• Custom vim text objects, such a a function or inner function

Install

Vim-go follows the standard runtime path structure, so I highly recommend to use a common and well known plugin manager to install vim-go. Do not use vim-go with other Go plugins. For Pathogen just clone the repo, for other plugin managers add the appropriate lines and execute the plugin's install command.

• Pathogen
• git clone https://github.com/fatih/vim-go.git ~/.vim/bundle/vim-go
• vim-plug
• Plug 'fatih/vim-go'
• NeoBundle
• NeoBundle 'fatih/vim-go'
• Vundle
• Plugin 'fatih/vim-go'

Please be sure all necessary binaries are installed (such as gocode, godef, goimports, etc..). You can easily install them with the included :GoInstallBinaries command. If you invoke it, all necessary binaries will be automatically downloaded and installed to your $GOBIN environment (if not set it will use $GOPATH/bin). It requires git for fetching the individual Go packages.

Optional

• Autocompletion is enabled by default via <C-x><C-o>, to get real-time completion (completion by type) install: YCM or neocomplete.
• To get displayed source code tag informations on a sidebar install tagbar.
• For snippet feature install: ultisnips or neosnippet.
• Screenshot color scheme is a slightly modified molokai: fatih/molokai.
• For a better documentation viewer checkout: go-explorer.

Usage

Many of the features are enabled by default. There are no additional settings needed. All usages and commands are listed in doc/vim-go.txt. Note that help tags needs to be populated. Check your plugin manager settings to generate the documentation (some do it automatically). After that just open the help page to see all commands:

:help vim-go

Mappings

vim-go has several <Plug> mappings which can be used to create custom mappings. Below are some examples you might find useful:

Run commands, such as go run with <leader>r for the current file or go build and go test for the current package with <leader>b and <leader>t. Display a beautiful annotated source code to see which functions are covered with <leader>c.

au FileType go nmap <leader>r <Plug>(go-run)
au FileType go nmap <leader>b <Plug>(go-build)
au FileType go nmap <leader>t <Plug>(go-test)
au FileType go nmap <leader>c <Plug>(go-coverage)

By default the mapping gd is enabled which opens the target identifier in current buffer. You can also open the definition/declaration in a new vertical, horizontal or tab for the word under your cursor:

au FileType go nmap <Leader>ds <Plug>(go-def-split)
au FileType go nmap <Leader>dv <Plug>(go-def-vertical)
au FileType go nmap <Leader>dt <Plug>(go-def-tab)

Open the relevant Godoc for the word under the cursor with <leader>gd or open it vertically with <leader>gv

au FileType go nmap <Leader>gd <Plug>(go-doc)
au FileType go nmap <Leader>gv <Plug>(go-doc-vertical)

Or open the Godoc in browser

au FileType go nmap <Leader>gb <Plug>(go-doc-browser)

Show a list of interfaces which is implemented by the type under your cursor with <leader>s

au FileType go nmap <Leader>s <Plug>(go-implements)

Show type info for the word under your cursor with <leader>i (useful if you have disabled auto showing type info via g:go_auto_type_info)

au FileType go nmap <Leader>i <Plug>(go-info)

Rename the identifier under the cursor to a new name

au FileType go nmap <Leader>e <Plug>(go-rename)

More <Plug> mappings can be seen with :he go-mappings. Also these are just recommendations, you are free to create more advanced mappings or functions based on :he go-commands.

Settings

Below are some settings you might find useful. For the full list see :he go-settings.

By default syntax-highlighting for Functions, Methods and Structs is disabled. To change it:

let g:go_highlight_functions = 1
let g:go_highlight_methods = 1
let g:go_highlight_structs = 1
let g:go_highlight_operators = 1
let g:go_highlight_build_constraints = 1

Enable goimports to automatically insert import paths instead of gofmt:

let g:go_fmt_command = "goimports"

By default vim-go shows errors for the fmt command, to disable it:

let g:go_fmt_fail_silently = 1

Disable auto fmt on save:

let g:go_fmt_autosave = 0

Disable opening browser after posting to your snippet to play.golang.org:

let g:go_play_open_browser = 0

By default when :GoInstallBinaries is called, the binaries are installed to $GOBIN or $GOPATH/bin. To change it:

let g:go_bin_path = expand("~/.gotools")
let g:go_bin_path = "/home/fatih/.mypath"      "or give absolute path

More info

Check out the Wiki page for more information. It includes Screencasts, FAQ section and many various piece of information:

https://github.com/fatih/vim-go/wiki

Donations

Vim-go is an open source project and I'm working on it on my free times. I'm spending a lot of time and thoughts to make it stable, fixing bugs, adding new features, etc... If you like vim-go and find it helpful, you might give me a gift from some of the books (kindle) I have in my wish list:

Amazon.com Fatih's Wish List. Thanks!

Credits

• Go Authors for official vim plugins
• Gocode, Godef, Golint, Oracle, Goimports, Gotags, Errcheck projects and authors of those projects.
• Other vim-plugins, thanks for inspiration (vim-golang, go.vim, vim-gocode, vim-godef)
• Contributors of vim-go

License

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