Status
Travis CI
Gitter

Go source for deoplete.nvim use gocode.

Asynchronous Go completion for Neovim.
Use,

Shougo/deoplete.nvim

Dark powered asynchronous completion framework for neovim.
Fastetst, Fully asynchronous, Nonblocking user interface, Customizable source for each languages, and more.
The Nextgen word completion.

nsf/gocode

An autocompletion daemon for the Go programming language.
Fastest, Context-sesinive, Server/Client architecture, Result caching.
The defact standard completion engine.

===

https://github.com/neovim/neovim
https://github.com/neovim/python-client

https://github.com/Shougo/deoplete.nvim

https://github.com/nsf/gocode

===

See Neovim wiki.

• Installing Neovim
• Following HEAD
• Building

Neovim remonte client for python.
See https://github.com/neovim/python-client

pip2 install --upgrade neovim
pip3 install --upgrade neovim

go get -u github.com/nsf/gocode

deoplete-go using esnme/ultrajson json module.
It's Python bindings for C library. Need compiling.
So, If you use Plugin manager supported build process, set make commmand.

" dein.vim
call dein#add('Shougo/deoplete.nvim')
call dein#add('zchee/deoplete-go', {'build': 'make'})

" NeoBundle
NeoBundle 'Shougo/deoplete.nvim'}
NeoBundle 'zchee/deoplete-go', {'build': {'unix': 'make'}}

" vim-plug
Plug 'Shougo/deoplete.nvim'
Plug 'zchee/deoplete-go', { 'do': 'make'}

===

deoplete-go will directly call gocode. Not vim bypass due to the omnifunc.
By default(not set), Find the gocode binary in $PATH environment.
This setting is Recommend.
If you set it, deoplete-go spared look for the binary. It will improve performance.

Also, If you want to use a different from the first found gocode binary from $PATH then set:

let g:deoplete#sources#go#gocode_binary = '/path/to/gocode'

Automatically insert dot(period) when you select package name in popup menu.
By default, no dot(period) is inserted after a package name.

If you would prefer adding a period then set:

let g:deoplete#sources#go#package_dot = 1

By befault, the completion word list is in the sort order of gocode. Same as omnifunc.
If you want to change it to an arbitrary order, set it.

Available values are [package, func, type, var, const].
If you did not include any value, it will always be hidden in the completion list.

To display all words while sorting, set:

let g:deoplete#sources#go#sort_class = ['package', 'func', 'type', 'var', 'const']

Support pointer(*) match.
Example are bellow code. | is cursor.

type Foo struct {
  FooName string
}

func NewFoo() *Foo {
  return &Foo{}
}

func (f *|

g:deoplete#sources#go#use_cache

g:deoplete#sources#go#json_directory

Use static json caching Go stdlib package API.
If matched name of stdlib and input package name, it returns the static json data without the use of gocode.
and, Possible to get package API if have not import of current buffer.

Terms:

• Hook the insert of dot . (e.g. fmt.|)
• You typed package name have not import current buffer
• Match the typed package name and json file name

deoplete-go will parse g:deoplete#sources#go#json_directory directory. You can define of json data directory.
Recommend is ~/.cache/deoplete/go/$GOOS_$GOARCH because this directly use other deoplete sources(e.g. deoplete-deji).

Also, See How to use static json caching

let g:deoplete#sources#go#use_cache = 1
let g:deoplete#sources#go#json_directory = '/path/to/data_dir'

If current buffer have import "C" also #include <foo.h> and when you type C., deoplete-go will be display the C function in the foo.h.

Simple example is below. | is cursor.

package main

/*
#include <stdlib.h>
*/
import "C"
import (
	"fmt"
)

func main() {
	fmt.Printf()
	C.|
}

Will return the pid_t, malloc, free and more.

The real example use libgit2.

package main

/*
#include <git2.h>
*/
import "C"
import (
	"log"
	"os"
	"path/filepath"

	"github.com/libgit2/git2go"
)

func main() {
	repoPath := filepath.Join(os.Getenv("GOPATH"), "src/github.com/libgit2/git2go")
	gitRepo, err := git.OpenRepository(repoPath)
	C.git_blame_|
	if err != nil {
		log.Fatal(err)
	}
	commitOid, err := gitRepo.Head()
	if err != nil {

	}
}

Will return the that completion list.

Now support current buffer only.
TODO: Support parses .c, .h file.

libclang shared library path option.
In darwin, libclang.dylib, In Linux, libclang.so.

C language standard version option.
If not set, deoplete-go use c11(latest) version.

===

Pre-generate json data is data/json.
If you use it, cp -r data/json/VERSION/$GOOS_$GOARCH /path/to/data_dir.
/path/to/data_dir is g:deoplete#sources#go#json_directory.

And, You can generate your Go environment. such as version is devel, GOARCH is arm.
If you want to it, run make gen_json.
Will generated json file to ./data/json/VERSION/$GOOS_$GOARCH.

make gen_json command also will create ./data/stdlib.txt. It same as go tool api result.
In detail,

go tool api -contexts $GOOS-$GOARCH-cgo | grep -v 'golang.org/x/net/http2/hpack' | sed -e s/,//g | awk '{print $2}' | uniq > ./data/stdlib.txt

This api list used in the base for the generation of json file.

===

" neocomplete like
set completeopt+=noinsert
" deoplete.nvim recommend
set completeopt+=noselect

" Path to python interpreter for neovim
let g:python3_host_prog  = '/path/to/python3'
" Skip the check of neovim module
let g:python3_host_skip_check = 1

" Run deoplete.nvim automatically
let g:deoplete#enable_at_startup = 1
" deoplete-go settings
let g:deoplete#sources#go#gocode_binary = $GOPATH.'/bin/gocode'
let g:deoplete#sources#go#sort_class = ['package', 'func', 'type', 'var', 'const']
let g:deoplete#sources#go#use_cache = 1
let g:deoplete#sources#go#json_directory = '/path/to/data_dir'

===

• Parse included cgo (C, C++ language) headers on current buffer
  • ctags will be blocking deoplete.nvim
• Support static json caching
  • See deoplete-plugins#19
• Support Go stdlib package import "***" name completion
  • This feature has been implemented in gocode. Thanks @nhooyr!
• Execute gocode binary instead of call vim function
• Get and parse completion list of json format. such as ycm
• When there is no candidate infomation, deoplete will cause an error
• Support fizzy matching