Vim Go IDE
通过配置,使得 vim 可以看起来像 ide 一样来开发 Go 。
说实在的,如果喜好折腾,喜好自己来配置环境,可以配置一下,如果不是很熟练 vi/vim
,还是踏踏实实使用 IDE 吧,比如 VSCode(我也会用) 、 GoLand 还都是不错的,不过你要是看到了我的这篇文档,就证明还是想要折腾一下,下面就是我折腾后的结果。
本配置是在 Ubuntu 18.04 下完成的, vim 版本是
VIM - Vi IMproved 8.0
,开启 lantern (不考虑网络不通畅的情况)
既然是 Go 的开发环境,第一步当前就是准备好 。
到 golang.org 将安装包下载,并配置好环境, 推荐使用二进制版本,下载完成后直接解压缩就可以使用。如果无法访问 go 官网,可以考虑去 golang.google.cn 去下载。
wget https://dl.google.com/go/go1.12.linux-amd64.tar.gz
sudo tar -xzvf go1.12.linux-amd64.tar.gz -C /usr/local/
创建 Go 的工作空间(目录)
# 这是默认的位置,也可以按照需求指定到其他目录
mkdir -p /nebula/go/{bin,pkg,src}
配置环境变量
用户 vim 创建一个配置文 vim /etc/profile.d/go.sh
,写入下面内容
也可以在~/.bashrc中更改
export GOPATH=/nebula/go
export GOROOT=/usr/local/go
export PATH=$PATH:$GOROOT/bin:$GOPATH/bin
打开 vimrc 文件 vim ~/.vimrc
,写入下面配置
"==============================================================================
" vim 内置配置
"==============================================================================
" 设置 vimrc 修改保存后立刻生效,不用在重新打开
" 建议配置完成后将这个关闭
autocmd BufWritePost $MYVIMRC source $MYVIMRC
" 关闭兼容模式
set nocompatible
set nu " 设置行号
set cursorline "突出显示当前行
" set cursorcolumn " 突出显示当前列
set showmatch " 显示括号匹配
" tab 缩进
set tabstop=4 " 设置Tab长度为4空格
set shiftwidth=4 " 设置自动缩进长度为4空格
set autoindent " 继承前一行的缩进方式,适用于多行注释
" 定义快捷键的前缀,即<Leader>
let mapleader=";"
" ==== 系统剪切板复制粘贴 ====
" v 模式下复制内容到系统剪切板
vmap <Leader>c "+yy
" n 模式下复制一行到系统剪切板
nmap <Leader>c "+yy
" n 模式下粘贴系统剪切板的内容
nmap <Leader>v "+p
" 开启实时搜索
set incsearch
" 搜索时大小写不敏感
set ignorecase
syntax enable
syntax on " 开启文件类型侦测
filetype plugin indent on " 启用自动补全
" 退出插入模式指定类型的文件自动保存
au InsertLeave *.go,*.sh,*.php write
插件的用途就是可以很方便的管理 vim 的各种插件,快速安装配置以及清除,网上现在的帖子多数都是使用的 Vundle 这个插件,不过个人觉得这个管理工具在插件安装多了的时候不是很流畅,更喜好使用 vim-plug 这个插件,两个插件都是很清除的安装文档,这里是介绍 vim-plug 。
在 Linux 下非常简单,直接通过 curl 下载即可(也可以手动下载,见官方文档)
curl -fLo ~/.vim/autoload/plug.vim --create-dirs \
https://raw.githubusercontent.com/junegunn/vim-plug/master/plug.vim
note
当https://raw.githubusercontent.com/junegunn/vim-plug/master/plug.vim 打不开的时候,或者错误的时候
接下来配置了vim之后会报错
Error detected while processing /Users/selton/.vim/vimrc:
E117: Unknown function: plug#begin
请在vim配置文件的开头第一句写明set nocompatible
也就是set nocompatible开启了vim相对于vi的很多新的功能,报错异步加载的功能
所以如果没有set nocompatible,接下来的plugin安装会下载成功,但是:PlugStatus查看状态就一直是失败
解决方案:
git clone https://github.com/steppenwolfyuetong/vim-plug.git
将下载后的plug.vim 放到~/.vim/autoload/下面
插件的配置也非常简单,只要将所有的插件配置在 call plug#begin('~/.vim/plugged')
和 call plug#end()
之间即可,常见的插件基本上都可以从 github 中找到,如果 github 找不到的话基本上 vim.org 的脚本都可以在 vim-script 中找到备份
在刚刚的 ~/.vimrc
下面继续添加插件相关的配置
" 插件开始的位置
call plug#begin('~/.vim/plugged')
" Shorthand notation; fetches https://github.com/junegunn/vim-easy-align
" 可以快速对齐的插件
Plug 'junegunn/vim-easy-align'
" 用来提供一个导航目录的侧边栏
Plug 'scrooloose/nerdtree'
" 可以使 nerdtree 的 tab 更加友好些
Plug 'jistr/vim-nerdtree-tabs'
" 可以在导航目录中看到 git 版本信息
Plug 'Xuyuanp/nerdtree-git-plugin'
" 查看当前代码文件中的变量和函数列表的插件,
" 可以切换和跳转到代码中对应的变量和函数的位置
" 大纲式导航, Go 需要 https://github.com/jstemmer/gotags 支持
Plug 'majutsushi/tagbar'
" 自动补全括号的插件,包括小括号,中括号,以及花括号
Plug 'jiangmiao/auto-pairs'
" Vim状态栏插件,包括显示行号,列号,文件类型,文件名,以及Git状态
Plug 'vim-airline/vim-airline'
" 有道词典在线翻译
Plug 'ianva/vim-youdao-translater'
" 代码自动完成,安装完插件还需要额外配置才可以使用
Plug 'Valloric/YouCompleteMe'
" 可以在文档中显示 git 信息
Plug 'airblade/vim-gitgutter'
" 下面两个插件要配合使用,可以自动生成代码块
Plug 'SirVer/ultisnips'
Plug 'honza/vim-snippets'
" 可以在 vim 中使用 tab 补全
"Plug 'vim-scripts/SuperTab'
" 可以在 vim 中自动完成
"Plug 'Shougo/neocomplete.vim'
" 配色方案
" colorscheme neodark
Plug 'KeitaNakamura/neodark.vim'
" colorscheme monokai
Plug 'crusoexia/vim-monokai'
" colorscheme github
Plug 'acarapetis/vim-colors-github'
" colorscheme one
Plug 'rakr/vim-one'
" go 主要插件
Plug 'fatih/vim-go', { 'tag': '*' }
" go 中的代码追踪,输入 gd 就可以自动跳转
Plug 'dgryski/vim-godef'
" markdown 插件
Plug 'iamcco/mathjax-support-for-mkdp'
Plug 'iamcco/markdown-preview.vim'
" 插件结束的位置,插件全部放在此行上面
call plug#end()
然后输入 :w
保存配置,在输入 :PlugInstall
,如下:
:w
:PlugInstall
插件会自动下载安装,看见上面显示 Finishing ... Done 的内容,插件安装成功
执行PlugStatus查看插件的状态是否OK
如果想要删除插件,只要将不需要的插件注释或者删除,执行 :PlugClean
就可以自动清理了
上面一起安装了很多个插件,有些插件要单独配置,记录到下面
这个是 go 语言支持插件,上面插件完成后还需要安装很多个 Go 的包才能正常工作,在 vim 中执行下面命令:
:GoInstallBinaries
出现 vim-go: installing finished!
安装成功,可以使用 Go 包的相关功能了
这一步可能去下载对应的插件失败,需要如下设置 go get层面增加代理 go 1.11版本新增了 GOPROXY 环境变量,go get会根据这个环境变量来决定去哪里取引入库的代码
$ export GOPROXY=https://goproxy.io 1 其中,https://goproxy.io 是一个goproxy.io这个开源项目提供的公开代理服务。
需要注意前面的 PATH 要配置正确,并且已经生效,如果配置正确没有生效,可以注销再登录查看
这个插件是用来自动完成的,不过需要手动做一些额外的配置
a. 安装以来关系
sudo apt install build-essential cmake python3-dev
b. 编译
cd ~/.vim/plugged/YouCompleteMe
# 编译,并加入 go 的支持
python3 install.py --clang-completer --go-completer
c. 配置和 SirVer/ultisnips
冲突的快捷键
let g:ycm_key_list_select_completion = ['<C-n>', '<space>']
let g:ycm_key_list_previous_completion = ['<C-p>', '<Up>']
let g:SuperTabDefaultCompletionType = '<C-n>'
" better key bindings for UltiSnipsExpandTrigger
let g:UltiSnipsExpandTrigger = "<tab>"
let g:UltiSnipsJumpForwardTrigger = "<tab>"
let g:UltiSnipsJumpBackwardTrigger = "<s-tab>"
其他的插件配置不多,直接看配置文件的注释即可,下面将所有的配置全部贴出来
下面是全部的 ~/.vimrc
中的配置, 也可以直接下载我配置好的 vimrc 文件
" Author: yuetong
" Date: 2019-10-28
" Language: Go
"
" =============================================================================
" 处理 Gnome 终端不能使用 alt 快捷键
" 参考:http://landcareweb.com/questions/8623/altjian-kuai-jie-jian-bu-gua-yong-yu-dai-you-vimde-gnomezhong-duan
" ==============================================================================
let c='a'
while c <= 'z'
exec "set <A-".c.">=\e".c
exec "imap \e".c." <A-".c.">"
let c = nr2char(1+char2nr(c))
endw
set timeout ttimeoutlen=50
" ==============================================================================
" vim 内置配置(vim 自身(非插件)快捷键)
" ==============================================================================
" >> 定义快捷键
" 定义快捷键到行首和行尾
nmap LB 0
nmap LE $
" 定义快捷键的前缀,即<Leader>
let mapleader=";"
" 设置快捷键将选中文本块复制至系统剪贴板
vnoremap <Leader>y "+y
" 设置快捷键将系统剪贴板内容粘贴至vim
nmap <Leader>p "+p
" 定义快捷键关闭当前分割窗口
nmap <Leader>q :q<CR>
" 定义快捷键保存当前窗口内容
nmap <Leader>w :w<CR>
" 定义快捷键保存所有窗口内容并退出 vim
nmap <Leader>WQ :wa<CR>:q<CR>
" 不做任何保存,直接退出 vim
nmap <Leader>Q :qa!<CR>
" 设置快捷键遍历子窗口
" 依次遍历
nnoremap nw <C-W><C-W>
" 跳转至左方的窗口
nnoremap <Leader>hw <C-W>h
" 跳转至下方的子窗口
nnoremap <Leader>jw <C-W>j
" 跳转至上方的子窗口
nnoremap <Leader>kw <C-W>k
" 跳转至右方的窗口
nnoremap <Leader>lw <C-W>l
" 定义快捷键在结对符之间跳转
nmap <Leader>M %
" <<
" >> 其他
"让配置变更立即生效
autocmd BufWritePost $MYVIMRC source $MYVIMRC
" 关闭兼容模式
set nocompatible
" 开启实时搜索
set incsearch
" 搜索时大小写不敏感
set ignorecase
set number " 设置绝对行号
" set relativenumber " 设置相对行号
set cursorline "突出显示当前行
set cursorcolumn " 突出显示当前列
set showmatch " 显示括号匹配
" tab 缩进
set tabstop=4 " 设置Tab长度为4空格
set shiftwidth=4 " 设置自动缩进长度为4空格
set autoindent " 继承前一行的缩进方式,适用于多行注释
syntax enable
syntax on " 开启文件类型侦测
filetype plugin indent on " 启用自动补全
" 退出插入模式指定类型的文件自动保存
au InsertLeave *.go,*.sh,*.php write
" vim 自身命令行模式智能补全
set wildmenu
" backspace键不能用的问题
set backspace=indent,eol,start
" 保持文件时自动删除尾部的空白字符
autocmd BufWrite * silent! :%s/[[:space:]]\+$//g
" <<
" =======================================================================
" 插件配置
" ========================================================================
" 插件开始的位置 vim-plug 管理的插件列表必须位于 plug#begin('~/.vim/plugged') 和 plug#end() 之间
call plug#begin('~/.vim/plugged')
" Vim 中文文档
Plug 'yianwillis/vimcdoc'
" Shorthand notation; fetches https://github.com/junegunn/vim-easy-align
" 可以快速对齐的插件
Plug 'junegunn/vim-easy-align'
" 用来提供一个导航目录的侧边栏
Plug 'scrooloose/nerdtree'
" 可以使 nerdtree Tab标签的名字更友好些
Plug 'jistr/vim-nerdtree-tabs'
" 可以在导航目录中看到 git 版本信息
Plug 'Xuyuanp/nerdtree-git-plugin'
" 查看当前代码文件中的变量和函数列表的插件,
" 可以切换和跳转到代码中对应的变量和函数的位置
" 大纲式导航, Go 需要 https://github.com/jstemmer/gotags 支持
Plug 'majutsushi/tagbar'
" 自动补全括号的插件,包括小括号,中括号,以及花括号
Plug 'jiangmiao/auto-pairs'
" Vim状态栏插件,包括显示行号,列号,文件类型,文件名,以及Git状态
Plug 'vim-airline/vim-airline'
" 有道词典在线翻译
Plug 'ianva/vim-youdao-translater'
" 代码自动完成,安装完插件还需要额外配置才可以使用
Plug 'Valloric/YouCompleteMe'
" 可以在文档中显示 git 信息
Plug 'airblade/vim-gitgutter'
" 下面两个插件要配合使用,可以自动生成代码块
Plug 'SirVer/ultisnips'
Plug 'honza/vim-snippets'
" 可以在 vim 中使用 tab 补全
"Plug 'vim-scripts/SuperTab'
" 可以在 vim 中自动完成
"Plug 'Shougo/neocomplete.vim'
" 配色方案
" colorscheme neodark
Plug 'KeitaNakamura/neodark.vim'
" colorscheme monokai
Plug 'crusoexia/vim-monokai'
" colorscheme github
Plug 'acarapetis/vim-colors-github'
" colorscheme one
Plug 'rakr/vim-one'
" go 主要插件
Plug 'fatih/vim-go', { 'tag': '*' }
" go 中的代码追踪,输入 gd 就可以自动跳转
Plug 'dgryski/vim-godef'
" markdown 插件
Plug 'iamcco/mathjax-support-for-mkdp'
Plug 'iamcco/markdown-preview.vim'
" 自动生成注释的插件
Plug 'scrooloose/nerdcommenter'
" 强大的文件搜索插件
Plug 'junegunn/fzf', { 'dir': '~/.fzf', 'do': './install --all' }
Plug 'junegunn/fzf.vim'
" 格式化代码插件
" 这个插件特定语言需要额外支持, 比如格式化 json, 需要 js-beautify
" 安装可以 yay -S js-beautify(archlinux) 或者 npm install -g js-beautify
" 更多支持参考: https://github.com/Chiel92/vim-autoformat#default-formatprograms
Plug 'Chiel92/vim-autoformat'
" 插件结束的位置,插件全部放在此行上面
call plug#end()
"==============================================================================
" 主题配色
"==============================================================================
" 开启24bit的颜色,开启这个颜色会更漂亮一些
set termguicolors
" 配色方案, 可以从上面插件安装中的选择一个使用
" 主题1
colorscheme one " 主题
set background=dark " 主题背景 dark-深色; light-浅色
"==============================================================================
" vim-go 插件
"==============================================================================
let g:go_fmt_command = "goimports" " 格式化将默认的 gofmt 替换
let g:go_autodetect_gopath = 1
let g:go_list_type = "quickfix"
let g:go_version_warning = 1
let g:go_highlight_types = 1
let g:go_highlight_fields = 1
let g:go_highlight_functions = 1
let g:go_highlight_function_calls = 1
let g:go_highlight_operators = 1
let g:go_highlight_extra_types = 1
let g:go_highlight_methods = 1
let g:go_highlight_generate_tags = 1
let g:godef_split=2
" 直接通过 go run 执行当前文件
autocmd FileType go nmap <leader>r :GoRun %<CR>
"==============================================================================
" NERDTree 插件
"==============================================================================
" 打开和关闭NERDTree快捷键
map <F10> :NERDTreeToggle<CR>
nmap <M-m> :NERDTreeFind<CR>
" 显示行号
let NERDTreeShowLineNumbers=1
" 打开文件时是否显示目录
let NERDTreeAutoCenter=1
" 是否显示隐藏文件
let NERDTreeShowHidden=0
" 设置宽度
" let NERDTreeWinSize=31
" 忽略一下文件的显示
let NERDTreeIgnore=['\.pyc','\~$','\.swp']
" 打开 vim 文件及显示书签列表
let NERDTreeShowBookmarks=2
" 在终端启动vim时,共享NERDTree
let g:nerdtree_tabs_open_on_console_startup=1
"==============================================================================
" majutsushi/tagbar 插件
"==============================================================================
" majutsushi/tagbar 插件打开关闭快捷键
nmap <F9> :TagbarToggle<CR>
let g:tagbar_type_go = {
\ 'ctagstype' : 'go',
\ 'kinds' : [
\ 'p:package',
\ 'i:imports:1',
\ 'c:constants',
\ 'v:variables',
\ 't:types',
\ 'n:interfaces',
\ 'w:fields',
\ 'e:embedded',
\ 'm:methods',
\ 'r:constructor',
\ 'f:functions'
\ ],
\ 'sro' : '.',
\ 'kind2scope' : {
\ 't' : 'ctype',
\ 'n' : 'ntype'
\ },
\ 'scope2kind' : {
\ 'ctype' : 't',
\ 'ntype' : 'n'
\ },
\ 'ctagsbin' : 'gotags',
\ 'ctagsargs' : '-sort -silent'
\ }
"==============================================================================
" nerdtree-git-plugin 插件
"==============================================================================
let g:NERDTreeIndicatorMapCustom = {
\ "Modified" : "✹",
\ "Staged" : "✚",
\ "Untracked" : "✭",
\ "Renamed" : "➜",
\ "Unmerged" : "═",
\ "Deleted" : "✖",
\ "Dirty" : "✗",
\ "Clean" : "✔︎",
\ 'Ignored' : '☒',
\ "Unknown" : "?"
\ }
let g:NERDTreeShowIgnoredStatus = 1
nmap <Leader>pwd :NERDTreeCWD<CR>
"==============================================================================
" Valloric/YouCompleteMe 插件
"==============================================================================
" make YCM compatible with UltiSnips (using supertab)
let g:ycm_key_list_select_completion = ['<M-w>', '<DOWN>']
let g:ycm_key_list_previous_completion = ['<M-d>', '<Up>']
let g:SuperTabDefaultCompletionType = '<M-w>'
" better key bindings for UltiSnipsExpandTrigger
let g:UltiSnipsExpandTrigger = "<tab>"
let g:UltiSnipsJumpForwardTrigger = "<tab>"
let g:UltiSnipsJumpBackwardTrigger = "<s-tab>"
" 关闭了提示再次触发的快捷键
let g:ycm_key_invoke_completion = '<Leader>,'
"==============================================================================
" UltiSnips 插件
"==============================================================================
" better key bindings for UltiSnipsExpandTrigger
let g:UltiSnipsExpandTrigger = "<tab>"
let g:UltiSnipsJumpForwardTrigger = "<tab>"
let g:UltiSnipsJumpBackwardTrigger = "<s-tab>"
"==============================================================================
" 其他插件配置
"==============================================================================
" markdwon 的快捷键
map <silent> <F5> <Plug>MarkdownPreview
map <silent> <F6> <Plug>StopMarkdownPreview
" tab 标签页切换快捷键
:nn <Leader>1 1gt
:nn <Leader>2 2gt
:nn <Leader>3 3gt
:nn <Leader>4 4gt
:nn <Leader>5 5gt
:nn <Leader>6 6gt
:nn <Leader>7 7gt
:nn <Leader>8 8gt
:nn <Leader>9 8gt
:nn <Leader>0 :tablast<CR>
:nn <M-1> 1gt
:nn <M-2> 2gt
:nn <M-3> 3gt
:nn <M-4> 4gt
:nn <M-5> 5gt
:nn <M-6> 6gt
:nn <M-7> 7gt
:nn <M-8> 8gt
:nn <M-9> 9gt
:nn <M-0> :tablast<CR>
" 自动注释的时候添加空格
let g:NERDSpaceDelims=1
"==============================================================================
" GVim 的配置
"==============================================================================
" 如果不使用 GVim ,可以不用配置下面的配置
if has('gui_running')
colorscheme one
" 设置启动时窗口的大小
set lines=999 columns=999 linespace=4
" 设置字体及大小
set guifont=Roboto\ Mono\ 13
set guioptions-=m " 隐藏菜单栏
set guioptions-=T " 隐藏工具栏
set guioptions-=L " 隐藏左侧滚动条
set guioptions-=r " 隐藏右侧滚动条
set guioptions-=b " 隐藏底部滚动条
set guifont=Fira\ Code\ 14
set lines=999 columns=999
endif
"==============================================================================
" 光标随着插入模式改变形状
" 参考: https://vim.fandom.com/wiki/Change_cursor_shape_in_different_modes
"==============================================================================
if has("autocmd")
au VimEnter,InsertLeave * silent execute '!echo -ne "\e[2 q"' | redraw!
au InsertEnter,InsertChange *
\ if v:insertmode == 'i' |
\ silent execute '!echo -ne "\e[6 q"' | redraw! |
\ elseif v:insertmode == 'r' |
\ silent execute '!echo -ne "\e[4 q"' | redraw! |
\ endif
au VimLeave * silent execute '!echo -ne "\e[ q"' | redraw!
endif
"==============================================================================
" 自定义的额外配置
"==============================================================================
"
" 自动保存 session
autocmd VimLeave * mks! ~/.vim/session.vim
" 加载 session 的快捷键
nmap <Leader>his :source ~/.vim/session.vim<CR>
nnoremap <silent> <C-p> :Files<CR>
nnoremap <silent> <C-S-i> :Autoformat<CR>
" 有道词典插件
map <M-t> :Ydc<CR>
" 自动切换到当前文件所在的目录 cdpath
map <Leader>cd :cd %:h<CR>
当使用 F9 的时候, 出现下面的错误:
Taglist: Exuberant ctags (http://ctags.sf.net) not found in PATH. Plugin is not loaded
解决方法:
sudo apt install ctags