A completion engine plugin for neovim written in Lua. Completion sources are installed from external repositories and "sourced".
Can be used. Feedback wanted!
- Provides a completion engine to handle completion sources
- Support pairs-wise plugin automatically
- 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
First, You should install nvim-cmp
itself and completion sources and snippet engine by your favourite plugin manager.
The nvim-cmp
sources can be found in here.
Using vim-plug:
" Install nvim-cmp
Plug 'hrsh7th/nvim-cmp'
" Install snippet engine (This example installs [hrsh7th/vim-vsnip](https://github.com/hrsh7th/vim-vsnip))
Plug 'hrsh7th/vim-vsnip'
" Install the buffer completion source
Plug 'hrsh7th/cmp-buffer'
Using packer.nvim:
-- Install nvim-cmp, and buffer source as a dependency
use {
"hrsh7th/nvim-cmp",
requires = {
"hrsh7th/vim-vsnip",
"hrsh7th/cmp-buffer",
}
}
First, You should do the following steps.
- You must set
snippet engine
up. See README.md of your choosen snippet engine. - Remove
longest
fromcompleteopt
. See:help completeopt
.
To use nvim-cmp
with the default configuration:
lua <<EOF
local cmp = require'cmp'
cmp.setup({
snippet = {
expand = function(args)
vim.fn["vsnip#anonymous"](args.body)
end,
},
mapping = {
['<C-y>'] = cmp.mapping.confirm({ select = true }),
},
sources = {
{ name = '...' },
...
}
})
EOF
The default configuration can be found in here
lua <<EOF
local cmp = require'cmp'
cmp.setup {
...
completion = {
autocomplete = { ... },
},
...
snippet = {
...
},
...
preselect = ...,
...
documentation = {
...
},
...
sorting = {
priority_weight = 2.,
comparators = { ... },
},
mapping = {
...
},
sources = { ... },
...
}
EOF
The configuration options will be merged with the default config.
If you want to remove the option, You can set the 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.
local check_back_space = function()
local col = vim.fn.col('.') - 1
return col == 0 or vim.fn.getline('.'):sub(col, col):match('%s')
end
mapping = {
['<Tab>'] = function(fallback)
if vim.fn.pumvisible() == 1 then
vim.fn.feedkeys(vim.api.nvim_replace_termcodes('<C-n>', true, true, true), 'n')
elseif check_back_space() then
vim.fn.feedkeys(vim.api.nvim_replace_termcodes('<Tab>', true, true, true), 'n')
elseif vim.fn['vsnip#available']() == 1 then
vim.fn.feedkeys(vim.api.nvim_replace_termcodes('<Plug>(vsnip-expand-or-jump)', true, true, true), '')
else
fallback()
end
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
.
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 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.
A default cmp.ConfirmBehavior
value when to use confirmed by commitCharacters
Default: cmp.ConfirmBehavior.Insert
Specify deprecated candidate should be marked as deprecated or not.
Default: true
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.
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
.
Default:
{
compare.offset,
compare.exact,
compare.score,
compare.kind,
compare.sort_text,
compare.length,
compare.order,
}
Specify preselect mode. The following modes are available.
- cmp.Preselect.Item
- If the item has
preselect = true
,nvim-cmp
will preselect it.
- If the item has
- cmp.Preselect.None
- Disable preselect feature.
Default: cmp.PreselectMode.Item
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.
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
}
}
I've optimized nvim-cmp
as much as possible, but there are currently some known / unfixable issues.
-
cmp-buffer
source and too large buffer Thecmp-buffer
source makes index of the current buffer so if the current buffer is too large, will be slowdown main UI thread. -
some language servers For example,
typescript-language-server
will returns 15k items to the client. In such case, the time near the 100ms will be consumed just to parse payloads as JSON. -
You set
vim.lsp.set_log_level
up by yourself. This setting will cause the filesystem operation for each LSP payloads. This will extremely slow down nvim-cmp (and other LSP related features).
This is supertab-like mapping for LuaSnip
local check_back_space = function()
local col = vim.fn.col '.' - 1
return col == 0 or vim.fn.getline('.'):sub(col, col):match '%s' ~= nil
end
local luasnip = require("luasnip")
local t = function(str)
return vim.api.nvim_replace_termcodes(str, true, true, true)
end
-- supertab-like mapping
mapping = {
["<Tab>"] = cmp.mapping(function(fallback)
if vim.fn.pumvisible() == 1 then
vim.fn.feedkeys(t("<C-n>"), "n")
elseif luasnip.expand_or_jumpable() then
vim.fn.feedkeys(t("<Plug>luasnip-expand-or-jump"), "")
elseif check_back_space() then
vim.fn.feedkeys(t("<Tab>"), "n")
else
fallback()
end
end, {
"i",
"s",
}),
["<S-Tab>"] = cmp.mapping(function(fallback)
if vim.fn.pumvisible() == 1 then
vim.fn.feedkeys(t("<C-p>"), "n")
elseif luasnip.jumpable(-1) then
vim.fn.feedkeys(t("<Plug>luasnip-jump-prev"), "")
else
fallback()
end
end, {
"i",
"s",
}),
}
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,
},
Warning: If the LSP spec is changed, nvim-comp will keep up to it without 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 name for some information.
function source:get_debug_name = function()
return 'example'
end
---Return the source is available or not.
---@return boolean
function source:is_available()
return true
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
return source