leigh/nvim-cmp
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Advertise

Browse Source
This commit is contained in:
hrsh7th
2021-10-10 15:11:54 +09:00
parent 20aa77b492
commit 5a2b5ded2f
1 changed files with 14 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
README.md
View File

@@ -6,13 +6,9 @@ Completion sources are installed from external repositories and "sourced".
Readme! Readme!
==================== ====================
nvim-cmp's breaking change are [here](https://github.com/hrsh7th/nvim-cmp/issues/231). 1. nvim-cmp's breaking changes are [here](https://github.com/hrsh7th/nvim-cmp/issues/231).
2. This is my hobby project. You can support me via GitHub sponsors.
3. The bug reports are welcome, but I might not fix if you don't provide a minimal reproduction configuration and steps.
Status
====================
Can be used. Feedback wanted!
Concept Concept
@@ -476,6 +472,9 @@ FAQ
You should check `:CmpStatus` command's output. Probably, your specified source name is wrong. You should check `:CmpStatus` command's output. Probably, your specified source name is wrong.
NOTE: `nvim_lsp` will be sourced on InsertEnter event. It will show as `unknown source` but it isn't problem.
#### What is the `pairs-wise plugin automatically supported`? #### What is the `pairs-wise plugin automatically supported`?
Some pairs-wise plugin set up the mapping automatically. Some pairs-wise plugin set up the mapping automatically.
@@ -496,6 +495,7 @@ mapping = {
} }
``` ```
#### How to set up like nvim-compe's `preselect = 'always'`? #### How to set up like nvim-compe's `preselect = 'always'`?
You can use the following configuration. You can use the following configuration.
@@ -508,6 +508,7 @@ cmp.setup {
} }
``` ```
#### I dislike auto-completion #### I dislike auto-completion
You can use `nvim-cmp` without auto-completion like this. You can use `nvim-cmp` without auto-completion like this.
@@ -520,6 +521,7 @@ cmp.setup {
} }
``` ```
#### How to disable nvim-cmp on the specific buffer? #### How to disable nvim-cmp on the specific buffer?
You can specify `enabled = false` like this. You can specify `enabled = false` like this.
@@ -528,6 +530,7 @@ You can specify `enabled = false` like this.
autocmd FileType TelescopePrompt lua require('cmp').setup.buffer { enabled = false } autocmd FileType TelescopePrompt lua require('cmp').setup.buffer { enabled = false }
``` ```
#### nvim-cmp is slow. #### nvim-cmp is slow.
I've optimized `nvim-cmp` as much as possible, but there are currently some known / unfixable issues. I've optimized `nvim-cmp` as much as possible, but there are currently some known / unfixable issues.
@@ -536,16 +539,12 @@ I've optimized `nvim-cmp` as much as possible, but there are currently some know
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. 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`** **`vim.lsp.set_log_level`**
This setting will cause the filesystem operation for each LSP payload. This setting will cause the filesystem operation for each LSP payload.
This will greatly slow down nvim-cmp (and other LSP related features). This will greatly slow down nvim-cmp (and other LSP related features).
#### How to show name of item kind and source (like compe)? #### How to show name of item kind and source (like compe)?
```lua ```lua
@@ -560,9 +559,10 @@ formatting = {
}, },
``` ```
#### How to setup supertab-like mapping?
You can found the solution in [Example mappings](https://github.com/hrsh7th/nvim-cmp/wiki/Example-mappings). #### How to setup mapping?
You can found any mapping solution in [Example mappings](https://github.com/hrsh7th/nvim-cmp/wiki/Example-mappings).
Source creation Source creation