129 lines
3.1 KiB
Markdown
129 lines
3.1 KiB
Markdown
# nvim-cmp
|
|
|
|
A completion plugin for neovim written in Lua.
|
|
|
|
|
|
Status
|
|
====================
|
|
|
|
not yet stable but ok to use (for testing).
|
|
|
|
|
|
Configuration
|
|
====================
|
|
|
|
First, you should install sources to use by your favorite plugin manager.
|
|
|
|
```viml
|
|
Plug 'hrsh7th/nvim-cmp'
|
|
Plug 'hrsh7th/cmp-buffer'
|
|
```
|
|
|
|
※ The above example is installing `cmp-buffer` source.
|
|
※ The `nvim-cmp` sources can be found in [here](https://github.com/topics/nvim-cmp).
|
|
|
|
```viml
|
|
-- Setup global configuration
|
|
lua require'cmp'.setup {
|
|
\ -- You should change this example to your chosen snippet engine.
|
|
\ snippet = {
|
|
\ expand = function(args)
|
|
\ vim.fn['vsnip#anonymous'](args.body)
|
|
\ end
|
|
\ },
|
|
\
|
|
\ -- You should specify your *installed* sources.
|
|
\ sources = {
|
|
\ {
|
|
\ name = 'buffer',
|
|
\ opts = {
|
|
\ get_bufnrs = function()
|
|
\ return vim.api.nvim_list_bufs()
|
|
\ end
|
|
\ }
|
|
\ }
|
|
\ },
|
|
\ }
|
|
|
|
-- Setup buffer configuration
|
|
autocmd FileType markdown lua require'cmp'.setup.buffer {
|
|
\ sources = {
|
|
\ { name = '...' }
|
|
\ },
|
|
\ }
|
|
```
|
|
|
|
Source creation
|
|
====================
|
|
|
|
If you publish `nvim-cmp` source to GitHub, please add `nvim-cmp` topic for the repo.
|
|
|
|
You should read [cmp types](/lua/cmp/types) and [LSP spec](https://microsoft.github.io/language-server-protocol/specifications/specification-current/) to create sources.
|
|
|
|
- The `complete` function is required but others can be omitted.
|
|
- The `callback` argument must always be called.
|
|
|
|
```lua
|
|
local source = {}
|
|
|
|
---Source constructor.
|
|
source.new = function()
|
|
local self = setmetatable({}, { __index = source })
|
|
self.your_awesome_variable = 1
|
|
return self
|
|
end
|
|
|
|
---Return keyword pattern which will be used...
|
|
--- 1. Trigger keyword completion
|
|
--- 2. Detect menu start offset
|
|
--- 3. Reset completion state
|
|
---@return string
|
|
function source:get_keyword_pattern()
|
|
return '???'
|
|
end
|
|
|
|
---Return trigger characters.
|
|
---@return string[]
|
|
function source:get_trigger_characters()
|
|
return { ??? }
|
|
end
|
|
|
|
---Invoke completion (required).
|
|
--- If you want to abort completion, just call the callback without arguments.
|
|
---@param request cmp.CompletionRequest
|
|
---@param callback fun(response: lsp.CompletionResponse|nil)
|
|
function source:complete(request, 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
|
|
```
|
|
|