Need help with coc.nvim?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

neoclide
14.0K Stars 540 Forks MIT License 636 Commits 22 Opened issues

Description

Intellisense engine for Vim8 & Neovim, full language server protocol support as VSCode

Services available

!
?

Need anything else?

Contributors list

No Data

Coc Logo

Make your Vim/Neovim as smart as VSCode.

Software License Actions Doc Gitter


Gif

True snippet and additional text editing support

Why?

Quick Start

Install nodejs >= 10.12:

curl -sL install-node.now.sh/lts | bash

For vim-plug users:

" Use release branch (recommend)
Plug 'neoclide/coc.nvim', {'branch': 'release'}

" Or build from source code by using yarn: https://yarnpkg.com Plug 'neoclide/coc.nvim', {'branch': 'master', 'do': 'yarn install --frozen-lockfile'}

in your

.vimrc
or
init.vim
, then restart Vim and run
:PlugInstall
.

Checkout Install coc.nvim for more info.

You have to install coc extension or configure language servers for LSP support.

Install extensions like:

:CocInstall coc-json coc-tsserver

Or configure language server in

coc-settings.json
opened by
:CocConfig
, like:
{
  "languageserver": {
    "go": {
      "command": "gopls",
      "rootPatterns": ["go.mod"],
      "trace.server": "verbose",
      "filetypes": ["go"]
    }
  }
}

Checkout wiki for more details:

Checkout

:h coc-nvim
for vim interface.

Example vim configuration

Configuration is required to make coc.nvim easier to work with, since it doesn't change your key-mappings or Vim options. This is done as much as possible to avoid conflict with your other plugins.

❗️Important: Some Vim plugins could change key mappings. Please use

:verbose imap 
to make sure that your keymap has taken effect.
" TextEdit might fail if hidden is not set.
set hidden

" Some servers have issues with backup files, see #649. set nobackup set nowritebackup

" Give more space for displaying messages. set cmdheight=2

" Having longer updatetime (default is 4000 ms = 4 s) leads to noticeable " delays and poor user experience. set updatetime=300

" Don't pass messages to |ins-completion-menu|. set shortmess+=c

" Always show the signcolumn, otherwise it would shift the text each time " diagnostics appear/become resolved. if has("patch-8.1.1564") " Recently vim can merge signcolumn and number column into one set signcolumn=number else set signcolumn=yes endif

" Use tab for trigger completion with characters ahead and navigate. " NOTE: Use command ':verbose imap ' to make sure tab is not mapped by " other plugin before putting this into your config. inoremap \ pumvisible() ? "<c-n>" : \ check_back_space() ? "<tab>" : \ coc#refresh() inoremap pumvisible() ? "<c-p>" : "<c-h>"

function! s:check_back_space() abort let col = col('.') - 1 return !col || getline('.')[col - 1] =~# '\s' endfunction

" Use to trigger completion. if has('nvim') inoremap coc#refresh() else inoremap coc#refresh() endif

" Make auto-select the first completion item and notify coc.nvim to " format on enter, could be remapped by other vim plugin inoremap pumvisible() ? coc#_select_confirm() : "<c-g>u<cr><c-r>=coc#on_enter()<cr>"

" Use [g and ]g to navigate diagnostics " Use :CocDiagnostics to get all diagnostics of current buffer in location list. nmap [g (coc-diagnostic-prev) nmap ]g (coc-diagnostic-next)

" GoTo code navigation. nmap gd (coc-definition) nmap gy (coc-type-definition) nmap gi (coc-implementation) nmap gr (coc-references)

" Use K to show documentation in preview window. nnoremap K :call show_documentation()

