Compare commits
No commits in common. "master" and "0.7.2" have entirely different histories.
1
.github/FUNDING.yml
vendored
1
.github/FUNDING.yml
vendored
|
|
@ -1 +0,0 @@
|
||||||
github: junegunn
|
|
||||||
37
.github/ISSUE_TEMPLATE.md
vendored
37
.github/ISSUE_TEMPLATE.md
vendored
|
|
@ -1,37 +0,0 @@
|
||||||
<!--
|
|
||||||
### Before Submitting
|
|
||||||
|
|
||||||
- You checked the [faq](https://github.com/junegunn/vim-plug/wiki/faq) for common problems.
|
|
||||||
- Check your [requirements](https://github.com/junegunn/vim-plug/wiki/requirements) are satisfied.
|
|
||||||
- You are not going to suggest vim-plug manage itself like Vundle, see #240, #364, #367 ...
|
|
||||||
-->
|
|
||||||
|
|
||||||
Explain the problem here ...
|
|
||||||
|
|
||||||
------------------------------
|
|
||||||
|
|
||||||
<!-- Paste your Plug block (from `call plug#begin()` to `call plug#end()`) -->
|
|
||||||
```
|
|
||||||
|
|
||||||
```
|
|
||||||
|
|
||||||
<!-- Paste the contents of `:version` below -->
|
|
||||||
```
|
|
||||||
|
|
||||||
```
|
|
||||||
|
|
||||||
<!-- Check all that apply. -->
|
|
||||||
- Type:
|
|
||||||
- [ ] Bug
|
|
||||||
- [ ] Enhancement
|
|
||||||
- [ ] Feature Request
|
|
||||||
- [ ] Question
|
|
||||||
- OS:
|
|
||||||
- [ ] All/Other
|
|
||||||
- [ ] Linux
|
|
||||||
- [ ] macOS
|
|
||||||
- [ ] Windows
|
|
||||||
- Vim:
|
|
||||||
- [ ] Terminal Vim
|
|
||||||
- [ ] GVim
|
|
||||||
- [ ] Neovim
|
|
||||||
8
.github/PULL_REQUEST_TEMPLATE.md
vendored
8
.github/PULL_REQUEST_TEMPLATE.md
vendored
|
|
@ -1,8 +0,0 @@
|
||||||
<!-- ## Before Submitting
|
|
||||||
|
|
||||||
- You made sure the existing tests/travis build works.
|
|
||||||
- You made sure any new features were tested where appropriate.
|
|
||||||
- You checked a similar feature wasn't already turned down by searching issues & PRs.
|
|
||||||
-->
|
|
||||||
|
|
||||||
Describe the details of your PR ...
|
|
||||||
52
.github/workflows/test.yml
vendored
52
.github/workflows/test.yml
vendored
|
|
@ -1,52 +0,0 @@
|
||||||
---
|
|
||||||
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 !
|
|
||||||
1
.gitignore
vendored
1
.gitignore
vendored
|
|
@ -1 +0,0 @@
|
||||||
doc/tags
|
|
||||||
100
.travis.yml
100
.travis.yml
|
|
@ -1,71 +1,35 @@
|
||||||
language: minimal
|
language: ruby
|
||||||
env:
|
rvm:
|
||||||
global:
|
- 1.8.7
|
||||||
- DEPS=$HOME/deps
|
- 1.9.2 # Test with vim-nox package on ubuntu
|
||||||
- PATH=$DEPS/bin:$PATH
|
- 1.9.3 # Test against python installer
|
||||||
jobs:
|
- 2.0.0
|
||||||
include:
|
- 2.1.0 # Test against python3 installer
|
||||||
- env: ENV=vim80-bionic
|
|
||||||
dist: bionic
|
before_script: |
|
||||||
stage: vim8
|
sudo apt-get update -y
|
||||||
- env: ENV=vim-nightly
|
if [ $(ruby -e 'puts RUBY_VERSION') = 1.9.2 ]; then
|
||||||
dist: trusty
|
sudo apt-get install -y vim-nox
|
||||||
stage: vim8
|
sudo ln -s /usr/bin/vim /usr/local/bin/vim
|
||||||
- env: ENV=neovim-stable
|
else
|
||||||
dist: bionic
|
git clone --depth 1 https://github.com/vim/vim
|
||||||
addons: {apt: {packages: [neovim], sources: [{sourceline: 'ppa:neovim-ppa/stable'}]}}
|
cd vim
|
||||||
stage: neovim
|
if [ $(ruby -e 'puts RUBY_VERSION') = 1.9.3 ]; then
|
||||||
- env: ENV=neovim-nightly
|
sudo apt-get install -y python2.7-dev
|
||||||
dist: bionic
|
./configure --with-features=huge --enable-pythoninterp
|
||||||
addons: {apt: {packages: [neovim], sources: [{sourceline: 'ppa:neovim-ppa/unstable'}]}}
|
elif [ $(ruby -e 'puts RUBY_VERSION') = 2.1.0 ]; then
|
||||||
stage: neovim
|
sudo apt-get install -y python3-dev
|
||||||
- env: ENV=vim74-trusty-python
|
./configure --with-features=huge --enable-python3interp
|
||||||
dist: trusty
|
else
|
||||||
stage: vim74
|
./configure --with-features=huge --enable-rubyinterp
|
||||||
- env: ENV=vim74-xenial-python3
|
fi
|
||||||
dist: xenial
|
make
|
||||||
stage: vim74
|
sudo make install
|
||||||
- env: ENV=vim74-trusty-ruby
|
cd -
|
||||||
dist: trusty
|
fi
|
||||||
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.email "you@example.com"
|
||||||
git config --global user.name "Your Name"
|
git config --global user.name "Your Name"
|
||||||
|
|
||||||
C_OPTS="--prefix=$DEPS --with-features=huge --disable-gui "
|
script: |
|
||||||
case "$ENV" in
|
test/run !
|
||||||
vim-*)
|
|
||||||
;;
|
|
||||||
neovim-*)
|
|
||||||
mkdir -p ${DEPS}/bin
|
|
||||||
ln -s /usr/bin/nvim ${DEPS}/bin/vim
|
|
||||||
export VADER_OUTPUT_FILE=/dev/stderr
|
|
||||||
return
|
|
||||||
;;
|
|
||||||
vim74-* | vim80-*)
|
|
||||||
mkdir -p ${DEPS}/bin
|
|
||||||
ln -s /usr/bin/vim.nox ${DEPS}/bin/vim
|
|
||||||
return
|
|
||||||
;;
|
|
||||||
*)
|
|
||||||
return
|
|
||||||
;;
|
|
||||||
esac
|
|
||||||
|
|
||||||
git clone --depth 1 https://github.com/vim/vim
|
|
||||||
cd vim
|
|
||||||
export PATH=/usr/bin:$PATH
|
|
||||||
./configure $C_OPTS
|
|
||||||
make
|
|
||||||
make install
|
|
||||||
cd -
|
|
||||||
script: test/run !
|
|
||||||
|
|
|
||||||
21
LICENSE
21
LICENSE
|
|
@ -1,21 +0,0 @@
|
||||||
MIT License
|
|
||||||
|
|
||||||
Copyright (c) 2017 Junegunn Choi
|
|
||||||
|
|
||||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
||||||
of this software and associated documentation files (the "Software"), to deal
|
|
||||||
in the Software without restriction, including without limitation the rights
|
|
||||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
||||||
copies of the Software, and to permit persons to whom the Software is
|
|
||||||
furnished to do so, subject to the following conditions:
|
|
||||||
|
|
||||||
The above copyright notice and this permission notice shall be included in all
|
|
||||||
copies or substantial portions of the Software.
|
|
||||||
|
|
||||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
||||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
||||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
||||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
||||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
||||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
||||||
SOFTWARE.
|
|
||||||
471
README.md
471
README.md
|
|
@ -1,302 +1,95 @@
|
||||||
<div align="center">
|
<img src="https://raw.githubusercontent.com/junegunn/vim-plug/master/plug.png" height="75" alt="vim-plug">[](https://travis-ci.org/junegunn/vim-plug)
|
||||||
<sup>Special thanks to:</sup>
|
===
|
||||||
<br>
|
|
||||||
<br>
|
|
||||||
<a href="https://warp.dev/?utm_source=github&utm_medium=referral&utm_campaign=vimplug_20240209">
|
|
||||||
<div>
|
|
||||||
<img src="https://raw.githubusercontent.com/junegunn/i/master/warp.png" width="300" alt="Warp">
|
|
||||||
</div>
|
|
||||||
<b>Warp is a modern, Rust-based terminal with AI built in so you and your team can build great software, faster.</b>
|
|
||||||
<div>
|
|
||||||
<sup>Visit warp.dev to learn more.</sup>
|
|
||||||
</div>
|
|
||||||
</a>
|
|
||||||
<br>
|
|
||||||
<hr>
|
|
||||||
</div>
|
|
||||||
<br>
|
|
||||||
|
|
||||||
<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.
|
A minimalist Vim plugin manager.
|
||||||
|
|
||||||
<img src="https://raw.githubusercontent.com/junegunn/i/master/vim-plug/installer.gif" height="450">
|
<img src="https://raw.githubusercontent.com/junegunn/i/master/vim-plug/installer.gif" height="450">
|
||||||
|
|
||||||
## Pros.
|
### Pros.
|
||||||
|
|
||||||
- Minimalist design
|
- Easier to setup: Single file. No boilerplate code required.
|
||||||
- Just one file with no dependencies. Super easy to set up.
|
- Easier to use: Concise, intuitive syntax
|
||||||
- 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
|
- [Super-fast][40/4] parallel installation/update
|
||||||
|
(with any of `+python`, `+python3`, `+ruby`, or [Neovim][nv])
|
||||||
- Creates shallow clones to minimize disk space usage and download time
|
- Creates shallow clones to minimize disk space usage and download time
|
||||||
- On-demand loading for [faster startup time][startup-time]
|
- On-demand loading for [faster startup time][startup-time]
|
||||||
- Can review and rollback updates
|
- Can review and rollback updates
|
||||||
- Branch/tag/commit support
|
- Branch/tag support
|
||||||
- Post-update hooks
|
- Post-update hooks
|
||||||
- Support for externally managed plugins
|
- Support for externally managed plugins
|
||||||
|
|
||||||
[40/4]: https://raw.githubusercontent.com/junegunn/i/master/vim-plug/40-in-4.gif
|
[40/4]: https://raw.githubusercontent.com/junegunn/i/master/vim-plug/40-in-4.gif
|
||||||
[startup-time]: https://github.com/junegunn/vim-startuptime-benchmark#result
|
[nv]: http://neovim.org/
|
||||||
|
[startup-time]: http://junegunn.kr/images/vim-startup-time.png
|
||||||
|
|
||||||
## Installation
|
### Usage
|
||||||
|
|
||||||
[Download plug.vim](https://raw.githubusercontent.com/junegunn/vim-plug/master/plug.vim)
|
[Download plug.vim](https://raw.githubusercontent.com/junegunn/vim-plug/master/plug.vim)
|
||||||
and put it in the "autoload" directory.
|
and put it in ~/.vim/autoload
|
||||||
|
|
||||||
<details>
|
|
||||||
<summary>Click to see the instructions</summary>
|
|
||||||
|
|
||||||
### Vim
|
|
||||||
|
|
||||||
#### Unix
|
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
curl -fLo ~/.vim/autoload/plug.vim --create-dirs \
|
curl -fLo ~/.vim/autoload/plug.vim --create-dirs \
|
||||||
https://raw.githubusercontent.com/junegunn/vim-plug/master/plug.vim
|
https://raw.githubusercontent.com/junegunn/vim-plug/master/plug.vim
|
||||||
```
|
```
|
||||||
|
|
||||||
You can automate the process by putting the command in your Vim configuration
|
Edit your .vimrc
|
||||||
file as suggested [here][auto].
|
|
||||||
|
|
||||||
[auto]: https://github.com/junegunn/vim-plug/wiki/tips#automatic-installation
|
|
||||||
|
|
||||||
#### Windows (PowerShell)
|
|
||||||
|
|
||||||
```powershell
|
|
||||||
iwr -useb https://raw.githubusercontent.com/junegunn/vim-plug/master/plug.vim |`
|
|
||||||
ni $HOME/vimfiles/autoload/plug.vim -Force
|
|
||||||
```
|
|
||||||
|
|
||||||
### Neovim
|
|
||||||
|
|
||||||
#### Unix, Linux
|
|
||||||
|
|
||||||
```sh
|
|
||||||
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)
|
|
||||||
|
|
||||||
```powershell
|
|
||||||
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
|
```vim
|
||||||
call plug#begin()
|
call plug#begin('~/.vim/plugged')
|
||||||
|
|
||||||
" 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 more about the basics of vim-plug
|
|
||||||
- See [tips] and [FAQ] pages for common problems and questions
|
|
||||||
|
|
||||||
[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
|
|
||||||
|
|
||||||
## Examples
|
|
||||||
|
|
||||||
The following examples demonstrate the additional features of vim-plug.
|
|
||||||
|
|
||||||
### Vim script example
|
|
||||||
|
|
||||||
```vim
|
|
||||||
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
|
" Make sure you use single quotes
|
||||||
|
|
||||||
" Shorthand notation for GitHub; translates to https://github.com/junegunn/seoul256.vim.git
|
|
||||||
Plug 'junegunn/seoul256.vim'
|
Plug 'junegunn/seoul256.vim'
|
||||||
|
Plug 'junegunn/vim-easy-align'
|
||||||
|
|
||||||
" Any valid git URL is allowed
|
" Group dependencies, vim-snippets depends on ultisnips
|
||||||
Plug 'https://github.com/junegunn/vim-easy-align.git'
|
Plug 'SirVer/ultisnips' | Plug 'honza/vim-snippets'
|
||||||
|
|
||||||
" Using a tagged release; wildcard allowed (requires git 1.9.2 or above)
|
" On-demand loading
|
||||||
Plug 'fatih/vim-go', { 'tag': '*' }
|
Plug 'scrooloose/nerdtree', { 'on': 'NERDTreeToggle' }
|
||||||
|
|
||||||
" 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': { -> 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' }
|
Plug 'tpope/vim-fireplace', { 'for': 'clojure' }
|
||||||
|
|
||||||
|
" Using git URL
|
||||||
|
Plug 'https://github.com/junegunn/vim-github-dashboard.git'
|
||||||
|
|
||||||
|
" Plugin options
|
||||||
|
Plug 'nsf/gocode', { 'tag': 'v.20150303', 'rtp': 'vim' }
|
||||||
|
|
||||||
|
" Plugin outside ~/.vim/plugged with post-update hook
|
||||||
|
Plug 'junegunn/fzf', { 'dir': '~/.fzf', 'do': 'yes \| ./install' }
|
||||||
|
|
||||||
" Unmanaged plugin (manually installed and updated)
|
" Unmanaged plugin (manually installed and updated)
|
||||||
Plug '~/my-prototype-plugin'
|
Plug '~/my-prototype-plugin'
|
||||||
|
|
||||||
" Call plug#end to update &runtimepath and initialize the plugin system.
|
|
||||||
" - It automatically executes `filetype plugin indent on` and `syntax enable`
|
|
||||||
call plug#end()
|
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
|
|
||||||
```
|
```
|
||||||
|
|
||||||
### Lua example for Neovim
|
Reload .vimrc and `:PlugInstall` to install plugins.
|
||||||
|
|
||||||
In Neovim, you can write your configuration in a Lua script file named
|
### Commands
|
||||||
`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 |
|
| Command | Description |
|
||||||
| ----------------------------------- | ------------------------------------------------------------------ |
|
| ----------------------------------- | ------------------------------------------------------------------ |
|
||||||
| `PlugInstall [name ...] [#threads]` | Install plugins |
|
| `PlugInstall [name ...] [#threads]` | Install plugins |
|
||||||
| `PlugUpdate [name ...] [#threads]` | Install or update plugins |
|
| `PlugUpdate [name ...] [#threads]` | Install or update plugins |
|
||||||
| `PlugClean[!]` | Remove unlisted plugins (bang version will clean without prompt) |
|
| `PlugClean[!]` | Remove unused directories (bang version will clean without prompt) |
|
||||||
| `PlugUpgrade` | Upgrade vim-plug itself |
|
| `PlugUpgrade` | Upgrade vim-plug itself |
|
||||||
| `PlugStatus` | Check the status of plugins |
|
| `PlugStatus` | Check the status of plugins |
|
||||||
| `PlugDiff` | Examine changes from the previous update and the pending changes |
|
| `PlugDiff` | See the updated changes from the previous PlugUpdate |
|
||||||
| `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
|
||||||
|
|
||||||
| Option | Description |
|
| Option | Description |
|
||||||
| ----------------------- | ----------------------------------------------------------- |
|
| -------------- | ------------------------------------------------ |
|
||||||
| `branch`/`tag`/`commit` | Branch/tag/commit of the repository to use |
|
| `branch`/`tag` | Branch or tag of the repository to use |
|
||||||
| `rtp` | Subdirectory that contains Vim plugin |
|
| `rtp` | Subdirectory that contains Vim plugin |
|
||||||
| `dir` | Custom directory for the plugin |
|
| `dir` | Custom directory for the plugin |
|
||||||
| `as` | Use different name for the plugin |
|
|
||||||
| `do` | Post-update hook (string or funcref) |
|
| `do` | Post-update hook (string or funcref) |
|
||||||
| `on` | On-demand loading: Commands or `<Plug>`-mappings |
|
| `on` | On-demand loading: Commands or `<Plug>`-mappings |
|
||||||
| `for` | On-demand loading: File types |
|
| `for` | On-demand loading: File types |
|
||||||
| `frozen` | Do not remove and do not update unless explicitly specified |
|
| `frozen` | Do not update unless explicitly specified |
|
||||||
|
|
||||||
## Global options
|
### Global options
|
||||||
|
|
||||||
| Flag | Default | Description |
|
| Flag | Default | Description |
|
||||||
| ------------------- | --------------------------------- | ------------------------------------------------------ |
|
| ------------------- | --------------------------------- | ------------------------------------------------------ |
|
||||||
|
|
@ -304,100 +97,34 @@ vim.cmd('silent! colorscheme seoul256')
|
||||||
| `g:plug_timeout` | 60 | Time limit of each task in seconds (*Ruby & Python*) |
|
| `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_retries` | 2 | Number of retries in case of timeout (*Ruby & Python*) |
|
||||||
| `g:plug_shallow` | 1 | Use shallow clone |
|
| `g:plug_shallow` | 1 | Use shallow clone |
|
||||||
| `g:plug_window` | `-tabnew` | Command to open plug window |
|
| `g:plug_window` | `vertical topleft new` | 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 |
|
||||||
| `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`
|
- `D` - `PlugDiff`
|
||||||
- `S` - `PlugStatus`
|
- `S` - `PlugStatus`
|
||||||
- `R` - Retry failed update or installation tasks
|
- `R` - Retry failed update or installation tasks
|
||||||
- `U` - Update plugins in the selected range
|
- `U` - Update plugins in the selected range
|
||||||
- `q` - Abort the running tasks or close the window
|
- `q` - Close the window
|
||||||
- `:PlugStatus`
|
- `:PlugStatus`
|
||||||
- `L` - Load plugin
|
- `L` - Load plugin
|
||||||
- `:PlugDiff`
|
- `:PlugDiff`
|
||||||
- `X` - Revert the update
|
- `X` - Revert the update
|
||||||
|
|
||||||
## Post-update hooks
|
### Example: A small [sensible](https://github.com/tpope/vim-sensible) Vim configuration
|
||||||
|
|
||||||
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
|
```vim
|
||||||
Plug 'Shougo/vimproc.vim', { 'do': 'make' }
|
call plug#begin()
|
||||||
Plug 'ycm-core/YouCompleteMe', { 'do': './install.py' }
|
Plug 'tpope/vim-sensible'
|
||||||
|
call plug#end()
|
||||||
```
|
```
|
||||||
|
|
||||||
If the value starts with `:`, it will be recognized as a Vim command.
|
### On-demand loading of plugins
|
||||||
|
|
||||||
```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
|
```vim
|
||||||
" NERD tree will be loaded on the first invocation of NERDTreeToggle command
|
" NERD tree will be loaded on the first invocation of NERDTreeToggle command
|
||||||
Plug 'preservim/nerdtree', { 'on': 'NERDTreeToggle' }
|
Plug 'scrooloose/nerdtree', { 'on': 'NERDTreeToggle' }
|
||||||
|
|
||||||
" Multiple commands
|
" Multiple commands
|
||||||
Plug 'junegunn/vim-github-dashboard', { 'on': ['GHDashboard', 'GHActivity'] }
|
Plug 'junegunn/vim-github-dashboard', { 'on': ['GHDashboard', 'GHActivity'] }
|
||||||
|
|
@ -411,53 +138,75 @@ Plug 'kovisoft/paredit', { 'for': ['clojure', 'scheme'] }
|
||||||
" On-demand loading on both conditions
|
" On-demand loading on both conditions
|
||||||
Plug 'junegunn/vader.vim', { 'on': 'Vader', 'for': 'vader' }
|
Plug 'junegunn/vader.vim', { 'on': 'Vader', 'for': 'vader' }
|
||||||
|
|
||||||
" Code to execute when the plugin is lazily loaded on demand
|
" Code to execute when the plugin is loaded on demand
|
||||||
Plug 'junegunn/goyo.vim', { 'for': 'markdown' }
|
Plug 'Valloric/YouCompleteMe', { 'for': 'cpp' }
|
||||||
autocmd! User goyo.vim echom 'Goyo is now loaded!'
|
autocmd! User YouCompleteMe call youcompleteme#Enable()
|
||||||
```
|
```
|
||||||
|
|
||||||
> [!NOTE]
|
`for` option is generally not needed as most plugins for specific file types
|
||||||
> #### Should I set up on-demand loading?
|
usually don't have too much code in `plugin` directory. You might want to
|
||||||
>
|
examine the output of `vim --startuptime` before applying the option.
|
||||||
> 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.
|
|
||||||
|
|
||||||
> [!TIP]
|
### Post-update hooks
|
||||||
> 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.
|
||||||
|
|
||||||
## Collaborators
|
```vim
|
||||||
|
Plug 'Shougo/vimproc.vim', { 'do': 'make' }
|
||||||
|
Plug 'Valloric/YouCompleteMe', { 'do': './install.sh' }
|
||||||
|
```
|
||||||
|
|
||||||
- [Jan Edmund Lazo](https://github.com/janlazo) - Windows support
|
If you need more control, you can pass a reference to a Vim function that
|
||||||
- [Jeremy Pallats](https://github.com/starcraftman) - Python installer
|
takes a single argument.
|
||||||
|
|
||||||
## License
|
```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
|
||||||
|
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 }
|
||||||
|
```
|
||||||
|
|
||||||
|
### FAQ/Troubleshooting
|
||||||
|
|
||||||
|
See [FAQ/Troubleshooting](https://github.com/junegunn/vim-plug/wiki/faq).
|
||||||
|
|
||||||
|
### 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
|
||||||
|
|
||||||
MIT
|
MIT
|
||||||
|
|
||||||
|
|
|
||||||
428
doc/plug.txt
428
doc/plug.txt
|
|
@ -1,428 +0,0 @@
|
||||||
plug.txt plug Last change: Jun 1 2024
|
|
||||||
PLUG - TABLE OF CONTENTS *plug* *plug-toc*
|
|
||||||
==============================================================================
|
|
||||||
|
|
||||||
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.
|
|
||||||
|
|
||||||
|
|
||||||
PROS. *plug-pros*
|
|
||||||
==============================================================================
|
|
||||||
|
|
||||||
- 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}{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} https://github.com/junegunn/vim-startuptime-benchmark#result
|
|
||||||
|
|
||||||
|
|
||||||
INSTALLATION *plug-installation*
|
|
||||||
==============================================================================
|
|
||||||
|
|
||||||
{Download plug.vim}{3} and put it in the "autoload" directory.
|
|
||||||
|
|
||||||
{3} https://raw.githubusercontent.com/junegunn/vim-plug/master/plug.vim
|
|
||||||
|
|
||||||
|
|
||||||
USAGE *plug-usage*
|
|
||||||
==============================================================================
|
|
||||||
|
|
||||||
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. End the section with `call plug#end()`
|
|
||||||
|
|
||||||
For example,
|
|
||||||
>
|
|
||||||
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 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': { -> 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'
|
|
||||||
|
|
||||||
" 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
|
|
||||||
<
|
|
||||||
|
|
||||||
< 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#']
|
|
||||||
|
|
||||||
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 *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
|
|
||||||
-------------------------------------+------------------------------------------------------------------
|
|
||||||
|
|
||||||
|
|
||||||
PLUG OPTIONS *plug-options*
|
|
||||||
==============================================================================
|
|
||||||
|
|
||||||
*<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
|
|
||||||
`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 *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*
|
|
||||||
|
|
||||||
--------------------+-----------------------------------+-----------------------------------------------------------------------------------
|
|
||||||
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)
|
|
||||||
`g:plug_shallow` | 1 | Use shallow clone
|
|
||||||
`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*
|
|
||||||
==============================================================================
|
|
||||||
|
|
||||||
- `D` - `PlugDiff`
|
|
||||||
- `S` - `PlugStatus`
|
|
||||||
- `R` - Retry failed update or installation tasks
|
|
||||||
- `U` - Update plugins in the selected range
|
|
||||||
- `q` - Close the window
|
|
||||||
- `:PlugStatus`
|
|
||||||
- `L` - Load plugin
|
|
||||||
- `:PlugDiff`
|
|
||||||
- `X` - Revert the update
|
|
||||||
|
|
||||||
|
|
||||||
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.
|
|
||||||
>
|
|
||||||
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 }
|
|
||||||
<
|
|
||||||
|
|
||||||
< 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 'preservim/nerdtree', { 'on': 'NERDTreeToggle' }
|
|
||||||
|
|
||||||
" Multiple commands
|
|
||||||
Plug 'junegunn/vim-github-dashboard', { 'on': ['GHDashboard', 'GHActivity'] }
|
|
||||||
|
|
||||||
" Loaded when clojure file is opened
|
|
||||||
Plug 'tpope/vim-fireplace', { 'for': 'clojure' }
|
|
||||||
|
|
||||||
" Multiple file types
|
|
||||||
Plug 'kovisoft/paredit', { 'for': ['clojure', 'scheme'] }
|
|
||||||
|
|
||||||
" 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!'
|
|
||||||
<
|
|
||||||
[!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`.
|
|
||||||
>
|
|
||||||
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.
|
|
||||||
|
|
||||||
*plug#load*
|
|
||||||
|
|
||||||
[!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
|
|
||||||
|
|
||||||
|
|
||||||
COLLABORATORS *plug-collaborators*
|
|
||||||
==============================================================================
|
|
||||||
|
|
||||||
- {Jan Edmund Lazo}{7} - Windows support
|
|
||||||
- {Jeremy Pallats}{8} - Python installer
|
|
||||||
|
|
||||||
{7} https://github.com/janlazo
|
|
||||||
{8} https://github.com/starcraftman
|
|
||||||
|
|
||||||
|
|
||||||
LICENSE *plug-license*
|
|
||||||
==============================================================================
|
|
||||||
|
|
||||||
MIT
|
|
||||||
|
|
||||||
==============================================================================
|
|
||||||
vim:tw=78:sw=2:ts=2:ft=help:norl:nowrap:
|
|
||||||
BIN
plug-dark.png
BIN
plug-dark.png
Binary file not shown.
|
Before Width: | Height: | Size: 26 KiB |
|
|
@ -1,41 +0,0 @@
|
||||||
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',
|
|
||||||
\ }),
|
|
||||||
|
|
@ -1,6 +1,5 @@
|
||||||
**********************************************************************
|
**********************************************************************
|
||||||
Execute (#112 On-demand loading should not suppress messages from ftplugin):
|
Execute (#112 On-demand loading should not suppress messages from ftplugin):
|
||||||
call ResetPlug()
|
|
||||||
call plug#begin('$PLUG_FIXTURES')
|
call plug#begin('$PLUG_FIXTURES')
|
||||||
Plug '$PLUG_FIXTURES/ftplugin-msg', { 'for': 'c' }
|
Plug '$PLUG_FIXTURES/ftplugin-msg', { 'for': 'c' }
|
||||||
call plug#end()
|
call plug#end()
|
||||||
|
|
@ -8,20 +7,19 @@ Execute (#112 On-demand loading should not suppress messages from ftplugin):
|
||||||
redir => out
|
redir => out
|
||||||
tabnew a.c
|
tabnew a.c
|
||||||
redir END
|
redir END
|
||||||
Assert stridx(out, 'ftplugin-c') >= 0, 'Unexpected output (1): '.out
|
Assert stridx(out, 'ftplugin') >= 0
|
||||||
|
|
||||||
* The same applies to plug#load())
|
* The same applies to plug#load())
|
||||||
call ResetPlug()
|
|
||||||
redir => out
|
redir => out
|
||||||
call plug#load('ftplugin-msg')
|
call plug#load('ftplugin-msg')
|
||||||
redir END
|
redir END
|
||||||
Assert stridx(out, 'ftplugin-c') >= 0, 'Unexpected output (2): '.out
|
Assert stridx(out, 'ftplugin') >= 0
|
||||||
q
|
q
|
||||||
|
|
||||||
|
|
||||||
**********************************************************************
|
**********************************************************************
|
||||||
Execute (#114 Should not contain empty path in &rtp):
|
Execute (#114 Should not contain empty path in &rtp):
|
||||||
call plug#begin('/tmp/vim-plug-test/plugged')
|
call plug#begin('/tmp/plugged')
|
||||||
call plug#end()
|
call plug#end()
|
||||||
|
|
||||||
Log &rtp
|
Log &rtp
|
||||||
|
|
@ -37,11 +35,10 @@ Execute (#130 Proper cleanup of on-demand loading triggers):
|
||||||
|
|
||||||
" Cleared on command
|
" Cleared on command
|
||||||
call ReloadPlug()
|
call ReloadPlug()
|
||||||
call plug#begin('/tmp/vim-plug-test/plugged')
|
call plug#begin('/tmp/plugged')
|
||||||
Plug 'junegunn/vim-emoji', { 'on': ['EmojiCommand', 'EmojiCommand2', '<Plug>(EmojiMapping)'] }
|
Plug 'junegunn/vim-emoji', { 'on': ['EmojiCommand', 'EmojiCommand2', '<Plug>(EmojiMapping)'] }
|
||||||
call plug#end()
|
call plug#end()
|
||||||
PlugInstall | q
|
PlugInstall | q
|
||||||
call mkdir(g:plugs['vim-emoji'].dir.'/after/plugin', 'p')
|
|
||||||
|
|
||||||
Assert exists(':EmojiCommand'), 'EmojiCommand not defined'
|
Assert exists(':EmojiCommand'), 'EmojiCommand not defined'
|
||||||
Assert exists(':EmojiCommand2'), 'EmojiCommand2 not defined'
|
Assert exists(':EmojiCommand2'), 'EmojiCommand2 not defined'
|
||||||
|
|
@ -55,7 +52,7 @@ Execute (#130 Proper cleanup of on-demand loading triggers):
|
||||||
|
|
||||||
" Cleared on FileType
|
" Cleared on FileType
|
||||||
call ReloadPlug()
|
call ReloadPlug()
|
||||||
call plug#begin('/tmp/vim-plug-test/plugged')
|
call plug#begin('/tmp/plugged')
|
||||||
Plug 'junegunn/vim-emoji', { 'on': ['EmojiCommandExtra', '<Plug>(EmojiMappingExtra)'], 'for': ['emoji'] }
|
Plug 'junegunn/vim-emoji', { 'on': ['EmojiCommandExtra', '<Plug>(EmojiMappingExtra)'], 'for': ['emoji'] }
|
||||||
call plug#end()
|
call plug#end()
|
||||||
|
|
||||||
|
|
@ -81,32 +78,31 @@ Execute (#131 Syntax error):
|
||||||
**********************************************************************
|
**********************************************************************
|
||||||
Execute (#139-1 Using new remote branch):
|
Execute (#139-1 Using new remote branch):
|
||||||
" Make sure to remove the clone
|
" Make sure to remove the clone
|
||||||
call plug#begin('/tmp/vim-plug-test/plugged')
|
call plug#begin('/tmp/plugged')
|
||||||
call plug#end()
|
call plug#end()
|
||||||
PlugClean!
|
PlugClean!
|
||||||
|
|
||||||
" Install master branch
|
" Install master branch
|
||||||
call plug#begin('/tmp/vim-plug-test/plugged')
|
call plug#begin('/tmp/plugged')
|
||||||
Plug expand('file:////tmp/vim-plug-test/new-branch')
|
Plug expand('file:////tmp/new-branch')
|
||||||
call plug#end()
|
call plug#end()
|
||||||
PlugUpdate
|
PlugUpdate
|
||||||
|
|
||||||
unlet! g:foo g:bar g:baz
|
unlet! g:foo g:bar g:baz
|
||||||
call ResetPlug()
|
|
||||||
call plug#load('new-branch')
|
call plug#load('new-branch')
|
||||||
Assert exists('g:foo'), 'g:foo should be found (1)'
|
Assert exists('g:foo'), 'g:foo should be found'
|
||||||
Assert !exists('g:bar'), 'g:bar should not be found (1)'
|
Assert !exists('g:bar'), 'g:bar should not be found'
|
||||||
Assert !exists('g:baz'), 'g:baz should not be found (1)'
|
Assert !exists('g:baz'), 'g:baz should not be found'
|
||||||
|
|
||||||
" Create a new branch on origin
|
" Create a new branch on origin
|
||||||
call system('cd /tmp/vim-plug-test/new-branch && git checkout -b new &&'
|
call system('cd /tmp/new-branch && git checkout -b new &&'
|
||||||
\. 'echo "let g:bar = 1" > plugin/bar.vim && git add plugin/bar.vim &&'
|
\. 'echo "let g:bar = 1" > plugin/bar.vim && git add plugin/bar.vim &&'
|
||||||
\. 'git commit -m second')
|
\. 'git commit -m second')
|
||||||
|
|
||||||
" We're setting up two plugins so that parallel installer is used
|
" We're setting up two plugins so that parallel installer is used
|
||||||
call plug#begin('/tmp/vim-plug-test/plugged')
|
call plug#begin('/tmp/plugged')
|
||||||
Plug 'junegunn/seoul256.vim'
|
Plug 'junegunn/seoul256.vim'
|
||||||
Plug expand('file:////tmp/vim-plug-test/new-branch'), { 'branch': 'new' }
|
Plug expand('file:////tmp/new-branch'), { 'branch': 'new' }
|
||||||
call plug#end()
|
call plug#end()
|
||||||
PlugUpdate
|
PlugUpdate
|
||||||
silent %y
|
silent %y
|
||||||
|
|
@ -114,11 +110,10 @@ Execute (#139-1 Using new remote branch):
|
||||||
Assert @" !~? 'error', 'Should be able to use new remote branch: ' . @"
|
Assert @" !~? 'error', 'Should be able to use new remote branch: ' . @"
|
||||||
|
|
||||||
unlet! g:foo g:bar g:baz
|
unlet! g:foo g:bar g:baz
|
||||||
call ResetPlug()
|
|
||||||
call plug#load('new-branch')
|
call plug#load('new-branch')
|
||||||
Assert exists('g:foo'), 'g:foo should be found (2)'
|
Assert exists('g:foo'), 'g:foo should be found'
|
||||||
Assert exists('g:bar'), 'g:bar should be found (2)'
|
Assert exists('g:bar'), 'g:bar should be found'
|
||||||
Assert !exists('g:baz'), 'g:baz should not be found (2)'
|
Assert !exists('g:baz'), 'g:baz should not be found'
|
||||||
|
|
||||||
call PlugStatusSorted()
|
call PlugStatusSorted()
|
||||||
|
|
||||||
|
|
@ -130,14 +125,14 @@ Expect:
|
||||||
|
|
||||||
Execute (#139-2 Using yet another new remote branch):
|
Execute (#139-2 Using yet another new remote branch):
|
||||||
" Create another branch on origin
|
" Create another branch on origin
|
||||||
call system('cd /tmp/vim-plug-test/new-branch && git checkout master &&'
|
call system('cd /tmp/new-branch && git checkout master &&'
|
||||||
\. 'git checkout -b brand-new &&'
|
\. 'git checkout -b brand-new &&'
|
||||||
\. 'echo "let g:baz = 1" > plugin/baz.vim && git add plugin/baz.vim &&'
|
\. 'echo "let g:baz = 1" > plugin/baz.vim && git add plugin/baz.vim &&'
|
||||||
\. 'git commit -m third')
|
\. 'git commit -m third')
|
||||||
|
|
||||||
" Test Vim installer here
|
" Test Vim installer here
|
||||||
call plug#begin('/tmp/vim-plug-test/plugged')
|
call plug#begin('/tmp/plugged')
|
||||||
Plug expand('file:////tmp/vim-plug-test/new-branch'), { 'branch': 'brand-new' }
|
Plug expand('file:////tmp/new-branch'), { 'branch': 'brand-new' }
|
||||||
call plug#end()
|
call plug#end()
|
||||||
PlugUpdate
|
PlugUpdate
|
||||||
silent %y
|
silent %y
|
||||||
|
|
@ -145,7 +140,6 @@ Execute (#139-2 Using yet another new remote branch):
|
||||||
Assert @" !~? 'error', 'Should be able to use new remote branch: ' . @"
|
Assert @" !~? 'error', 'Should be able to use new remote branch: ' . @"
|
||||||
|
|
||||||
unlet! g:foo g:bar g:baz
|
unlet! g:foo g:bar g:baz
|
||||||
call ResetPlug()
|
|
||||||
call plug#load('new-branch')
|
call plug#load('new-branch')
|
||||||
Assert exists('g:foo'), 'g:foo should be found'
|
Assert exists('g:foo'), 'g:foo should be found'
|
||||||
Assert !exists('g:bar'), 'g:bar should not be found'
|
Assert !exists('g:bar'), 'g:bar should not be found'
|
||||||
|
|
@ -160,19 +154,19 @@ Expect:
|
||||||
|
|
||||||
Execute (#139-3 Should fail when not possible to fast-forward):
|
Execute (#139-3 Should fail when not possible to fast-forward):
|
||||||
" Commit on cloned repo
|
" Commit on cloned repo
|
||||||
call system('cd /tmp/vim-plug-test/plugged/new-branch && git checkout master &&'
|
call system('cd /tmp/plugged/new-branch && git checkout master &&'
|
||||||
\. 'touch foobar && git add foobar && git commit -m foobar')
|
\. 'touch foobar && git add foobar && git commit -m foobar')
|
||||||
|
|
||||||
" Different commit on remote
|
" Different commit on remote
|
||||||
call system('cd /tmp/vim-plug-test/new-branch && git checkout master &&'
|
call system('cd /tmp/new-branch && git checkout master &&'
|
||||||
\. 'touch foobaz && git add foobaz && git commit -m foobaz')
|
\. 'touch foobaz && git add foobaz && git commit -m foobaz')
|
||||||
|
|
||||||
for multi in [0, 1]
|
for multi in [0, 1]
|
||||||
call plug#begin('/tmp/vim-plug-test/plugged')
|
call plug#begin('/tmp/plugged')
|
||||||
if multi
|
if multi
|
||||||
Plug 'junegunn/seoul256.vim'
|
Plug 'junegunn/seoul256.vim'
|
||||||
endif
|
endif
|
||||||
Plug expand('file:////tmp/vim-plug-test/new-branch')
|
Plug expand('file:////tmp/new-branch')
|
||||||
call plug#end()
|
call plug#end()
|
||||||
PlugUpdate
|
PlugUpdate
|
||||||
silent %y
|
silent %y
|
||||||
|
|
@ -216,7 +210,7 @@ Execute (#159: shell=/bin/tcsh):
|
||||||
let org = &shell
|
let org = &shell
|
||||||
try
|
try
|
||||||
set shell=/bin/tcsh
|
set shell=/bin/tcsh
|
||||||
call plug#begin('/tmp/vim-plug-test/plugged')
|
call plug#begin('/tmp/plugged')
|
||||||
Plug 'junegunn/seoul256.vim'
|
Plug 'junegunn/seoul256.vim'
|
||||||
call plug#end()
|
call plug#end()
|
||||||
|
|
||||||
|
|
@ -230,21 +224,21 @@ Execute (#159: shell=/bin/tcsh):
|
||||||
|
|
||||||
**********************************************************************
|
**********************************************************************
|
||||||
Execute (#154: Spaces in &rtp should not be escaped):
|
Execute (#154: Spaces in &rtp should not be escaped):
|
||||||
call plug#begin('/tmp/vim-plug-test/plug it')
|
call plug#begin('/tmp/plug it')
|
||||||
Plug 'foo/seoul256 vim'
|
Plug 'seoul256 vim'
|
||||||
call plug#end()
|
call plug#end()
|
||||||
Log &rtp
|
Log &rtp
|
||||||
Assert stridx(&rtp, 'plug it/seoul256 vim') >= 0
|
Assert stridx(&rtp, 'plug it/seoul256 vim') >= 0
|
||||||
|
|
||||||
**********************************************************************
|
**********************************************************************
|
||||||
Execute (#184: Duplicate entries in &rtp):
|
Execute (#184: Duplicate entries in &rtp):
|
||||||
call plug#begin('/tmp/vim-plug-test/plugged')
|
call plug#begin('/tmp/plugged')
|
||||||
Plug 'foo/plugin1'
|
Plug 'plugin1'
|
||||||
\| Plug 'foo/plugin0'
|
\| Plug 'plugin0'
|
||||||
|
|
||||||
Plug 'foo/plugin2'
|
Plug 'plugin2'
|
||||||
\| Plug 'foo/plugin0'
|
\| Plug 'plugin0'
|
||||||
\| Plug 'foo/plugin1'
|
\| Plug 'plugin1'
|
||||||
call plug#end()
|
call plug#end()
|
||||||
|
|
||||||
Log &rtp
|
Log &rtp
|
||||||
|
|
@ -256,7 +250,7 @@ Execute (#236: Plugin removed from &rtp when .vimrc is reloaded):
|
||||||
silent! delc EasyAlign
|
silent! delc EasyAlign
|
||||||
|
|
||||||
call ReloadPlug()
|
call ReloadPlug()
|
||||||
call plug#begin('/tmp/vim-plug-test/plugged')
|
call plug#begin('/tmp/plugged')
|
||||||
Plug 'junegunn/vim-easy-align', { 'on': 'EasyAlign' }
|
Plug 'junegunn/vim-easy-align', { 'on': 'EasyAlign' }
|
||||||
call plug#end()
|
call plug#end()
|
||||||
PlugInstall | q
|
PlugInstall | q
|
||||||
|
|
@ -265,111 +259,7 @@ Execute (#236: Plugin removed from &rtp when .vimrc is reloaded):
|
||||||
%EasyAlign=
|
%EasyAlign=
|
||||||
Assert &rtp =~ '/vim-easy-align', 'Plugin should be in &rtp'
|
Assert &rtp =~ '/vim-easy-align', 'Plugin should be in &rtp'
|
||||||
|
|
||||||
call plug#begin('/tmp/vim-plug-test/plugged')
|
call plug#begin('/tmp/plugged')
|
||||||
Plug 'junegunn/vim-easy-align', { 'on': 'EasyAlign' }
|
Plug 'junegunn/vim-easy-align', { 'on': 'EasyAlign' }
|
||||||
call plug#end()
|
call plug#end()
|
||||||
Assert &rtp =~ '/vim-easy-align', 'Plugin should still be in &rtp'
|
Assert &rtp =~ '/vim-easy-align', 'Plugin should still be in &rtp'
|
||||||
|
|
||||||
**********************************************************************
|
|
||||||
Execute (#350: Ruby installer failed to unshallow tagged plugin on update):
|
|
||||||
call plug#begin('/tmp/vim-plug-test/plugged')
|
|
||||||
call plug#end()
|
|
||||||
PlugClean!
|
|
||||||
|
|
||||||
" Shallow clone. We should have at least 2 plugins to enable parallel installer.
|
|
||||||
call plug#begin('/tmp/vim-plug-test/plugged')
|
|
||||||
Plug 'junegunn/vim-easy-align'
|
|
||||||
Plug 'junegunn/seoul256.vim'
|
|
||||||
call plug#end()
|
|
||||||
PlugUpdate
|
|
||||||
Assert filereadable(g:plugs['vim-easy-align'].dir.'/.git/shallow')
|
|
||||||
|
|
||||||
" Now unshallowed
|
|
||||||
call plug#begin('/tmp/vim-plug-test/plugged')
|
|
||||||
Plug 'junegunn/vim-easy-align', { 'tag': '2.9.0' }
|
|
||||||
Plug 'junegunn/seoul256.vim'
|
|
||||||
call plug#end()
|
|
||||||
PlugUpdate
|
|
||||||
Assert !filereadable(g:plugs['vim-easy-align'].dir.'/.git/shallow')
|
|
||||||
q
|
|
||||||
|
|
||||||
**********************************************************************
|
|
||||||
Execute (#474: Load ftdetect files in filetypedetect augroup):
|
|
||||||
call plug#begin('/tmp/vim-plug-test/plugged')
|
|
||||||
Plug 'junegunn/rust.vim', { 'for': 'rust', 'commit': '115d321d383eb96d438466c56cc871fcc1bd0faa' }
|
|
||||||
call plug#end()
|
|
||||||
PlugInstall!
|
|
||||||
q
|
|
||||||
|
|
||||||
tabnew /tmp/vim-plug-test/any.rs
|
|
||||||
AssertEqual 'rust', &filetype
|
|
||||||
Log &filetype
|
|
||||||
filetype detect
|
|
||||||
AssertEqual 'rust', &filetype
|
|
||||||
Log &filetype
|
|
||||||
bd
|
|
||||||
|
|
||||||
**********************************************************************
|
|
||||||
Execute (#489/#587 On-demand loading with 'on' option should trigger BufRead autocmd w/o nomodeline):
|
|
||||||
call plug#begin('$PLUG_FIXTURES')
|
|
||||||
Plug 'foo/ftplugin-msg', { 'on': 'XXX' }
|
|
||||||
call plug#end()
|
|
||||||
|
|
||||||
tabnew a.java
|
|
||||||
call setline(1, '// vim: set filetype=lava:')
|
|
||||||
redir => out
|
|
||||||
silent! XXX
|
|
||||||
redir END
|
|
||||||
Assert stridx(out, 'ftplugin-java') >= 0
|
|
||||||
AssertEqual 'lava', &filetype
|
|
||||||
q!
|
|
||||||
|
|
||||||
**********************************************************************
|
|
||||||
Execute (Cursor moved to another window during post-update hook):
|
|
||||||
function! DoSplit(...)
|
|
||||||
new
|
|
||||||
call setline(1, 'empty')
|
|
||||||
endfunction
|
|
||||||
call plug#begin('/tmp/vim-plug-test/plugged')
|
|
||||||
Plug 'junegunn/rust.vim', { 'do': function('DoSplit') }
|
|
||||||
call plug#end()
|
|
||||||
PlugInstall!
|
|
||||||
AssertEqual 1, line('$')
|
|
||||||
AssertEqual 'empty', getline(1)
|
|
||||||
q!
|
|
||||||
q
|
|
||||||
|
|
||||||
**********************************************************************
|
|
||||||
Execute (#593 Add plugin to &rtp before running post-update hook with : prefix):
|
|
||||||
call ReloadPlug()
|
|
||||||
call plug#begin()
|
|
||||||
Plug 'junegunn/vim-pseudocl', { 'on': 'XXX', 'do': ':let g:bar = pseudocl#complete#extract_words(''a b'')' }
|
|
||||||
call plug#end()
|
|
||||||
PlugInstall!
|
|
||||||
AssertEqual ['a', 'b'], g:bar
|
|
||||||
|
|
||||||
**********************************************************************
|
|
||||||
Execute (#602 Confusion with branch name and path name):
|
|
||||||
call plug#begin()
|
|
||||||
Plug expand('file:////tmp/vim-plug-test/new-branch'), { 'branch': 'plugin' }
|
|
||||||
call plug#end()
|
|
||||||
PlugUpdate
|
|
||||||
call PlugStatusSorted()
|
|
||||||
|
|
||||||
Expect:
|
|
||||||
- new-branch: OK
|
|
||||||
Finished. 0 error(s).
|
|
||||||
[=]
|
|
||||||
|
|
||||||
**********************************************************************
|
|
||||||
Execute (PlugStatus showed error with wildcard tag):
|
|
||||||
call plug#begin()
|
|
||||||
Plug 'junegunn/vim-easy-align', { 'tag': '*' }
|
|
||||||
call plug#end()
|
|
||||||
PlugUpdate
|
|
||||||
call PlugStatusSorted()
|
|
||||||
|
|
||||||
Expect:
|
|
||||||
- vim-easy-align: OK
|
|
||||||
Finished. 0 error(s).
|
|
||||||
[=]
|
|
||||||
|
|
|
||||||
92
test/run
92
test/run
|
|
@ -1,32 +1,25 @@
|
||||||
#!/bin/bash
|
#!/bin/bash
|
||||||
|
|
||||||
# Privileged mode, ignores $CDPATH etc.
|
cd $(dirname "${BASH_SOURCE[0]}")
|
||||||
set -p
|
|
||||||
set -eu
|
|
||||||
|
|
||||||
cd "$(dirname "${BASH_SOURCE[0]}")"
|
|
||||||
|
|
||||||
export BASE="$PWD"
|
export BASE="$PWD"
|
||||||
export PLUG_SRC="$PWD/../plug.vim"
|
export PLUG_SRC="$PWD/../plug.vim"
|
||||||
export PLUG_FIXTURES="$PWD/fixtures"
|
export PLUG_FIXTURES="$PWD/fixtures"
|
||||||
mkdir -p "$PLUG_FIXTURES"
|
mkdir -p "$PLUG_FIXTURES"
|
||||||
export TEMP=/tmp/vim-plug-test
|
|
||||||
rm -rf "$TEMP"
|
|
||||||
mkdir -p "$TEMP"
|
|
||||||
|
|
||||||
cat > $TEMP/mini-vimrc << VIMRC
|
cat > /tmp/mini-vimrc << VIMRC
|
||||||
set rtp+=$TEMP/junegunn/vader.vim
|
set rtp+=/tmp/junegunn/vader.vim
|
||||||
set shell=/bin/bash
|
set shell=/bin/bash
|
||||||
VIMRC
|
VIMRC
|
||||||
|
|
||||||
clone() {
|
clone() {
|
||||||
if [ ! -d "$2" ]; then
|
if [ ! -d $2 ]; then
|
||||||
git clone "$1" "$2"
|
git clone $1 $2
|
||||||
fi
|
fi
|
||||||
}
|
}
|
||||||
|
|
||||||
clone_repos() (
|
clone_repos() {
|
||||||
cd $TEMP
|
cd /tmp
|
||||||
mkdir -p junegunn vim-scripts jg
|
mkdir -p junegunn vim-scripts jg
|
||||||
for repo in vader.vim goyo.vim rust.vim seoul256.vim vim-easy-align vim-fnr \
|
for repo in vader.vim goyo.vim rust.vim seoul256.vim vim-easy-align vim-fnr \
|
||||||
vim-oblique vim-pseudocl vim-redis vim-emoji; do
|
vim-oblique vim-pseudocl vim-redis vim-emoji; do
|
||||||
|
|
@ -34,22 +27,22 @@ clone_repos() (
|
||||||
done
|
done
|
||||||
clone https://github.com/vim-scripts/beauty256.git vim-scripts/beauty256 &
|
clone https://github.com/vim-scripts/beauty256.git vim-scripts/beauty256 &
|
||||||
clone https://github.com/junegunn/fzf.git fzf &
|
clone https://github.com/junegunn/fzf.git fzf &
|
||||||
clone https://github.com/yous/subsubmodule.git yous/subsubmodule && \
|
|
||||||
(cd yous/subsubmodule && git submodule update --init --recursive &) &
|
|
||||||
wait
|
wait
|
||||||
|
|
||||||
clone junegunn/vim-emoji jg/vim-emoji
|
clone junegunn/vim-emoji jg/vim-emoji
|
||||||
cd junegunn/seoul256.vim && git checkout no-t_co && git checkout master
|
cd junegunn/seoul256.vim && git checkout no-t_co && git checkout master
|
||||||
)
|
|
||||||
|
|
||||||
make_dirs() (
|
cd "$BASE"
|
||||||
|
}
|
||||||
|
|
||||||
|
make_dirs() {
|
||||||
rm -rf "$PLUG_FIXTURES/$1"
|
rm -rf "$PLUG_FIXTURES/$1"
|
||||||
mkdir -p "$PLUG_FIXTURES/$1"
|
mkdir -p "$PLUG_FIXTURES/$1"
|
||||||
cd "$PLUG_FIXTURES/$1"
|
cd "$PLUG_FIXTURES/$1"
|
||||||
mkdir -p autoload colors ftdetect ftplugin indent plugin syntax
|
mkdir -p autoload colors ftdetect ftplugin indent plugin syntax
|
||||||
for d in *; do
|
for d in *; do
|
||||||
[ -d "$d" ] || continue
|
[ -d $d ] || continue
|
||||||
cat > "$d/xxx.vim" << EOF
|
cat > $d/xxx.vim << EOF
|
||||||
" echom expand('<sfile>')
|
" echom expand('<sfile>')
|
||||||
let g:total_order = get(g:, 'total_order', [])
|
let g:total_order = get(g:, 'total_order', [])
|
||||||
let g:$2 = get(g:, '$2', [])
|
let g:$2 = get(g:, '$2', [])
|
||||||
|
|
@ -58,13 +51,9 @@ make_dirs() (
|
||||||
call add(g:total_order, s:name)
|
call add(g:total_order, s:name)
|
||||||
EOF
|
EOF
|
||||||
done
|
done
|
||||||
)
|
|
||||||
|
|
||||||
gitinit() (
|
cd "$BASE"
|
||||||
cd "$PLUG_FIXTURES/$1"
|
}
|
||||||
git init -b master
|
|
||||||
git commit -m 'commit' --allow-empty
|
|
||||||
)
|
|
||||||
|
|
||||||
prepare() {
|
prepare() {
|
||||||
make_dirs xxx/ xxx
|
make_dirs xxx/ xxx
|
||||||
|
|
@ -73,65 +62,36 @@ prepare() {
|
||||||
cat > "$PLUG_FIXTURES/xxx/doc/xxx.txt" << DOC
|
cat > "$PLUG_FIXTURES/xxx/doc/xxx.txt" << DOC
|
||||||
hello *xxx*
|
hello *xxx*
|
||||||
DOC
|
DOC
|
||||||
gitinit xxx
|
|
||||||
|
|
||||||
make_dirs yyy/ yyy
|
make_dirs yyy/ yyy
|
||||||
make_dirs yyy/after yyy
|
make_dirs yyy/after yyy
|
||||||
mkdir -p "$PLUG_FIXTURES/yyy/rtp/doc"
|
|
||||||
cat > "$PLUG_FIXTURES/yyy/rtp/doc/yyy.txt" << DOC
|
|
||||||
hello *yyy*
|
|
||||||
DOC
|
|
||||||
gitinit yyy
|
|
||||||
|
|
||||||
make_dirs z1/ z1
|
make_dirs z1/ z1
|
||||||
make_dirs z2/ z2
|
make_dirs z2/ z2
|
||||||
|
|
||||||
rm -rf "$PLUG_FIXTURES/ftplugin-msg"
|
rm -rf "$PLUG_FIXTURES/ftplugin-msg"
|
||||||
mkdir -p "$PLUG_FIXTURES"/ftplugin-msg/{plugin,ftplugin}
|
mkdir -p "$PLUG_FIXTURES/ftplugin-msg/ftplugin"
|
||||||
echo "echomsg 'ftplugin-c'" > "$PLUG_FIXTURES/ftplugin-msg/ftplugin/c.vim"
|
echo "echomsg 'ftplugin'" > "$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"
|
rm -rf /tmp/new-branch
|
||||||
mkdir -p "$PLUG_FIXTURES/cant-delete/autoload"
|
cd /tmp
|
||||||
touch "$PLUG_FIXTURES/cant-delete/autoload/cant-delete.vim"
|
git init new-branch
|
||||||
chmod -w "$PLUG_FIXTURES/cant-delete/autoload"
|
|
||||||
|
|
||||||
rm -rf $TEMP/new-branch
|
|
||||||
cd $TEMP
|
|
||||||
git init new-branch -b master
|
|
||||||
cd new-branch
|
cd new-branch
|
||||||
mkdir plugin
|
mkdir plugin
|
||||||
echo 'let g:foo = 1' > plugin/foo.vim
|
echo 'let g:foo = 1' > plugin/foo.vim
|
||||||
git add plugin/foo.vim
|
git add plugin/foo.vim
|
||||||
git commit -m initial
|
git commit -m initial
|
||||||
git checkout -b plugin
|
|
||||||
git checkout master
|
|
||||||
|
|
||||||
cd "$BASE"
|
cd "$BASE"
|
||||||
}
|
}
|
||||||
|
|
||||||
select_vim() {
|
|
||||||
local vim=/usr/bin/vim
|
|
||||||
if [ -n "${DEPS:-}" ] && [ -e "${DEPS}/bin/vim" ]; then
|
|
||||||
vim="${DEPS}/bin/vim"
|
|
||||||
elif [ -e "/usr/local/bin/vim" ]; then
|
|
||||||
vim=/usr/local/bin/vim
|
|
||||||
fi
|
|
||||||
echo $vim
|
|
||||||
}
|
|
||||||
|
|
||||||
clone_repos
|
clone_repos
|
||||||
prepare
|
prepare
|
||||||
|
if [ "$1" = '!' ]; then
|
||||||
git --version
|
/usr/local/bin/vim -Nu /tmp/mini-vimrc -c 'Vader! test.vader' > /dev/null &&
|
||||||
vim=$(select_vim)
|
prepare &&
|
||||||
echo "Selected Vim: $vim"
|
/usr/local/bin/vim -Nu /tmp/mini-vimrc -c 'let g:plug_threads = 1 | Vader! test.vader' > /dev/null
|
||||||
if [ "${1:-}" = '!' ]; then
|
|
||||||
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
|
else
|
||||||
$vim -Nu $TEMP/mini-vimrc -c 'Vader test.vader'
|
/usr/local/bin/vim -Nu /tmp/mini-vimrc -c 'Vader test.vader'
|
||||||
fi
|
fi
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -2,7 +2,7 @@ Execute (Initialize test environment):
|
||||||
Save &rtp, g:plugs, g:plug_home, g:plug_window
|
Save &rtp, g:plugs, g:plug_home, g:plug_window
|
||||||
unlet! g:plugs g:plug_home g:plug_window
|
unlet! g:plugs g:plug_home g:plug_window
|
||||||
|
|
||||||
let g:plug_url_format = 'file:///tmp/vim-plug-test/%s'
|
let g:plug_url_format = 'file:///tmp/%s'
|
||||||
let g:base_rtp = &rtp
|
let g:base_rtp = &rtp
|
||||||
let g:first_rtp = split(&rtp, ',')[0]
|
let g:first_rtp = split(&rtp, ',')[0]
|
||||||
let g:last_rtp = split(&rtp, ',')[-1]
|
let g:last_rtp = split(&rtp, ',')[-1]
|
||||||
|
|
@ -10,15 +10,11 @@ Execute (Initialize test environment):
|
||||||
if !exists('$PLUG_SRC')
|
if !exists('$PLUG_SRC')
|
||||||
let $PLUG_SRC = globpath(&rtp, 'autoload/plug.vim')
|
let $PLUG_SRC = globpath(&rtp, 'autoload/plug.vim')
|
||||||
endif
|
endif
|
||||||
let $PLUG_TMP = fnamemodify(tempname(), ':h').'/plug.vim'
|
|
||||||
|
|
||||||
" Temporarily patch plug.vim
|
" Temporarily patch plug.vim
|
||||||
call system('cp "$PLUG_SRC" "$PLUG_TMP"')
|
call system('cp $PLUG_SRC $PLUG_SRC.org')
|
||||||
let patch =
|
call writefile(extend(readfile($PLUG_SRC),
|
||||||
\ ['function! ResetPlug()', 'let s:loaded = {}', 'endfunction',
|
\ ['function! ResetPlug()', 'let s:loaded = {}', 'endfunction']), $PLUG_SRC)
|
||||||
\ 'function! CompareURI(a, b)', 'return s:compare_git_uri(a:a, a:b)', 'endfunction']
|
|
||||||
|
|
||||||
call writefile(extend(readfile($PLUG_TMP), patch), $PLUG_TMP)
|
|
||||||
|
|
||||||
set t_Co=256
|
set t_Co=256
|
||||||
colo default
|
colo default
|
||||||
|
|
@ -33,10 +29,9 @@ Execute (Initialize test environment):
|
||||||
g/^$/d
|
g/^$/d
|
||||||
endfunction
|
endfunction
|
||||||
|
|
||||||
function! AssertExpect(bang, pat, cnt, ...)
|
function! AssertExpect(bang, pat, cnt)
|
||||||
let op = a:bang ? '==#' : '=~#'
|
let op = a:bang ? '==#' : '=~#'
|
||||||
let args = [a:cnt, len(filter(getline(1, '$'), "v:val ".op." '".a:pat."'"))] + a:000
|
AssertEqual a:cnt, len(filter(getline(1, '$'), "v:val ".op." '".a:pat."'"))
|
||||||
call call('vader#assert#equal', args)
|
|
||||||
endfunction
|
endfunction
|
||||||
command! -nargs=+ -bang AssertExpect call AssertExpect('<bang>' == '!', <args>)
|
command! -nargs=+ -bang AssertExpect call AssertExpect('<bang>' == '!', <args>)
|
||||||
|
|
||||||
|
|
@ -52,41 +47,26 @@ Execute (Initialize test environment):
|
||||||
|
|
||||||
function! ReloadPlug()
|
function! ReloadPlug()
|
||||||
call ResetPlug()
|
call ResetPlug()
|
||||||
source $PLUG_TMP
|
source $PLUG_SRC
|
||||||
let &rtp = g:base_rtp
|
let &rtp = g:base_rtp
|
||||||
endfunction
|
endfunction
|
||||||
|
|
||||||
function! GitBranch(repo)
|
source $PLUG_SRC
|
||||||
return system(printf('cd %s && git rev-parse --abbrev-ref HEAD', g:plugs[a:repo].dir))[:-2]
|
|
||||||
endfunction
|
|
||||||
|
|
||||||
function! GitTag(repo)
|
|
||||||
return system(printf('cd %s && git describe --tags', g:plugs[a:repo].dir))[:-2]
|
|
||||||
endfunction
|
|
||||||
|
|
||||||
function! GitCommit(repo)
|
|
||||||
return system(printf('cd %s && git rev-parse HEAD', g:plugs[a:repo].dir))[:-2]
|
|
||||||
endfunction
|
|
||||||
|
|
||||||
source $PLUG_TMP
|
|
||||||
|
|
||||||
Execute (Print Interpreter Version):
|
Execute (Print Interpreter Version):
|
||||||
redir => out
|
redir => out
|
||||||
if has('ruby')
|
if has('ruby')
|
||||||
silent! ruby puts 'Ruby: ' + RUBY_VERSION
|
silent ruby puts 'Ruby: ' + RUBY_VERSION
|
||||||
endif
|
elseif has('python')
|
||||||
if has('python')
|
silent python import sys; svi = sys.version_info; print 'Python: {}.{}.{}'.format(svi[0], svi[1], svi[2])
|
||||||
silent! python import sys; svi = sys.version_info; print 'Python: {}.{}.{}'.format(svi[0], svi[1], svi[2])
|
elseif has('python3')
|
||||||
endif
|
silent python3 import sys; svi = sys.version_info; print('Python: {}.{}.{}'.format(svi[0], svi[1], svi[2]))
|
||||||
if has('python3')
|
|
||||||
silent! python3 import sys; svi = sys.version_info; print('Python: {}.{}.{}'.format(svi[0], svi[1], svi[2]))
|
|
||||||
endif
|
endif
|
||||||
redir END
|
redir END
|
||||||
Log split(out, '\n')
|
Log substitute(out, '\n', '', 'g')
|
||||||
|
|
||||||
Include: workflow.vader
|
Include: workflow.vader
|
||||||
Include: regressions.vader
|
Include: regressions.vader
|
||||||
Include: functional.vader
|
|
||||||
|
|
||||||
Execute (Cleanup):
|
Execute (Cleanup):
|
||||||
silent! call RmRf(g:temp_plugged)
|
silent! call RmRf(g:temp_plugged)
|
||||||
|
|
@ -100,7 +80,7 @@ Execute (Cleanup):
|
||||||
silent! delc AssertExpect
|
silent! delc AssertExpect
|
||||||
silent! unmap /
|
silent! unmap /
|
||||||
silent! unmap ?
|
silent! unmap ?
|
||||||
call delete($PLUG_TMP)
|
call system('mv $PLUG_SRC.org $PLUG_SRC')
|
||||||
|
|
||||||
Restore
|
Restore
|
||||||
|
|
||||||
|
|
|
||||||
File diff suppressed because it is too large
Load Diff
Loading…
Reference in New Issue
Block a user