vim-plug/README.md

199 lines
7.1 KiB
Markdown
Raw Normal View History

![vim-plug](https://raw.githubusercontent.com/junegunn/vim-plug/master/plug.png)
2014-06-22 20:57:46 -07:00
![travis-ci](https://travis-ci.org/junegunn/vim-plug.svg?branch=master)
2013-09-10 07:58:41 -07:00
2014-07-31 10:00:04 -07:00
A minimalist Vim plugin manager.
2013-09-18 05:26:15 -07:00
![](https://raw.githubusercontent.com/junegunn/i/master/vim-plug/installer.gif)
2013-09-23 21:10:57 -07:00
2013-09-10 08:08:51 -07:00
### Pros.
2013-09-10 07:58:41 -07:00
2014-07-31 10:00:04 -07:00
- Easier to setup: Single file. No boilerplate code required.
- Easier to use: Concise, intuitive syntax
- [Super-fast](https://raw.githubusercontent.com/junegunn/i/master/vim-plug/40-in-4.gif)
2014-08-01 07:37:19 -07:00
parallel installation/update (requires
2014-08-01 09:12:01 -07:00
[+ruby](https://github.com/junegunn/vim-plug/wiki/ruby))
2014-07-31 10:00:04 -07:00
- On-demand loading to achieve
[fast startup time](http://junegunn.kr/images/vim-startup-time.png)
- Post-update hooks
- Can choose a specific branch or tag for each plugin
- Support for externally managed plugins
2013-09-10 07:58:41 -07:00
2013-09-10 08:08:51 -07:00
### Usage
2013-09-10 07:58:41 -07:00
[Download plug.vim](https://raw.githubusercontent.com/junegunn/vim-plug/master/plug.vim)
2013-09-26 07:15:04 -07:00
and put it in ~/.vim/autoload
2013-09-10 07:58:41 -07:00
```sh
mkdir -p ~/.vim/autoload
2014-08-04 23:32:28 -07:00
curl -fLo ~/.vim/autoload/plug.vim \
https://raw.githubusercontent.com/junegunn/vim-plug/master/plug.vim
2013-09-10 07:58:41 -07:00
```
Edit your .vimrc
```vim
call plug#begin('~/.vim/plugged')
2013-09-10 07:58:41 -07:00
2014-07-16 04:40:49 -07:00
" Make sure you use single quotes
2013-09-30 09:32:34 -07:00
Plug 'junegunn/seoul256.vim'
2013-09-10 07:58:41 -07:00
Plug 'junegunn/vim-easy-align'
2014-07-21 20:47:34 -07:00
" On-demand loading
2014-06-16 19:59:42 -07:00
Plug 'scrooloose/nerdtree', { 'on': 'NERDTreeToggle' }
Plug 'tpope/vim-fireplace', { 'for': 'clojure' }
2014-07-21 20:47:34 -07: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 04:00:21 -07: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 01:37:09 -07:00
call plug#end()
2013-09-10 07:58:41 -07:00
```
Reload .vimrc and `:PlugInstall` to install plugins.
2013-09-22 09:49:34 -07:00
2013-09-10 08:08:51 -07:00
### Commands
2013-09-10 07:58:41 -07: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 08:08:51 -07: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-26 19:55:06 -07:00
| `do` | Post-update hook (string or funcref) |
2014-07-26 20:00:36 -07: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 |
2014-08-19 20:38:02 -07:00
### Global options
2014-08-25 09:36:50 -07:00
| 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 |
| `g:plug_window` | `vertical topleft new` | Command to open plug window |
2014-08-25 09:39:12 -07:00
| `g:plug_url_format` | `https://git::@github.com/%s.git` | `printf` format to build repo URL |
2013-09-10 07:58:41 -07:00
2014-04-08 05:43:49 -07:00
### Keybindings
- `D` - `PlugDiff`
- `S` - `PlugStatus`
2014-07-21 20:47:34 -07:00
- `R` - Retry failed update or installation tasks
2014-04-08 05:43:49 -07:00
- `q` - Close the window
- `:PlugStatus`
- `L` - Load plugin
- `:PlugDiff`
- `X` - Revert the update
2014-04-08 05:43:49 -07:00
2013-09-28 06:49:14 -07: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 08:45:23 -07: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-16 19:59:42 -07:00
" Loaded when clojure file is opened
Plug 'tpope/vim-fireplace', { 'for': 'clojure' }
" Multiple file types
Plug 'kovisoft/paredit', { 'for': ['clojure', 'scheme'] }
2014-06-16 19:59:42 -07:00
" On-demand loading on both conditions
Plug 'junegunn/vader.vim', { 'on': 'Vader', 'for': 'vader' }
2014-02-11 08:45:23 -07:00
```
2014-09-10 07:39:49 -07:00
`for` option is generally not needed as most plugins for specific file types
usually don't have too much code in `plugin` directory. You might want to
examine the output of `vim --startuptime` before applying the option.
2014-08-01 09:00:59 -07:00
### Post-update hooks
2014-07-26 19:06:47 -07:00
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-26 19:06:47 -07:00
```vim
function! BuildYCM(info)
" info is a dictionary with 3 fields
" - name: name of the plugin
" - status: 'installed', 'updated', or 'unchanged'
" - force: set on PlugInstall! or PlugUpdate!
if a:info.status == 'installed' || a:info.force
!./install.sh
endif
2014-07-26 19:06:47 -07:00
endfunction
Plug 'Valloric/YouCompleteMe', { 'do': function('BuildYCM') }
```
Both forms of post-update hook are executed inside the directory of the plugin
and only run when the repository has changed, but you can force it to run
unconditionally with the bang-versions of the commands: `PlugInstall!` and
`PlugUpdate!`.
2014-07-26 19:06:47 -07:00
Make sure to escape BARs and double-quotes when you write `do` option inline
as they are mistakenly recognized as command separator or the start of the
trailing comment.
2014-07-26 19:06:47 -07:00
```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 }
```
2014-08-01 07:46:50 -07:00
### FAQ/Troubleshooting
See [FAQ/Troubleshooting](https://github.com/junegunn/vim-plug/wiki/faq).
2013-09-18 05:26:15 -07:00
### Articles
- [Writing my own Vim plugin manager](http://junegunn.kr/2013/09/writing-my-own-vim-plugin-manager)
- [Vim plugins and startup time](http://junegunn.kr/2014/07/vim-plugins-and-startup-time)
2014-08-01 07:46:50 -07: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*
2013-09-18 05:26:15 -07:00
2014-07-16 04:39:39 -07:00
### License
MIT
2013-09-24 07:15:31 -07:00