Merge 82ffd4f9ca into a7d4a73dd6

If you press 'q' while `PlugInstall` or `PlugUpdate` is in progress,
the current version of vim-plug immediately closes its window and aborts
all the running processes.

This commit enhances the 'q' map so that it doesn't close the window,
but instead displays the aborted tasks so that the user can press 'R' to
retry the tasks.

Fix #1285

.github/FUNDING.yml

@@ -0,0 +1 @@
+github: junegunn

.github/ISSUE_TEMPLATE.md

@@ -10,7 +10,12 @@ Explain the problem here ...
 
 ------------------------------
 
-<!-- Put the contents of `:version` below -->
+<!-- Paste your Plug block (from `call plug#begin()` to `call plug#end()`) -->
+```
+
+```
+
+<!-- Paste the contents of `:version` below -->
 ```
 
 ```
@@ -24,7 +29,7 @@ Explain the problem here ...
 - OS:
     - [ ] All/Other
     - [ ] Linux
-    - [ ] OS X
+    - [ ] macOS
     - [ ] Windows
 - Vim:
     - [ ] Terminal Vim

.github/workflows/test.yml

@@ -0,0 +1,52 @@
+---
+name: Test vim-plug
+
+on:
+  push:
+    branches: [master, devel]
+  pull_request:
+    branches: [master]
+  workflow_dispatch:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        vim:
+          - vim
+          # FIXME: (core dumped) https://github.com/junegunn/vim-plug/runs/4422576984?check_suite_focus=true#step:3:238
+          # - neovim-stable
+          # - neovim-unstable
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+
+      - name: Install packages and test
+        env:
+          ENV: ${{ matrix.vim }}
+        run: |
+          export DEPS=~/deps
+          export PATH=~/deps/bin:$PATH
+
+          git config --global user.email "you@example.com"
+          git config --global user.name "Your Name"
+
+          case "$ENV" in
+            vim)
+              sudo apt-get install vim
+              ;;
+            neovim-*)
+              sudo add-apt-repository ppa:neovim-ppa/${ENV/neovim-/}
+              sudo apt-get update
+              sudo apt-get install neovim
+
+              mkdir -p $DEPS/bin
+              echo 'nvim "$@"' > $DEPS/bin/vim
+              chmod +x $DEPS/bin/vim
+              export VADER_OUTPUT_FILE=/dev/stderr
+              ;;
+          esac
+
+          test/run !

.gitignore

@@ -0,0 +1 @@
+doc/tags

.travis.yml

@@ -1,54 +1,63 @@
-language: ruby
-dist: trusty
-sudo: false
+language: minimal
 env:
   global:
     - DEPS=$HOME/deps
     - PATH=$DEPS/bin:$PATH
-matrix:
+jobs:
   include:
-    - env: ENV=vim72
-      rvm: 1.8.7
-      addons: { apt: { packages: [vim-nox] } }
-    - env: ENV=python
-      rvm: 1.8.7
-      addons: { apt: { packages: [python2.7-dev] } }
-    - env: ENV=python3
-      rvm: 1.8.7
-      addons: { apt: { packages: [python3-dev] } }
-    - env: ENV=ruby18
-      rvm: 1.8.7
-    - env: ENV=ruby20
-      rvm: 2.0.0
-    - env: ENV=neovim
-    - env: ENV=vim8
+    - env: ENV=vim80-bionic
+      dist: bionic
+      stage: vim8
+    - env: ENV=vim-nightly
+      dist: trusty
+      stage: vim8
+    - env: ENV=neovim-stable
+      dist: bionic
+      addons: {apt: {packages: [neovim], sources: [{sourceline: 'ppa:neovim-ppa/stable'}]}}
+      stage: neovim
+    - env: ENV=neovim-nightly
+      dist: bionic
+      addons: {apt: {packages: [neovim], sources: [{sourceline: 'ppa:neovim-ppa/unstable'}]}}
+      stage: neovim
+    - env: ENV=vim74-trusty-python
+      dist: trusty
+      stage: vim74
+    - env: ENV=vim74-xenial-python3
+      dist: xenial
+      stage: vim74
+    - env: ENV=vim74-trusty-ruby
+      dist: trusty
+      addons: {apt: {packages: [vim-nox]}}
+      stage: vim74
+    - env: ENV=vim74-xenial-ruby
+      dist: xenial
+      addons: {apt: {packages: [vim-nox]}}
+      stage: vim74
+    - env: ENV=osx-highsierra
+      os: osx
+      osx_image: xcode9.4
+      stage: vim8
 install: |
   git config --global user.email "you@example.com"
   git config --global user.name "Your Name"
 
-  if [ "$ENV" == "vim72" ]; then
-    mkdir -p ${DEPS}/bin
-    ln -s /usr/bin/vim.nox ${DEPS}/bin/vim
-    return
-  elif [ "$ENV" == "neovim" ]; then
-    # https://github.com/neovim/bot-ci#nightly-builds
-    eval "$(curl -Ss https://raw.githubusercontent.com/neovim/bot-ci/master/scripts/travis-setup.sh) nightly-x64"
-    mkdir -p ${DEPS}/bin
-    ln -s $(which nvim) ${DEPS}/bin/vim
-    export VADER_OUTPUT_FILE=/dev/stderr
-    return
-  fi
-
   C_OPTS="--prefix=$DEPS --with-features=huge --disable-gui "
   case "$ENV" in
-    python)
-      C_OPTS+=--enable-pythoninterp
+    vim-*)
       ;;
-    python3)
-      C_OPTS+=--enable-python3interp
+    neovim-*)
+      mkdir -p ${DEPS}/bin
+      ln -s /usr/bin/nvim ${DEPS}/bin/vim
+      export VADER_OUTPUT_FILE=/dev/stderr
+      return
       ;;
-    ruby*)
-      C_OPTS+=--enable-rubyinterp
+    vim74-* | vim80-*)
+      mkdir -p ${DEPS}/bin
+      ln -s /usr/bin/vim.nox ${DEPS}/bin/vim
+      return
+      ;;
+    *)
+      return
       ;;
   esac
 

README.md

@@ -1,16 +1,26 @@
-<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)
-===
+<h1 title="vim-plug">
+  <picture>
+    <source media="(prefers-color-scheme: dark)" srcset="./plug-dark.png">
+    <img src="./plug.png" height="75" alt="vim-plug">
+  </picture>
+  <a href="https://github.com/junegunn/vim-plug/actions/workflows/test.yml?query=branch%3Amaster">
+    <img src="https://img.shields.io/github/actions/workflow/status/junegunn/vim-plug/test.yml?branch=master">
+  </a>
+</h1>
 
 A minimalist Vim plugin manager.
 
 <img src="https://raw.githubusercontent.com/junegunn/i/master/vim-plug/installer.gif" height="450">
 
-### Pros.
+## Pros.
 
-- Easier to setup: Single file. No boilerplate code required.
-- Easier to use: Concise, intuitive syntax
+- Minimalist design
+    - Just one file with no dependencies. Super easy to set up.
+    - Concise, intuitive syntax that you can learn within minutes. No boilerplate code required.
+    - No feature bloat
+- Extremely stable with flawless backward compatibility
+    - Works perfectly with all versions of Vim since 2006 and all versions of Neovim ever released
 - [Super-fast][40/4] parallel installation/update
-  (with any of `+job`, `+python`, `+python3`, `+ruby`, or [Neovim][nv])
 - Creates shallow clones to minimize disk space usage and download time
 - On-demand loading for [faster startup time][startup-time]
 - Can review and rollback updates
@@ -19,17 +29,19 @@ A minimalist Vim plugin manager.
 - Support for externally managed plugins
 
 [40/4]: https://raw.githubusercontent.com/junegunn/i/master/vim-plug/40-in-4.gif
-[nv]: http://neovim.org/
 [startup-time]: https://github.com/junegunn/vim-startuptime-benchmark#result
 
