Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hanspinckaers/zap.nvim
:zap: fast, typo-resistant, fuzzy, simplistic LSP auto-completion plugin for Neovim.
https://github.com/hanspinckaers/zap.nvim
lua nvim nvim-plugin
Last synced: 2 months ago
JSON representation
:zap: fast, typo-resistant, fuzzy, simplistic LSP auto-completion plugin for Neovim.
- Host: GitHub
- URL: https://github.com/hanspinckaers/zap.nvim
- Owner: hanspinckaers
- License: mit
- Created: 2024-10-15T08:32:49.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2024-10-17T07:50:41.000Z (3 months ago)
- Last Synced: 2024-10-22T10:08:04.401Z (3 months ago)
- Topics: lua, nvim, nvim-plugin
- Language: Lua
- Homepage:
- Size: 33.2 KB
- Stars: 30
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## zap.nvim
:zap: fast, typo-resistant, fuzzy LSP auto-completion plugin for Neovim.
https://github.com/user-attachments/assets/63e070ba-b1e2-4051-8356-53a565eac14d
> [!WARNING]
> This is me open sourcing my hacky completion plugin. I don't know how it will work for others. However, it has been my daily drivers for a few months.
**My goals were:**
- instantaneous (requesting early, caching completions, filtering cached completions)
- support for multiple LSPs
- no flicker
- limited amount of features to improve hackability (for me)
- if you want to add snippet support or documentation viewing, that's fine! Please send a PR 😊
**Smaller niceties:**
- fuzzy: `tlf` would rank `this_long_function` highly.
- typo's: when you make a mistake the completion menu never disappears
- pum_width is *minimum* and *maximum* width.
**Requires Neovim nightly** (I think? not tested on release versions)
> [!NOTE]
> zap.nvim is heavily inspired by [`epo.nvim`](https://github.com/nvimdev/epo.nvim), but has evolved into a fast and typo-resistant completion plugin. It supports multiple LSPs per buffer. However, it currently does not support snippets or provide additional info.
## Usage
```lua
-- Suggested completeopt
vim.opt.completeopt = "menu,menuone,noselect"
-- Default settings
require('zap').setup({
-- Debounce time to avoid triggering complete too frequently
debounce_time = 2,
-- Width of the completion popup menu
pum_width = 33,
-- Format LSP kind indicators, e.g., "Field", "Struct", "Keyword"
kind_format = function(k)
return k:lower():sub(1, 1)
end,
-- Custom formatting for completion entries
additional_format_completion = function(entry)
return entry -- Default does nothing, can be customized
end,
-- Adjust score of particular completion entries
additional_score_handler = function(score, entry)
return score -- Default does nothing, can be customized
end,
-- Customize sorting of completion entries
additional_sorting_handler = function(entries)
return entries -- Default does nothing, can be customized
end,
})
```
To pass the enhanced capabilities to your LSP client:
```lua
local capabilities = vim.tbl_deep_extend(
'force',
vim.lsp.protocol.make_client_capabilities(),
require('zap').register_cap()
)
```
If the completion menu appears dull, ensure your colorscheme includes these highlights:
```
Pmenu
PmenuExtra
PmenuSel
PmenuKind
PmenuKindSel
PmenuExtraSel
PmenuSbar
PmenuThumb
```
### TAB for completion cycling:
```lua
vim.keymap.set('i', '', function()
if vim.fn.pumvisible() == 1 then
return ''
elseif vim.snippet and vim.snippet.jumpable(1) then
return 'lua vim.snippet.jump(1)'
else
return ''
end
end, { expr = true })
vim.keymap.set('i', '', function()
if vim.fn.pumvisible() == 1 then
return ''
elseif vim.snippet and vim.snippet.jumpable(-1) then
return 'lua vim.snippet.jump(-1)'
else
return ''
end
end, { expr = true })
```
### Python-Specific Configuration
Here's an example setup for Python, using `pyright` and optionally integrating with `jedi`. This config formats auto-import completions and moves them under at least two normal completion items:
```lua
-- Python-specific configuration with zap.nvim setup functions
local zap = require('zap')
zap.setup({
-- Customize to replace menu label for auto-import entries
additional_format_completion = function(entry)
if entry.menu == "Auto-import" then
entry.menu = "+"
end
return entry
end,
-- Adjust score logic for particular entries
additional_score_handler = function(score, entry)
if entry.menu and entry.menu:sub(1, 1) == '+' then
return score - 3 -- Lower priority for auto-import entries
end
return score
end,
-- Sort normal entries before certain categorized ones
additional_sorting_handler = function(entries)
local function is_auto_import(entry)
return entry.menu and entry.menu:sub(1, 1) == '+'
end
local normal_entries, modified = {}, {}
for i, entry in ipairs(entries) do
if not is_auto_import(entry) then
table.insert(normal_entries, entry)
if #normal_entries == 2 then
table.insert(modified, normal_entries[1])
table.insert(modified, normal_entries[2])
for j = 1, #entries do
if is_auto_import(entries[j]) or (j > 2 and not vim.tbl_contains(normal_entries, entries[j])) then
table.insert(modified, entries[j])
end
end
for k = 1, #modified do
entries[k] = modified[k]
end
return entries
end
end
end
return entries
end,
})
```
## License
MIT