A completion engine plugin for neovim written in Lua. Completion sources are installed from external repositories and "sourced".
Can be used. Feedback wanted!
- No flicker
- Works properly
- Fully customizable via Lua functions
- Fully supported LSP's Completion capabilities
- Snippets
- CommitCharacters
- TriggerCharacters
- TextEdit and InsertReplaceTextEdit
- AdditionalTextEdits
- Markdown documentation
- Execute commands (Some LSP server needs it to auto-importing. e.g.
sumneko_lua
orpurescript-language-server
) - Preselect
- CompletionItemTags
- Support pairs-wise plugin automatically
This example configuration is using vim-plug
.
call plug#begin(s:plug_dir)
Plug 'neovim/nvim-lspconfig'
Plug 'hrsh7th/cmp-nvim-lsp'
Plug 'hrsh7th/cmp-buffer'
Plug 'hrsh7th/nvim-cmp'
" For vsnip user.
Plug 'hrsh7th/cmp-vsnip'
Plug 'hrsh7th/vim-vsnip'
" For luasnip user.
" Plug 'L3MON4D3/LuaSnip'
" Plug 'saadparwaiz1/cmp_luasnip'
" For ultisnips user.
" Plug 'SirVer/ultisnips'
" Plug 'quangnguyen30192/cmp-nvim-ultisnips'
call plug#end()
set completeopt=menu,menuone,noselect
lua <<EOF
-- Setup nvim-cmp.
local cmp = require'cmp'
cmp.setup({
snippet = {
expand = function(args)
-- For `vsnip` user.
vim.fn["vsnip#anonymous"](args.body) -- For `vsnip` user.
-- For `luasnip` user.
-- require('luasnip').lsp_expand(args.body)
-- For `ultisnips` user.
-- vim.fn["UltiSnips#Anon"](args.body)
end,
},
mapping = {
['<C-d>'] = cmp.mapping.scroll_docs(-4),
['<C-f>'] = cmp.mapping.scroll_docs(4),
['<C-Space>'] = cmp.mapping.complete(),
['<C-e>'] = cmp.mapping.close(),
['<CR>'] = cmp.mapping.confirm({ select = true }),
},
sources = {
{ name = 'nvim_lsp' },
-- For vsnip user.
{ name = 'vsnip' },
-- For luasnip user.
-- { name = 'luasnip' },
-- For ultisnips user.
-- { name = 'ultisnips' },
{ name = 'buffer' },
}
})
-- Setup lspconfig.
require('lspconfig')[%YOUR_LSP_SERVER%].setup {
capabilities = require('cmp_nvim_lsp').update_capabilities(vim.lsp.protocol.make_client_capabilities())
}
EOF
You can see the all of nvim-cmp
sources here.
You can specify the following configuration options via cmp.setup { ... }
.
The configuration options will be merged with the default config.
If you want to remove an option, you can set it to false
instead.
Built in helper cmd.mappings
are:
- cmp.mapping.select_prev_item()
- cmp.mapping.select_next_item()
- cmp.mapping.scroll_docs(number)
- cmp.mapping.complete()
- cmp.mapping.close()
- cmp.mapping.abort()
- cmp.mapping.confirm({ select = bool, behavior = cmp.ConfirmBehavior.{Insert,Replace} })
You can configure nvim-cmp
to use these cmd.mappings
like this:
mapping = {
['<C-d>'] = cmp.mapping.scroll_docs(-4),
['<C-f>'] = cmp.mapping.scroll_docs(4),
['<C-Space>'] = cmp.mapping.complete(),
['<C-e>'] = cmp.mapping.close(),
['<CR>'] = cmp.mapping.confirm({
behavior = cmp.ConfirmBehavior.Replace,
select = true,
})
}
In addition, the mapping mode can be specified. The default is insert mode (i).
mapping = {
...
['<Tab>'] = cmp.mapping(cmp.mapping.select_next_item(), { 'i', 's' })
...
}
You can specify your own custom mapping function.
mapping = {
['<Tab>'] = function(fallback)
if ...some_condition... then
vim.api.nvim_feedkeys(vim.api.nvim_replace_termcodes('...', true, true, true), 'n', true)
else
fallback() -- The fallback function is treated as original mapped key. In this case, it might be `<Tab>`.
end
end,
}
The function or boolean value to specify all cmp's features enabled or not.
Default:
function()
return vim.api.nvim_buf_get_option(0, 'buftype') ~= 'prompt'
end
Globals source lists are listed in the source
table. These are applied to all
buffers. The order of the sources list helps define the source priority, see
the sorting.priority_weight options below.
It is possible to setup different source lists for different filetypes, this is
an example using the FileType
autocommand to setup different sources for the
lua filetype.
" Setup buffer configuration (nvim-lua source only enables in Lua filetype).
autocmd FileType lua lua require'cmp'.setup.buffer {
\ sources = {
\ { name = 'nvim_lua' },
\ { name = 'buffer' },
\ },
\ }
Note that the source name isn't necessarily the source repository name.
Source names are defined in the source repository README files. For
example look at the hrsh7th/cmp-buffer
source README which defines the source name as buffer
.
The source name.
The source customization options. It is defined by each source.
The manually specified source priority.
If you don't specifies it, The source priority will determine by the default algorithm (see sorting.priority_weight
).
The source specific keyword_pattern for override.
The source specific keyword_length for override.
The source specific maximum item count.
Specify preselect mode. The following modes are available.
cmp.PreselectMode.Item
- If the item has
preselect = true
,nvim-cmp
will preselect it.
- If the item has
cmp.PreselectMode.None
- Disable preselect feature.
Default: cmp.PreselectMode.Item
Which events should trigger autocompletion
.
If you set this to false
, nvim-cmp
will not perform completion
automatically. You can still use manual completion though (like omni-completion
via the cmp.mapping.complete
function).
Default: { types.cmp.TriggerEvent.TextChanged }
The default keyword pattern. This value will be used if a source does not set a source specific pattern.
Default: [[\%(-\?\d\+\%(\.\d\+\)\?\|\h\w*\%(-\w*\)*\)]]
The minimum length of a word to complete on; e.g., do not try to complete when the
length of the word to the left of the cursor is less than keyword_length
.
Default: 1
The function to resolve trigger_characters.
Default: function(trigger_characters) return trigger_characters end
vim's completeopt
setting. Warning: Be careful when changing this value.
Default: menu,menuone,noselect
A default cmp.ConfirmBehavior
value when to use confirmed by commitCharacters
Default: cmp.ConfirmBehavior.Insert
The function to resolve commit_characters.
When sorting completion items before displaying them, boost each item's score
based on the originating source. Each source gets a base priority of #sources - (source_index - 1)
, and we then multiply this by priority_weight
:
score = score + ((#sources - (source_index - 1)) * sorting.priority_weight)
Default: 2
When sorting completion items, the sort logic tries each function in
sorting.comparators
consecutively when comparing two items. The first function
to return something other than nil
takes precedence.
Each function must return boolean|nil
.
You can use the preset functions from cmp.config.compare.*
.
Default:
{
cmp.config.compare.offset,
cmp.config.compare.exact,
cmp.config.compare.score,
cmp.config.compare.kind,
cmp.config.compare.sort_text,
cmp.config.compare.length,
cmp.config.compare.order,
}
A documentation configuration or false to disable feature.
Border characters used for documentation window.
A neovim's winhighlight
option for documentation window.
The documentation window's max width.
The documentation window's max height.
Specify deprecated candidate should be marked as deprecated or not.
This option is useful but disabled by default because sometimes, this option can break your terminal appearance.
Default: false
A function to customize completion menu.
The return value is defined by vim. See :help complete-items
.
You can display the fancy icons to completion-menu with lspkind-nvim.
Please see FAQ if you would like to show symbol-text (e.g. function) and source (e.g. LSP) like compe.
local lspkind = require('lspkind')
cmp.setup {
formatting = {
format = function(entry, vim_item)
vim_item.kind = lspkind.presets.default[vim_item.kind]
return vim_item
end
}
}
A callback function called when the item is confirmed.
Specify whether to display ghost text.
Default: false
Show the source statuses
Invoke after nvim-cmp setup.
You can use the following APIs.
Confirm current selected item if possible.
Invoke manual completion.
Close current completion menu.
Close current completion menu and restore current line (similar to native <C-e>
behavior).
Select next completion item if possible.
Select prev completion item if possible.
Scroll documentation window if possible.
You should check :CmpStatus
command's output. Probably, your specified source name is wrong.
Some pairs-wise plugin set up the mapping automatically.
For example, vim-endwise
will map <CR>
even if you don't do any mapping instructions for the plugin.
But I think the user want to override <CR>
mapping only when the mapping item is selected.
The nvim-cmp
does it automatically.
The following configuration will be working as
- If the completion-item is selected, will be working as
cmp.mapping.confirm
. - If the completion-item isn't selected, will be working as vim-endwise feature.
mapping = {
['<CR>'] = cmp.mapping.confirm()
}
You can use the following configuration.
cmp.setup {
completion = {
completeopt = 'menu,menuone,noinsert',
}
}
You can use nvim-cmp
without auto-completion like this.
cmp.setup {
completion = {
autocomplete = false
}
}
You can specify enabled = false
like this.
autocmd FileType TelescopePrompt lua require('cmp').setup.buffer { enabled = false }
I've optimized nvim-cmp
as much as possible, but there are currently some known / unfixable issues.
cmp-buffer
source and too large buffer
The cmp-buffer
source makes an index of the current buffer so if the current buffer is too large, it will slowdown the main UI thread.
Slow language server
For example, typescript-language-server
will returns 15k items to the client.
In such a case, it will take 100ms just to parse payloads as JSON.
vim.lsp.set_log_level
This setting will cause the filesystem operation for each LSP payload. This will greatly slow down nvim-cmp (and other LSP related features).
formatting = {
format = function(entry, vim_item)
-- fancy icons and a name of kind
vim_item.kind = require("lspkind").presets.default[vim_item.kind] .. " " .. vim_item.kind
-- set a name for each source
vim_item.menu = ({
buffer = "[Buffer]",
nvim_lsp = "[LSP]",
luasnip = "[LuaSnip]",
nvim_lua = "[Lua]",
latex_symbols = "[Latex]",
})[entry.source.name]
return vim_item
end,
},
You can found the solution in Example mappings.
Warning: If the LSP spec is changed, nvim-cmp will keep up to it without an announcement.
If you publish nvim-cmp
source to GitHub, please add nvim-cmp
topic for the repo.
You should read cmp types and LSP spec to create sources.
- The
complete
function is required but others can be omitted. - The
callback
argument must always be called. - The custom source only can use
require('cmp')
. - The custom source can specify
word
property to CompletionItem. (It isn't an LSP specification but supported as a special case.)
local source = {}
---Source constructor.
source.new = function()
local self = setmetatable({}, { __index = source })
self.your_awesome_variable = 1
return self
end
---Return the source is available or not.
---@return boolean
function source:is_available()
return true
end
---Return the source name for some information.
function source:get_debug_name()
return 'example'
end
---Return keyword pattern which will be used...
--- 1. Trigger keyword completion
--- 2. Detect menu start offset
--- 3. Reset completion state
---@param params cmp.SourceBaseApiParams
---@return string
function source:get_keyword_pattern(params)
return '???'
end
---Return trigger characters.
---@param params cmp.SourceBaseApiParams
---@return string[]
function source:get_trigger_characters(params)
return { ??? }
end
---Invoke completion (required).
--- If you want to abort completion, just call the callback without arguments.
---@param params cmp.SourceCompletionApiParams
---@param callback fun(response: lsp.CompletionResponse|nil)
function source:complete(params, callback)
callback({
{ label = 'January' },
{ label = 'February' },
{ label = 'March' },
{ label = 'April' },
{ label = 'May' },
{ label = 'June' },
{ label = 'July' },
{ label = 'August' },
{ label = 'September' },
{ label = 'October' },
{ label = 'November' },
{ label = 'December' },
})
end
---Resolve completion item that will be called when the item selected or before the item confirmation.
---@param completion_item lsp.CompletionItem
---@param callback fun(completion_item: lsp.CompletionItem|nil)
function source:resolve(completion_item, callback)
callback(completion_item)
end
---Execute command that will be called when after the item confirmation.
---@param completion_item lsp.CompletionItem
---@param callback fun(completion_item: lsp.CompletionItem|nil)
function source:execute(completion_item, callback)
callback(completion_item)
end
require('cmp').register_source(source.new())
You can also create source by Vim script like this (This is useful to support callback style plugins).
- If you want to return
boolean
, you must returnv:true
/v:false
. It doesn't0
/1
.
let s:source = {}
function! s:source.new() abort
return extend(deepcopy(s:source))
endfunction
" The other APIs are also available.
function! s:source.complete(params, callback) abort
call a:callback({
\ { 'label': 'January' },
\ { 'label': 'February' },
\ { 'label': 'March' },
\ { 'label': 'April' },
\ { 'label': 'May' },
\ { 'label': 'June' },
\ { 'label': 'July' },
\ { 'label': 'August' },
\ { 'label': 'September' },
\ { 'label': 'October' },
\ { 'label': 'November' },
\ { 'label': 'December' },
\ })
endfunction
call cmp#register_source('month', s:source.new())