-### Installation
+## Installation
 
 [Download plug.vim](https://raw.githubusercontent.com/junegunn/vim-plug/master/plug.vim)
 and put it in the "autoload" directory.
 
-#### Vim
+<details>
+<summary>Click to see the instructions</summary>
 
-###### Unix
+### Vim
+
+#### Unix
 
 ```sh
 curl -fLo ~/.vim/autoload/plug.vim --create-dirs \
@@ -41,133 +53,232 @@ file as suggested [here][auto].
 
 [auto]: https://github.com/junegunn/vim-plug/wiki/tips#automatic-installation
 
-###### Windows (PowerShell)
+#### 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"
-  )
-)
+iwr -useb https://raw.githubusercontent.com/junegunn/vim-plug/master/plug.vim |`
+    ni $HOME/vimfiles/autoload/plug.vim -Force
 ```
 
-#### Neovim
+### Neovim
 
-###### Unix
+#### Unix, Linux
 
 ```sh
-curl -fLo ~/.local/share/nvim/site/autoload/plug.vim --create-dirs \
+sh -c 'curl -fLo "${XDG_DATA_HOME:-$HOME/.local/share}"/nvim/site/autoload/plug.vim --create-dirs \
+       https://raw.githubusercontent.com/junegunn/vim-plug/master/plug.vim'
+```
+
+#### Linux (Flatpak)
+
+```sh
+curl -fLo ~/.var/app/io.neovim.nvim/data/nvim/site/autoload/plug.vim --create-dirs \
     https://raw.githubusercontent.com/junegunn/vim-plug/master/plug.vim
 ```
 
-###### Windows (PowerShell)
+#### Windows (PowerShell)
 
 ```powershell
-md ~\AppData\Local\nvim\autoload
-$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"
-  )
-)
+iwr -useb https://raw.githubusercontent.com/junegunn/vim-plug/master/plug.vim |`
+    ni "$(@($env:XDG_DATA_HOME, $env:LOCALAPPDATA)[$null -eq $env:XDG_DATA_HOME])/nvim-data/site/autoload/plug.vim" -Force
 ```
 
+</details>
+
+## Usage
+
+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. End the section with `call plug#end()`
+
+For example,
+
+```vim
+call plug#begin()
+
+" List your plugins here
+Plug 'tpope/vim-sensible'
+
+call plug#end()
+```
+
+Reload the file or restart Vim, then you can,
+
+* `:PlugInstall` to install the plugins
+* `:PlugUpdate` to install or update the plugins
+* `:PlugDiff` to review the changes from the last update
+* `:PlugClean` to remove plugins no longer in the list
+
+> [!NOTE]
+> That's basically all you need to know to get started. The rest of the
+> document is for advanced users who want to know more about the features and
+> options.
+
+> [!TIP]
+> `plug#end()` automatically executes `filetype plugin indent on` and `syntax
+> enable`. We believe this is a good default for most users, but if you don't
+> want this behavior, you can revert the settings after the call.
+>
+> ```vim
+> call plug#end()
+> filetype indent off   " Disable file-type-specific indentation
+> syntax off            " Disable syntax highlighting
+> ```
+
 ### Getting Help
 
-- See [tutorial] page to learn the basics of vim-plug
+- See [tutorial] page to learn more about the basics of vim-plug
 - See [tips] and [FAQ] pages for common problems and questions
