install.fairie/dotfiles/.vim/plugged/coc.nvim

Make your Vim/Neovim as smart as VSCode.

---

Custom popup menu with snippet support

Why?

• 🚀 Fast: separated NodeJS process that does not block your vim most of the time.
• 💎 Reliable: typed language, tested with CI.
• 🌟 Featured: all LSP 3.16 features are supported, see :h coc-lsp.
• ❤️ Flexible: configured like VSCode, extensions work like in VSCode

Quick Start

Make sure use vim >= 8.1.1719 or neovim >= 0.4.0.

Install nodejs >= 14.14:

curl -sL install-node.vercel.app/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:

• Completion with sources
• Using the configuration file
• Using coc extensions
• Configure language servers
• F.A.Q

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 command like:verbose imap <tab> to make sure that your keymap has taken effect.

" May need for vim (not neovim) since coc.nvim calculate byte offset by count
" utf-8 byte sequence.
set encoding=utf-8
" Some servers have issues with backup files, see #649.
set nobackup
set nowritebackup

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

" Always show the signcolumn, otherwise it would shift the text each time
" diagnostics appear/become resolved.
set signcolumn=yes

" Use tab for trigger completion with characters ahead and navigate.
" NOTE: There's always complete item selected by default, you may want to enable
" no select by `"suggest.noselect": true` in your configuration file.
" NOTE: Use command ':verbose imap <tab>' to make sure tab is not mapped by
" other plugin before putting this into your config.
inoremap <silent><expr> <TAB>
      \ coc#pum#visible() ? coc#pum#next(1) :
      \ CheckBackspace() ? "\<Tab>" :
      \ coc#refresh()
inoremap <expr><S-TAB> coc#pum#visible() ? coc#pum#prev(1) : "\<C-h>"

" Make <CR> to accept selected completion item or notify coc.nvim to format
" <C-g>u breaks current undo, please make your own choice.
inoremap <silent><expr> <CR> coc#pum#visible() ? coc#pum#confirm()
                              \: "\<C-g>u\<CR>\<c-r>=coc#on_enter()\<CR>"

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

" Use <c-space> to trigger completion.
if has('nvim')
  inoremap <silent><expr> <c-space> coc#refresh()
else
  inoremap <silent><expr> <c-@> coc#refresh()
endif

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

" GoTo code navigation.
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 to show documentation in preview window.
nnoremap <silent> K :call ShowDocumentation()<CR>

function! ShowDocumentation()
  if CocAction('hasProvider', 'hover')
    call CocActionAsync('doHover')
  else
    call feedkeys('K', 'in')
  endif
endfunction

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

" Symbol renaming.
nmap <leader>rn <Plug>(coc-rename)

