blink.compat
A compatibility layer that allows nvim-cmp completion sources to be used with blink.cmp in Neovim.
What is blink.compat?
blink.compat is a compatibility layer for Neovim that allows developers to use nvim-cmp completion sources with the blink.cmp completion framework. It solves the problem of migrating between completion systems by providing a bridge that reuses existing nvim-cmp source configurations, reducing setup time and maintaining workflow consistency.
Neovim users who are transitioning from nvim-cmp to blink.cmp or want to experiment with blink.cmp while retaining their preferred nvim-cmp completion sources.
Developers choose blink.compat because it eliminates the need to reconfigure or abandon proven nvim-cmp sources, offering a smooth integration path with flexible provider setup and debug capabilities for reliable compatibility.
Overview
Compatibility layer for using nvim-cmp sources on blink.cmp
Use Cases
Best For
- Migrating from nvim-cmp to blink.cmp without losing existing completion sources
- Experimenting with blink.cmp while keeping nvim-cmp sources as a fallback
- Using niche nvim-cmp completion plugins that lack native blink.cmp equivalents
- Maintaining consistent completion behavior across different Neovim setups
- Debugging compatibility issues between nvim-cmp sources and blink.cmp
- Reducing configuration overhead when switching Neovim completion frameworks
Not Ideal For
- Teams using blink.cmp exclusively with its native sources and no legacy nvim-cmp plugins
- Projects where completion triggering relies heavily on nvim-cmp's keyword patterns, which blink.cmp lacks
- Developers seeking a plug-and-play completion setup without managing compatibility layers
Pros & Cons
Pros
Supports most nvim-cmp completion sources, enabling reuse of existing configurations without modification, as highlighted in the README's feature list.
Allows passing options directly to the proxied nvim-cmp source, providing fine-grained control over source behavior, as shown in the usage example.
Reduces friction when adopting blink.cmp by preserving investments in nvim-cmp plugins, aligning with the project's stated philosophy.
Includes a debug option for troubleshooting source integration issues, helping developers identify compatibility problems quickly.
Cons
Due to blink.cmp's lack of keyword patterns, some nvim-cmp sources may not trigger as expected, leading to unreliable completion behavior as noted in the README.
The README explicitly advises against using blink.compat for blink.cmp's native sources like LSP and snippets, making it unnecessary overhead in many cases.
Setting up providers requires matching names and options precisely, adding an error-prone layer of configuration compared to using native sources directly.
Frequently Asked Questions
Related Projects
nvim-cmpA completion plugin for neovim coded in Lua.
nvim-mini/mini.nvim#mini.completionLibrary of 45+ independent Lua modules improving Neovim experience with minimal effort
blink.cmpPerformant, batteries-included completion plugin for Neovim
copilot.luaFully featured & enhanced replacement for copilot.vim complete with API for interacting with Github Copilot
Found a gem we're missing?
Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.