-- See [requirements] page for debugging information & tested configurations
-- Create an [issue](https://github.com/junegunn/vim-plug/issues/new)
 
 [tutorial]: https://github.com/junegunn/vim-plug/wiki/tutorial
 [tips]: https://github.com/junegunn/vim-plug/wiki/tips
 [FAQ]: https://github.com/junegunn/vim-plug/wiki/faq
-[requirements]: https://github.com/junegunn/vim-plug/wiki/requirements
 
-### Usage
+## Examples
 
-Add a vim-plug section to your `~/.vimrc` (or `~/.config/nvim/init.vim` for Neovim):
+The following examples demonstrate the additional features of vim-plug.
 
-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
+### Vim script example
 
 ```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')
+call plug#begin()
+" The default plugin directory will be as follows:
+"   - Vim (Linux/macOS): '~/.vim/plugged'
+"   - Vim (Windows): '~/vimfiles/plugged'
+"   - Neovim (Linux/macOS/Windows): stdpath('data') . '/plugged'
+" You can specify a custom plugin directory by passing it as the argument
+"   - e.g. `call plug#begin('~/.vim/plugged')`
+"   - Avoid using standard Vim directory names like 'plugin'
 
 " Make sure you use single quotes
 
-" Shorthand notation; fetches https://github.com/junegunn/vim-easy-align
-Plug 'junegunn/vim-easy-align'
+" Shorthand notation for GitHub; translates to https://github.com/junegunn/seoul256.vim.git
+Plug 'junegunn/seoul256.vim'
 
 " 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
-Plug 'SirVer/ultisnips' | Plug 'honza/vim-snippets'
-
-" On-demand loading
-Plug 'scrooloose/nerdtree', { 'on':  'NERDTreeToggle' }
-Plug 'tpope/vim-fireplace', { 'for': 'clojure' }
-
-" Using a non-master branch
-Plug 'rdnetto/YCM-Generator', { 'branch': 'stable' }
+Plug 'https://github.com/junegunn/vim-easy-align.git'
 
 " Using a tagged release; wildcard allowed (requires git 1.9.2 or above)
 Plug 'fatih/vim-go', { 'tag': '*' }
 
-" Plugin options
-Plug 'nsf/gocode', { 'tag': 'v.20150303', 'rtp': 'vim' }
+" Using a non-default branch
+Plug 'neoclide/coc.nvim', { 'branch': 'release' }
 
-" Plugin outside ~/.vim/plugged with post-update hook
+" Use 'dir' option to install plugin in a non-default directory
+Plug 'junegunn/fzf', { 'dir': '~/.fzf' }
+
+" Post-update hook: run a shell command after installing or updating the plugin
 Plug 'junegunn/fzf', { 'dir': '~/.fzf', 'do': './install --all' }
 
+" Post-update hook can be a lambda expression
+Plug 'junegunn/fzf', { 'do': { -> fzf#install() } }
+
+" If the vim plugin is in a subdirectory, use 'rtp' option to specify its path
+Plug 'nsf/gocode', { 'rtp': 'vim' }
+
+" On-demand loading: loaded when the specified command is executed
+Plug 'preservim/nerdtree', { 'on': 'NERDTreeToggle' }
+
+" On-demand loading: loaded when a file with a specific file type is opened
+Plug 'tpope/vim-fireplace', { 'for': 'clojure' }
+
 " Unmanaged plugin (manually installed and updated)
 Plug '~/my-prototype-plugin'
 
-" Initialize plugin system
+" Call plug#end to update &runtimepath and initialize the plugin system.
+" - It automatically executes `filetype plugin indent on` and `syntax enable`
 call plug#end()
+" You can revert the settings after the call like so:
+"   filetype indent off   " Disable file-type-specific indentation
+"   syntax off            " Disable syntax highlighting
+
+" Color schemes should be loaded after plug#end().
+" We prepend it with 'silent!' to ignore errors when it's not yet installed.
+silent! colorscheme seoul256
 ```
 
-Reload .vimrc and `:PlugInstall` to install plugins.
+### Lua example for Neovim
 
-### Commands
+In Neovim, you can write your configuration in a Lua script file named
+`init.lua`. The following code is the Lua script equivalent to the Vim script
+example above.
+
+```lua
+local vim = vim
+local Plug = vim.fn['plug#']
+
+vim.call('plug#begin')
+
+-- Shorthand notation for GitHub; translates to https://github.com/junegunn/seoul256.vim.git
+Plug('junegunn/seoul256.vim')
+
+-- Any valid git URL is allowed
+Plug('https://github.com/junegunn/vim-easy-align.git')
+
+-- Using a tagged release; wildcard allowed (requires git 1.9.2 or above)
+Plug('fatih/vim-go', { ['tag'] = '*' })
+
+-- Using a non-default branch
+Plug('neoclide/coc.nvim', { ['branch'] = 'release' })
+
+-- Use 'dir' option to install plugin in a non-default directory
+Plug('junegunn/fzf', { ['dir'] = '~/.fzf' })
+
+-- Post-update hook: run a shell command after installing or updating the plugin
+Plug('junegunn/fzf', { ['dir'] = '~/.fzf', ['do'] = './install --all' })
+
+-- Post-update hook can be a lambda expression
+Plug('junegunn/fzf', { ['do'] = function()
+  vim.fn['fzf#install']()
+end })
+
+-- If the vim plugin is in a subdirectory, use 'rtp' option to specify its path
+Plug('nsf/gocode', { ['rtp'] = 'vim' })
+
+-- On-demand loading: loaded when the specified command is executed
+Plug('preservim/nerdtree', { ['on'] = 'NERDTreeToggle' })
+
+-- On-demand loading: loaded when a file with a specific file type is opened
+Plug('tpope/vim-fireplace', { ['for'] = 'clojure' })
+
+-- Unmanaged plugin (manually installed and updated)
+Plug('~/my-prototype-plugin')
+
+vim.call('plug#end')
+
+-- Color schemes should be loaded after plug#end().
+-- We prepend it with 'silent!' to ignore errors when it's not yet installed.
+vim.cmd('silent! colorscheme seoul256')
+```
+
+## Commands
 
 | Command                             | Description                                                        |
 | ----------------------------------- | ------------------------------------------------------------------ |
 | `PlugInstall [name ...] [#threads]` | Install plugins                                                    |
 | `PlugUpdate [name ...] [#threads]`  | Install or update plugins                                          |
-| `PlugClean[!]`                      | Remove unused directories (bang version will clean without prompt) |
+| `PlugClean[!]`                      | Remove unlisted plugins (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  |
 
-### `Plug` options
+## `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                  |
-| `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        |
+| 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                             |
+| `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 remove and do not update unless explicitly specified |
 
-### Global options
+## Global options
 
 | Flag                | Default                           | Description                                            |
 | ------------------- | --------------------------------- | ------------------------------------------------------ |
@@ -175,36 +286,100 @@ Reload .vimrc and `:PlugInstall` to install plugins.
 | `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*) |
 | `g:plug_shallow`    | 1                                 | Use shallow clone                                      |
-| `g:plug_window`     | `vertical topleft new`            | Command to open plug window                            |
-| `g:plug_pwindow`    | `above 12new`                     | Command to open preview window in `PlugDiff`           |
+| `g:plug_window`     | `-tabnew`                         | Command to open plug window                            |
+| `g:plug_pwindow`    | `vertical rightbelow new`         | Command to open preview window in `PlugDiff`           |
 | `g:plug_url_format` | `https://git::@github.com/%s.git` | `printf` format to build repo URL (Only applies to the subsequent `Plug` commands) |
 
 
-### Keybindings
+## Keybindings
 
 - `D` - `PlugDiff`
 - `S` - `PlugStatus`
 - `R` - Retry failed update or installation tasks
 - `U` - Update plugins in the selected range
-- `q` - Close the window
+- `q` - Abort the running tasks or close the window
 - `:PlugStatus`
     - `L` - Load plugin
 - `:PlugDiff`
     - `X` - Revert the update
 
-### Example: A small [sensible](https://github.com/tpope/vim-sensible) Vim configuration
+## Post-update hooks
+
+There are some plugins that require extra steps after installation or update.
+In that case, use the `do` option to describe the task to be performed.
 
 ```vim
-call plug#begin()
-Plug 'tpope/vim-sensible'
-call plug#end()
+Plug 'Shougo/vimproc.vim', { 'do': 'make' }
+Plug 'ycm-core/YouCompleteMe', { 'do': './install.py' }
 ```
 
-### On-demand loading of plugins
+If the value starts with `:`, it will be recognized as a Vim command.
+
+```vim
+Plug 'fatih/vim-go', { 'do': ':GoInstallBinaries' }
+```
+
+To call a Vim function, you can pass a lambda expression like so:
+
+```vim
+Plug 'junegunn/fzf', { 'do': { -> fzf#install() } }
+```
+
+If you need more control, you can pass a reference to a Vim function that
+takes a dictionary argument.
+
+```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
+endfunction
+
+Plug 'ycm-core/YouCompleteMe', { 'do': function('BuildYCM') }
+```
+
+A post-update hook is 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!`.
+
+> [!TIP]
+> Make sure to escape BARs and double-quotes when you write the `do` option
+> inline as they are mistakenly recognized as command separator or the start of
+> the trailing comment.
+>
+> ```vim
+> Plug 'junegunn/fzf', { 'do': 'yes \| ./install' }
+> ```
+>
+> But you can avoid the escaping if you extract the inline specification using a
+> variable (or any Vim script 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 the `!` suffix ensure that all steps are run unconditionally.
+
+## On-demand loading of plugins
 
 ```vim
 " NERD tree will be loaded on the first invocation of NERDTreeToggle command
-Plug 'scrooloose/nerdtree', { 'on': 'NERDTreeToggle' }
+Plug 'preservim/nerdtree', { 'on': 'NERDTreeToggle' }
 
 " Multiple commands
 Plug 'junegunn/vim-github-dashboard', { 'on': ['GHDashboard', 'GHActivity'] }
@@ -223,84 +398,48 @@ Plug 'junegunn/goyo.vim', { 'for': 'markdown' }
 autocmd! User goyo.vim echom 'Goyo is now loaded!'
 ```
 
-`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.
+> [!NOTE]
+> #### Should I set up on-demand loading?
+>
+> You probably don't need to.
+>
+> A properly implemented Vim plugin should already load lazily without any
+> help from a plugin manager (`:help autoload`). So there are few cases where
+> these options actually make much sense. Making a plugin load faster is
+> the responsibility of the plugin developer, not the user. If you find
+> a plugin that takes too long to load, consider opening an issue on the
+> plugin's issue tracker.
+>
+> Let me give you a perspective. The time it takes to load a plugin is usually
+> less than 2 or 3ms on modern computers. So unless you use a very large
+> number of plugins, you are unlikely to save more than 50ms. If you have
+> spent an hour carefully setting up the options to shave off 50ms, you
+> will have to start Vim 72,000 times just to break even. You should ask
+> yourself if that's a good investment of your time.
+>
+> Make sure that you're tackling the right problem by breaking down the
+> startup time of Vim using `--startuptime`.
+>
+> ```sh
+> vim --startuptime /tmp/log
+> ```
+>
+> On-demand loading should only be used as a last resort. It is basically
+> a hacky workaround and is not always guaranteed to work.
 
-### Post-update hooks
+> [!TIP]
+> You can pass an empty list to `on` or `for` option to disable the loading
+> of the plugin. You can manually load the plugin using `plug#load(NAMES...)`
+> function.
+>
+> See https://github.com/junegunn/vim-plug/wiki/tips#loading-plugins-manually
 
-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 'Shougo/vimproc.vim', { 'do': 'make' }
-Plug 'Valloric/YouCompleteMe', { 'do': './install.py' }
-```
+## Collaborators
 
-If the value starts with `:`, it will be recognized as a Vim command.
+- [Jan Edmund Lazo](https://github.com/janlazo) - Windows support
+- [Jeremy Pallats](https://github.com/starcraftman) - Python installer
 
-```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.
-
-```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
-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!`.
-
-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.
-
-```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.
-
-### 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)
-- ~~[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*
-
-### License
+## License
 
 MIT
-

doc/plug.txt

@@ -1,213 +1,249 @@
-plug.txt	plug	Last change: November 27 2017
+plug.txt	plug	Last change: Jun 1 2024
 PLUG - TABLE OF CONTENTS                                         *plug* *plug-toc*
 ==============================================================================
 
-  vim-plug
-    Pros.
-    Installation
-      Vim
-        Unix
-        Windows (PowerShell)
-      Neovim
-        Unix
-        Windows (PowerShell)
-    Getting Help
-    Usage
-      Example
-    Commands
-    Plug options
-    Global options
-    Keybindings
-    Example: A small sensible Vim configuration
-    On-demand loading of plugins
-    Post-update hooks
-    PlugInstall! and PlugUpdate!
-    Articles
-    License
+  vim-plug                          |vim-plug|
+    Pros.                           |plug-pros|
+    Installation                    |plug-installation|
+    Usage                           |plug-usage|
+      Getting Help                  |plug-getting-help|
+    Examples                        |plug-examples|
+      Vim script example            |plug-vim-script-example|
+      Lua example for Neovim        |plug-lua-example-for-neovim|
+    Commands                        |plug-commands|
+    Plug options                    |plug-options|
+    Global options                  |plug-global-options|
+    Keybindings                     |plug-keybindings|
+    Post-update hooks               |plug-post-update-hooks|
+      PlugInstall! and PlugUpdate!  |pluginstall-and-plugupdate|
+    On-demand loading of plugins    |plug-on-demand-loading-of-plugins|
+    Collaborators                   |plug-collaborators|
+    License                         |plug-license|
 
 VIM-PLUG                                                              *vim-plug*
 ==============================================================================
 
 A minimalist Vim plugin manager.
 
-https://raw.githubusercontent.com/junegunn/i/master/vim-plug/installer.gif
 
+PROS.                                                                *plug-pros*
+==============================================================================
 
-< Pros. >_____________________________________________________________________~
-                                                                     *plug-pros*
-
- - Easier to setup: Single file. No boilerplate code required.
- - Easier to use: Concise, intuitive syntax
- - {Super-fast}{1} parallel installation/update (with any of `+job`, `+python`,
-   `+python3`, `+ruby`, or {Neovim}{2})
+ - Minimalist design
+   - Just one file with no dependencies. Super easy to set up.
+   - Concise, intuitive syntax that you can learn within minutes. No
+     boilerplate code required.
+   - No feature bloat
+ - Extremely stable with flawless backward compatibility
+   - Works perfectly with all versions of Vim since 2006 and all versions of
+     Neovim ever released
+ - {Super-fast}{1} parallel installation/update
  - Creates shallow clones to minimize disk space usage and download time
- - On-demand loading for {faster startup time}{3}
+ - On-demand loading for {faster startup time}{2}
  - Can review and rollback updates
  - Branch/tag/commit support
  - Post-update hooks
  - Support for externally managed plugins
 
   {1} https://raw.githubusercontent.com/junegunn/i/master/vim-plug/40-in-4.gif
-  {2} http://neovim.org/
-  {3} https://github.com/junegunn/vim-startuptime-benchmark#result
+  {2} https://github.com/junegunn/vim-startuptime-benchmark#result
 
 
-< Installation >______________________________________________________________~
-                                                             *plug-installation*
+INSTALLATION                                                 *plug-installation*
+==============================================================================
 
-{Download plug.vim}{4} and put it in the "autoload" directory.
+{Download plug.vim}{3} and put it in the "autoload" directory.
 
-       {4} https://raw.githubusercontent.com/junegunn/vim-plug/master/plug.vim
+       {3} https://raw.githubusercontent.com/junegunn/vim-plug/master/plug.vim
 
 
-Vim~
-                                                                      *plug-vim*
+USAGE                                                               *plug-usage*
+==============================================================================
 
-
->> Unix~
->
-    curl -fLo ~/.vim/autoload/plug.vim --create-dirs \
-        https://raw.githubusercontent.com/junegunn/vim-plug/master/plug.vim
-<
-You can automate the process by putting the command in your Vim configuration
-file as suggested {here}{5}.
-
-     {5} https://github.com/junegunn/vim-plug/wiki/tips#automatic-installation
-
-
->> Windows (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~
-                                                                   *plug-neovim*
-
-
->> Unix~
->
-    curl -fLo ~/.local/share/nvim/site/autoload/plug.vim --create-dirs \
-        https://raw.githubusercontent.com/junegunn/vim-plug/master/plug.vim
-<
-
->> Windows (PowerShell)~
->
-    md ~\AppData\Local\nvim\autoload
-    $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"
-      )
-    )
-<
-
-< Getting Help >______________________________________________________________~
-                                                             *plug-getting-help*
-
- - See {tutorial}{6} page to learn the basics of vim-plug
- - See {tips}{7} and {FAQ}{8} pages for common problems and questions
- - See {requirements}{9} page for debugging information & tested configurations
- - Create an {issue}{10}
-
-                    {6} https://github.com/junegunn/vim-plug/wiki/tutorial
-                    {7} https://github.com/junegunn/vim-plug/wiki/tips
-                    {8} https://github.com/junegunn/vim-plug/wiki/faq
-                    {9} https://github.com/junegunn/vim-plug/wiki/requirements
-                    {10} https://github.com/junegunn/vim-plug/issues/new
-
-
-< Usage >_____________________________________________________________________~
-                                                                    *plug-usage*
-
-Add a vim-plug section to your `~/.vimrc` (or `~/.config/nvim/init.vim` for
-Neovim):
+Add a vim-plug section to your `~/.vimrc` (or `init.vim` for Neovim)
 
                                                            *plug#begin* *plug#end*
 
  1. Begin the section with `call plug#begin()`
  2. List the plugins with `Plug` commands
- 3. `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.
+ 3. End the section with `call plug#end()`
 
-
-Example~
-                                                                  *plug-example*
+For example,
 >
-    " Specify a directory for plugins
-    " - For Neovim: ~/.local/share/nvim/plugged
-    " - Avoid using standard Vim directory names like 'plugin'
-    call plug#begin('~/.vim/plugged')
+    call plug#begin()
+
+    " List your plugins here
+    Plug 'tpope/vim-sensible'
+
+    call plug#end()
+<
+Reload the file or restart Vim, then you can,
+
+                                            *:PlugInstall* *:PlugUpdate* *:PlugDiff*
+
+ - `:PlugInstall` to install the plugins
+ - `:PlugUpdate` to install or update the plugins
+ - `:PlugDiff` to review the changes from the last update
+
+[!NOTE] That's basically all you need to know to get started. The rest of the
+document is for advanced users who want to know more about the features and
+options.
+
+
+< Getting Help >______________________________________________________________~
+                                                             *plug-getting-help*
+
+ - See {tutorial}{4} page to learn more about the basics of vim-plug
+ - See {tips}{5} and {FAQ}{6} pages for common problems and questions
+
+                        {4} https://github.com/junegunn/vim-plug/wiki/tutorial
+                        {5} https://github.com/junegunn/vim-plug/wiki/tips
+                        {6} https://github.com/junegunn/vim-plug/wiki/faq
+
+
+EXAMPLES                                                         *plug-examples*
+==============================================================================
+
+The following examples demonstrate the additional features of vim-plug.
+
+
+< Vim script example >________________________________________________________~
+                                                       *plug-vim-script-example*
+>
+    call plug#begin()
+    " The default plugin directory will be as follows:
+    "   - Vim (Linux/macOS): '~/.vim/plugged'
+    "   - Vim (Windows): '~/vimfiles/plugged'
+    "   - Neovim (Linux/macOS/Windows): stdpath('data') . '/plugged'
+    " You can specify a custom plugin directory by passing it as the argument
+    "   - e.g. `call plug#begin('~/.vim/plugged')`
+    "   - Avoid using standard Vim directory names like 'plugin'
 
     " Make sure you use single quotes
 
-    " Shorthand notation; fetches https://github.com/junegunn/vim-easy-align
-    Plug 'junegunn/vim-easy-align'
+    " Shorthand notation for GitHub; translates to https://github.com/junegunn/seoul256.vim.git
+    Plug 'junegunn/seoul256.vim'
 
     " 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
-    Plug 'SirVer/ultisnips' | Plug 'honza/vim-snippets'
-
-    " On-demand loading
-    Plug 'scrooloose/nerdtree', { 'on':  'NERDTreeToggle' }
-    Plug 'tpope/vim-fireplace', { 'for': 'clojure' }
-
-    " Using a non-master branch
-    Plug 'rdnetto/YCM-Generator', { 'branch': 'stable' }
+    Plug 'https://github.com/junegunn/vim-easy-align.git'
 
     " Using a tagged release; wildcard allowed (requires git 1.9.2 or above)
     Plug 'fatih/vim-go', { 'tag': '*' }
 
-    " Plugin options
-    Plug 'nsf/gocode', { 'tag': 'v.20150303', 'rtp': 'vim' }
+    " Using a non-default branch
+    Plug 'neoclide/coc.nvim', { 'branch': 'release' }
 
-    " Plugin outside ~/.vim/plugged with post-update hook
+    " Use 'dir' option to install plugin in a non-default directory
+    Plug 'junegunn/fzf', { 'dir': '~/.fzf' }
+
+    " Post-update hook: run a shell command after installing or updating the plugin
     Plug 'junegunn/fzf', { 'dir': '~/.fzf', 'do': './install --all' }
 
+    " Post-update hook can be a lambda expression
+    Plug 'junegunn/fzf', { 'do': { -> fzf#install() } }
+
+    " If the vim plugin is in a subdirectory, use 'rtp' option to specify its path
+    Plug 'nsf/gocode', { 'rtp': 'vim' }
+
+    " On-demand loading: loaded when the specified command is executed
+    Plug 'preservim/nerdtree', { 'on': 'NERDTreeToggle' }
+
+    " On-demand loading: loaded when a file with a specific file type is opened
+    Plug 'tpope/vim-fireplace', { 'for': 'clojure' }
+
     " Unmanaged plugin (manually installed and updated)
     Plug '~/my-prototype-plugin'
 
-    " Initialize plugin system
+    " Call plug#end to update &runtimepath and initialize the plugin system.
+    " - It automatically executes `filetype plugin indent on` and `syntax enable`
     call plug#end()
+    " You can revert the settings after the call like so:
+    "   filetype indent off   " Disable file-type-specific indentation
+    "   syntax off            " Disable syntax highlighting
+
+    " Color schemes should be loaded after plug#end().
+    " We prepend it with 'silent!' to ignore errors when it's not yet installed.
+    silent! colorscheme seoul256
 <
-                                                                  *:PlugInstall*
 
-Reload .vimrc and `:PlugInstall` to install plugins.
+< Lua example for Neovim >____________________________________________________~
+                                                   *plug-lua-example-for-neovim*
 
+In Neovim, you can write your configuration in a Lua script file named
+`init.lua`. The following code is the Lua script equivalent to the Vim script
+example above.
+>
+    local vim = vim
+    local Plug = vim.fn['plug#']
 
-< Commands >__________________________________________________________________~
-                                                                 *plug-commands*
+    vim.call('plug#begin')
 
- ------------------------------------+-------------------------------------------------------------------
- Command                             | Description                                                       ~
- ------------------------------------+-------------------------------------------------------------------
-  `PlugInstall [name ...] [#threads]`  | Install plugins
-  `PlugUpdate [name ...] [#threads]`   | Install or update plugins
-  `PlugClean[!]`                       | Remove unused directories (bang version will clean without prompt)
+    -- Shorthand notation for GitHub; translates to https://github.com/junegunn/seoul256.vim.git
+    Plug('junegunn/seoul256.vim')
+
+    -- Any valid git URL is allowed
+    Plug('https://github.com/junegunn/vim-easy-align.git')
+
+    -- Using a tagged release; wildcard allowed (requires git 1.9.2 or above)
+    Plug('fatih/vim-go', { ['tag'] = '*' })
+
+    -- Using a non-default branch
+    Plug('neoclide/coc.nvim', { ['branch'] = 'release' })
+
+    -- Use 'dir' option to install plugin in a non-default directory
+    Plug('junegunn/fzf', { ['dir'] = '~/.fzf' })
+
+    -- Post-update hook: run a shell command after installing or updating the plugin
+    Plug('junegunn/fzf', { ['dir'] = '~/.fzf', ['do'] = './install --all' })
+
+    -- Post-update hook can be a lambda expression
+    Plug('junegunn/fzf', { ['do'] = function()
+      vim.fn['fzf#install']()
+    end })
+
+    -- If the vim plugin is in a subdirectory, use 'rtp' option to specify its path
+    Plug('nsf/gocode', { ['rtp'] = 'vim' })
+
+    -- On-demand loading: loaded when the specified command is executed
+    Plug('preservim/nerdtree', { ['on'] = 'NERDTreeToggle' })
+
+    -- On-demand loading: loaded when a file with a specific file type is opened
+    Plug('tpope/vim-fireplace', { ['for'] = 'clojure' })
+
+    -- Unmanaged plugin (manually installed and updated)
+    Plug('~/my-prototype-plugin')
+
+    vim.call('plug#end')
+
+    -- Color schemes should be loaded after plug#end().
+    -- We prepend it with 'silent!' to ignore errors when it's not yet installed.
+    vim.cmd('silent! colorscheme seoul256')
+<
+
+COMMANDS                                                         *plug-commands*
+==============================================================================
+
+ -------------------------------------+------------------------------------------------------------------
+ Command                              | Description                                                      ~
+ -------------------------------------+------------------------------------------------------------------
+  `PlugInstall [name ...] [#threads]`  | Install plugins
+  `PlugUpdate [name ...] [#threads]`   | Install or update plugins
+  `PlugClean[!]`                       | Remove unlisted plugins (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
- ------------------------------------+-------------------------------------------------------------------
+  `PlugSnapshot[!] [output path]`      | Generate script for restoring the current snapshot of the plugins
+ -------------------------------------+------------------------------------------------------------------
 
 
-< Plug options >______________________________________________________________~
-                                                                  *plug-options*
+PLUG OPTIONS                                                      *plug-options*
+==============================================================================
 
- ------------------------+-----------------------------------------------
- Option                  | Description                                   ~
- ------------------------+-----------------------------------------------
+                                                               *<Plug>-mappings*
+
+ ------------------------+------------------------------------------------------------
+ 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
@@ -215,12 +251,12 @@ Reload .vimrc and `:PlugInstall` to install plugins.
   `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
- ------------------------+-----------------------------------------------
+  `frozen`                 | Do not remove and do not update unless explicitly specified
+ ------------------------+------------------------------------------------------------
 
 
-< Global options >____________________________________________________________~
-                                                           *plug-global-options*
+GLOBAL OPTIONS                                             *plug-global-options*
+==============================================================================
 
      *g:plug_threads* *g:plug_timeout* *g:plug_retries* *g:plug_shallow* *g:plug_window*
                                               *g:plug_pwindow* *g:plug_url_format*
@@ -232,16 +268,14 @@ Reload .vimrc and `:PlugInstall` to install plugins.
   `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)
   `g:plug_shallow`     | 1                                 | Use shallow clone
-  `g:plug_window`      |  `vertical topleft new`             | Command to open plug window
-  `g:plug_pwindow`     |  `above 12new`                      | Command to open preview window in  `PlugDiff`
+  `g:plug_window`      |  `-tabnew`                          | Command to open plug window
+  `g:plug_pwindow`     |  `vertical rightbelow new`          | Command to open preview window in  `PlugDiff`
   `g:plug_url_format`  |  `https://git::@github.com/%s.git`  |  `printf`  format to build repo URL (Only applies to the subsequent  `Plug`  commands)
  --------------------+-----------------------------------+-----------------------------------------------------------------------------------
 
 
-< Keybindings >_______________________________________________________________~
-                                                              *plug-keybindings*
-
-                                                         *:PlugStatus* *:PlugDiff*
+KEYBINDINGS                                                   *plug-keybindings*
+==============================================================================
 
  - `D` - `PlugDiff`
  - `S` - `PlugStatus`
@@ -254,19 +288,75 @@ Reload .vimrc and `:PlugInstall` to install plugins.
    - `X` - Revert the update
 
 
-< Example: A small sensible Vim configuration >_______________________________~
-                               *plug-example-a-small-sensible-vim-configuration*
+POST-UPDATE HOOKS                                       *plug-post-update-hooks*
+==============================================================================
+
+There are some plugins that require extra steps after installation or update.
+In that case, use the `do` option to describe the task to be performed.
 >
-    call plug#begin()
-    Plug 'tpope/vim-sensible'
-    call plug#end()
+    Plug 'Shougo/vimproc.vim', { 'do': 'make' }
+    Plug 'ycm-core/YouCompleteMe', { 'do': './install.py' }
+<
+If the value starts with `:`, it will be recognized as a Vim command.
+>
+    Plug 'fatih/vim-go', { 'do': ':GoInstallBinaries' }
+<
+To call a Vim function, you can pass a lambda expression like so:
+>
+    Plug 'junegunn/fzf', { 'do': { -> fzf#install() } }
+<
+If you need more control, you can pass a reference to a Vim function that
+takes a dictionary argument.
+>
+    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
+    endfunction
+
+    Plug 'ycm-core/YouCompleteMe', { 'do': function('BuildYCM') }
+<
+A post-update hook is 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!`.
+
+[!TIP] Make sure to escape BARs and double-quotes when you write the `do`
+option inline as they are mistakenly recognized as command separator or the
+start of the trailing comment.
+>
+    Plug 'junegunn/fzf', { 'do': 'yes \| ./install' }
+<
+But you can avoid the escaping if you extract the inline specification using a
+variable (or any Vim script expression) as follows:
+>
+    let g:fzf_install = 'yes | ./install'
+    Plug 'junegunn/fzf', { 'do': g:fzf_install }
 <
 
-< On-demand loading of plugins >______________________________________________~
-                                             *plug-on-demand-loading-of-plugins*
+< PlugInstall! and PlugUpdate! >______________________________________________~
+                                                    *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 the `!` suffix ensure that all steps are run
+unconditionally.
+
+
+ON-DEMAND LOADING OF PLUGINS                 *plug-on-demand-loading-of-plugins*
+==============================================================================
 >
     " NERD tree will be loaded on the first invocation of NERDTreeToggle command
-    Plug 'scrooloose/nerdtree', { 'on': 'NERDTreeToggle' }
+    Plug 'preservim/nerdtree', { 'on': 'NERDTreeToggle' }
 
     " Multiple commands
     Plug 'junegunn/vim-github-dashboard', { 'on': ['GHDashboard', 'GHActivity'] }
@@ -284,93 +374,55 @@ Reload .vimrc and `:PlugInstall` to install plugins.
     Plug 'junegunn/goyo.vim', { 'for': 'markdown' }
     autocmd! User goyo.vim echom 'Goyo is now loaded!'
 <
-`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.
+[!NOTE] #### Should I set up on-demand loading?
 
+You probably don't need to.
 
-< Post-update hooks >_________________________________________________________~
-                                                        *plug-post-update-hooks*
+A properly implemented Vim plugin should already load lazily without any help
+from a plugin manager (`:help autoload`). So there are few cases where these
+options actually make much sense. Making a plugin load faster is the
+responsibility of the plugin developer, not the user. If you find a plugin
+that takes too long to load, consider opening an issue on the plugin's issue
+tracker.
 
-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.
+Let me give you a perspective. The time it takes to load a plugin is usually
+less than 2 or 3ms on modern computers. So unless you use a very large number
+of plugins, you are unlikely to save more than 50ms. If you have spent an hour
+carefully setting up the options to shave off 50ms, you will have to start Vim
+72,000 times just to break even. You should ask yourself if that's a good
+investment of your time.
+
+Make sure that you're tackling the right problem by breaking down the startup
+time of Vim using `--startuptime`.
 >
-    Plug 'Shougo/vimproc.vim', { 'do': 'make' }
-    Plug 'Valloric/YouCompleteMe', { 'do': './install.py' }
+    vim --startuptime /tmp/log
 <
-If the value starts with `:`, it will be recognized as a Vim command.
+On-demand loading should only be used as a last resort. It is basically a
+hacky workaround and is not always guaranteed to work.
 
-                                                            *:GoInstallBinaries*
->
-    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.
->
-    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
-    endfunction
+                                                                     *plug#load*
 
-    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!`.
+[!TIP] You can pass an empty list to `on` or `for` option to disable the
+loading of the plugin. You can manually load the plugin using
+`plug#load(NAMES...)` function.
 
-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.
->
-    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:
-
-                                                                 *g:fzf_install*
->
-    let g:fzf_install = 'yes | ./install'
-    Plug 'junegunn/fzf', { 'do': g:fzf_install }
-<
-
-< PlugInstall! and PlugUpdate! >______________________________________________~
-                                                    *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.
+See https://github.com/junegunn/vim-plug/wiki/tips#loading-plugins-manually
 
 
-< Articles >__________________________________________________________________~
-                                                                 *plug-articles*
+COLLABORATORS                                               *plug-collaborators*
+==============================================================================
 
- - {Writing my own Vim plugin manager}{11}
- - {Vim plugins and startup time}{12}
- - ~~{Thoughts on Vim plugin dependency}{13}~~
-   - Support for Plugfile has been removed since 0.5.0
+ - {Jan Edmund Lazo}{7} - Windows support
+ - {Jeremy Pallats}{8} - Python installer
 
-             {11} http://junegunn.kr/2013/09/writing-my-own-vim-plugin-manager
-             {12} http://junegunn.kr/2014/07/vim-plugins-and-startup-time
-             {13} http://junegunn.kr/2013/09/thoughts-on-vim-plugin-dependency
+                                           {7} https://github.com/janlazo
+                                           {8} https://github.com/starcraftman
 
 
-< License >___________________________________________________________________~
-                                                                  *plug-license*
+LICENSE                                                           *plug-license*
+==============================================================================
 
 MIT
 
-
 ==============================================================================
 vim:tw=78:sw=2:ts=2:ft=help:norl:nowrap:

test/functional.vader

@@ -0,0 +1,41 @@
+Execute (plug#shellescape() works without optional arguments):
+  if has('unix')
+    AssertEqual "''", plug#shellescape("")
+    AssertEqual "'foo'\\'''", plug#shellescape("foo'")
+  endif
+
+Execute (plug#shellescape() ignores invalid optional argument):
+  if has('unix')
+    AssertEqual "''", plug#shellescape("", '')
+    AssertEqual "'foo'\\'''", plug#shellescape("foo'", [])
+  endif
+
+Execute (plug#shellescape() depends on the shell):
+  AssertEqual "'foo'\\'''", plug#shellescape("foo'", {'shell': 'sh'})
+  AssertEqual '^"foo''^"', plug#shellescape("foo'", {'shell': 'cmd.exe'})
+  AssertEqual "'foo'''", plug#shellescape("foo'", {'shell': 'powershell'})
+  AssertEqual "'foo'''", plug#shellescape("foo'", {'shell': 'powershell.exe'})
+  AssertEqual "'foo'''", plug#shellescape("foo'", {'shell': 'pwsh'})
+
+Execute (plug#shellescape() supports non-trivial cmd.exe escaping):
+  " batchfile
+  AssertEqual '^"^^%%PATH^^%%^"', plug#shellescape("^%PATH^%", {
+  \ 'shell': 'cmd.exe',
+  \ })
+  AssertEqual '^"^^%%PATH^^%%^"', plug#shellescape("^%PATH^%", {
+  \ 'shell': 'cmd.exe',
+  \ 'script': 1,
+  \ })
+  " command prompt
+  AssertEqual '^"^^^%PATH^^^%^"', plug#shellescape("^%PATH^%", {
+  \ 'shell': 'cmd.exe',
+  \ 'script': 0,
+  \ }),
+
+Execute (plug#shellescape() supports non-trivial powershell.exe escaping):
+  AssertEqual '''\"Foo\\''''\\Bar\"''', plug#shellescape('"Foo\''\Bar"', {
+  \ 'shell': 'powershell',
+  \ }),
+  AssertEqual '''\"Foo\\''''\\Bar\"''', plug#shellescape('"Foo\''\Bar"', {
+  \ 'shell': 'powershell.exe',
+  \ }),

test/run

@@ -62,7 +62,7 @@ EOF
 
 gitinit() (
   cd "$PLUG_FIXTURES/$1"
-  git init
+  git init -b master
   git commit -m 'commit' --allow-empty
 )
 
@@ -91,9 +91,14 @@ DOC
   echo "echomsg 'ftplugin-c'" > "$PLUG_FIXTURES/ftplugin-msg/ftplugin/c.vim"
   echo "echomsg 'ftplugin-java'" > "$PLUG_FIXTURES/ftplugin-msg/ftplugin/java.vim"
 
+  chmod +w "$PLUG_FIXTURES/cant-delete/autoload" || rm -rf "$PLUG_FIXTURES/cant-delete"
+  mkdir -p "$PLUG_FIXTURES/cant-delete/autoload"
+  touch "$PLUG_FIXTURES/cant-delete/autoload/cant-delete.vim"
+  chmod -w "$PLUG_FIXTURES/cant-delete/autoload"
+
   rm -rf $TEMP/new-branch
   cd $TEMP
-  git init new-branch
+  git init new-branch -b master
   cd new-branch
   mkdir plugin
   echo 'let g:foo = 1' > plugin/foo.vim
@@ -122,9 +127,11 @@ git --version
 vim=$(select_vim)
 echo "Selected Vim: $vim"
 if [ "${1:-}" = '!' ]; then
-  $vim -Nu $TEMP/mini-vimrc -c 'Vader! test.vader' > /dev/null &&
-  prepare &&
-  $vim -Nu $TEMP/mini-vimrc -c 'let g:plug_threads = 1 | Vader! test.vader' > /dev/null
+  FAIL=0
+  $vim -Nu $TEMP/mini-vimrc -c 'Vader! test.vader' > /dev/null || FAIL=1
+  prepare
+  $vim -Nu $TEMP/mini-vimrc -c 'let g:plug_threads = 1 | Vader! test.vader' > /dev/null || FAIL=1
+  test $FAIL -eq 0
 else
   $vim -Nu $TEMP/mini-vimrc -c 'Vader test.vader'
 fi

test/test.vader

@@ -18,10 +18,6 @@ Execute (Initialize test environment):
   \ ['function! ResetPlug()', 'let s:loaded = {}', 'endfunction',
   \  'function! CompareURI(a, b)', 'return s:compare_git_uri(a:a, a:b)', 'endfunction']
 
-  if $ENV != 'vim8'
-    call add(patch, 'let s:vim8 = 0')
-  endif
-
   call writefile(extend(readfile($PLUG_TMP), patch), $PLUG_TMP)
 
   set t_Co=256
@@ -90,6 +86,7 @@ Execute (Print Interpreter Version):
 
 Include: workflow.vader
 Include: regressions.vader
+Include: functional.vader
 
 Execute (Cleanup):
   silent! call RmRf(g:temp_plugged)

test/workflow.vader

@@ -2,7 +2,7 @@ Execute (plug#end() before plug#begin() should fail):
   redir => out
   silent! AssertEqual 0, plug#end()
   redir END
-  Assert stridx(out, 'Call plug#begin() first') >= 0
+  Assert stridx(out, 'plug#end() called without calling plug#begin() first') >= 0
 
 Execute (plug#begin() without path argument):
   call plug#begin()
@@ -49,24 +49,32 @@ Execute (Test Plug command):
   AssertEqual 'no-t_co', g:plugs['seoul256.vim'].branch
 
 ^ Git repo with tag (DEPRECATED. USE TAG OPTION)
+  redir => out
+  silent Plug 'foo/bar.vim', ''
+  redir END
+  Assert out =~ 'Invalid argument for "tag" option of :Plug (expected: string)'
   Plug 'junegunn/goyo.vim', '1.5.2'
   AssertEqual 'file:///tmp/vim-plug-test/junegunn/goyo.vim', g:plugs['goyo.vim'].uri
   AssertEqual join([g:temp_plugged, 'goyo.vim/'], '/'), g:plugs['goyo.vim'].dir
   AssertEqual '1.5.2', g:plugs['goyo.vim'].tag
 
+  redir => out
+  silent Plug 'foo/bar.vim', {'tag': ''}
+  redir END
+  Assert out =~ 'Invalid argument for "tag" option of :Plug (expected: string)'
   Plug 'junegunn/goyo.vim', { 'tag': '1.5.3' } " Using tag option
   AssertEqual '1.5.3', g:plugs['goyo.vim'].tag
 
   " Git URI
   Plug 'file:///tmp/vim-plug-test/jg/vim-emoji'
   AssertEqual 'file:///tmp/vim-plug-test/jg/vim-emoji', g:plugs['vim-emoji'].uri
-  AssertEqual 'master', g:plugs['vim-emoji'].branch
+  AssertEqual '', g:plugs['vim-emoji'].branch
   AssertEqual join([g:temp_plugged, 'vim-emoji/'], '/'), g:plugs['vim-emoji'].dir
 
   " vim-scripts/
   Plug 'vim-scripts/beauty256'
   AssertEqual 'file:///tmp/vim-plug-test/vim-scripts/beauty256', g:plugs.beauty256.uri
-  AssertEqual 'master', g:plugs.beauty256.branch
+  AssertEqual '', g:plugs.beauty256.branch
 
   AssertEqual 4, len(g:plugs)
 
@@ -77,6 +85,26 @@ Execute (Test Plug command):
 
 Execute (Plug command with dictionary option):
   Log string(g:plugs)
+  for opt in ['branch', 'tag', 'commit', 'rtp', 'dir', 'as']
+    let opts = {}
+    let opts[opt] = ''
+    redir => out
+    silent Plug 'foo/bar.vim', opts
+    redir END
+    Assert out =~ 'Invalid argument for "'.opt.'" option of :Plug (expected: string)'
+  endfor
+  for opt in ['on', 'for']
+    let opts = {}
+    let opts[opt] = ''
+    redir => out
+    silent Plug 'foo/bar.vim', opts
+    redir END
+    Assert out =~ 'Invalid argument for "'.opt.'" option of :Plug (expected: string or list)'
+  endfor
+  redir => out
+  silent Plug 'foo/bar.vim', {'do': ''}
+  redir END
+  Assert out =~ 'Invalid argument for "do" option of :Plug (expected: string or funcref)'
   Plug 'junegunn/seoul256.vim', { 'branch': 'no-t_co', 'rtp': '././' }
   AssertEqual join([g:temp_plugged, 'seoul256.vim/'], '/'), g:plugs['seoul256.vim'].dir
   AssertEqual '././', g:plugs['seoul256.vim'].rtp
@@ -343,6 +371,9 @@ Execute (PlugDiff - 'No updates.'):
   q
 
 Execute (New commits on remote, PlugUpdate, then PlugDiff):
+  let g:plug_window = 'vertical topleft new'
+  let g:plug_pwindow = 'above 12new'
+
   for repo in ['seoul256.vim', 'vim-emoji']
     for _ in range(2)
       call system(printf('cd /tmp/vim-plug-test/junegunn/%s && git commit --allow-empty -m "update"', repo))
@@ -354,6 +385,7 @@ Execute (New commits on remote, PlugUpdate, then PlugDiff):
   " Now we have updates
   normal D
   AssertEqual '2 plugin(s) updated.', getline(1)
+  AssertThrows execute('/gpg')
 
   " Preview commit
   silent! wincmd P
@@ -364,6 +396,14 @@ Execute (New commits on remote, PlugUpdate, then PlugDiff):
   let lnum = line('.')
   AssertEqual 3, col('.')
 
+  " Open full diff (empty)
+  execute "normal \<cr>"
+  wincmd P
+  AssertEqual 1, &previewwindow
+  AssertEqual 'git', &filetype
+  AssertEqual [''], getline(1, '$')
+  pclose
+
   " Open commit preview
   execute "normal j\<cr>"
   wincmd P
@@ -399,13 +439,17 @@ Execute (New commits on remote, PlugUpdate, then PlugDiff):
   execute "normal Xy\<cr>"
   AssertExpect '^- ', 1
 
-  " q will close preview window as well
+  " q will only close preview window
   normal q
 
   " We no longer have preview window
   silent! wincmd P
   AssertEqual 0, &previewwindow
 
+  " And we're still on main vim-plug window
+  AssertEqual 'vim-plug', &filetype
+  normal q
+
   " q should not close preview window if it's already open
   pedit
   PlugDiff
@@ -417,6 +461,8 @@ Execute (New commits on remote, PlugUpdate, then PlugDiff):
   AssertEqual 1, &previewwindow
   pclose
 
+  unlet g:plug_window g:plug_pwindow
+
 Execute (Test g:plug_pwindow):
   let g:plug_pwindow = 'below 5new'
   PlugDiff
@@ -430,6 +476,11 @@ Execute (Test g:plug_pwindow):
   AssertEqual 2, winnr()
   AssertEqual 5, winheight('.')
   wincmd p
+
+  " Close preview window
+  normal q
+
+  " Close main window
   normal q
   unlet g:plug_pwindow
 
@@ -537,6 +588,51 @@ Execute (PlugDiff):
   Assert !empty(mapcheck("\<cr>"))
   q
 
+Execute (Do not show diff for commits outside of rtp):
+  call plug#begin()
+  call plug#end()
+  PlugClean!
+
+  call plug#begin()
+  Plug 'file://'.expand('$PLUG_FIXTURES').'/xxx'
+  Plug 'file://'.expand('$PLUG_FIXTURES').'/yyy', { 'rtp': 'rtp' }
+  call plug#end()
+  PlugInstall
+  Log getline(1, '$')
+
+  call system('cd "$PLUG_FIXTURES/xxx" && git commit --allow-empty -m update-xxx && git tag -f xxx')
+  call system('cd "$PLUG_FIXTURES/yyy" && git commit --allow-empty -m update-yyy && git tag -f yyy')
+
+  let g:plugs.yyy.tag = 'yyy'
+  PlugUpdate
+  Log getline(1, '$')
+
+  PlugDiff
+  " 1 plugin(s) updated.
+  " [==]
+  "
+  " Last update:
+  " ------------
+  "
+  " - xxx:
+  "   * 7faa9b2 update-xxx (0 seconds ago)
+  "
+  " Pending updates:
+  " ----------------
+  "
+  " N/A
+  "
+  Log getline(1, '$')
+  AssertEqual 14, line('$')
+  AssertEqual '1 plugin(s) updated.', getline(1)
+  AssertEqual '[==]', getline(2)
+  AssertEqual 'Last update:', getline(4)
+  AssertEqual '- xxx:', getline(7)
+  Assert !empty(mapcheck('o'))
+  Assert !empty(mapcheck('X'))
+  Assert !empty(mapcheck("\<cr>"))
+  q
+
 **********************************************************************
 ~ On-demand loading / Partial installation/update ~
 **********************************************************************
@@ -708,6 +804,14 @@ Execute (Check &rtp after SomeCommand):
   AssertEqual g:first_rtp, split(&rtp, ',')[0]
   AssertEqual g:last_rtp, split(&rtp, ',')[-1]
 
+Execute (PlugClean should not care about frozen plugins):
+  call plug#begin()
+  Plug 'xxx/vim-easy-align', { 'frozen': 1 }
+  call plug#end()
+  PlugClean
+  AssertExpect 'Already clean', 1
+  q
+
 Execute (Common parent):
   call plug#begin()
   Plug 'junegunn/vim-pseudocl'
@@ -892,7 +996,8 @@ Execute (PlugInstall!):
   Assert filereadable(g:plugs['vim-easy-align'].dir.'/installed2'),
     \ 'vim-easy-align/installed2 should exist'
   AssertEqual '7f8cd78cb1fe52185b98b16a3749811f0cc508af', GitCommit('vim-pseudocl')
-  AssertEqual 'no-t_co', GitBranch('seoul256.vim')
+  " Was updated to the default branch of origin by previous PlugUpdate
+  AssertEqual 'master', GitBranch('seoul256.vim')
   AssertEqual '1.5.3', GitTag('goyo.vim')
 
 Execute (When submodules are not initialized):
@@ -991,9 +1096,10 @@ Execute (Post-update hook output; success and failure):
 
 Execute (Post-update hook output; invalid type or funcref):
   call plug#begin()
-  Plug 'junegunn/vim-easy-align', { 'do': 1 }
+  Plug 'junegunn/vim-easy-align', { 'do': ':echo 1' }
   Plug 'junegunn/vim-pseudocl',   { 'do': function('call') }
   call plug#end()
+  let g:plugs['vim-easy-align'].do = 1
 
   silent PlugInstall! 1
   AssertEqual 'x Post-update hook for vim-pseudocl ... Vim(call):E119: Not enough arguments for function: call', getline(5)
@@ -1397,6 +1503,7 @@ Execute (PlugClean should not try to remove unmanaged plugins inside g:plug_home
   Plug '$PLUG_FIXTURES/fzf'
   Plug '$PLUG_FIXTURES/xxx'
   Plug '$PLUG_FIXTURES/yyy'
+  Plug '$PLUG_FIXTURES/cant-delete'
   call plug#end()
 
   " Remove z1, z2
@@ -1535,10 +1642,12 @@ Execute (Commit hash support):
   Assert empty(mapcheck('X'))
   Assert !empty(mapcheck("\<cr>"))
 
-  " Nor in PlugSnapshot output
+  " The exact hash values in PlugSnapshot output
   PlugSnapshot
   Log getline(1, '$')
-  AssertEqual 8, line('$')
+  AssertEqual "silent! let g:plugs['goyo.vim'].commit = 'ffffffff'", getline(6)
+  AssertEqual "silent! let g:plugs['vim-emoji'].commit = '9db7fcfee0d90dafdbcb7a32090c0a9085eb054a'", getline(7)
+  AssertEqual 10, line('$')
   q
 
 Execute (Commit hash support - cleared):
@@ -1613,6 +1722,8 @@ Execute (#530 - Comparison of incompatible git URIs):
   Assert !CompareURI('https://github.com/junegunn/vim-plug.git', 'https://github.com:12345/junegunn/vim-plug.git')
 
 Execute (#532 - Reuse plug window):
+  let g:plug_window = 'vertical topleft new'
+  let g:plug_pwindow = 'above 12new'
   call plug#begin()
   Plug 'junegunn/goyo.vim'
   call plug#end()
@@ -1639,6 +1750,8 @@ Execute (#532 - Reuse plug window):
   AssertEqual 2, winnr('$'), 'Three windows after PlugStatus (but got '.winnr('$').')'
   q
 
+  unlet g:plug_window g:plug_pwindow
+
 Execute (#766 - Allow cloning into an empty directory):
   let d = '/tmp/vim-plug-test/goyo-already'
   call system('rm -rf ' . d)
@@ -1650,3 +1763,25 @@ Execute (#766 - Allow cloning into an empty directory):
   AssertExpect! '[=]', 1
   q
   unlet d
+
+Execute (#982 - PlugClean should report when directories cannot be removed):
+  call plug#begin('$PLUG_FIXTURES')
+  Plug '$PLUG_FIXTURES/ftplugin-msg', { 'for': [] }
+  Plug '$PLUG_FIXTURES/fzf'
+  Plug '$PLUG_FIXTURES/xxx'
+  Plug '$PLUG_FIXTURES/yyy'
+  call plug#end()
+
+  " Fail to remove cant-delete
+  PlugClean!
+  AssertEqual 'Removed 0 directories. Failed to remove 1 directories.', getline(4)
+  AssertExpect '^x ', 1
+  q
+
+  " Delete tmp but fail to remove cant-delete
+  call mkdir(expand('$PLUG_FIXTURES/tmp'))
+  PlugClean!
+  AssertEqual 'Removed 1 directories. Failed to remove 1 directories.', getline(4)
+  AssertExpect '^x ', 1
+  AssertExpect '^\~ ', 1
+  q