function! s:show_documentation() if (index(['vim','help'], &filetype) >= 0) execute 'h '.expand('') elseif (coc#rpc#ready()) call CocActionAsync('doHover') else execute '!' . &keywordprg . " " . expand('') endif endfunction

" Highlight the symbol and its references when holding the cursor. autocmd CursorHold * silent call CocActionAsync('highlight')

" Symbol renaming. nmap rn (coc-rename)

" Formatting selected code. xmap f (coc-format-selected) nmap f (coc-format-selected)

augroup mygroup autocmd! " Setup formatexpr specified filetype(s). autocmd FileType typescript,json setl formatexpr=CocAction('formatSelected') " Update signature help on jump placeholder. autocmd User CocJumpPlaceholder call CocActionAsync('showSignatureHelp') augroup end

" Applying codeAction to the selected region. " Example: <leader>aap for current paragraph xmap a (coc-codeaction-selected) nmap a (coc-codeaction-selected)

" Remap keys for applying codeAction to the current buffer. nmap ac (coc-codeaction) " Apply AutoFix to problem on the current line. nmap qf (coc-fix-current)

" Map function and class text objects " NOTE: Requires 'textDocument.documentSymbol' support from the language server. xmap if (coc-funcobj-i) omap if (coc-funcobj-i) xmap af (coc-funcobj-a) omap af (coc-funcobj-a) xmap ic (coc-classobj-i) omap ic (coc-classobj-i) xmap ac (coc-classobj-a) omap ac (coc-classobj-a)

" Remap and for scroll float windows/popups. if has('nvim-0.4.0') || has('patch-8.2.0750') nnoremap coc#float#has_scroll() ? coc#float#scroll(1) : "<c-f>" nnoremap coc#float#has_scroll() ? coc#float#scroll(0) : "<c-b>" inoremap coc#float#has_scroll() ? "<c-r>=coc#float#scroll(1)<cr>" : "<right>" inoremap coc#float#has_scroll() ? "<c-r>=coc#float#scroll(0)<cr>" : "<left>" vnoremap coc#float#has_scroll() ? coc#float#scroll(1) : "<c-f>" vnoremap coc#float#has_scroll() ? coc#float#scroll(0) : "<c-b>" endif

" NeoVim-only mapping for visual mode scroll " Useful on signatureHelp after jump placeholder of snippet expansion if has('nvim') vnoremap coc#float#has_scroll() ? coc#float#nvim_scroll(1, 1) : "<c-f>" vnoremap coc#float#has_scroll() ? coc#float#nvim_scroll(0, 1) : "<c-b>" endif

" Use CTRL-S for selections ranges. " Requires 'textDocument/selectionRange' support of language server. nmap (coc-range-select) xmap (coc-range-select)

" Add :Format command to format current buffer. command! -nargs=0 Format :call CocAction('format')

" Add :Fold command to fold current buffer. command! -nargs=? Fold :call CocAction('fold', )

" Add :OR command for organize imports of the current buffer. command! -nargs=0 OR :call CocAction('runCommand', 'editor.action.organizeImport')

" Add (Neo)Vim's native statusline support. " NOTE: Please see :h coc-status for integrations with external plugins that " provide custom statusline: lightline.vim, vim-airline. set statusline^=%{coc#status()}%{get(b:,'coc_current_function','')}

" Mappings for CoCList " Show all diagnostics. nnoremap a :CocList diagnostics " Manage extensions. nnoremap e :CocList extensions " Show commands. nnoremap c :CocList commands " Find symbol of current document. nnoremap o :CocList outline " Search workspace symbols. nnoremap s :CocList -I symbols " Do default action for next item. nnoremap j :CocNext " Do default action for previous item. nnoremap k :CocPrev " Resume latest coc list. nnoremap p :CocListResume

Articles

Trouble shooting

Try these steps when you have problem with coc.nvim.

  • Make sure your Vim version >= 8.0 by command
    :version
    .
  • If service failed to start, use command
    :CocInfo
    or
    :checkhealth
    on Neovim.
  • Checkout the log of coc.nvim by command
    :CocOpenLog
    .
  • When you have issues with the language server, it's recommended to checkout the output.

Feedback

Backers

Become a backer and get your image on our README on Github with a link to your site.

License

MIT

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.