vim-plug/README.md

289 lines
11 KiB
Markdown
Raw Normal View History

2015-03-14 11:13:24 -07:00
<img src="https://raw.githubusercontent.com/junegunn/vim-plug/master/plug.png" height="75" alt="vim-plug">[![travis-ci](https://travis-ci.org/junegunn/vim-plug.svg?branch=master)](https://travis-ci.org/junegunn/vim-plug)
===
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
2014-12-08 01:35:41 -07:00
<img src="https://raw.githubusercontent.com/junegunn/i/master/vim-plug/installer.gif" height="450">
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
2015-01-31 11:11:58 -07:00
- [Super-fast][40/4] parallel installation/update
2016-10-17 02:00:20 -07:00
(with any of `+job`, `+python`, `+python3`, `+ruby`, or [Neovim][nv])
2015-05-02 07:50:58 -07:00
- Creates shallow clones to minimize disk space usage and download time
2015-01-31 11:11:58 -07:00
- On-demand loading for [faster startup time][startup-time]
- Can review and rollback updates
- Branch/tag/commit support
2014-07-31 10:00:04 -07:00
- Post-update hooks
- Support for externally managed plugins
2013-09-10 07:58:41 -07:00
2015-01-31 11:11:58 -07:00
[40/4]: https://raw.githubusercontent.com/junegunn/i/master/vim-plug/40-in-4.gif
[nv]: http://neovim.org/
2017-01-29 10:20:36 -07:00
[startup-time]: https://github.com/junegunn/vim-startuptime-benchmark#result
2015-01-31 11:11:58 -07:00
### Installation
2013-09-10 07:58:41 -07:00
[Download plug.vim](https://raw.githubusercontent.com/junegunn/vim-plug/master/plug.vim)
2015-11-27 22:00:19 -07:00
and put it in the "autoload" directory.
2015-10-29 19:43:05 -07:00
#### Vim
2015-10-29 19:43:05 -07:00
###### Unix
2013-09-10 07:58:41 -07:00
```sh
2015-01-31 11:19:00 -07:00
curl -fLo ~/.vim/autoload/plug.vim --create-dirs \
https://raw.githubusercontent.com/junegunn/vim-plug/master/plug.vim
2013-09-10 07:58:41 -07:00
```
###### Windows (PowerShell)
```powershell
md ~\vimfiles\autoload
$uri = 'https://raw.githubusercontent.com/junegunn/vim-plug/master/plug.vim'
(New-Object Net.WebClient).DownloadFile($uri, $ExecutionContext.SessionState.Path.GetUnresolvedProviderPathFromPSPath("~\vimfiles\autoload\plug.vim"))
```
#### Neovim
###### Unix
```sh
curl -fLo ~/.local/share/nvim/site/autoload/plug.vim --create-dirs \
https://raw.githubusercontent.com/junegunn/vim-plug/master/plug.vim
```
###### Windows (PowerShell)
2015-10-29 19:43:05 -07:00
```powershell
md ~\AppData\Local\nvim\autoload
2015-10-29 19:43:05 -07:00
$uri = 'https://raw.githubusercontent.com/junegunn/vim-plug/master/plug.vim'
(New-Object Net.WebClient).DownloadFile($uri, $ExecutionContext.SessionState.Path.GetUnresolvedProviderPathFromPSPath("~\AppData\Local\nvim\autoload\plug.vim"))
2015-10-29 19:43:05 -07:00
```
### Getting Help
- See the [requirements] page for debugging information & tested configurations.
- See the [FAQ] for common problems and questions.
- Create an [issue](https://github.com/junegunn/vim-plug/issues/new).
[FAQ]: https://github.com/junegunn/vim-plug/wiki/faq
[requirements]: https://github.com/junegunn/vim-plug/wiki/requirements
### Usage
2016-01-10 11:05:23 -07:00
Add a vim-plug section to your `~/.vimrc` (or `~/.config/nvim/init.vim` for Neovim):
1. Begin the section with `call plug#begin()`
1. List the plugins with `Plug` commands
1. `call plug#end()` to update `&runtimepath` and initialize plugin system
- Automatically executes `filetype plugin indent on` and `syntax enable`.
You can revert the settings after the call. e.g. `filetype indent off`, `syntax off`, etc.
#### Example
2013-09-10 07:58:41 -07:00
```vim
" Specify a directory for plugins
" - For Neovim: ~/.local/share/nvim/plugged
" - Avoid using standard Vim directory names like 'plugin'
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
" Shorthand notation; fetches https://github.com/junegunn/vim-easy-align
2013-09-10 07:58:41 -07:00
Plug 'junegunn/vim-easy-align'
2014-07-21 20:47:34 -07:00
" Any valid git URL is allowed
Plug 'https://github.com/junegunn/vim-github-dashboard.git'
" Multiple Plug commands can be written in a single line using | separators
2015-05-23 07:02:41 -07:00
Plug 'SirVer/ultisnips' | Plug 'honza/vim-snippets'
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
2015-10-28 09:30:15 -07:00
" Using a non-master branch
Plug 'rdnetto/YCM-Generator', { 'branch': 'stable' }
" Using a tagged release; wildcard allowed (requires git 1.9.2 or above)
Plug 'fatih/vim-go', { 'tag': '*' }
2014-07-21 20:47:34 -07:00
" Plugin options
2015-05-03 06:10:32 -07:00
Plug 'nsf/gocode', { 'tag': 'v.20150303', 'rtp': 'vim' }
2014-07-21 20:47:34 -07:00
2014-07-30 04:00:21 -07:00
" Plugin outside ~/.vim/plugged with post-update hook
2015-11-08 06:41:37 -07:00
Plug 'junegunn/fzf', { 'dir': '~/.fzf', 'do': './install --all' }
2014-07-30 04:00:21 -07:00
" Unmanaged plugin (manually installed and updated)
Plug '~/my-prototype-plugin'
2013-09-16 01:37:09 -07:00
2016-12-18 09:58:15 -07:00
" Initialize plugin system
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` | Examine changes from the previous update and the pending changes |
| `PlugSnapshot[!] [output path]` | Generate script for restoring the current snapshot of the plugins |
2013-09-10 08:08:51 -07:00
### `Plug` options
| Option | Description |
| ----------------------- | ------------------------------------------------ |
| `branch`/`tag`/`commit` | Branch/tag/commit of the repository to use |
| `rtp` | Subdirectory that contains Vim plugin |
| `dir` | Custom directory for the plugin |
2016-01-25 11:01:20 -07:00
| `as` | Use different name for the plugin |
| `do` | Post-update hook (string or funcref) |
| `on` | On-demand loading: Commands or `<Plug>`-mappings |
| `for` | On-demand loading: File types |
| `frozen` | Do not update unless explicitly specified |
2014-08-19 20:38:02 -07:00
### Global options
2015-02-27 02:56:09 -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 (*Ruby & Python*) |
| `g:plug_retries` | 2 | Number of retries in case of timeout (*Ruby & Python*) |
2015-04-27 22:12:00 -07:00
| `g:plug_shallow` | 1 | Use shallow clone |
2015-02-27 02:56:09 -07:00
| `g:plug_window` | `vertical topleft new` | Command to open plug window |
| `g:plug_pwindow` | `above 12new` | Command to open preview window in `PlugDiff` |
2016-03-17 00:15:45 -07:00
| `g:plug_url_format` | `https://git::@github.com/%s.git` | `printf` format to build repo URL (Only applies to the subsequent `Plug` commands) |
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
- `U` - Update plugins in the selected range
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' }
" Code to execute when the plugin is lazily loaded on demand
Plug 'junegunn/goyo.vim', { 'for': 'markdown' }
autocmd! User goyo.vim echom 'Goyo is now loaded!'
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
2014-12-18 07:53:32 -07:00
Plug 'Shougo/vimproc.vim', { 'do': 'make' }
Plug 'Valloric/YouCompleteMe', { 'do': './install.py' }
2014-07-26 19:06:47 -07:00
```
If the value starts with `:`, it will be recognized as a Vim command.
```vim
Plug 'fatih/vim-go', { 'do': ':GoInstallBinaries' }
```
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.py
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 }
```
### `PlugInstall!` and `PlugUpdate!`
The installer takes the following steps when installing/updating a plugin:
1. `git clone` or `git fetch` from its origin
2. Check out branch, tag, or commit and optionally `git merge` remote branch
3. If the plugin was updated (or installed for the first time)
1. Update submodules
2. Execute post-update hooks
The commands with `!` suffix ensure that all steps are run unconditionally.
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