" Formatting selected code.
xmap <leader>f  <Plug>(coc-format-selected)
nmap <leader>f  <Plug>(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 <leader>a  <Plug>(coc-codeaction-selected)
nmap <leader>a  <Plug>(coc-codeaction-selected)

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

" Run the Code Lens action on the current line.
nmap <leader>cl  <Plug>(coc-codelens-action)

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

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

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

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

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

" Add `:OR` command for organize imports of the current buffer.
command! -nargs=0 OR   :call     CocActionAsync('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 <silent><nowait> <space>a  :<C-u>CocList diagnostics<cr>
" Manage extensions.
nnoremap <silent><nowait> <space>e  :<C-u>CocList extensions<cr>
" Show commands.
nnoremap <silent><nowait> <space>c  :<C-u>CocList commands<cr>
" Find symbol of current document.
nnoremap <silent><nowait> <space>o  :<C-u>CocList outline<cr>
" Search workspace symbols.
nnoremap <silent><nowait> <space>s  :<C-u>CocList -I symbols<cr>
" Do default action for next item.
nnoremap <silent><nowait> <space>j  :<C-u>CocNext<CR>
" Do default action for previous item.
nnoremap <silent><nowait> <space>k  :<C-u>CocPrev<CR>
" Resume latest coc list.
nnoremap <silent><nowait> <space>p  :<C-u>CocListResume<CR>

Example lua configuration

NOTE: This works in Neovim 0.7.0dev+ only.

-- Some servers have issues with backup files, see #649.
vim.opt.backup = false
vim.opt.writebackup = false

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

-- Always show the signcolumn, otherwise it would shift the text each time
-- diagnostics appear/become resolved.
vim.opt.signcolumn = "yes"

local keyset = vim.keymap.set
-- Auto complete
function _G.check_back_space()
    local col = vim.fn.col('.') - 1
    return col == 0 or vim.fn.getline('.'):sub(col, col):match('%s') ~= nil
end

-- Use tab for trigger completion with characters ahead and navigate.
-- NOTE: There's always complete item selected by default, you may want to enable
-- no select by `"suggest.noselect": true` in your configuration file.
-- NOTE: Use command ':verbose imap <tab>' to make sure tab is not mapped by
-- other plugin before putting this into your config.
local opts = {silent = true, noremap = true, expr = true, replace_keycodes = false}
keyset("i", "<TAB>", 'coc#pum#visible() ? coc#pum#next(1) : v:lua.check_back_space() ? "<TAB>" : coc#refresh()', opts)
keyset("i", "<S-TAB>", [[coc#pum#visible() ? coc#pum#prev(1) : "\<C-h>"]], opts)

-- Make <CR> to accept selected completion item or notify coc.nvim to format
-- <C-g>u breaks current undo, please make your own choice.
keyset("i", "<cr>", [[coc#pum#visible() ? coc#pum#confirm() : "\<C-g>u\<CR>\<c-r>=coc#on_enter()\<CR>"]], opts)

-- Use <c-j> to trigger snippets
keyset("i", "<c-j>", "<Plug>(coc-snippets-expand-jump)")
-- Use <c-space> to trigger completion.
keyset("i", "<c-space>", "coc#refresh()", {silent = true, expr = true})

-- Use `[g` and `]g` to navigate diagnostics
-- Use `:CocDiagnostics` to get all diagnostics of current buffer in location list.
keyset("n", "[g", "<Plug>(coc-diagnostic-prev)", {silent = true})
keyset("n", "]g", "<Plug>(coc-diagnostic-next)", {silent = true})

-- GoTo code navigation.
keyset("n", "gd", "<Plug>(coc-definition)", {silent = true})
keyset("n", "gy", "<Plug>(coc-type-definition)", {silent = true})
keyset("n", "gi", "<Plug>(coc-implementation)", {silent = true})
keyset("n", "gr", "<Plug>(coc-references)", {silent = true})


-- Use K to show documentation in preview window.
function _G.show_docs()
    local cw = vim.fn.expand('<cword>')
    if vim.fn.index({'vim', 'help'}, vim.bo.filetype) >= 0 then
        vim.api.nvim_command('h ' .. cw)
    elseif vim.api.nvim_eval('coc#rpc#ready()') then
        vim.fn.CocActionAsync('doHover')
    else
        vim.api.nvim_command('!' .. vim.o.keywordprg .. ' ' .. cw)
    end
end
keyset("n", "K", '<CMD>lua _G.show_docs()<CR>', {silent = true})


-- Highlight the symbol and its references when holding the cursor.
vim.api.nvim_create_augroup("CocGroup", {})
vim.api.nvim_create_autocmd("CursorHold", {
    group = "CocGroup",
    command = "silent call CocActionAsync('highlight')",
    desc = "Highlight symbol under cursor on CursorHold"
})


-- Symbol renaming.
keyset("n", "<leader>rn", "<Plug>(coc-rename)", {silent = true})


-- Formatting selected code.
keyset("x", "<leader>f", "<Plug>(coc-format-selected)", {silent = true})
keyset("n", "<leader>f", "<Plug>(coc-format-selected)", {silent = true})


-- Setup formatexpr specified filetype(s).
vim.api.nvim_create_autocmd("FileType", {
    group = "CocGroup",
    pattern = "typescript,json",
    command = "setl formatexpr=CocAction('formatSelected')",
    desc = "Setup formatexpr specified filetype(s)."
})

-- Update signature help on jump placeholder.
vim.api.nvim_create_autocmd("User", {
    group = "CocGroup",
    pattern = "CocJumpPlaceholder",
    command = "call CocActionAsync('showSignatureHelp')",
    desc = "Update signature help on jump placeholder"
})


-- Applying codeAction to the selected region.
-- Example: `<leader>aap` for current paragraph
local opts = {silent = true, nowait = true}
keyset("x", "<leader>a", "<Plug>(coc-codeaction-selected)", opts)
keyset("n", "<leader>a", "<Plug>(coc-codeaction-selected)", opts)

-- Remap keys for applying codeAction to the current buffer.
keyset("n", "<leader>ac", "<Plug>(coc-codeaction)", opts)


-- Apply AutoFix to problem on the current line.
keyset("n", "<leader>qf", "<Plug>(coc-fix-current)", opts)


-- Run the Code Lens action on the current line.
keyset("n", "<leader>cl", "<Plug>(coc-codelens-action)", opts)


-- Map function and class text objects
-- NOTE: Requires 'textDocument.documentSymbol' support from the language server.
keyset("x", "if", "<Plug>(coc-funcobj-i)", opts)
keyset("o", "if", "<Plug>(coc-funcobj-i)", opts)
keyset("x", "af", "<Plug>(coc-funcobj-a)", opts)
keyset("o", "af", "<Plug>(coc-funcobj-a)", opts)
keyset("x", "ic", "<Plug>(coc-classobj-i)", opts)
keyset("o", "ic", "<Plug>(coc-classobj-i)", opts)
keyset("x", "ac", "<Plug>(coc-classobj-a)", opts)
keyset("o", "ac", "<Plug>(coc-classobj-a)", opts)


-- Remap <C-f> and <C-b> for scroll float windows/popups.
---@diagnostic disable-next-line: redefined-local
local opts = {silent = true, nowait = true, expr = true}
keyset("n", "<C-f>", 'coc#float#has_scroll() ? coc#float#scroll(1) : "<C-f>"', opts)
keyset("n", "<C-b>", 'coc#float#has_scroll() ? coc#float#scroll(0) : "<C-b>"', opts)
keyset("i", "<C-f>",
       'coc#float#has_scroll() ? "<c-r>=coc#float#scroll(1)<cr>" : "<Right>"', opts)
keyset("i", "<C-b>",
       'coc#float#has_scroll() ? "<c-r>=coc#float#scroll(0)<cr>" : "<Left>"', opts)
keyset("v", "<C-f>", 'coc#float#has_scroll() ? coc#float#scroll(1) : "<C-f>"', opts)
keyset("v", "<C-b>", 'coc#float#has_scroll() ? coc#float#scroll(0) : "<C-b>"', opts)


-- Use CTRL-S for selections ranges.
-- Requires 'textDocument/selectionRange' support of language server.
keyset("n", "<C-s>", "<Plug>(coc-range-select)", {silent = true})
keyset("x", "<C-s>", "<Plug>(coc-range-select)", {silent = true})


-- Add `:Format` command to format current buffer.
vim.api.nvim_create_user_command("Format", "call CocAction('format')", {})

-- " Add `:Fold` command to fold current buffer.
vim.api.nvim_create_user_command("Fold", "call CocAction('fold', <f-args>)", {nargs = '?'})

-- Add `:OR` command for organize imports of the current buffer.
vim.api.nvim_create_user_command("OR", "call CocActionAsync('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.
vim.opt.statusline:prepend("%{coc#status()}%{get(b:,'coc_current_function','')}")

-- Mappings for CoCList
-- code actions and coc stuff
---@diagnostic disable-next-line: redefined-local
local opts = {silent = true, nowait = true}
-- Show all diagnostics.
keyset("n", "<space>a", ":<C-u>CocList diagnostics<cr>", opts)
-- Manage extensions.
keyset("n", "<space>e", ":<C-u>CocList extensions<cr>", opts)
-- Show commands.
keyset("n", "<space>c", ":<C-u>CocList commands<cr>", opts)
-- Find symbol of current document.
keyset("n", "<space>o", ":<C-u>CocList outline<cr>", opts)
-- Search workspace symbols.
keyset("n", "<space>s", ":<C-u>CocList -I symbols<cr>", opts)
-- Do default action for next item.
keyset("n", "<space>j", ":<C-u>CocNext<cr>", opts)
-- Do default action for previous item.
keyset("n", "<space>k", ":<C-u>CocPrev<cr>", opts)
-- Resume latest coc list.
keyset("n", "<space>p", ":<C-u>CocListResume<cr>", opts)

Articles

• coc.nvim 插件体系介绍
• CocList 入坑指南
• Create coc.nvim extension to improve Vim experience
• How to write a coc.nvim extension (and why)

Troubleshooting

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

• If you think Coc is useful, consider giving it a star.
• If you have a question, ask on gitter
• 中文用户请到 中文 gitter 讨论
• If something is not working, create an issue.

Backers

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

Contributors

Qiming zhao 💻	Heyward Fann 💻	Raidou 💻	kevinhwang91 💻	年糕小豆汤 💻	Avi Dessauer 💻	最上川 💻
Yatao Li 💻	wongxy 💻	Sam McCall 💻	Samuel Roeca 💻	Amirali Esmaeili 💻	Jack Rowlingson 💻	Jaehwang Jung 💻
Antoine 💻	Cosmin Popescu 💻	Duc Nghiem Xuan 💻	Francisco Lopes 💻	daquexian 💻	dependabot[bot] 💻	greenkeeper[bot] 💻
Chris Kipp 💻	Dmytro Meleshko 💻	Kirill Bobyrev 💻	Gontran Baerts 💻	Andy 💻	Cheng JIANG 💻	Corin 💻
Daniel Zhang 💻	Ferdinand Bachmann 💻	Guangqing Chen 💻	Jade Meskill 💻	Jasper Poppe 💻	Jean Jordaan 💻	Kid 💻
Pieter van Loon 💻	Robert Liebowitz 💻	Seth Messer 💻	UncleBill 💻	ZERO 💻	fsouza 💻	XiaoZhang 💻
whyreal 💻	yehuohan 💻	バクダンくん 💻	Raphael 💻	tbodt 💻	Aaron McDaid 💻	Aasif Versi 💻
Abner Silva 💻	Adam Stankiewicz 💻	Adamansky Anton 💻	Ahmed El Gabri 💻	Alexandr Kondratev 💻	Andrew Shim 💻	Andy Lindeman 💻
Augustin 💻	Bastien Orivel 💻	Ben Lu 💻	Ben 💻	Brendan Roy 💻	brianembry 💻	br 💻
Cason Adams 💻	Chang Y 💻	Chayoung You 💻	Chen Lijun 💻	Chen Mulong 💻	Chris Weyl 💻	dezza 💻
Cody Allen 💻	Damien Rajon 💻	Daniel Eriksson 💻	Daniel Jenson 💻	David Mejorado 💻	Deric Pang 💻	Ding Tao 💻
Doron Behar 💻	Egor Kovetskiy 💻	ElKowar 💻	Emeliov Dmitrii 💻	Fabian Becker 💻	FallenWarrior2k 💻	Fausto Núñez Alberro 💻
Felipe Ramos 💻	Fredrik Borg 💻	Gavin Sim 💻	Gibson Fahnestock 💻	Giovanni Giordano 💻	Gopal Adhikari 💻	Hanh Le 💻
hedy 💻	Hendrik Lammers 💻	Henry Barreto 💻	Hugo 💻	Jackie Li 💻	Jakub Nowak 💻	James Pickard 💻
Jia Sui 💻	Ellie Hermaszewska 💻	Joel Bradshaw 💻	John Carlo Roberto 💻	Jonas Holst Damtoft 💻	Jonathan Lehman 💻	Joosep Alviste 💻
Josa Gesell 💻	Joshua Rubin 💻	Julian Grinblat 💻	Julian Valentin 💻	KabbAmine 💻	Kay Gosho 💻	Kenny Huynh 💻
Kevin Rambaud 💻	Kian Cross 💻	Kristijan Husak 💻	NullVoxPopuli 💻	Lasse Peters 💻	Noel Errenil 💻	LinArcX 💻
Liu-Cheng Xu 💻	Marc 💻	Marius Gawrisch 💻	Mark Hintz 💻	Mathieu Le Tiec 💻	Matt White 💻	Matthew Evans 💻
Me1onRind 💻	Qyriad 💻	Narcis B. 💻	Neur1n 💻	Nicolas Dermine 💻	Noah 💻	PENG Rui 💻
Paco 💻	Peng Guanwen 💻	Petter Wahlman 💻	Pooya Moradi 💻	Quade Morrison 💻	Ralf Vogler 💻	Ran Chen 💻
Ricardo García Vega 💻	Rick Jones 💻	Ryan Christian 💻	Salo 💻	Sam Nolan 💻	Saurav 💻	Sean Mackesey 💻
Sheel Patel 💻	Solomon Ng 💻	Sri Kadimisetty 💻	Stephen Prater 💻	Sune Kibsgaard 💻	Aquaakuma 💻	Takumi Kawase 💻
The Blob SCP 💻	Tomasz N 💻	Tomoyuki Harada 💻	Tony Fettes 💻	Tony Narlock 💻	Tony Wang 💻	Victor Quach 💻
Whisperity 💻	William Turner 💻	Xiaochao Dong 💻	Hugh Hou 💻	Jackie Li 💻	Zachary Freed 💻	akiyosi 💻
alexjg 💻	aste4 💻	clyfish 💻	dev7ba 💻	diartyz 💻	doza-daniel 💻	equal-l2 💻
fong 💻	hexh 💻	hhiraba 💻	ic-768 💻	javiertury 💻	karasu 💻	kevineato 💻
Eduardo Costa 💻	micchy326 💻	midchildan 💻	minefuto 💻	miyanokomiya 💻	miyaviee 💻	monkoose 💻 🐛
mujx 💻	mvilim 💻	naruaway 💻	piersy 💻	ryantig 💻	rydesun 💻	sc00ter 💻
smhc 💻	Sam Kaplan 💻	tasuten 💻	todesking 💻	typicode 💻	李鸣飞 💻	Ikko Ashimine 📖
Rammiah 🐛	Alisue 🐛	bigshans 📖	Robert Boyd III 🐛	Yuki Iwanaga 💻	SpringHack 🐛	Lucas Burns 📖
qiqiboy 💻	timsu92 📖	Shawn M Moore 💻	Aaron U'Ren 🐛	SeniorMars 📖	牧羊犬真Q 📖

This project follows the all-contributors specification. Contributions of any kind are welcome!

License

Anti 996