blink-ripgrep.nvim
A Neovim completion source for blink.cmp that provides project-wide word completions using ripgrep or git grep.
What is blink-ripgrep.nvim?
blink-ripgrep.nvim is a Neovim plugin that integrates ripgrep and git grep as completion sources for the blink.cmp framework. It scans your entire project to suggest matching words as you type, helping to prevent typos and reduce repetitive typing. It supports both automatic triggering and manual search invocation.
Neovim users who use the blink.cmp completion plugin and want project-wide word completions to improve coding efficiency and accuracy.
It provides fast, configurable project-wide completions by leveraging efficient search tools like ripgrep and git grep, with options to balance performance and coverage based on project size and git usage.
Overview
Ripgrep/gitgrep source for the blink.cmp Neovim completion plugin
Use Cases
Best For
- Adding project-wide word completions to Neovim
- Reducing typos in large codebases
- Finding and reusing existing variable or function names
- Speeding up coding in git-tracked projects with git grep
- Configuring completion performance for different project sizes
- Enhancing blink.cmp with additional completion sources
Not Ideal For
- Projects not using git where the faster git grep backend cannot be leveraged
- Neovim users who prefer or are locked into other completion frameworks like nvim-cmp
- Small-scale editing tasks where project-wide search adds unnecessary complexity
- Environments where ripgrep is not installed or cannot be used
Pros & Cons
Pros
Supports both ripgrep for any directory and git grep for faster searches in git-tracked projects, offering flexibility as described in the backend options.
Searches across the entire project for matching words, reducing typos and repetitive typing, which is the core value proposition.
Includes tunable parameters like prefix_min_len and max_filesize to optimize search speed based on project characteristics, detailed in the configuration.
Allows both automatic triggering as you type and manual invocation via keymaps, catering to different workflow preferences.
Cons
Exclusively designed for blink.cmp, making it incompatible with other popular Neovim completion plugins, which limits its user base.
Requires ripgrep or git grep to be installed and configured externally, adding setup steps and potential dependency issues.
Even with optimizations, searching large projects can introduce latency, as acknowledged in the performance section with mitigation strategies.
Integration involves modifying blink.cmp's configuration with nested options, which might be challenging for users new to Neovim plugin setup.
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.