- \n
- Nvim lsp: configure language servers, shortcuts for listing your symbols, rename, code actions, get definition\/declaration, workspace, highlights<\/a><\/li>\n\n\n\n
- Nvim lsp: diagnostics \u2013 keybindings, error\/warning signs, floating and virtual texts<\/a><\/li>\n\n\n\n
- Nvim lsp: autocompletion (this article)<\/li>\n<\/ol>\n\n\n\n
I recommend you to follow all three articles in the above order.<\/p>\n\n\n\n
Table of Contents<\/h2>\n\n\n\n
- \n
- Install useful plug-ins<\/a><\/li>\n\n\n\n
- Snippets setup using Ultisnips<\/a><\/li>\n\n\n\n
- Create icons in nvim-lsp autocompletion<\/a><\/li>\n\n\n\n
- Configure mapping, fuzzy matching, sources, and formatting in the autocompletion menu<\/a>\n
- \n
- Snippet configuration in nvim-lsp autocompletion<\/a><\/li>\n\n\n\n
- Formatting in nvim-lsp autocompletion<\/a><\/li>\n\n\n\n
- Mapping in nvim-lsp autocompletion<\/a><\/li>\n\n\n\n
- Keyword length in nvim-lsp autocompletion<\/a><\/li>\n\n\n\n
- Fuzzy matching in nvim-lsp autocompletion<\/a><\/li>\n\n\n\n
- Configure sources to be used in the autocompletion menu<\/a><\/li>\n<\/ul>\n<\/li>\n\n\n\n
- Configure nvim-lsp autocompletion for command line (console)<\/a><\/li>\n\n\n\n
- Configure nvim-lsp autocompletion for search (\/)<\/a><\/li>\n\n\n\n
- Conclusion<\/a><\/li>\n<\/ul>\n\n\n\n
Install useful plug-ins<\/h2>\n\n\n\n
Please install the following plug-ins if you have not installed them. I will be showing the power of neovim-lsp autocompletion using these plug-ins.<\/p>\n\n\n\n
- \n
- collection of configurations for builtin neovim-lsp:
neovim\/nvim-lspconfig<\/code><\/li>\n\n\n\nSirVer\/ultisnips<\/code> for snippets.<\/span> There are other snippet plug-ins. But this is one of the most famous plug-ins. So, I will be using it.<\/li>\n\n\n\nhonza\/vim-snippets<\/code> – it has the pre-built snippets for bash, python, etc. it integrates with ultisnips.<\/li>\n\n\n\n- Autocompletion engine:
hrsh7th\/nvim-cmp<\/code><\/li>\n\n\n\n- Autocompletion sources for the above engine (these sources’ output will be shown in the floating autocompletion-menu):\n
- \n
hrsh7th\/cmp-nvim-lsp<\/code> providesnvim_lsp<\/code> source for language servers’ completion service. It is a very important plug-in. <\/li>\n\n\n\nhrsh7th\/cmp-cmdline<\/code> providescmdline<\/code> source for vim’s commands (figure 4)<\/li>\n\n\n\nhrsh7th\/cmp-path<\/code> providespath<\/code> source for the completion of filepaths<\/li>\n\n\n\nhrsh7th\/cmp-buffer<\/code> providesbuffer<\/code> source for completion from the opened buffer<\/li>\n\n\n\nhrsh7th\/cmp-calc<\/code> providescalc<\/code> source for completion from vim’s built-in mathematical expression calculation facility (for example, suppose I have typed2+3=<\/code> in a text file. Now,5<\/code> will be suggested in the autocompletion menu.<\/li>\n\n\n\nf3fora\/cmp-spell<\/code> provides aspell<\/code> source based on vim’sspellsuggest<\/code>. It is good for typing difficult words such asflibbertigibbet<\/code> in English.<\/li>\n\n\n\ntamago324\/cmp-zsh<\/code> provideszsh<\/code> source. It gives completion like your zsh. A similar plugin isValodim\/vim-zsh-completion<\/code>.<\/li>\n\n\n\nquangnguyen30192\/cmp-nvim-ultisnips<\/code> providesultisnips<\/code> source to put the list of available snippets into the autocompletion menu (figure 1)<\/li>\n\n\n\nhrsh7th\/cmp-nvim-lsp-signature-help<\/code> providesnvim_lsp_signature_help<\/code> source. Signature help shows information about the parameters of your function\/method in a floating window. For more, see the Signature Help section in nvim-lsp<\/a>.<\/li>\n\n\n\n- For more sources, look at the List of Sources<\/a>.<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n\n\n\n
Snippets setup using Ultisnips<\/h2>\n\n\n\n
Please note that there are other snippet plug-ins that have been covered in this article at appropriate places. However, I have not tested them as extensively as Ultisnips.<\/p>\n\n\n\n
When it comes to snippets’ expansion, most of the snippet plug-ins such as Ultisnips set up a shortcut. For example, in bash language, when you type
for<\/code> and press the shortcut for thefor<\/code> snippet expansion, an “empty”for<\/code> loop will be created. But here, we will use an auto-completion engine for this purpose. The engine will suggest to you if there are any snippets. Now, you don’t have to use any shortcuts. As soon as you type thefor<\/code> keyword, a snippet, if any, will be shown. Just select that and the snippet will be expanded.<\/p>\n\n\n\n![\"nvim-lsp](\"https:\/\/i0.wp.com\/smarttech101.com\/wp-content\/uploads\/2022\/06\/nvim-lsp-snippet-autocompletion.png?resize=731%2C458&ssl=1\")
fig 1: nvim-lsp autocompletion: for<\/code> snippet<\/figcaption><\/figure>\n\n\n\nFor the above configuration, create a file
~\/.config\/nvim\/plug-config\/auto-cmp.lua<\/code>. Until this file is “sourced”, you will not see any result. I will show you how to source this file at the very end of this article.<\/p>\n\n\n\nNow, put the following lines in the file
~\/.config\/nvim\/plug-config\/auto-cmp.lua<\/code>:<\/p>\n\n\n\nvim.cmd [[\nlet g:UltiSnipsJumpForwardTrigger='<Tab>'\nlet g:UltiSnipsJumpBackwardTrigger='<S-Tab>'\n]]<\/code><\/pre>\n\n\n\nNow, to move from one “tabstop” to another, use the tab key (“tabstops” are special stops within which you can move using the tab key). And when there is no tabstops type a tab i.e. ‘\\t’.<\/p>\n\n\n\n
Similarly, to go to the previous tabstop, use Shift+Tab.<\/p>\n\n\n\n
In the above code, you can change the shortcut keys other than “Tab” and “Shift+Tab” (called
<S-Tab><\/code> in neovim).<\/p>\n\n\n\nFor more about snippets, please keep reading.<\/p>\n\n\n\n
Create icons in nvim-lsp autocompletion<\/h2>\n\n\n\n
To see the icons in the autocompletion menu as shown in figure 1, put the following code in the file
~\/.config\/nvim\/plug-config\/auto-cmp.lua<\/code>:<\/p>\n\n\n\nlocal kind_icons = {\n Class = \"\ufd2f\",\n Color = \"\uf8d7\",\n Constant = \"\uf8fe\",\n Constructor = \"\uf423\",\n Enum = \"\uf15d\",\n EnumMember = \"\uf15d\",\n Event = \"\uf0e7\",\n Field = \"\uf6fc\",\n File = \"\uf718\",\n Folder = \"\uf74a\",\n Function = \"\uf794\",\n Interface = \"\uf0e8\",\n Keyword = \"\uf80a\",\n Method = \"\uf6a6\",\n Module = \"\uf487\",\n Operator = \"\uf694\",\n Property = \"\ufc20\",\n Reference = \"\uf481\",\n Snippet = \"\uf44f\",\n Struct = \"\uf1b3\",\n Text = \"\ue612\",\n TypeParameter = \"\uf671\",\n Unit = \"\ue21f\",\n Value = \"\uf89f\",\n Variable = \"\uf5a0\",\n}<\/code><\/pre>\n\n\n\n\ud83d\udcd3 Note<\/strong>: You might not see the above icons in your browser. To see them, just enable a nerd font<\/a> in your terminal and then copy and paste these lines into a text file.<\/p>\n\n\n\n
Now, kindly follow the heading Formatting in nvim-lsp autocompletion<\/a>.<\/p>\n\n\n\n
Configure mapping, fuzzy matching, sources, and formatting in the autocompletion menu<\/h2>\n\n\n\n
Put the following codes in the file
~\/.config\/nvim\/plug-config\/auto-cmp.lua<\/code>:<\/p>\n\n\n\nlocal cmp = require 'cmp'\ncmp.setup({\n snippet = {\n SNIPPET_CONFIGURATION_GOES_HERE\n },\n formatting = {\n FORMATTING_GOES_HERE\n },\n mapping = {\n MAPPING_GOES_HERE\n },\n completion = {\n COMPLETION_RELATED_CONFIGURATION_GOES_HERE\n },\n matching = {\n FUZZY_MATCHING_GOES_HERE\n },\n sources = cmp.config.sources(SOURCES_RELATED_CONFIGURATION)\n})<\/code><\/pre>\n\n\n\nWhere all the capitalized words will be replaced by your main configuration. And it is covered in the next headings (subheadings).<\/p>\n\n\n\n
Snippet configuration in nvim-lsp autocompletion<\/h3>\n\n\n\n
Replace the “SNIPPET_CONFIGURATION_GOES_HERE” with the following:<\/p>\n\n\n\n
expand = function(args)\n -- For `vsnip`, uncomment the following.\n -- vim.fn[\"vsnip#anonymous\"](args.body)\n -- For `luasnip`, uncomment the following.\n -- require('luasnip').lsp_expand(args.body)\n -- For snippy, uncomment the following.\n -- require('snippy').expand_snippet(args.body)\n -- For `ultisnips`\n vim.fn[\"UltiSnips#Anon\"](args.body)\n end,<\/code><\/pre>\n\n\n\nIf you want to use a snippet engine other than Ultisnips, uncomment (delete the
--<\/code> in front of that) that from the above code instead.<\/p>\n\n\n\nFormatting in nvim-lsp autocompletion<\/h3>\n\n\n\n
Formatting decides how autocompletion menu is shown – what is the order of icons, icon kinds, etc.<\/p>\n\n\n\n
![\"Formatting](\"https:\/\/i0.wp.com\/smarttech101.com\/wp-content\/uploads\/2022\/06\/nvim-lsp-autocompletion-formatting.png?resize=731%2C458&ssl=1\")
Fig 2: Formatting in nvim-lsp autocompletion menu: see how icons, icons’ kinds, and icons’ names are written<\/figcaption><\/figure>\n\n\n\n To configure the formatting, replace the FORMATTING_GOES_HERE with the following code:<\/p>\n\n\n\n
format = function(entry, vim_item)\n -- Kind icons\n vim_item.kind = string.format(\"%s %s\", kind_icons[vim_item.kind], vim_item.kind) --Concatonate the icons with name of the item-kind\n vim_item.menu = ({\n nvim_lsp = \"[LSP]\",\n spell = \"[Spellings]\",\n zsh = \"[Zsh]\",\n buffer = \"[Buffer]\",\n ultisnips = \"[Snip]\",\n treesitter = \"[Treesitter]\",\n calc = \"[Calculator]\",\n nvim_lua = \"[Lua]\",\n path = \"[Path]\",\n nvim_lsp_signature_help = \"[Signature]\",\n cmdline = \"[Vim Command]\"\n })[entry.source.name]\n return vim_item\n end,<\/code><\/pre>\n\n\n\n\ud83d\udcd3 Note 1<\/strong>: If you don’t mention any source in the
vim_item.menu()<\/code>, the right part of the completion menu will have unsightly empty space.<\/p>\n\n\n\n![\"Unsightly](\"https:\/\/i0.wp.com\/smarttech101.com\/wp-content\/uploads\/2022\/06\/nvim-lsp-autocompletion-empty-space.png?resize=731%2C458&ssl=1\")
Fig 3: Unsightly empty space in the autocompletion menu if I delete the line nvim_lsp = \"[LSP]\"<\/code><\/figcaption><\/figure>\n\n\n\n\ud83d\udcd3 Note 2<\/strong>: Change the
vim_item.kind<\/code> line to have the desired format of the autocompletion menu. Theformat()<\/code> function shown above is almost like theformat()<\/code> function in any other language. So it should not be very difficult.<\/p>\n\n\n\nMapping in nvim-lsp autocompletion<\/h3>\n\n\n\n
Replace the MAPPING_GOES_HERE with the following:<\/p>\n\n\n\n
['<C-n>'] = cmp.mapping(cmp.mapping.select_next_item(), { 'i', 'c' }),\n ['<C-p>'] = cmp.mapping(cmp.mapping.select_prev_item(), { 'i', 'c' }),\n ['<C-M-k>'] = cmp.mapping(cmp.mapping.scroll_docs(-4), { 'i', 'c' }),\n ['<C-M-j>'] = cmp.mapping(cmp.mapping.scroll_docs(4), { 'i', 'c' }),\n ['<C-Space>'] = cmp.mapping(cmp.mapping.complete(), { 'i', 'c' }),\n ['<C-y>'] = cmp.config.disable,\n ['<C-e>'] = cmp.mapping({\n i = cmp.mapping.abort(),\n c = cmp.mapping.close(),\n }),\n ['<CR>'] = cmp.mapping.confirm({ select = false }),<\/code><\/pre>\n\n\n\n\ud83e\udde0 Explanation 1<\/strong>:
i<\/code>, andc<\/code> shown above are for “insert” and “command” modes. Having them means the key bindings work in the autocompletion menu shown in both the insert as well as in command mode.<\/p>\n\n\n\n![\"nvim-lsp](\"https:\/\/i0.wp.com\/smarttech101.com\/wp-content\/uploads\/2022\/06\/nvim-lsp-autocompletion-commmand.png?resize=731%2C458&ssl=1\")
Fig 4: nvim-lsp autocompletion in command mode<\/figcaption><\/figure>\n\n\n\n \ud83e\udde0 Explanation 2<\/strong>: I am using “Control + n” (
<C-n><\/code>) and “Control + p” (<C-p><\/code>) to move to the Next and Previous items shown in the auto-completion menu. This is similar to many other applications like Dmenu<\/a>, Ranger’s command line, Interactive Bash and Zsh Shells, Emacs, Fzf, and many more. Most of the shortcuts have been set up in this fashion. This is what I love above Linux (or Unix in general) based operating systems. You can configure all of your apps, their color schemes, shortcut keys, etc. in a similar fashion and thus reducing confusion.<\/p>\n\n\n\n\ud83e\udde0 Explanation 3<\/strong>: You need to use
<C-M-k><\/code> (Control+Alt+k) and<C-M-j><\/code> (Control+Alt+j) to scroll up and down in the scroll documents. Alternatively, you can also use your mouse scroll wheel. But that will require a vim command:set mouse=a<\/code><\/p>\n\n\n\n![\"Scroll](\"https:\/\/i0.wp.com\/smarttech101.com\/wp-content\/uploads\/2022\/06\/scroll-document-nvim-lsp-autocompletion.png?resize=731%2C458&ssl=1\")
Fig 5: Scroll Document in nvim-lsp autocompletion<\/figcaption><\/figure>\n\n\n\n Increase the numbers shown in
scroll_docs()<\/code> (in the above code it is4)<\/code>), to increase the scroll sensitivity.<\/p>\n\n\n\n\ud83e\udde0 Explanation 4<\/strong>:
<C-e><\/code> to escape i.e. close\/abort the completion menu. In insert mode, this shortcut, usingcmp.mapping.abort()<\/code> will close the completion menu and restore the initial state. But in the console mode, it, usingcmp.mapping.abort()<\/code> only closes the completion menu.<\/p>\n\n\n\n\ud83d\udcd3 Note<\/strong>: Many other keys are already set up as default by the nvim-lsp. For example,
<C-m><\/code> (Control+m) chooses your item from the completion menu.<\/p>\n\n\n\nKeyword length in nvim-lsp autocompletion<\/h3>\n\n\n\n
keyword_length<\/code> sets the number of keywords you need to type before the autocompletion menu pops up. By default, it is 1. If you want to change it to a higher value, for example to 3, replace the COMPLETION_RELATED_CONFIGURATION_GOES_HERE with the following line:<\/p>\n\n\n\nkeyword_length = 1,<\/code><\/pre>\n\n\n\nFuzzy matching in nvim-lsp autocompletion<\/h3>\n\n\n\n
I do a lot of incorrect spellings. Therefore I have enabled the fuzzy matching. So, for example, if I just type
fr<\/code> instead offor<\/code>, and there is a snippet for the loop, it will be shown in the autocompletion menu.<\/p>\n\n\n\n![\"fuzzy](\"https:\/\/i0.wp.com\/smarttech101.com\/wp-content\/uploads\/2022\/06\/fuzzy-matching-nvim-lsp-autocompletion.png?resize=731%2C458&ssl=1\")
fig 6: fuzzy matching in nvim-lsp autocompletion<\/figcaption><\/figure>\n\n\n\n To enable the fuzzy matching, replace the FUZZY_MATCHING_GOES_HERE with the following:<\/p>\n\n\n\n
disallow_fuzzy_matching = false,<\/code><\/pre>\n\n\n\nBut if you like to disable this nice feature due to some reason, use
true<\/code> instead offalse<\/code>.<\/p>\n\n\n\nConfigure sources to be used in the autocompletion menu<\/h3>\n\n\n\n
SOURCES_RELATED_CONFIGURATION decides items (sources), their orders, terms, and conditions, etc. in the autocompletion menu.<\/p>\n\n\n\n
To set this, replace the SOURCES_RELATED_CONFIGURATION with the following code:<\/p>\n\n\n\n
{\n { name = 'nvim_lsp' },\n -- For ultisnips users\n { name = 'ultisnips' },\n -- For vsnip users, uncomment the following.\n -- { name = 'vsnip' },\n -- For luasnip users, uncomment the following.\n -- { name = 'luasnip' },\n -- For snippy users, uncomment the following.\n -- { name = 'snippy' },\n }, {\n { name = 'buffer' },\n }, {\n { name = 'nvim_lsp_signature_help' },\n }, {\n { name = 'path' },\n }<\/code><\/pre>\n\n\n\n\ud83d\udcd3 Note 1<\/strong>: The above settings make sure that
buffer<\/code> source is visible in the completion menu only when thenvim_lsp<\/code> andultisnips<\/code> sources are not available. Similarly,nvim_lsp_signature_help<\/code> will be visible only when thenvim_lsp<\/code>,ultisnips<\/code>, andbuffer<\/code> are not available. The same goes for sourcepath<\/code>.<\/p>\n\n\n\n\ud83d\udcd3 Note 2<\/strong>: Having
nvim_lsp<\/code> andultisnips<\/code> in a single bracket will allow them to be mixed in the listing otherwise, all the autocompletion menu’s place is taken over bynvim_lsp<\/code>.<\/p>\n\n\n\n\ud83d\udcd3 Note 3<\/strong>: I have tried to optimize the above order as much as possible so that you get maximum recommendations in the right order in the autocompletion menu. You can rearrange the above sources or install new source plug-ins and use them here according to your own preference. But at the same time, you can also set these orders depending upon your filetypes. That is shown in the upcoming headings.<\/p>\n\n\n\n
Configure nvim-lsp autocompletion for command line (console)<\/h2>\n\n\n\n
You can use the nvim-lsp autocompletion in the neovim’s command line as well. To see it in action, see figure 4.<\/p>\n\n\n\n
To use sources
cmdline<\/code> andpath<\/code> source, append the following code in your file~\/.config\/nvim\/plug-config\/auto-cmp.lua<\/code>:<\/p>\n\n\n\ncmp.setup.cmdline(':', {\n sources = cmp.config.sources({\n { name = 'path' },\n { name = 'cmdline' },\n })\n})<\/code><\/pre>\n\n\n\nHere
cmdline<\/code> source will suggest you vim\/neovim commands andpath<\/code> source will complete file-path (ex – \/usr\/share, etc. in Linux).<\/p>\n\n\n\n\ud83d\udcd3 Note<\/strong>: if you have enabled
native_menu<\/code>, the above code will not work.<\/p>\n\n\n\nConfigure nvim-lsp autocompletion for search (\/)<\/h2>\n\n\n\n
Similarly, you can also use the autocompletion menu in the neovim’s search (\/) as shown in the following figure.<\/p>\n\n\n\n
![\"nvim-lsp](\"https:\/\/i0.wp.com\/smarttech101.com\/wp-content\/uploads\/2022\/06\/nvim-lsp-autocompletion-for-search.png?resize=731%2C458&ssl=1\")
fig 7: nvim-lsp autocompletion for search (\/)<\/figcaption><\/figure>\n\n\n\n To use
buffer<\/code> source for\/<\/code>, append the following code in the file~\/.config\/nvim\/plug-config\/auto-cmp.lua<\/code>:<\/p>\n\n\n\ncmp.setup.cmdline('\/', {\n sources = {\n { name = 'buffer' },\n }\n})<\/code><\/pre>\n\n\n\nConclusion<\/h2>\n\n\n\n
That\u2019s all folks for nvim-LSP configuration. And don\u2019t forget to source the file
~\/.config\/nvim\/plug-config\/auto-cmp.lua<\/code> in your fileinit.vim<\/code>:<\/p>\n\n\n\nsource $HOME\/.config\/nvim\/plug-config\/auto-cmp.lua<\/code><\/pre>\n\n\n\nIn order to completely set up your Nvim-lsp, please go through all articles in the nvim-lsp series<\/a>.<\/p>\n\n\n\n
- Formatting in nvim-lsp autocompletion<\/a><\/li>\n\n\n\n
- Snippets setup using Ultisnips<\/a><\/li>\n\n\n\n
- Nvim lsp: diagnostics \u2013 keybindings, error\/warning signs, floating and virtual texts<\/a><\/li>\n\n\n\n