Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ms-jpq/coq_nvim
Fast as FUCK nvim completion. SQLite, concurrent scheduler, hundreds of hours of optimization.
https://github.com/ms-jpq/coq_nvim
completion neovim neovim-plugin
Last synced: 4 days ago
JSON representation
Fast as FUCK nvim completion. SQLite, concurrent scheduler, hundreds of hours of optimization.
- Host: GitHub
- URL: https://github.com/ms-jpq/coq_nvim
- Owner: ms-jpq
- License: gpl-3.0
- Created: 2020-07-16T03:58:40.000Z (over 4 years ago)
- Default Branch: coq
- Last Pushed: 2024-12-06T14:48:44.000Z (about 2 months ago)
- Last Synced: 2025-01-14T17:45:15.268Z (11 days ago)
- Topics: completion, neovim, neovim-plugin
- Language: Python
- Homepage:
- Size: 5.12 MB
- Stars: 3,603
- Watchers: 16
- Forks: 97
- Open Issues: 175
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-neovim - ms-jpq/coq_nvim - Fast as FUCK Neovim completion. SQLite, concurrent scheduler, hundreds of hours of optimization. (Completion / (requires Neovim 0.5))
- my-awesome-github-stars - ms-jpq/coq_nvim - Fast as FUCK nvim completion. SQLite, concurrent scheduler, hundreds of hours of optimization. (Python)
- jimsghstars - ms-jpq/coq_nvim - Fast as FUCK nvim completion. SQLite, concurrent scheduler, hundreds of hours of optimization. (Python)
README
# [coq.nvim 🐔](https://ms-jpq.github.io/coq_nvim)
Named after the [famous theorem prover](https://coq.inria.fr/)
`coq` also means `鸡` in [`français québécois`](https://youtu.be/ZoAhZPRBMgE), and I guess `🥖`.
Fast as FUCK and loads of features.
## Faster Than Pure Lua
- Native C in-memory B-trees
- SQLite VM interrupts
- Coroutine based incremental & interruptible scheduler
- TCP-esque flow control
More details at the [PERFORMANCE.md](https://github.com/ms-jpq/coq_nvim/tree/coq/docs/PERF.md)
## Features
**Note: Due to compression, reality is _faster_ than gifs**
### Fast as fuck
- Results on **every keystroke**
- Throttling? Never heard of her
- Real time [performance statistics](https://github.com/ms-jpq/coq_nvim/tree/coq/docs/STATS.md)
- Look at the gifs! The bottom few are the **fastest when I didn't slow down on purpose** to show features.
### Fuzzy Search
- **Typo resistant**
- Recency bonus
- Proximity bonus
- Weighted average of [relative ranks & ensemble metrics](https://github.com/ms-jpq/coq_nvim/tree/coq/docs/FUZZY.md)
Error correction: `cour` -> `colour_space`, `flgr` -> `flag_group`, `nasp` -> `Namespace`
### Preview
- [Press key](https://github.com/ms-jpq/coq_nvim/tree/coq/docs/KEYBIND.md) to view documentation in big buffer
- Auto open preview on **side with most space**
- [Customizable location](https://github.com/ms-jpq/coq_nvim/tree/coq/docs/DISPLAY.md): n, s, w, e
- Ubiquitous: Tags, LSP, TreeSitter, Paths, Snippets
### LSP
- **Incremental completion**
- **Client-side caching**
- **Multi-server** completion (i.e. `tailwind` + `cssls`)
- **Multi-encoding** `utf-8`, `utf-16`, `utf-32`
- Header imports
- Snippet Support
Install the [Nvim Official LSP integration](https://github.com/neovim/nvim-lspconfig)
**Requires 2 lines of change to support LSP snippets**
```lua
local lsp = require "lspconfig"
local coq = require "coq" -- add this
lsp..setup() -- before
lsp..setup(coq.lsp_ensure_capabilities()) -- after
```
### Snippets
- [**Over 9000** built-in snippets](https://raw.githubusercontent.com/ms-jpq/coq.artifacts/artifacts/coq%2Bsnippets%2Bv2.json)
- 99% of LSP grammar, 95% of Vim grammar
- [Press key](https://github.com/ms-jpq/coq_nvim/tree/coq/docs/KEYBIND.md) to jump to next edit region.
- Linked regions
- Custom snippets with [**Live Repl**](https://github.com/ms-jpq/coq_nvim/tree/coq/docs/SNIPS.md)
_The `%` statistic comes from compiling the 10,000 snippets_
### TreeSitter
- **Shows context**
- **Partial document parsing**
- Auto-disable if document is too big
- Unicode ready
**Treesitter is still unstable in nvim0.5: slow and crash prone**
The promise is that Treesitter will have real time parsing on every keystroke, but it's actually too slow on big files.
The Treesitter source only parses a limited number of lines about the cursor and only on `Idle` events due to unrealized performance promises.
### CTags
- **LSP like**
- Incremental & automatic **background compilation**
- Non-blocking
**Requires `Universal CTags`, NOT `ctags`**
```sh
# MacOS
brew uninstall ctags # bad
brew install universal-ctags # good
# Ubuntu
apt remove ctags # bad
apt install universal-ctags # good
```
### Paths
- **Preview contents**
- `$VARIABLE` expansion, `%EVEN_UNDER_WINDOWS%`
- Relative to both `cwd` and file path
### Buffers
- **Real time** completion
- **Fast** in files with thousands of lines
### Registers
- **words** Last yank `0` + custom `a-z` `coq_settings.clients.registers.words`
- **lines** `coq_settings.clients.registers.lines` (`a-z`)
### Tmux
### Tabnine
- CPU preserving flow control
- Auto download & install & update
- Platform specific `cgroupv2` & `taskpolicy` core pinning / CPU management.
_T9 is disabled by default, I might remove it, if they do not improve the CPU usage. [Their own bug tracker](https://github.com/codota/TabNine/issues/43)._
Enable via: `coq_settings.clients.tabnine.enabled=true`
### [Modular lua sources](https://github.com/ms-jpq/coq.thirdparty) & external third party integrations
- **Even faster than pure lua**! (transparent `sqlite` caching)
- [**Tons of built-ins**](https://github.com/ms-jpq/coq.thirdparty)
- External third party plugins too
- [Easy to hack](https://github.com/ms-jpq/coq_nvim/tree/coq/docs/CUSTOM_SOURCES.md)
Shown above: shell repl.
Some other built-ins:
- nvim lua API
- [vim runtime](https://github.com/neovim/neovim/tree/master/runtime/autoload): `ada, c, clojure, css, haskell, html, js, php, syntax`
- [scientific calculator](https://linux.die.net/man/1/bc)
- [comment banners](https://linux.die.net/man/6/figlet)
- [moo!](https://linux.die.net/man/1/cowsay)
- [vimtex](https://github.com/lervag/vimtex)
- [orgmode.nvim](https://github.com/kristijanhusak/orgmode.nvim)
- [vim dadbod](https://github.com/kristijanhusak/vim-dadbod-completion)
- [nvim-dap](https://github.com/mfussenegger/nvim-dap)
### Statistics
`:COQstats`
### Validating config parser
- Prevents typos & type errors in your config
Here I make a type error on purpose inputting `string` instead of an `integer`.
### Pretty
- [Customizable](https://github.com/ms-jpq/coq_nvim/tree/coq/docs/DISPLAY.md)
**If you can't see icons properly**:
Either set `let g:coq_settings = { 'display.icons.mode': 'none' }` to disable icons, or [install a supported font](https://www.nerdfonts.com/#home)
## Install
**Windows** requires symlinks support in git.
```bash
git config --global core.symlinks true
```
Needs python virtual env
```bash
apt install --yes -- python3-venv
```
**Minimum version**: python:`3.8.2`, nvim: `0.5`, sqlite: `recentish`
Vim
Install the usual way, ie. VimPlug, Vundle, etc
```VimL
" main one
Plug 'ms-jpq/coq_nvim', {'branch': 'coq'}
" 9000+ Snippets
Plug 'ms-jpq/coq.artifacts', {'branch': 'artifacts'}
" lua & third party sources -- See https://github.com/ms-jpq/coq.thirdparty
" Need to **configure separately**
Plug 'ms-jpq/coq.thirdparty', {'branch': '3p'}
" - shell repl
" - nvim lua api
" - scientific calculator
" - comment banner
" - etc
```
Neovim
### lazy.nvim
```lua
{
"neovim/nvim-lspconfig", -- REQUIRED: for native Neovim LSP integration
lazy = false, -- REQUIRED: tell lazy.nvim to start this plugin at startup
dependencies = {
-- main one
{ "ms-jpq/coq_nvim", branch = "coq" },
-- 9000+ Snippets
{ "ms-jpq/coq.artifacts", branch = "artifacts" },
-- lua & third party sources -- See https://github.com/ms-jpq/coq.thirdparty
-- Need to **configure separately**
{ 'ms-jpq/coq.thirdparty', branch = "3p" }
-- - shell repl
-- - nvim lua api
-- - scientific calculator
-- - comment banner
-- - etc
},
init = function()
vim.g.coq_settings = {
auto_start = true, -- if you want to start COQ at startup
-- Your COQ settings here
}
end,
config = function()
-- Your LSP settings here
end,
}
```
## Documentation
To start `coq`
```viml
" the [-s, --shut-up] flag will remove the greeting message
:COQnow [--shut-up]
```
🌟 If required, it will ask you to run `:COQdeps`, please run it and do `:COQnow` again.
There is built-in [help command](https://github.com/ms-jpq/coq_nvim/tree/coq/docs/README.md)
```viml
:COQhelp [--web] [topic]
```
- [:COQhelp config](https://github.com/ms-jpq/coq_nvim/tree/coq/docs/CONF.md)
- [:COQhelp keybind](https://github.com/ms-jpq/coq_nvim/tree/coq/docs/KEYBIND.md)
- [:COQhelp snips](https://github.com/ms-jpq/coq_nvim/tree/coq/docs/SNIPS.md)
- [:COQhelp fuzzy](https://github.com/ms-jpq/coq_nvim/tree/coq/docs/FUZZY.md)
- [:COQhelp comp](https://github.com/ms-jpq/coq_nvim/tree/coq/docs/COMPLETION.md)
- [:COQhelp display](https://github.com/ms-jpq/coq_nvim/tree/coq/docs/DISPLAY.md)
- [:COQhelp sources](https://github.com/ms-jpq/coq_nvim/tree/coq/docs/SOURCES.md)
- [:COQhelp misc](https://github.com/ms-jpq/coq_nvim/tree/coq/docs/MISC.md)
- [:COQhelp perf](https://github.com/ms-jpq/coq_nvim/tree/coq/docs/PERF.md)
- [:COQhelp stats](https://github.com/ms-jpq/coq_nvim/tree/coq/docs/STATS.md)
- [:COQhelp custom_sources](https://github.com/ms-jpq/coq_nvim/tree/coq/docs/CUSTOM_SOURCES.md)
## FAQ
#### Default hotkeys?
Always:
| key | function |
| ----------- | ------------------------ |
| `` | manual completion |
| `` | edit snippet placeholder |
When completion menu is open:
| key | function |
| ------------- | ----------------------------- |
| `` | move preview to bigger window |
| `` | exit to normal |
| `` | backspace |
| `` | select completion |
| `` | next result |
| `` | prev result |
Unbound:
| keymap | function |
| -------------------------------- | --------------------------------------------- |
| `coq_settings.keymap.repeat` | repeat last edit |
| `coq_settings.keymap.eval_snips` | evulate snippet in document / under selection |
**When hovering over a result, entering any key [a-z] will select it**
This is a vim thing, I have zero control over :(
#### `.` Repeat
Set `coq_settings.keymap.repeat` to a hotkey.
See `:COQhelp keybind` for details
#### Flickering
By default, the old results are cleared on each keystroke, so the popup menu is closed right away.
You can disable this: at the cost of having stale results shown until the new ones come in.
`let g:coq_settings = { 'display.pum.fast_close': v:false }`
This is not the default because some LSP servers are very slow (ie. tailwindcss), leading to stale results being shown for too long.
#### Autostart COQ
`let g:coq_settings = { 'auto_start': v:true }` or `let g:coq_settings = { 'auto_start': 'shut-up' }`
This must be set **BEFORE** `require("coq")`
#### LSP too slow to show up on keystroke.
You have some options, each has its trade off:
1. Increase the `coq_settings.limits.completion_auto_timeout`.
This will slow down feedback on _every keystroke_, as `coq` waits for LSP.
2. Use the manual completion hotkey (default ``)
Annoying! And the manual completion also has a timeout `coq_settings.limits.completion_manual_timeout`.
Some LSP servers will still fail to respond within the default `.66` seconds, in that case pressing `` multiple times might actually help some LSP servers catch up, depending on their implementation.
#### LSP sometimes not importing
Increase `coq_settings.clients.lsp.resolve_timeout`
This will however, make applying edits slower.
#### Missing Results
On keystroke only a max of `coq_settings.match.max_results` are shown.
Use manual completion hotkey to show all results.
#### Some LSP servers give inconsistent completions
This happens when certain LSP servers give you 1000s of unfiltered results in _alphabetical order_ and you still have to respond in a few dozen milliseconds.
To eliminate `a-z` bias, `coq` does a random sort on the resultset and process and cache as many of them as possible within the performance window.
So if some results are not in the SQLite cache, and have yet to be processed, they will be missing. They might however still show up on later keystrokes.
Use the manual hotkey if you need to see everything.
#### My vim crashed!
**Disable TreeSitter**
Treesitter still needs stability work.
#### I want to use a different python version
`vim.g.python3_host_prog=`
## If you like this...
Also check out
- [`sad`](https://github.com/ms-jpq/sad), it's a modern `sed` that does previews with syntax highlighting, and lets you pick and choose which chunks to edit.
- [`CHADTree`](https://github.com/ms-jpq/chadtree), it's a FULLY featured file manager.
- [isomorphic-copy](https://github.com/ms-jpq/isomorphic-copy), it's a cross platform clipboard that is daemonless, and does not require third party support.
## Special Thanks & Acknowledgements
The snippets are compiled from the following open source projects:
- [Shougo/neosnippet-snippets](https://github.com/Shougo/neosnippet-snippets)
- [fatih/vim-go](https://github.com/fatih/vim-go)
- [honza/vim-snippets](https://github.com/honza/vim-snippets)
- [Ikuyadeu/vscode-R](https://github.com/Ikuyadeu/vscode-R)
- [Rocketseat/rocketseat-vscode-react-native-snippets](https://github.com/Rocketseat/rocketseat-vscode-react-native-snippets)
- [dsznajder/vscode-es7-javascript-react-snippets](https://github.com/dsznajder/vscode-es7-javascript-react-snippets)
- [johnpapa/vscode-angular-snippets](https://github.com/johnpapa/vscode-angular-snippets)
- [sdras/vue-vscode-snippets](https://github.com/sdras/vue-vscode-snippets)
- [snipsnapdev/snipsnap](https://github.com/snipsnapdev/snipsnap)
- [xabikos/vscode-javascript](https://github.com/xabikos/vscode-javascript)
- [xabikos/vscode-react](https://github.com/xabikos/vscode-react)
- [rafamadriz/friendly-snippets](https://github.com/rafamadriz/friendly-snippets)
Super special thanks goes to [Typescript LSP](https://github.com/typescript-language-server/typescript-language-server).
Nothing like good motivation to improve my design than dumping 1000 results on my client every other keystroke.