completion-nvim

completion-nvim is a auto completion framework aims to provide a better completion experience with neovim's built-in LSP. Other LSP sources is not supported.

Features

• Asynchronous completion using libuv api.
• Automatically open hover windows when popupmenu is available.
• Automatically open signature help if it's available.
• Snippets integration with UltiSnips and Neosnippet.

Demo

Demo using sumneko_lua

Prerequisite

• Neovim nightly
• You should be setting up language server with the help of nvim-lsp

Install

• Install with any plugin manager by using the path on GitHub.

Plug 'haorenW1025/completion-nvim'

Setup

• completion-nvim require several autocommand set up to work properly, you should set it up using the on_attach function like this.

  lua require'nvim_lsp'.pyls.setup{on_attach=require'completion'.on_attach}

• Change pyls to whatever language server you are using.

Configuration

Recommended Setting

" Use <Tab> and <S-Tab> to navigate through popup menu
inoremap <expr> <Tab>   pumvisible() ? "\<C-n>" : "\<Tab>"
inoremap <expr> <S-Tab> pumvisible() ? "\<C-p>" : "\<S-Tab>"

" Auto close popup menu when finish completion
autocmd! CompleteDone * if pumvisible() == 0 | pclose | endif

" Set completeopt to have a better completion experience
set completeopt=menuone,noinsert,noselect

Enable/Disable auto popup

• By default auto popup is enable, turn it off by

let g:completion_enable_auto_popup = 0

• You can manually trigger completion with mapping key by

inoremap <silent><expr> <c-p> completion#trigger_completion() "map <c-p> to manually trigger completion

• Or you want to use <Tab> as completion keys

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

inoremap <silent><expr> <TAB>
  \ pumvisible() ? "\<C-n>" :
  \ <SID>check_back_space() ? "\<TAB>" :
  \ completion#trigger_completion()

Enable Snippets Support

• By default other snippets source support are closed, turn it on by

let g:completion_enable_snippet = 'UltiSnips'

• Support UltiSnips and Neosnippet

Changing Completion Confirm key

• By default <CR> is use for confirm completion and expand snippets, change it by

let g:completion_confirm_key = "\<C-y>"

• Make sure to use " " and add escape key \ to avoid parsing issue.

• If confirm key has a fallback mapping, for example, if you use auto pairs plugin that maps to <CR>, provide it like this:

"Fallback for https://github.com/Raimondi/delimitMate expanding on enter
let g:completion_confirm_key_rhs = "\<Plug>delimitMateCR"

Enable/Disable auto hover

• By default when navigate through complete items, LSP's hover is automatically called and display in floating window, disable it by

let g:completion_enable_auto_hover = 0

Enable/Disable auto signature

• By default signature help is open automatically whenever it's available, disable it by

let g:completion_enable_auto_signature = 0

Enable/Disable completion in comment

• By default completion will not activate when you're in a comment section, enable it by

let g:completion_enable_in_comment = 1

Trigger Characters

• You can add or disable trigger character that will trigger completion. By default trigger character = ['.'], you can disable it by

let g:completion_trigger_character = []

• Or multiple trigger character

let g:completion_trigger_character = ['.', '::']

• If you want different trigger character for different language, wrap it in an autocommand like

augroup CompleteionTriggerCharacter
    autocmd!
    autocmd BufEnter * let g:completion_trigger_character = ['.']
    autocmd BufEnter *.c,*.cpp let g:completion_trigger_character = ['.', '::']
augroup end

TODO

• Support other ins-complete
• Support other snippets engine
• Treesitter integration
• Support custom source

WARNING

This plugin is in early stage, might have unexpected issues.