https://github.com/tamago324/compe-zsh
zsh completion source for nvim-compe
https://github.com/tamago324/compe-zsh
Last synced: 4 months ago
JSON representation
zsh completion source for nvim-compe
- Host: GitHub
- URL: https://github.com/tamago324/compe-zsh
- Owner: tamago324
- License: mit
- Archived: true
- Created: 2021-01-14T15:11:58.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2021-04-03T08:29:34.000Z (over 4 years ago)
- Last Synced: 2025-07-14T20:18:45.921Z (4 months ago)
- Language: Shell
- Homepage:
- Size: 7.81 KB
- Stars: 21
- Watchers: 4
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-zsh-plugins - compe - Add completion for [nvim-compe](https://github.com/hrsh7th/nvim-compe). (Plugins / ZSH on Windows)
- fucking-awesome-zsh-plugins - compe - Add completion for <b><code> 1278⭐</code></b> <b><code> 52🍴</code></b> [nvim-compe](https://github.com/hrsh7th/nvim-compe)). (Plugins / ZSH on Windows)
README
# compe-zsh
Zsh completion source for [nvim-compe](https://github.com/hrsh7th/nvim-compe)
## Requirements
* [Neovim](https://github.com/neovim/neovim/)
* [nvim-compe](https://github.com/hrsh7th/nvim-compe)
* zsh/zpty module
```zsh
zmodload zsh/zpty
```
## Installation
```vim
Plug 'hrsh7th/nvim-compe'
Plug 'tamago324/compe-zsh'
Plug 'nvim-lua/plenary.nvim'
Plug 'Shougo/deol.nvim' " recommended to use together.
lua << EOF
require'compe'.setup {
-- ...
source = {
-- ...
zsh = true,
}
}
EOF
```
## Configuration
It saves compdump file in `$COMPE_ZSH_CACHE_DIR` or `$XDG_CACHE_HOME` or
`$HOME/.cache` directory.
NOTE: In my case, I had to add the directory of the complete function to `$FPATH` in `~/.zshenv`.
```zsh
# completions
if [ -d $HOME/.zsh/comp ]; then
export FPATH="$HOME/.zsh/comp:$FPATH"
fi
```
## Credit
* [deoplete-zsh](https://github.com/deoplete-plugins/deoplete-zsh)
* [zsh-capture-completion](https://github.com/Valodim/zsh-capture-completion)
## License
MIT