rajibahmed/coc.nvim

Intellisense engine for vim & neovim, featured language server support as VSCode

Conqure of Completion

Coc is an intellisense engine for vim & neovim.

It's a completion framework, language server client while comes with bundled extensions from VSCode that just works.

True snippet and additional text edit support

Checkout doc/coc.txt for vim interface.

Pros.

• Easy to install and many features just work.
• Super fast initialization and completion.
• Full completion feature support of LSP.
• Featured language server extensions from VSCode, like tsserver, tslint etc.
• Custom language server configuration support.

Extensions

Language server are decoupled from coc.nvim to make the core smaller, and easier for user to use their own version of language server.

• Tsserver

  Used for javascript and typescript

    yarn global add typescript
  

• Html

  Used for html handlebars razor

    yarn global add vscode-html-languageserver-bin
  

• Json

  Used for json and jsonc

    yarn global add vscode-json-languageserver
  

• Css

  Used for css scss less and wxss

    yarn global add css-langserver
  

• Wxml

    yarn global add wxml-langserver
  

• Vetur

  Used for vue

    yarn global add vue-language-server
  

• Solargraph

  Used for ruby

  Install solargraph by:

    gem install solargraph
  

• Pyls

  Used for python

  Install pyls by:

    pip install 'python-language-server[all]'
  

• Stylelint

  Used for css wxss scss less markdown postcss sugarss vue.

    yarn global add stylelint-langserver
  

• Eslint

  Used for javascript

    yarn global add eslint-server
  

• Tslint

  Used for typescript

    yarn global add tslint-server
  

Note: use :CocConfig to edit configuration file, auto completion is supported

Table of contents

• Installation

  Install nodejs and yarn

  For vim-plug user. Add:

  Plug 'neoclide/coc.nvim', {'do': 'yarn install'}

  to your .vimrc, restart neovim and run :PlugInstall.

• Completion with sources

  • Trigger mode of completion
  • Snippet completion
  • Use <Tab> or custom key for trigger completion
  • Improve completion experience
  • Completion sources

• Using configuration file

  • Configuration file resolve
  • Default COC preferences
  • Configuration for sources
  • Extension configuration

• Language servers

  • Supported features
  • Built in server extensions
  • Register custom language servers
  • Debug language server

• Statusline integration

• Create custom source

• F.A.Q

Example configuration

" Use tab for trigger completion with characters ahead.
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.
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

" Show signature help while editing
autocmd CursorHoldI,CursorMovedI * silent! call CocAction('showSignatureHelp')

" Open quickfix list on quickfix change triggered by coc
autocmd User CocQuickfixChange :copen

" 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)

" 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 file
command! -nargs=0 Format :call CocAction('format')

" 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>

Trouble shooting

Don't be hesitated to open a issue.

LICENSE