https://github.com/antoinemadec/coc-fzf
fzf :heart: coc.nvim
https://github.com/antoinemadec/coc-fzf
coc coc-fzf fzf lsp neovim-plugin
Last synced: 7 months ago
JSON representation
fzf :heart: coc.nvim
- Host: GitHub
- URL: https://github.com/antoinemadec/coc-fzf
- Owner: antoinemadec
- Created: 2020-01-26T03:42:15.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-04-24T19:55:59.000Z (over 1 year ago)
- Last Synced: 2024-10-30T19:42:57.159Z (12 months ago)
- Topics: coc, coc-fzf, fzf, lsp, neovim-plugin
- Language: Vim Script
- Homepage:
- Size: 193 KB
- Stars: 389
- Watchers: 8
- Forks: 28
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# fzf :heart: coc.nvim
Use [FZF][fzf] instead of [coc.nvim][coc.nvim] built-in fuzzy finder.
## Rationale
This plugin uses [FZF][fzf] fuzzy finder in place of [Coc][coc.nvim]'s built-in [CocList sources][coc_sources] as well as Coc's jumps (definition, reference etc).\
It makes the interaction with Coc easier when you are used to FZF.
The main features are:
- FZF preview
- FZF bindings for splits and tabs
- FZF layout (floating windows etc)
- FZF multi-select to populate the quickfix window
It was inspired by [Robert Buhren's functions][RobertBuhren] and [coc-denite][coc_denite].
## Installation
Make sure to have the following plugins in your **vimrc**:
```vim
Plug 'junegunn/fzf', {'dir': '~/.fzf','do': './install --all'}
Plug 'junegunn/fzf.vim' " needed for previews
Plug 'neoclide/coc.nvim', {'do': 'yarn install --frozen-lockfile'}
Plug 'antoinemadec/coc-fzf'
```
Or, if you prefer using the **release** branch:
```vim
Plug 'junegunn/fzf', {'dir': '~/.fzf','do': './install --all'}
Plug 'junegunn/fzf.vim' " needed for previews
Plug 'neoclide/coc.nvim', {'branch': 'release'}
Plug 'antoinemadec/coc-fzf', {'branch': 'release'}
```
Also consider installing [bat][bat] for colorful previews.
## Commands
| Command | List |
| --- | --- |
| `:CocFzfList` | List all list sources |
| `:CocFzfList --original-only` | List only original sources |
| `:CocFzfList {source}` | Run a list source |
| `:CocFzfListResume` | Retrieve last list source |
### Original Sources
These are the list sources implemented with FZF:
| Source | List | Preview | Multi-select | Vim support |
| --- | --- | --- | --- | --- |
| `actions` | Like :CocList actions | - | - | ✅ |
| `commands` | Like :CocList commands | - | - | ✅ |
| `diagnostics` | Like :CocList diagnostics | ✅ | ✅ | ✅ |
| `diagnostics --current-buf` | Like :CocList diagnostics in the current buffer only | ✅ | ✅ | ✅ |
| `issues` | Like :CocList issues. Requires [coc-git][coc-git] | ✅ | - | ✅ |
| `location` | Like :CocList location. Requires [fzf.vim][fzfvim] | ✅ | ✅ | ✅ |
| `outline` | Like :CocList outline, with colors. Requires [ctags][ctags] | ✅ | ✅ | ✅ |
| `output` | Like :CocList output | - | ✅ | ✅ |
| `services` | Like :CocList services | - | - | ✅ |
| `snippets ` | Like :CocList snippets. Requires [coc-snippets][coc-snippets] | ✅ | ✅ | ✅ |
| `sources ` | Like :CocList sources | - | - | ✅ |
| `symbols ({query})` | Like :CocList symbols. Requires [pynvim] | ✅ | ✅ | ❌ |
| `symbols --kind {kind} ({query})` | Like :CocList symbols -kind {kind} Requires [pynvim] | ✅ | ✅ | ❌ |
| `yank` | Like :CocList yank. Requires [coc-yank][coc-yank] | ✅ | ✅ | ✅ |
FZF bindings (default):
- **ctrl-t**: open in tab
- **ctrl-v**: open in vertical split
- **ctrl-x**: open in horizontal split
- **tab**: multi-select, populate quickfix window
- **?**: toggle preview window
### Wrapper Sources
Not every list source is implementable with FZF.\
For those sources, `:CocFzfList` acts as a wrapper calling `:CocList`
Wrapper Sources appear with the **[wrapper]** mention when running `:CocFzfList`
### Add/Delete Sources
```vim
" add_list_source(name, description, command)
call coc_fzf#common#add_list_source('fzf-buffers', 'display open buffers', 'Buffers')
" delete_list_source(name)
call coc_fzf#common#delete_list_source('fzf-buffers')
```
## Options
| Option | Type | Description | Default value |
| --- | --- | --- | --- |
| `g:coc_fzf_preview_toggle_key` | string | Change the key to toggle the preview window | `'?'` |
| `g:coc_fzf_preview_fullscreen` | number | Set to 1 to use FZF fullscreen mode in coc-references etc. | `0` |
| `g:coc_fzf_preview` | string | Change the preview window position | `'up:50%'` |
| `g:coc_fzf_opts` | array | Pass additional parameters to fzf, e.g. `['--layout=reverse']` | `['--layout=reverse-list']` |
| `g:coc_fzf_location_delay` | number | Delay(ms) fzf_run() to solve weird race conditions. | 0 |
## Vimrc Example
```vim
" allow to scroll in the preview
set mouse=a
" mappings
nnoremap :CocFzfList
nnoremap a :CocFzfList diagnostics
nnoremap b :CocFzfList diagnostics --current-buf
nnoremap c :CocFzfList commands
nnoremap e :CocFzfList extensions
nnoremap l :CocFzfList location
nnoremap o :CocFzfList outline
nnoremap s :CocFzfList symbols
nnoremap p :CocFzfListResume
```
## FAQ
**Q**: How to get the FZF floating window?\
**A**: You can look at [FZF Vim integration][fzf_vim_integration]:
```vim
let g:fzf_layout = { 'window': { 'width': 0.9, 'height': 0.6 } }
```
**Q**: How to see references, definitions etc in a FZF window?\
**A**: It is already supported by default, just make sure to have the default coc mappings:
```vim
nmap gd (coc-definition)
nmap gy (coc-type-definition)
nmap gi (coc-implementation)
nmap gr (coc-references)
```
**Q**: How to get colors in previews?\
**A**: Install [bat][bat].
**Q**: CocFzf looks different from my other Fzf commands. How to make it the same?\
**A**: By default, CocFzf tries to mimic CocList. Here is how to change this:
```vim
let g:coc_fzf_preview = ''
let g:coc_fzf_opts = []
```
**Q**: CocFzf symbol search reports get_workspace_symbols.py could not be executed successfully
**A**: You are most likely missing [pynvim]
License
-------
MIT
[fzf]: https://github.com/junegunn/fzf
[fzf_vim_integration]: https://github.com/junegunn/fzf/blob/master/README-VIM.md
[coc.nvim]: https://github.com/neoclide/coc.nvim
[coc_sources]: https://github.com/neoclide/coc.nvim/wiki/Using-coc-list#builtin-list-sources
[RobertBuhren]: https://gist.github.com/RobertBuhren/02e05506255c667c0038ce74ee1cef96
[coc_denite]: https://github.com/neoclide/coc-denite
[ctags]: https://github.com/universal-ctags/ctags
[fzfvim]: https://github.com/junegunn/fzf.vim
[coc-snippets]: https://github.com/neoclide/coc-snippets
[coc-yank]: https://github.com/neoclide/coc-yank
[bat]: https://github.com/sharkdp/bat
[coc-git]: https://github.com/neoclide/coc-git
[pynvim]: https://github.com/neovim/pynvim