| CI (Linux, macOS) | Coverage | Gitter | Doc |
|---|---|---|---|
 |
 |
 |
 |
Coc is an intellisense engine for vim8 & neovim.
It's a completion framework, language server client which support extension features of VSCode
True snippet and additional text edit support
Checkout doc/coc.txt for vim interface.
- 🚀 Fast: instant increment completion, increment buffer sync using buffer update events.
- 💎 Reliable: typed language, tested with CI.
- 🌟 Featured: full LSP support
- ❤️ Flexible: configured as VSCode, extensions works like VSCode
-
For vim-plug user. Add:
Plug 'neoclide/coc.nvim', {'tag': '*', 'do': { -> coc#util#install()}}
Or build from source code by install nodejs and yarn
curl -sL install-node.now.sh/lts | sh curl --compressed -o- -L https://yarnpkg.com/install.sh | bash
And add:
Plug 'neoclide/coc.nvim', {'do': 'yarn install'}
to your
.vimrcorinit.vim, restart vim and run:PlugInstall.For other plugin manager, run command
:call coc#util#install()to download binary after coc is installed.Note: neovim >= 0.3.0 or vim >= 8.1 is required.
Note: for vim user, global installed vim-node-rpc module required.
Completion for words of buffers and file path are supported by default.
For other completion sources, check out:
- coc-sources: includes some common completion source extensions.
- coc-neco: viml completion support.
Or you can create custom source.
Extension are powerful than configured language server. Checkout Using coc extensions.
- coc-json for
json. - coc-tsserver for
javascriptandtypescript. - coc-html for
html,handlebarsandrazor. - coc-css for
css,scssandless. - coc-vetur for
vue, use vetur. - coc-java for
java, use eclipse.jdt.ls. - coc-solargraph for
ruby, use solargraph. - coc-rls for
rust, use Rust Language Server
And more, to get full list of coc extensions, search coc.nvim on npm.
Note: use :CocConfig to edit configuration file, auto completion is
supported after coc-json installed.
" if hidden not set, TextEdit might fail.
set hidden
" Better display for messages
set cmdheight=2
" Smaller updatetime for CursorHold & CursorHoldI
set updatetime=300
" always show signcolumns
set signcolumn=yes
" Use tab for trigger completion with characters ahead and navigate.
" Use command ':verbose imap <tab>' to make sure tab is not mapped by other plugin.
inoremap <silent><expr> <TAB>
\ pumvisible() ? "\<C-n>" :
\ <SID>check_back_space() ? "\<TAB>" :
\ coc#refresh()
inoremap <expr><S-TAB> pumvisible() ? "\<C-p>" : "\<C-h>"
function! s:check_back_space() abort
let col = col('.') - 1
return !col || getline('.')[col - 1] =~# '\s'
endfunction
" Use <c-space> for trigger completion.
inoremap <silent><expr> <c-space> coc#refresh()
" Use <cr> for confirm completion.
" Coc only does snippet and additional edit on confirm.
inoremap <expr> <cr> pumvisible() ? "\<C-y>" : "\<C-g>u\<CR>"
" Use `[c` and `]c` for navigate diagnostics
nmap <silent> [c <Plug>(coc-diagnostic-prev)
nmap <silent> ]c <Plug>(coc-diagnostic-next)
" Remap keys for gotos
nmap <silent> gd <Plug>(coc-definition)
nmap <silent> gy <Plug>(coc-type-definition)
nmap <silent> gi <Plug>(coc-implementation)
nmap <silent> gr <Plug>(coc-references)
" Use K for show documentation in preview window
nnoremap <silent> K :call <SID>show_documentation()<CR>
function! s:show_documentation()
if &filetype == 'vim'
execute 'h '.expand('<cword>')
else
call CocAction('doHover')
endif
endfunction
" Highlight symbol under cursor on CursorHold
autocmd CursorHold * silent call CocActionAsync('highlight')
" Remap for rename current word
nmap <leader>rn <Plug>(coc-rename)
" Remap for format selected region
vmap <leader>f <Plug>(coc-format-selected)
nmap <leader>f <Plug>(coc-format-selected)
" Or use formatexpr for range format
set formatexpr=CocAction('formatSelected')
" Remap for do codeAction of selected region, ex: `<leader>aap` for current paragraph
vmap <leader>a <Plug>(coc-codeaction-selected)
nmap <leader>a <Plug>(coc-codeaction-selected)
" Remap for do codeAction of current line
nmap <leader>ac <Plug>(coc-codeaction)
" Use `:Format` for format current buffer
command! -nargs=0 Format :call CocAction('format')
" Use `:Fold` for fold current buffer
command! -nargs=? Fold :call CocAction('fold', <f-args>)
" Add diagnostic info for https://github.com/itchyny/lightline.vim
let g:lightline = {
\ 'colorscheme': 'wombat',
\ 'active': {
\ 'left': [ [ 'mode', 'paste' ],
\ [ 'cocstatus', 'readonly', 'filename', 'modified' ] ]
\ },
\ 'component_function': {
\ 'cocstatus': 'coc#status'
\ },
\ }
" Shortcuts for denite interface
" Show symbols of current buffer
nnoremap <silent> <space>o :<C-u>Denite coc-symbols<cr>
" Search symbols of current workspace
nnoremap <silent> <space>t :<C-u>Denite coc-workspace<cr>
" Show diagnostics of current workspace
nnoremap <silent> <space>a :<C-u>Denite coc-diagnostic<cr>
" Show available commands
nnoremap <silent> <space>c :<C-u>Denite coc-command<cr>
" Show available services
nnoremap <silent> <space>s :<C-u>Denite coc-service<cr>
" Show links of current buffer
nnoremap <silent> <space>l :<C-u>Denite coc-link<cr>If you like this plugin, star it! It's a great way of getting feedback. The same goes for reporting issues or feature requests.
