vim-plug/README.md

242 lines
8.2 KiB
Markdown
Raw Normal View History

2013-09-30 17:36:58 +02:00
![vim-plug](https://raw.github.com/junegunn/vim-plug/master/plug.png)
2014-06-23 05:57:46 +02:00
![travis-ci](https://travis-ci.org/junegunn/vim-plug.svg?branch=master)
2013-09-10 16:58:41 +02:00
2013-09-11 05:06:57 +02:00
A single-file Vim plugin manager.
2013-09-10 16:58:41 +02:00
2013-09-22 17:43:38 +02:00
Somewhere between [Pathogen](https://github.com/tpope/vim-pathogen) and
[Vundle](https://github.com/gmarik/vundle), but with faster parallel installer.
2013-09-18 14:26:15 +02:00
2014-07-13 10:39:19 +02:00
![](https://raw.github.com/junegunn/i/master/vim-plug/installer.gif)
2013-09-24 06:10:57 +02:00
2013-09-10 17:08:51 +02:00
### Pros.
2013-09-10 16:58:41 +02:00
2013-09-11 05:06:57 +02:00
- Easier to setup
2013-09-22 07:32:06 +02:00
- Parallel installation/update (requires
[+ruby](http://junegunn.kr/2013/09/installing-vim-with-ruby-support/))
2013-09-22 17:43:38 +02:00
- Smallest possible feature set
2014-02-11 16:45:23 +01:00
- Branch/tag support
- On-demand loading
2013-09-10 16:58:41 +02:00
2013-09-10 17:08:51 +02:00
### Cons.
2013-09-10 16:58:41 +02:00
- Everything else
2013-09-10 16:58:41 +02:00
2013-09-10 17:08:51 +02:00
### Usage
2013-09-10 16:58:41 +02:00
2013-09-26 16:15:04 +02:00
[Download plug.vim](https://raw.github.com/junegunn/vim-plug/master/plug.vim)
and put it in ~/.vim/autoload
2013-09-10 16:58:41 +02:00
```sh
mkdir -p ~/.vim/autoload
2013-09-11 05:06:57 +02:00
curl -fLo ~/.vim/autoload/plug.vim https://raw.github.com/junegunn/vim-plug/master/plug.vim
2013-09-10 16:58:41 +02:00
```
Edit your .vimrc
```vim
call plug#begin('~/.vim/plugged')
2013-09-10 16:58:41 +02:00
2014-07-16 13:40:49 +02:00
" Make sure you use single quotes
2013-09-30 18:32:34 +02:00
Plug 'junegunn/seoul256.vim'
2013-09-10 16:58:41 +02:00
Plug 'junegunn/vim-easy-align'
2014-07-22 05:47:34 +02:00
" On-demand loading
2014-06-17 04:59:42 +02:00
Plug 'scrooloose/nerdtree', { 'on': 'NERDTreeToggle' }
Plug 'tpope/vim-fireplace', { 'for': 'clojure' }
2014-07-22 05:47:34 +02:00
" Using git URL
Plug 'https://github.com/junegunn/vim-github-dashboard.git'
" Plugin options
Plug 'nsf/gocode', { 'tag': 'go.weekly.2012-03-13', 'rtp': 'vim' }
2014-07-30 13:00:21 +02:00
" Plugin outside ~/.vim/plugged with post-update hook
Plug 'junegunn/fzf', { 'dir': '~/.fzf', 'do': 'yes \| ./install' }
" Unmanaged plugin (manually installed and updated)
Plug '~/my-prototype-plugin'
2013-09-16 10:37:09 +02:00
call plug#end()
2013-09-10 16:58:41 +02:00
```
Reload .vimrc and `:PlugInstall` to install plugins.
2013-09-22 18:49:34 +02:00
2013-09-10 17:08:51 +02:00
### Commands
2013-09-10 16:58:41 +02:00
| Command | Description |
| --------------------------------- | ------------------------------------------------------------------ |
| PlugInstall [name ...] [#threads] | Install plugins |
| PlugUpdate [name ...] [#threads] | Install or update plugins |
| PlugClean[!] | Remove unused directories (bang version will clean without prompt) |
| PlugUpgrade | Upgrade vim-plug itself |
| PlugStatus | Check the status of plugins |
| PlugDiff | See the updated changes from the previous PlugUpdate |
2013-09-10 17:08:51 +02:00
### `Plug` options
| Option | Description |
| -------------- | -------------------------------------------------------------------- |
| `branch`/`tag` | Branch or tag of the repository to use |
| `rtp` | Subdirectory that contains Vim plugin |
| `dir` | Custom directory for the plugin |
2014-07-27 04:55:06 +02:00
| `do` | Post-update hook (string or funcref) |
2014-07-27 05:00:36 +02:00
| `on` | On-demand loading: Commands or `<Plug>`-mappings |
| `for` | On-demand loading: File types |
| `frozen` | Do not install/update plugin unless explicitly given as the argument |
### Options for parallel installer
| Flag | Default | Description |
| ---------------- | ------- | ------------------------------------ |
| `g:plug_threads` | 16 | Default number of threads to use |
| `g:plug_timeout` | 60 | Time limit of each task in seconds |
| `g:plug_retries` | 2 | Number of retries in case of timeout |
2013-09-10 16:58:41 +02:00
2014-04-08 14:43:49 +02:00
### Keybindings
- `D` - `PlugDiff`
- `S` - `PlugStatus`
2014-07-22 05:47:34 +02:00
- `R` - Retry failed update or installation tasks
2014-04-08 14:43:49 +02:00
- `q` - Close the window
2013-09-28 15:49:14 +02:00
### Example: A small [sensible](https://github.com/tpope/vim-sensible) Vim configuration
```vim
call plug#begin()
Plug 'tpope/vim-sensible'
call plug#end()
```
2014-02-11 16:45:23 +01:00
### On-demand loading of plugins
```vim
" NERD tree will be loaded on the first invocation of NERDTreeToggle command
Plug 'scrooloose/nerdtree', { 'on': 'NERDTreeToggle' }
" Multiple commands
Plug 'junegunn/vim-github-dashboard', { 'on': ['GHDashboard', 'GHActivity'] }
2014-06-17 04:59:42 +02:00
" Loaded when clojure file is opened
Plug 'tpope/vim-fireplace', { 'for': 'clojure' }
" On-demand loading on both conditions
Plug 'junegunn/vader.vim', { 'on': 'Vader', 'for': 'vader' }
2014-02-11 16:45:23 +01:00
```
2014-07-27 04:06:47 +02:00
### Post-installation/update hooks
There are some plugins that require extra steps after installation or update.
In that case, use `do` option to describe the task to be performed.
```vim
Plug 'Valloric/YouCompleteMe', { 'do': './install.sh' }
```
If you need more control, you can pass a reference to a Vim function that
takes a single argument.
2014-07-27 04:06:47 +02:00
```vim
function! BuildYCM(info)
" info is a dictionary with two fields
" - name: name of the plugin
" - status: 'installed' or 'updated'
if a:info.status == 'installed'
!./install.sh
endif
2014-07-27 04:06:47 +02:00
endfunction
Plug 'Valloric/YouCompleteMe', { 'do': function('BuildYCM') }
```
Both forms of post-update hook are executed inside the directory of the plugin.
Make sure to escape BARs when you write `do` option inline as they are
mistakenly recognized as command separator for Plug command.
```vim
Plug 'junegunn/fzf', { 'do': 'yes \| ./install' }
```
But you can avoid the escaping if you extract the inline specification using a
variable (or any Vimscript expression) as follows:
```vim
let g:fzf_install = 'yes | ./install'
Plug 'junegunn/fzf', { 'do': g:fzf_install }
```
2013-09-18 14:26:15 +02:00
### Articles
- [Writing my own Vim plugin manager](http://junegunn.kr/2013/09/writing-my-own-vim-plugin-manager)
2013-09-28 15:42:33 +02:00
- [Thoughts on Vim plugin dependency](http://junegunn.kr/2013/09/thoughts-on-vim-plugin-dependency)
- *Support for Plugfile has been removed since 0.5.0*
2014-07-27 05:00:36 +02:00
- [Vim plugins and startup time](http://junegunn.kr/2014/07/vim-plugins-and-startup-time)
2013-09-18 14:26:15 +02:00
2014-01-21 18:35:30 +01:00
### FAQ/Troubleshooting
2013-10-02 04:36:08 +02:00
#### Plugins are not installed/updated in parallel
Your Vim does not support Ruby interface. `:echo has('ruby')` should print 1.
In order to setup Vim with Ruby support, you may refer to [this
article](http://junegunn.kr/2013/09/installing-vim-with-ruby-support).
#### *Vim: Caught deadly signal SEGV*
If your Vim crashes with the above message, first check if its Ruby interface is
2013-10-02 04:36:08 +02:00
working correctly with the following command:
```vim
:ruby puts RUBY_VERSION
```
If Vim crashes even with this command, it is likely that Ruby interface is
broken, and you have to rebuild Vim with a working version of Ruby.
(`brew remove vim && brew install vim` or `./configure && make ...`)
If you're on OS X, one possibility is that you had installed Vim with
[Homebrew](http://brew.sh/) while using a Ruby installed with
[RVM](http://rvm.io/) or [rbenv](https://github.com/sstephenson/rbenv) and later
removed that version of Ruby.
2013-10-02 04:36:08 +02:00
[Please let me know](https://github.com/junegunn/vim-plug/issues) if you can't
resolve the problem. In the meantime, you can set `g:plug_threads` to 1, so that
Ruby installer is not used at all.
2014-03-13 17:32:08 +01:00
#### Errors on fish shell
If vim-plug doesn't work correctly on fish shell, you might need to add `set
shell=/bin/sh` to your .vimrc.
Refer to the following links for the details:
- http://badsimplicity.com/vim-fish-e484-cant-open-file-tmpvrdnvqe0-error/
- https://github.com/junegunn/vim-plug/issues/12
2014-01-21 18:35:30 +01:00
#### Freezing plugin version with commit hash
vim-plug does not allow you to freeze the version of a plugin with its commit
hash. This is by design. I don't believe a user of a plugin should be looking
at its individual commits. Instead, one should be choosing the right version
using release tags or versioned branches (e.g. 1.2.3, stable, devel, etc.)
```vim
Plug 'junegunn/vim-easy-align', '2.9.2'
```
If the repository doesn't come with such tags or branches, you should think of
it as "unstable" or "in development", and always use its latest revision.
If you really must choose a certain untagged revision, consider forking the
repository.
2014-07-27 04:06:47 +02:00
#### Migrating from other plugin managers
vim-plug does not require any extra statement other than `plug#begin()` and
`plug#end()`. You can remove `filetype off`, `filetype plugin indent on` and
`syntax on` from your .vimrc as they are automatically handled by
`plug#end()`.
2014-07-16 13:39:39 +02:00
### License
MIT
2013-09-24 16:15:31 +02:00