Update vundle

This commit is contained in:
Jeremy Gardais 2014-09-12 09:19:24 +02:00
parent d41a2b7904
commit 57ad451299
10 changed files with 1219 additions and 377 deletions

View File

@ -0,0 +1,111 @@
Pull Requests
=============
1. Please squash your commits to minimize the log pollution. This is more of a convenience for the maintainer who pulls. If you are unfamiliar, see [here](http://ariejan.net/2011/07/05/git-squash-your-latests-commits-into-one/).
2. Clearly describe what you aim to fix or add to Vundle.
3. Try to minimize code changes and use existing style/functions.
Issues
======
## Check For Answers
Before submitting an issue, be sure to check the following places for answers.
1. Vundle docs at [`:h vundle`](https://github.com/gmarik/Vundle.vim/blob/master/doc/vundle.txt).
2. The [FAQ](https://github.com/gmarik/Vundle.vim/search).
3. [Search](https://github.com/gmarik/Vundle.vim/search) the repository for related issues.
## Try To Eliminate Your Vimrc
In order to make sure it isn't just `.vimrc` replace your own config file with the [minimal vimrc](https://github.com/gmarik/Vundle.vim/blob/master/test/minirc.vim). Clear out bundles and then try to reproduce.
If the problem stops, likely there is an issue in your user configuration. You can incrementally add back your user changes to the minimal file testing the bug each time. This will allow you to slowly bisect the issue. You may want to test one plugin at a time.
If you can still reproduce the problem, try to find the smallest `.vimrc` config file that creates the problem to include later.
## Guidelines
To better respond to issues please follow these general guidelines when explaining the problem.
1. Clearly describe what the error is, if relevant attach output/screenshots.
2. Describe how developers can reproduce the bug, the steps should be from starting Vim.
3. Include your OS, version and architecture. For example, Windows 7 64, Kubuntu 13.04 32, etc...
4. If relevant to reproducing the bug, include the smallest subset of your `.vimrc` that causes the issue. Put this in code tags.
5. At the end of your issue, please put the output of `vim --version` in code tags.
## Example Post
I am using Vim on Kubuntu 13.04 64 bit and I get the following error... (add further explanation here)
To reproduce the bug, use the vimrc file below and run `:BundleInstall`... (continue with steps)
Vimrc:
```
set nocompatible
syntax on
filetype off
set rtp+=~/.vim/bundle/Vundle.vim/
call vundle#rc()
Bundle 'gmarik/Vundle.vim'
Bundle 'relevant/plugin'
filetype plugin indent on
.... more user configs here...
```
Vim Version:
```
VIM - Vi IMproved 7.4 (2013 Aug 10, compiled Aug 15 2013 10:58:39)
Included patches: 1-5
Modified by pkg-vim-maintainers@lists.alioth.debian.org
Compiled by buildd@
Huge version with GTK2 GUI. Features included (+) or not (-):
+arabic +file_in_path +mouse_sgr +tag_binary
+autocmd +find_in_path -mouse_sysmouse +tag_old_static
+balloon_eval +float +mouse_urxvt -tag_any_white
+browse +folding +mouse_xterm +tcl
++builtin_terms -footer +multi_byte +terminfo
+byte_offset +fork() +multi_lang +termresponse
+cindent +gettext -mzscheme +textobjects
+clientserver -hangul_input +netbeans_intg +title
+clipboard +iconv +path_extra +toolbar
+cmdline_compl +insert_expand +perl +user_commands
+cmdline_hist +jumplist +persistent_undo +vertsplit
+cmdline_info +keymap +postscript +virtualedit
+comments +langmap +printer +visual
+conceal +libcall +profile +visualextra
+cryptv +linebreak +python +viminfo
+cscope +lispindent -python3 +vreplace
+cursorbind +listcmds +quickfix +wildignore
+cursorshape +localmap +reltime +wildmenu
+dialog_con_gui +lua +rightleft +windows
+diff +menu +ruby +writebackup
+digraphs +mksession +scrollbind +X11
+dnd +modify_fname +signs -xfontset
-ebcdic +mouse +smartindent +xim
+emacs_tags +mouseshape -sniff +xsmp_interact
+eval +mouse_dec +startuptime +xterm_clipboard
+ex_extra +mouse_gpm +statusline -xterm_save
+extra_search -mouse_jsbterm -sun_workshop
+farsi +mouse_netterm +syntax
system vimrc file: "$VIM/vimrc"
user vimrc file: "$HOME/.vimrc"
2nd user vimrc file: "~/.vim/vimrc"
user exrc file: "$HOME/.exrc"
system gvimrc file: "$VIM/gvimrc"
user gvimrc file: "$HOME/.gvimrc"
2nd user gvimrc file: "~/.vim/gvimrc"
system menu file: "$VIMRUNTIME/menu.vim"
fall-back for $VIM: "/usr/share/vim"
Compilation: gcc -c -I. -Iproto -DHAVE_CONFIG_H -DFEAT_GUI_GTK -pthread -I/usr/include/gtk-2.0 -I/usr/lib/x86_64-linux-gnu/gtk-2.0/include -I/usr/include/atk-1.0 -I/usr/include/cairo -I/usr/include/gdk-pixbuf-2.0 -I/usr/include/pango-1.0 -I/usr/include/gio-unix-2.0/ -I/usr/include/glib-2.0 -I/usr/lib/x86_64-linux-gnu/glib-2.0/include -I/usr/include/pixman-1 -I/usr/include/freetype2 -I/usr/include/libpng12 -I/usr/include/harfbuzz -g -O2 -fstack-protector --param=ssp-buffer-size=4 -Wformat -Werror=format-security -U_FORTIFY_SOURCE -D_FORTIFY_SOURCE=1 -I/usr/include/tcl8.5 -D_REENTRANT=1 -D_THREAD_SAFE=1 -D_LARGEFILE64_SOURCE=1
Linking: gcc -L. -Wl,-Bsymbolic-functions -Wl,-z,relro -rdynamic -Wl,-export-dynamic -Wl,-E -Wl,-Bsymbolic-functions -Wl,-z,relro -Wl,--as-needed -o vim -lgtk-x11-2.0 -lgdk-x11-2.0 -latk-1.0 -lgio-2.0 -lpangoft2-1.0 -lpangocairo-1.0 -lgdk_pixbuf-2.0 -lcairo -lpango-1.0 -lfreetype -lfontconfig -lgobject-2.0 -lglib-2.0 -lSM -lICE -lXpm -lXt -lX11 -lXdmcp -lSM -lICE -lm -ltinfo -lnsl -lselinux -lacl -lattr -lgpm -ldl -L/usr/lib -llua5.1 -Wl,-E -fstack-protector -L/usr/local/lib -L/usr/lib/perl/5.14/CORE -lperl -ldl -lm -lpthread -lcrypt -L/usr/lib/python2.7/config-x86_64-linux-gnu -lpython2.7 -lpthread -ldl -lutil -lm -Xlinker -export-dynamic -Wl,-O1 -Wl,-Bsymbolic-functions -L/usr/lib/x86_64-linux-gnu -ltcl8.5 -ldl -lpthread -lieee -lm -lruby-1.9.1 -lpthread -lrt -ldl -lcrypt -lm -L/usr/lib
```

View File

@ -1,108 +1,120 @@
## [Help Maintain Vundle](https://github.com/gmarik/Vundle.vim/issues/383)
## About ## About
[Vundle] is short for _Vim bundle_ and is a [Vim] plugin manager. [Vundle] is short for _Vim bundle_ and is a [Vim] plugin manager.
![Vundle-installer](http://25.media.tumblr.com/tumblr_m8m96w06G81r39828o1_1280.png) [Vundle] allows you to...
## Quick start * keep track of and [configure] your plugins right in the `.vimrc`
* [install] configured plugins (a.k.a. scripts/bundle)
* [update] configured plugins
* [search] by name all available [Vim scripts]
* [clean] unused plugins up
* run the above actions in a *single keypress* with [interactive mode]
1. Set up [Vundle]: [Vundle] automatically...
``` * manages the [runtime path] of your installed scripts
$ git clone https://github.com/gmarik/vundle.git ~/.vim/bundle/vundle * regenerates [help tags] after installing and updating
```
2. Configure bundles: [Vundle] is undergoing an [interface change], please stay up to date to get latest changes.
Sample `.vimrc`: [![Gitter-chat](https://badges.gitter.im/gmarik/Vundle.vim.png)](https://gitter.im/gmarik/Vundle.vim) for discussion and support.
![Vundle-installer](http://i.imgur.com/Rueh7Cc.png)
## Quick Start
1. Introduction:
Installation requires [Git] and triggers [`git clone`] for each configured repository to `~/.vim/bundle/` by default.
Curl is required for search.
If you are using Windows, go directly to [Windows setup]. If you run into any issues, please consult the [FAQ].
See [Tips] for some advanced configurations.
2. Set up [Vundle]:
`$ git clone https://github.com/gmarik/Vundle.vim.git ~/.vim/bundle/Vundle.vim`
3. Configure Plugins:
Put this at the top of your `.vimrc` to use Vundle. Remove plugins you don't need, they are for illustration purposes.
```vim ```vim
set nocompatible " be iMproved set nocompatible " be iMproved, required
filetype off " required! filetype off " required
set rtp+=~/.vim/bundle/vundle/ " set the runtime path to include Vundle and initialize
call vundle#rc() set rtp+=~/.vim/bundle/Vundle.vim
call vundle#begin()
" alternatively, pass a path where Vundle should install plugins
"call vundle#begin('~/some/path/here')
" let Vundle manage Vundle " let Vundle manage Vundle, required
" required! Plugin 'gmarik/Vundle.vim'
Bundle 'gmarik/vundle'
" My bundles here: " The following are examples of different formats supported.
" " Keep Plugin commands between vundle#begin/end.
" original repos on GitHub " plugin on GitHub repo
Bundle 'tpope/vim-fugitive' Plugin 'tpope/vim-fugitive'
Bundle 'Lokaltog/vim-easymotion' " plugin from http://vim-scripts.org/vim/scripts.html
Bundle 'rstacruz/sparkup', {'rtp': 'vim/'} Plugin 'L9'
Bundle 'tpope/vim-rails.git' " Git plugin not hosted on GitHub
" vim-scripts repos Plugin 'git://git.wincent.com/command-t.git'
Bundle 'L9' " git repos on your local machine (i.e. when working on your own plugin)
Bundle 'FuzzyFinder' Plugin 'file:///home/gmarik/path/to/plugin'
" non-GitHub repos " The sparkup vim script is in a subdirectory of this repo called vim.
Bundle 'git://git.wincent.com/command-t.git' " Pass the path to set the runtimepath properly.
" Git repos on your local machine (i.e. when working on your own plugin) Plugin 'rstacruz/sparkup', {'rtp': 'vim/'}
Bundle 'file:///Users/gmarik/path/to/plugin' " Avoid a name conflict with L9
" ... Plugin 'user/L9', {'name': 'newL9'}
filetype plugin indent on " required! " All of your Plugins must be added before the following line
call vundle#end() " required
filetype plugin indent on " required
" To ignore plugin indent changes, instead use:
"filetype plugin on
" "
" Brief help " Brief help
" :BundleList - list configured bundles " :PluginList - lists configured plugins
" :BundleInstall(!) - install (update) bundles " :PluginInstall - installs plugins; append `!` to update or just :PluginUpdate
" :BundleSearch(!) foo - search (or refresh cache first) for foo " :PluginSearch foo - searches for foo; append `!` to refresh local cache
" :BundleClean(!) - confirm (or auto-approve) removal of unused bundles " :PluginClean - confirms removal of unused plugins; append `!` to auto-approve removal
" "
" see :h vundle for more details or wiki for FAQ " see :h vundle for more details or wiki for FAQ
" NOTE: comments after Bundle commands are not allowed. " Put your non-Plugin stuff after this line
``` ```
3. Install configured bundles: 4. Install Plugins:
Launch `vim`, run `:BundleInstall` Launch `vim` and run `:PluginInstall`
(or `vim +BundleInstall +qall` for CLI lovers)
*Windows users*: see [Vundle for Windows](https://github.com/gmarik/vundle/wiki/Vundle-for-Windows) To install from command line: `vim +PluginInstall +qall`
Installation requires [Git] and triggers [`git clone`](http://gitref.org/creating/#clone) for each configured repo to `~/.vim/bundle/`.
## Why Vundle
[Vundle] allows you to:
- keep track of and configure your scripts right in `.vimrc`
- [install] configured scripts (a.k.a. bundle)
- [update] configured scripts
- [search] by name [all available Vim scripts]
- [clean] unused scripts up
- run the above actions in a *single keypress* with [interactive mode]
[Vundle] also:
- manages the [runtime path] of your installed scripts
- [regenerates help tags][helptags] automatically
## Docs ## Docs
See the [`:h vundle`](https://github.com/gmarik/vundle/blob/master/doc/vundle.txt) Vimdoc for more details. See the [`:h vundle`](https://github.com/gmarik/Vundle.vim/blob/master/doc/vundle.txt) Vimdoc for more details.
## People using Vundle ## Changelog
see [Examples](https://github.com/gmarik/vundle/wiki/Examples) See the [changelog](https://github.com/gmarik/Vundle.vim/blob/master/changelog.md).
## FAQ ## People Using Vundle
see [the wiki](https://github.com/gmarik/vundle/wiki#faq) see [Examples](https://github.com/gmarik/Vundle.vim/wiki/Examples)
## Contributors ## Contributors
see [Vundle contributors](https://github.com/gmarik/vundle/graphs/contributors) see [Vundle contributors](https://github.com/gmarik/Vundle.vim/graphs/contributors)
*Thank you!* *Thank you!*
## Inspiration and ideas from ## Inspiration & Ideas
* [pathogen.vim] * [pathogen.vim](http://github.com/tpope/vim-pathogen/)
* [Bundler] * [Bundler](https://github.com/bundler/bundler)
* [Scott Bronson](http://github.com/bronson) * [Scott Bronson](http://github.com/bronson)
## Also ## Also
@ -113,7 +125,7 @@ see [Vundle contributors](https://github.com/gmarik/vundle/graphs/contributors)
## TODO: ## TODO:
[Vundle] is a work in progress, so any ideas and patches are appreciated. [Vundle] is a work in progress, so any ideas and patches are appreciated.
* ✓ activate newly added bundles on `.vimrc` reload or after `:BundleInstall` * ✓ activate newly added bundles on `.vimrc` reload or after `:PluginInstall`
* ✓ use preview window for search results * ✓ use preview window for search results
* ✓ Vim documentation * ✓ Vim documentation
* ✓ put Vundle in `bundles/` too (will fix Vundle help) * ✓ put Vundle in `bundles/` too (will fix Vundle help)
@ -125,17 +137,22 @@ see [Vundle contributors](https://github.com/gmarik/vundle/graphs/contributors)
* search by description as well * search by description as well
* make it rock! * make it rock!
[Vundle]:http://github.com/gmarik/vundle [Vundle]:http://github.com/gmarik/Vundle.vim
[pathogen.vim]:http://github.com/tpope/vim-pathogen/ [Windows setup]:https://github.com/gmarik/Vundle.vim/wiki/Vundle-for-Windows
[Bundler]:https://github.com/bundler/bundler [FAQ]:https://github.com/gmarik/Vundle.vim/wiki
[Tips]:https://github.com/gmarik/Vundle.vim/wiki/Tips-and-Tricks
[Vim]:http://www.vim.org [Vim]:http://www.vim.org
[Git]:http://git-scm.com [Git]:http://git-scm.com
[all available Vim scripts]:http://vim-scripts.org/vim/scripts.html [`git clone`]:http://gitref.org/creating/#clone
[helptags]:http://vimdoc.sourceforge.net/htmldoc/helphelp.html#:helptags
[Vim scripts]:http://vim-scripts.org/vim/scripts.html
[help tags]:http://vimdoc.sourceforge.net/htmldoc/helphelp.html#:helptags
[runtime path]:http://vimdoc.sourceforge.net/htmldoc/options.html#%27runtimepath%27 [runtime path]:http://vimdoc.sourceforge.net/htmldoc/options.html#%27runtimepath%27
[install]:https://github.com/gmarik/vundle/blob/master/doc/vundle.txt#L115-129 [configure]:https://github.com/gmarik/Vundle.vim/blob/v0.10.2/doc/vundle.txt#L126-L233
[update]:https://github.com/gmarik/vundle/blob/master/doc/vundle.txt#L131-137 [install]:https://github.com/gmarik/Vundle.vim/blob/v0.10.2/doc/vundle.txt#L234-L254
[search]:https://github.com/gmarik/vundle/blob/master/doc/vundle.txt#L139-161 [update]:https://github.com/gmarik/Vundle.vim/blob/v0.10.2/doc/vundle.txt#L255-L265
[clean]:https://github.com/gmarik/vundle/blob/master/doc/vundle.txt#L171-L183 [search]:https://github.com/gmarik/Vundle.vim/blob/v0.10.2/doc/vundle.txt#L266-L295
[interactive mode]:https://github.com/gmarik/vundle/blob/master/doc/vundle.txt#L186-213 [clean]:https://github.com/gmarik/Vundle.vim/blob/v0.10.2/doc/vundle.txt#L303-L318
[interactive mode]:https://github.com/gmarik/Vundle.vim/blob/v0.10.2/doc/vundle.txt#L319-L360
[interface change]:https://github.com/gmarik/Vundle.vim/blob/v0.10.2/doc/vundle.txt#L372-L396

View File

@ -1,48 +1,83 @@
" Vundle is a shortcut for Vim Bundle and Is a simple plugin manager for Vim " Vundle is a shortcut for Vim Bundle and Is a simple plugin manager for Vim
" Author: gmarik " Author: gmarik
" HomePage: http://github.com/gmarik/vundle " HomePage: http://github.com/gmarik/Vundle.vim
" Readme: http://github.com/gmarik/vundle/blob/master/README.md " Readme: http://github.com/gmarik/Vundle.vim/blob/master/README.md
" Version: 0.9 " Version: 0.10.2
com! -nargs=+ Bundle " Plugin Commands
com! -nargs=+ -bar Plugin
\ call vundle#config#bundle(<args>) \ call vundle#config#bundle(<args>)
com! -nargs=? -bang -complete=custom,vundle#scripts#complete BundleInstall com! -nargs=? -bang -complete=custom,vundle#scripts#complete PluginInstall
\ call vundle#installer#new('!' == '<bang>', <q-args>) \ call vundle#installer#new('!' == '<bang>', <q-args>)
com! -nargs=? -bang -complete=custom,vundle#scripts#complete BundleSearch com! -nargs=? -bang -complete=custom,vundle#scripts#complete PluginSearch
\ call vundle#scripts#all('!'=='<bang>', <q-args>) \ call vundle#scripts#all('!' == '<bang>', <q-args>)
com! -nargs=? -bang -complete=custom,vundle#scripts#complete Bundles com! -nargs=0 -bang PluginList
\ call vundle#scripts#all('!'=='<bang>', <q-args>) \ call vundle#installer#list('!' == '<bang>')
com! -nargs=0 -bang BundleList com! -nargs=? -bang PluginClean
\ call vundle#installer#list('!'=='<bang>')
com! -nargs=? -bang BundleClean
\ call vundle#installer#clean('!' == '<bang>') \ call vundle#installer#clean('!' == '<bang>')
com! -nargs=0 BundleDocs com! -nargs=0 PluginDocs
\ call vundle#installer#helptags(g:bundles) \ call vundle#installer#helptags(g:bundles)
" Aliases " Aliases
com! BundleUpdate BundleInstall! com! PluginUpdate PluginInstall!
" Vundle Aliases
com! -nargs=? -bang -complete=custom,vundle#scripts#complete VundleInstall PluginInstall<bang> <args>
com! -nargs=? -bang -complete=custom,vundle#scripts#complete VundleSearch PluginSearch<bang> <args>
com! -nargs=? -bang VundleClean PluginClean<bang>
com! -nargs=0 VundleDocs PluginDocs
com! VundleUpdate PluginInstall!
" Deprecated Commands
com! -nargs=+ Bundle call vundle#config#bundle(<args>)
com! -nargs=? -bang -complete=custom,vundle#scripts#complete BundleInstall PluginInstall<bang> <args>
com! -nargs=? -bang -complete=custom,vundle#scripts#complete BundleSearch PluginSearch<bang> <args>
com! -nargs=0 -bang BundleList PluginList<bang>
com! -nargs=? -bang BundleClean PluginClean<bang>
com! -nargs=0 BundleDocs PluginDocs
com! BundleUpdate PluginInstall!
" Set up the signs used in the installer window. (See :help signs)
if (has('signs')) if (has('signs'))
sign define Vu_error text=! texthl=Error sign define Vu_error text=! texthl=Error
sign define Vu_active text=> texthl=Comment sign define Vu_active text=> texthl=Comment
sign define Vu_todate text=. texthl=Comment sign define Vu_todate text=. texthl=Comment
sign define Vu_new text=+ texthl=Comment sign define Vu_new text=+ texthl=Comment
sign define Vu_updated text=* texthl=Comment sign define Vu_updated text=* texthl=Comment
sign define Vu_deleted text=- texthl=Comment sign define Vu_deleted text=- texthl=Comment
sign define Vu_helptags text=* texthl=Comment sign define Vu_helptags text=* texthl=Comment
sign define Vu_pinned text== texthl=Comment
endif endif
" Set up Vundle. This function has to be called from the users vimrc file.
" This will force Vim to source this file as a side effect which wil define
" the :Plugin command. After calling this function the user can use the
" :Plugin command in the vimrc. It is not possible to do this automatically
" because when loading the vimrc file no plugins where loaded yet.
func! vundle#rc(...) abort func! vundle#rc(...) abort
let g:bundle_dir = len(a:000) > 0 ? expand(a:1, 1) : expand('$HOME/.vim/bundle', 1) let g:bundle_dir = len(a:000) > 0 ? expand(a:1, 1) : expand('$HOME/.vim/bundle', 1)
let g:updated_bundles = [] let g:updated_bundles = []
let g:vundle_log = [] let g:vundle_log = []
let g:vundle_changelog = ['Updated Bundles:'] let g:vundle_changelog = ['Updated Plugins:']
call vundle#config#init() call vundle#config#init()
endf endf
" Alternative to vundle#rc, offers speed up by modifying rtp only when end()
" called later.
func! vundle#begin(...) abort
let g:vundle_lazy_load = 1
call call('vundle#rc', a:000)
endf
" Finishes putting plugins on the rtp.
func! vundle#end(...) abort
unlet g:vundle_lazy_load
call vundle#config#activate_bundles()
endf
" vim: set expandtab sts=2 ts=2 sw=2 tw=78 norl:

View File

@ -1,17 +1,57 @@
" ---------------------------------------------------------------------------
" Add a plugin to the runtimepath.
"
" arg -- a string specifying the plugin
" ... -- a dictionary of options for the plugin
" return -- the return value from vundle#config#init_bundle()
" ---------------------------------------------------------------------------
func! vundle#config#bundle(arg, ...) func! vundle#config#bundle(arg, ...)
let bundle = vundle#config#init_bundle(a:arg, a:000) let bundle = vundle#config#init_bundle(a:arg, a:000)
call s:rtp_rm_a() if !s:check_bundle_name(bundle)
call add(g:bundles, bundle) return
call s:rtp_add_a() endif
if exists('g:vundle_lazy_load') && g:vundle_lazy_load
call add(g:bundles, bundle)
else
call s:rtp_rm_a()
call add(g:bundles, bundle)
call s:rtp_add_a()
call s:rtp_add_defaults()
endif
return bundle return bundle
endf endf
" ---------------------------------------------------------------------------
" When lazy bundle load is used (begin/end functions), add all configured
" bundles to runtimepath and reorder appropriately.
" ---------------------------------------------------------------------------
func! vundle#config#activate_bundles()
call s:rtp_add_a()
call s:rtp_add_defaults()
endf
" ---------------------------------------------------------------------------
" Initialize Vundle.
"
" Start a new bundles list and make sure the runtimepath does not contain
" directories from a previous call. In theory, this should only be called
" once.
" ---------------------------------------------------------------------------
func! vundle#config#init() func! vundle#config#init()
if !exists('g:bundles') | let g:bundles = [] | endif if !exists('g:bundles') | let g:bundles = [] | endif
call s:rtp_rm_a() call s:rtp_rm_a()
let g:bundles = [] let g:bundles = []
let g:bundle_names = {}
endf endf
" ---------------------------------------------------------------------------
" Add a list of bundles to the runtimepath and source them.
"
" bundles -- a list of bundle objects
" ---------------------------------------------------------------------------
func! vundle#config#require(bundles) abort func! vundle#config#require(bundles) abort
for b in a:bundles for b in a:bundles
call s:rtp_add(b.rtpath) call s:rtp_add(b.rtpath)
@ -21,18 +61,56 @@ func! vundle#config#require(bundles) abort
exec 'runtime! '.b.name.'/after/*.vim' exec 'runtime! '.b.name.'/after/*.vim'
call s:rtp_rm(g:bundle_dir) call s:rtp_rm(g:bundle_dir)
endfor endfor
call s:rtp_add_defaults()
endf endf
" ---------------------------------------------------------------------------
" Create a bundle object from a bundle specification.
"
" name -- the bundle specification as a string
" opts -- the options dictionary from then bundle definition
" return -- an initialized bundle object
" ---------------------------------------------------------------------------
func! vundle#config#init_bundle(name, opts) func! vundle#config#init_bundle(name, opts)
if a:name != substitute(a:name, '^\s*\(.\{-}\)\s*$', '\1', '') if a:name != substitute(a:name, '^\s*\(.\{-}\)\s*$', '\1', '')
echo "Spurious leading and/or trailing whitespace found in bundle spec '" . a:name . "'" echo "Spurious leading and/or trailing whitespace found in plugin spec '" . a:name . "'"
endif endif
let opts = extend(s:parse_options(a:opts), s:parse_name(substitute(a:name,"['".'"]\+','','g'))) let opts = extend(s:parse_options(a:opts), s:parse_name(substitute(a:name,"['".'"]\+','','g')), 'keep')
let b = extend(opts, copy(s:bundle)) let b = extend(opts, copy(s:bundle))
let b.rtpath = s:rtpath(opts) let b.rtpath = s:rtpath(opts)
return b return b
endf endf
" ---------------------------------------------------------------------------
" Check if the current bundle name has already been used in this running
" instance and show an error to that effect.
"
" bundle -- a bundle object whose name is to be checked
" return -- 0 if the bundle's name has been seen before, 1 otherwise
" ---------------------------------------------------------------------------
funct! s:check_bundle_name(bundle)
if has_key(g:bundle_names, a:bundle.name)
echoerr 'Vundle error: Name collision for Plugin ' . a:bundle.name_spec .
\ '. Plugin ' . g:bundle_names[a:bundle.name] .
\ ' previously used the name "' . a:bundle.name . '"' .
\ '. Skipping Plugin ' . a:bundle.name_spec . '.'
return 0
endif
let g:bundle_names[a:bundle.name] = a:bundle.name_spec
return 1
endf
" ---------------------------------------------------------------------------
" Parse the options which can be supplied with the bundle specification.
" Corresponding documentation: vundle-plugins-configure
"
" opts -- a dictionary with the user supplied options for the bundle
" return -- a dictionary with the user supplied options for the bundle, this
" will be merged with a s:bundle object into one dictionary.
" ---------------------------------------------------------------------------
func! s:parse_options(opts) func! s:parse_options(opts)
" TODO: improve this " TODO: improve this
if len(a:opts) != 1 | return {} | endif if len(a:opts) != 1 | return {} | endif
@ -44,6 +122,16 @@ func! s:parse_options(opts)
endif endif
endf endf
" ---------------------------------------------------------------------------
" Parse the plugin specification. Corresponding documentation:
" vundle-plugins-uris
"
" arg -- the string supplied to identify the plugin
" return -- a dictionary with the folder name (key 'name') and the uri (key
" 'uri') for cloning the plugin and the original argument (key
" 'name_spec')
" ---------------------------------------------------------------------------
func! s:parse_name(arg) func! s:parse_name(arg)
let arg = a:arg let arg = a:arg
let git_proto = exists('g:vundle_default_git_proto') ? g:vundle_default_git_proto : 'https' let git_proto = exists('g:vundle_default_git_proto') ? g:vundle_default_git_proto : 'https'
@ -67,6 +155,30 @@ func! s:parse_name(arg)
return {'name': name, 'uri': uri, 'name_spec': arg } return {'name': name, 'uri': uri, 'name_spec': arg }
endf endf
" ---------------------------------------------------------------------------
" Modify the runtimepath, after all bundles have been added, so that the
" directories that were in the default runtimepath appear first in the list
" (with their 'after' directories last).
" ---------------------------------------------------------------------------
func! s:rtp_add_defaults()
let current = &rtp
set rtp&vim
let default = &rtp
let &rtp = current
let default_rtp_items = split(default, ',')
if !empty(default_rtp_items)
let first_item = fnameescape(default_rtp_items[0])
exec 'set rtp-=' . first_item
exec 'set rtp^=' . first_item
endif
endf
" ---------------------------------------------------------------------------
" Remove all paths for the plugins which are managed by Vundle from the
" runtimepath.
" ---------------------------------------------------------------------------
func! s:rtp_rm_a() func! s:rtp_rm_a()
let paths = map(copy(g:bundles), 'v:val.rtpath') let paths = map(copy(g:bundles), 'v:val.rtpath')
let prepends = join(paths, ',') let prepends = join(paths, ',')
@ -75,6 +187,11 @@ func! s:rtp_rm_a()
exec 'set rtp-='.fnameescape(appends) exec 'set rtp-='.fnameescape(appends)
endf endf
" ---------------------------------------------------------------------------
" Add all paths for the plugins which are managed by Vundle to the
" runtimepath.
" ---------------------------------------------------------------------------
func! s:rtp_add_a() func! s:rtp_add_a()
let paths = map(copy(g:bundles), 'v:val.rtpath') let paths = map(copy(g:bundles), 'v:val.rtpath')
let prepends = join(paths, ',') let prepends = join(paths, ',')
@ -83,27 +200,79 @@ func! s:rtp_add_a()
exec 'set rtp+='.fnameescape(appends) exec 'set rtp+='.fnameescape(appends)
endf endf
" ---------------------------------------------------------------------------
" Remove a directory and the corresponding 'after' directory from runtimepath.
"
" dir -- the directory name to be removed as a string. The corresponding
" 'after' directory will also be removed.
" ---------------------------------------------------------------------------
func! s:rtp_rm(dir) abort func! s:rtp_rm(dir) abort
exec 'set rtp-='.fnameescape(expand(a:dir, 1)) exec 'set rtp-='.fnameescape(expand(a:dir, 1))
exec 'set rtp-='.fnameescape(expand(a:dir.'/after', 1)) exec 'set rtp-='.fnameescape(expand(a:dir.'/after', 1))
endf endf
" ---------------------------------------------------------------------------
" Add a directory and the corresponding 'after' directory to runtimepath.
"
" dir -- the directory name to be added as a string. The corresponding
" 'after' directory will also be added.
" ---------------------------------------------------------------------------
func! s:rtp_add(dir) abort func! s:rtp_add(dir) abort
exec 'set rtp^='.fnameescape(expand(a:dir, 1)) exec 'set rtp^='.fnameescape(expand(a:dir, 1))
exec 'set rtp+='.fnameescape(expand(a:dir.'/after', 1)) exec 'set rtp+='.fnameescape(expand(a:dir.'/after', 1))
endf endf
" ---------------------------------------------------------------------------
" Expand and simplify a path.
"
" path -- the path to expand as a string
" return -- the expanded and simplified path
" ---------------------------------------------------------------------------
func! s:expand_path(path) abort func! s:expand_path(path) abort
return simplify(expand(a:path, 1)) return simplify(expand(a:path, 1))
endf endf
" ---------------------------------------------------------------------------
" Find the actual path inside a bundle directory to be added to the
" runtimepath. It might be provided by the user with the 'rtp' option.
" Corresponding documentation: vundle-plugins-configure
"
" opts -- a bundle dict
" return -- expanded path to the corresponding plugin directory
" ---------------------------------------------------------------------------
func! s:rtpath(opts) func! s:rtpath(opts)
return has_key(a:opts, 'rtp') ? s:expand_path(a:opts.path().'/'.a:opts.rtp) : a:opts.path() return has_key(a:opts, 'rtp') ? s:expand_path(a:opts.path().'/'.a:opts.rtp) : a:opts.path()
endf endf
" ---------------------------------------------------------------------------
" a bundle 'object'
" ---------------------------------------------------------------------------
let s:bundle = {} let s:bundle = {}
" ---------------------------------------------------------------------------
" Return the absolute path to the directory inside the bundle directory
" (prefix) where thr bundle will be cloned.
"
" return -- the target location to clone this bundle to
" ---------------------------------------------------------------------------
func! s:bundle.path() func! s:bundle.path()
return s:expand_path(g:bundle_dir.'/'.self.name) return s:expand_path(g:bundle_dir.'/'.self.name)
endf endf
" ---------------------------------------------------------------------------
" Determine if the bundle has the pinned attribute set in the config
"
" return -- 1 if the bundle is pinned, 0 otherwise
" ---------------------------------------------------------------------------
func! s:bundle.is_pinned()
return get(self, 'pinned')
endf
" vim: set expandtab sts=2 ts=2 sw=2 tw=78 norl:

View File

@ -1,17 +1,35 @@
" ---------------------------------------------------------------------------
" Try to clone all new bundles given (or all bundles in g:bundles by default)
" to g:bundle_dir. If a:bang is 1 it will also update all plugins (git pull).
"
" bang -- 1 or 0
" ... -- any number of bundle specifications (separate arguments)
" ---------------------------------------------------------------------------
func! vundle#installer#new(bang, ...) abort func! vundle#installer#new(bang, ...) abort
let bundles = (a:1 == '') ? let bundles = (a:1 == '') ?
\ g:bundles : \ g:bundles :
\ map(copy(a:000), 'vundle#config#bundle(v:val, {})') \ map(copy(a:000), 'vundle#config#bundle(v:val, {})')
let names = vundle#scripts#bundle_names(map(copy(bundles), 'v:val.name_spec')) let names = vundle#scripts#bundle_names(map(copy(bundles), 'v:val.name_spec'))
call vundle#scripts#view('Installer',['" Installing bundles to '.expand(g:bundle_dir, 1)], names + ['Helptags']) call vundle#scripts#view('Installer',['" Installing plugins to '.expand(g:bundle_dir, 1)], names + ['Helptags'])
" This calls 'add' as a normal mode command. This is a buffer local mapping
" defined in vundle#scripts#view(). The mapping will call a buffer local
" command InstallPlugin which in turn will call vundle#installer#run() with
" vundle#installer#install().
call s:process(a:bang, (a:bang ? 'add!' : 'add')) call s:process(a:bang, (a:bang ? 'add!' : 'add'))
call vundle#config#require(bundles) call vundle#config#require(bundles)
endf endf
" ---------------------------------------------------------------------------
" Iterate over all lines in a Vundle window and execute the given command for
" every line. Used by the installation and cleaning functions.
"
" bang -- not used (FIXME)
" cmd -- the (normal mode) command to execute for every line as a string
" ---------------------------------------------------------------------------
func! s:process(bang, cmd) func! s:process(bang, cmd)
let msg = '' let msg = ''
@ -30,7 +48,7 @@ func! s:process(bang, cmd)
endif endif
if 'updated' == g:vundle_last_status && empty(msg) if 'updated' == g:vundle_last_status && empty(msg)
let msg = 'Bundles updated; press u to view changelog' let msg = 'Plugins updated; press u to view changelog'
endif endif
" goto next one " goto next one
@ -43,6 +61,16 @@ func! s:process(bang, cmd)
echo 'Done! '.msg echo 'Done! '.msg
endf endf
" ---------------------------------------------------------------------------
" Call another function in the different Vundle windows.
"
" func_name -- the function to call
" name -- the bundle name to call func_name for (string)
" ... -- the argument to be used when calling func_name (only the first
" optional argument will be used)
" return -- the status returned by the call to func_name
" ---------------------------------------------------------------------------
func! vundle#installer#run(func_name, name, ...) abort func! vundle#installer#run(func_name, name, ...) abort
let n = a:name let n = a:name
@ -67,6 +95,8 @@ func! vundle#installer#run(func_name, name, ...) abort
echo n.' deleted' echo n.' deleted'
elseif 'helptags' == status elseif 'helptags' == status
echo n.' regenerated' echo n.' regenerated'
elseif 'pinned' == status
echo n.' pinned'
elseif 'error' == status elseif 'error' == status
echohl Error echohl Error
echo 'Error processing '.n echo 'Error processing '.n
@ -81,6 +111,13 @@ func! vundle#installer#run(func_name, name, ...) abort
return status return status
endf endf
" ---------------------------------------------------------------------------
" Put a sign on the current line, indicating the status of the installation
" step.
"
" status -- string describing the status
" ---------------------------------------------------------------------------
func! s:sign(status) func! s:sign(status)
if (!has('signs')) if (!has('signs'))
return return
@ -89,6 +126,14 @@ func! s:sign(status)
exe ":sign place ".line('.')." line=".line('.')." name=Vu_". a:status ." buffer=" . bufnr("%") exe ":sign place ".line('.')." line=".line('.')." name=Vu_". a:status ." buffer=" . bufnr("%")
endf endf
" ---------------------------------------------------------------------------
" Install a plugin, then add it to the runtimepath and source it.
"
" bang -- 1 or 0, passed directly to vundle#installer#install()
" name -- the name of a bundle (string)
" return -- the return value from vundle#installer#install()
" ---------------------------------------------------------------------------
func! vundle#installer#install_and_require(bang, name) abort func! vundle#installer#install_and_require(bang, name) abort
let result = vundle#installer#install(a:bang, a:name) let result = vundle#installer#install(a:bang, a:name)
let b = vundle#config#bundle(a:name, {}) let b = vundle#config#bundle(a:name, {})
@ -97,14 +142,35 @@ func! vundle#installer#install_and_require(bang, name) abort
return result return result
endf endf
" ---------------------------------------------------------------------------
" Install or update a bundle given by its name.
"
" bang -- 1 or 0, passed directly to s:sync()
" name -- the name of a bundle (string)
" return -- the return value from s:sync()
" ---------------------------------------------------------------------------
func! vundle#installer#install(bang, name) abort func! vundle#installer#install(bang, name) abort
if !isdirectory(g:bundle_dir) | call mkdir(g:bundle_dir, 'p') | endif if !isdirectory(g:bundle_dir) | call mkdir(g:bundle_dir, 'p') | endif
let b = vundle#config#init_bundle(a:name, {}) let n = substitute(a:name,"['".'"]\+','','g')
let matched = filter(copy(g:bundles), 'v:val.name_spec == n')
if len(matched) > 0
let b = matched[0]
else
let b = vundle#config#init_bundle(a:name, {})
endif
return s:sync(a:bang, b) return s:sync(a:bang, b)
endf endf
" ---------------------------------------------------------------------------
" Call :helptags for all bundles in g:bundles.
"
" return -- 'error' if an error occurred, else return 'helptags'
" ---------------------------------------------------------------------------
func! vundle#installer#docs() abort func! vundle#installer#docs() abort
let error_count = vundle#installer#helptags(g:bundles) let error_count = vundle#installer#helptags(g:bundles)
if error_count > 0 if error_count > 0
@ -113,6 +179,14 @@ func! vundle#installer#docs() abort
return 'helptags' return 'helptags'
endf endf
" ---------------------------------------------------------------------------
" Call :helptags for a list of bundles.
"
" bundles -- a list of bundle dictionaries for which :helptags should be
" called.
" return -- the number of directories where :helptags failed
" ---------------------------------------------------------------------------
func! vundle#installer#helptags(bundles) abort func! vundle#installer#helptags(bundles) abort
let bundle_dirs = map(copy(a:bundles),'v:val.rtpath') let bundle_dirs = map(copy(a:bundles),'v:val.rtpath')
let help_dirs = filter(bundle_dirs, 's:has_doc(v:val)') let help_dirs = filter(bundle_dirs, 's:has_doc(v:val)')
@ -123,19 +197,33 @@ func! vundle#installer#helptags(bundles) abort
let statuses = map(copy(help_dirs), 's:helptags(v:val)') let statuses = map(copy(help_dirs), 's:helptags(v:val)')
let errors = filter(statuses, 'v:val == 0') let errors = filter(statuses, 'v:val == 0')
call s:log('Helptags: '.len(help_dirs).' bundles processed') call s:log('Helptags: '.len(help_dirs).' plugins processed')
return len(errors) return len(errors)
endf endf
" ---------------------------------------------------------------------------
" List all installed plugins.
" Corresponding documentation: vundle-plugins-list
"
" bang -- not used
" ---------------------------------------------------------------------------
func! vundle#installer#list(bang) abort func! vundle#installer#list(bang) abort
let bundles = vundle#scripts#bundle_names(map(copy(g:bundles), 'v:val.name_spec')) let bundles = vundle#scripts#bundle_names(map(copy(g:bundles), 'v:val.name_spec'))
call vundle#scripts#view('list', ['" My Bundles'], bundles) call vundle#scripts#view('list', ['" My Plugins'], bundles)
redraw redraw
echo len(g:bundles).' bundles configured' echo len(g:bundles).' plugins configured'
endf endf
" ---------------------------------------------------------------------------
" List and remove all directories in the bundle directory which are not
" activated (added to the bundle list).
"
" bang -- 0 if the user should be asked to confirm every deletion, 1 if they
" should be removed unconditionally
" ---------------------------------------------------------------------------
func! vundle#installer#clean(bang) abort func! vundle#installer#clean(bang) abort
let bundle_dirs = map(copy(g:bundles), 'v:val.path()') let bundle_dirs = map(copy(g:bundles), 'v:val.path()')
let all_dirs = (v:version > 702 || (v:version == 702 && has("patch51"))) let all_dirs = (v:version > 702 || (v:version == 702 && has("patch51")))
@ -147,7 +235,7 @@ func! vundle#installer#clean(bang) abort
let headers = ['" All clean!'] let headers = ['" All clean!']
let names = [] let names = []
else else
let headers = ['" Removing bundles:'] let headers = ['" Removing Plugins:']
let names = vundle#scripts#bundle_names(map(copy(x_dirs), 'fnamemodify(v:val, ":t")')) let names = vundle#scripts#bundle_names(map(copy(x_dirs), 'fnamemodify(v:val, ":t")'))
end end
@ -167,6 +255,14 @@ func! vundle#installer#clean(bang) abort
endf endf
" ---------------------------------------------------------------------------
" Delete to directory for a plugin.
"
" bang -- not used
" dir_name -- the bundle directory to be deleted (as a string)
" return -- 'error' if an error occurred, 'deleted' if the plugin folder was
" successfully deleted
" ---------------------------------------------------------------------------
func! vundle#installer#delete(bang, dir_name) abort func! vundle#installer#delete(bang, dir_name) abort
let cmd = ((has('win32') || has('win64')) && empty(matchstr(&shell, 'sh'))) ? let cmd = ((has('win32') || has('win64')) && empty(matchstr(&shell, 'sh'))) ?
@ -174,14 +270,14 @@ func! vundle#installer#delete(bang, dir_name) abort
\ 'rm -rf' \ 'rm -rf'
let bundle = vundle#config#init_bundle(a:dir_name, {}) let bundle = vundle#config#init_bundle(a:dir_name, {})
let cmd .= ' '.shellescape(bundle.path()) let cmd .= ' '.vundle#installer#shellesc(bundle.path())
let out = s:system(cmd) let out = s:system(cmd)
call s:log('') call s:log('')
call s:log('Bundle '.a:dir_name) call s:log('Plugin '.a:dir_name)
call s:log('$ '.cmd) call s:log(cmd, '$ ')
call s:log('> '.out) call s:log(out, '> ')
if 0 != v:shell_error if 0 != v:shell_error
return 'error' return 'error'
@ -190,6 +286,13 @@ func! vundle#installer#delete(bang, dir_name) abort
endif endif
endf endf
" ---------------------------------------------------------------------------
" Check if a bundled plugin has any documentation.
"
" rtp -- a path (string) where the plugin is installed
" return -- 1 if some documentation was found, 0 otherwise
" ---------------------------------------------------------------------------
func! s:has_doc(rtp) abort func! s:has_doc(rtp) abort
return isdirectory(a:rtp.'/doc') return isdirectory(a:rtp.'/doc')
\ && (!filereadable(a:rtp.'/doc/tags') || filewritable(a:rtp.'/doc/tags')) \ && (!filereadable(a:rtp.'/doc/tags') || filewritable(a:rtp.'/doc/tags'))
@ -198,11 +301,19 @@ func! s:has_doc(rtp) abort
\ : !(empty(glob(a:rtp.'/doc/*.txt')) && empty(glob(a:rtp.'/doc/*.??x'))) \ : !(empty(glob(a:rtp.'/doc/*.txt')) && empty(glob(a:rtp.'/doc/*.??x')))
endf endf
" ---------------------------------------------------------------------------
" Update the helptags for a plugin.
"
" rtp -- the path to the plugin's root directory (string)
" return -- 1 if :helptags succeeded, 0 otherwise
" ---------------------------------------------------------------------------
func! s:helptags(rtp) abort func! s:helptags(rtp) abort
let doc_path = a:rtp.'/doc/' " it is important to keep trailing slash here
let doc_path = resolve(a:rtp . '/doc/')
call s:log(':helptags '.doc_path) call s:log(':helptags '.doc_path)
try try
execute 'helptags ' . resolve(doc_path) execute 'helptags ' . doc_path
catch catch
call s:log("> Error running :helptags ".doc_path) call s:log("> Error running :helptags ".doc_path)
return 0 return 0
@ -210,27 +321,123 @@ func! s:helptags(rtp) abort
return 1 return 1
endf endf
func! s:sync(bang, bundle) abort
" ---------------------------------------------------------------------------
" Get the URL for the remote called 'origin' on the repository that
" corresponds to a given bundle.
"
" bundle -- a bundle object to check the repository for
" return -- the URL for the origin remote (string)
" ---------------------------------------------------------------------------
func! s:get_current_origin_url(bundle) abort
let cmd = 'cd '.vundle#installer#shellesc(a:bundle.path()).' && git config --get remote.origin.url'
let cmd = vundle#installer#shellesc_cd(cmd)
let out = s:strip(s:system(cmd))
return out
endf
" ---------------------------------------------------------------------------
" Get a short sha of the HEAD of the repository for a given bundle
"
" bundle -- a bundle object
" return -- A 15 character log sha for the current HEAD
" ---------------------------------------------------------------------------
func! s:get_current_sha(bundle)
let cmd = 'cd '.vundle#installer#shellesc(a:bundle.path()).' && git rev-parse HEAD'
let cmd = vundle#installer#shellesc_cd(cmd)
let out = s:system(cmd)[0:15]
return out
endf
" ---------------------------------------------------------------------------
" Create the appropriate sync command to run according to the current state of
" the local repository (clone, pull, reset, etc).
"
" In the case of a pull (update), also return the current sha, so that we can
" later check that there has been an upgrade.
"
" bang -- 0 if only new plugins should be installed, 1 if existing plugins
" should be updated
" bundle -- a bundle object to create the sync command for
" return -- A list containing the command to run and the sha for the current
" HEAD
" ---------------------------------------------------------------------------
func! s:make_sync_command(bang, bundle) abort
let git_dir = expand(a:bundle.path().'/.git/', 1) let git_dir = expand(a:bundle.path().'/.git/', 1)
if isdirectory(git_dir) || filereadable(expand(a:bundle.path().'/.git', 1)) if isdirectory(git_dir) || filereadable(expand(a:bundle.path().'/.git', 1))
if !(a:bang) | return 'todate' | endif
let cmd = 'cd '.shellescape(a:bundle.path()).' && git pull && git submodule update --init --recursive'
let cmd = g:shellesc_cd(cmd) let current_origin_url = s:get_current_origin_url(a:bundle)
if current_origin_url != a:bundle.uri
call s:log('Plugin URI change detected for Plugin ' . a:bundle.name)
call s:log('> Plugin ' . a:bundle.name . ' old URI: ' . current_origin_url)
call s:log('> Plugin ' . a:bundle.name . ' new URI: ' . a:bundle.uri)
" Directory names match but the origin remotes are not the same
let cmd_parts = [
\ 'cd '.vundle#installer#shellesc(a:bundle.path()) ,
\ 'git remote set-url origin ' . vundle#installer#shellesc(a:bundle.uri),
\ 'git fetch',
\ 'git reset --hard origin/HEAD',
\ 'git submodule update --init --recursive',
\ ]
let cmd = join(cmd_parts, ' && ')
let cmd = vundle#installer#shellesc_cd(cmd)
let initial_sha = ''
return [cmd, initial_sha]
endif
let get_current_sha = 'cd '.shellescape(a:bundle.path()).' && git rev-parse HEAD' if !(a:bang)
let get_current_sha = g:shellesc_cd(get_current_sha) " The repo exists, and no !, so leave as it is.
let initial_sha = s:system(get_current_sha)[0:15] return ['', '']
endif
let cmd_parts = [
\ 'cd '.vundle#installer#shellesc(a:bundle.path()),
\ 'git pull',
\ 'git submodule update --init --recursive',
\ ]
let cmd = join(cmd_parts, ' && ')
let cmd = vundle#installer#shellesc_cd(cmd)
let initial_sha = s:get_current_sha(a:bundle)
else else
let cmd = 'git clone --recursive '.shellescape(a:bundle.uri).' '.shellescape(a:bundle.path()) let cmd = 'git clone --recursive '.vundle#installer#shellesc(a:bundle.uri).' '.vundle#installer#shellesc(a:bundle.path())
let initial_sha = '' let initial_sha = ''
endif endif
return [cmd, initial_sha]
endf
" ---------------------------------------------------------------------------
" Install or update a given bundle object with git.
"
" bang -- 0 if only new plugins should be installed, 1 if existing plugins
" should be updated
" bundle -- a bundle object (dictionary)
" return -- a string indicating the status of the bundle installation:
" - todate : Nothing was updated or the repository was up to date
" - new : The plugin was newly installed
" - updated : Some changes where pulled via git
" - error : An error occurred in the shell command
" - pinned : The bundle is marked as pinned
" ---------------------------------------------------------------------------
func! s:sync(bang, bundle) abort
" Do not sync if this bundle is pinned
if a:bundle.is_pinned()
return 'pinned'
endif
let [ cmd, initial_sha ] = s:make_sync_command(a:bang, a:bundle)
if empty(cmd)
return 'todate'
endif
let out = s:system(cmd) let out = s:system(cmd)
call s:log('') call s:log('')
call s:log('Bundle '.a:bundle.name_spec) call s:log('Plugin '.a:bundle.name_spec)
call s:log('$ '.cmd) call s:log(cmd, '$ ')
call s:log('> '.out) call s:log(out, '> ')
if 0 != v:shell_error if 0 != v:shell_error
return 'error' return 'error'
@ -240,7 +447,7 @@ func! s:sync(bang, bundle) abort
return 'new' return 'new'
endif endif
let updated_sha = s:system(get_current_sha)[0:15] let updated_sha = s:get_current_sha(a:bundle)
if initial_sha == updated_sha if initial_sha == updated_sha
return 'todate' return 'todate'
@ -250,31 +457,78 @@ func! s:sync(bang, bundle) abort
return 'updated' return 'updated'
endf endf
func! g:shellesc(cmd) abort
" ---------------------------------------------------------------------------
" Escape special characters in a string to be able to use it as a shell
" command with system().
"
" cmd -- the string holding the shell command
" return -- a string with the relevant characters escaped
" ---------------------------------------------------------------------------
func! vundle#installer#shellesc(cmd) abort
if ((has('win32') || has('win64')) && empty(matchstr(&shell, 'sh'))) if ((has('win32') || has('win64')) && empty(matchstr(&shell, 'sh')))
if &shellxquote != '(' " workaround for patch #445 return '"' . substitute(a:cmd, '"', '\\"', 'g') . '"'
return '"'.a:cmd.'"' " enclose in quotes so && joined cmds work
endif
endif endif
return a:cmd return shellescape(a:cmd)
endf endf
func! g:shellesc_cd(cmd) abort
" ---------------------------------------------------------------------------
" Fix a cd shell command to be used on Windows.
"
" cmd -- the command to be fixed (string)
" return -- the fixed command (string)
" ---------------------------------------------------------------------------
func! vundle#installer#shellesc_cd(cmd) abort
if ((has('win32') || has('win64')) && empty(matchstr(&shell, 'sh'))) if ((has('win32') || has('win64')) && empty(matchstr(&shell, 'sh')))
let cmd = substitute(a:cmd, '^cd ','cd /d ','') " add /d switch to change drives let cmd = substitute(a:cmd, '^cd ','cd /d ','') " add /d switch to change drives
let cmd = g:shellesc(cmd)
return cmd return cmd
else else
return a:cmd return a:cmd
endif endif
endf endf
" ---------------------------------------------------------------------------
" Make a system call. This can be used to change the way system calls
" are made during developing, without searching the whole code base for
" actual system() calls.
"
" cmd -- the command passed to system() (string)
" return -- the return value from system()
" ---------------------------------------------------------------------------
func! s:system(cmd) abort func! s:system(cmd) abort
return system(a:cmd) return system(a:cmd)
endf endf
func! s:log(str) abort
let fmt = '%y%m%d %H:%M:%S' " ---------------------------------------------------------------------------
call add(g:vundle_log, '['.strftime(fmt).'] '.a:str) " Add a log message to Vundle's internal logging variable.
"
" str -- the log message (string)
" prefix -- optional prefix for multi-line entries (string)
" return -- a:str
" ---------------------------------------------------------------------------
func! s:log(str, ...) abort
let prefix = a:0 > 0 ? a:1 : ''
let fmt = '%Y-%m-%d %H:%M:%S'
let lines = split(a:str, '\n', 1)
let time = strftime(fmt)
for line in lines
call add(g:vundle_log, '['. time .'] '. prefix . line)
endfor
return a:str return a:str
endf endf
" ---------------------------------------------------------------------------
" Remove leading and trailing whitespace from a string
"
" str -- The string to rid of trailing and leading spaces
" return -- A string stripped of side spaces
" ---------------------------------------------------------------------------
func! s:strip(str)
return substitute(a:str, '\%^\_s*\(.\{-}\)\_s*\%$', '\1', '')
endf
" vim: set expandtab sts=2 ts=2 sw=2 tw=78 norl:

View File

@ -1,6 +1,14 @@
" ---------------------------------------------------------------------------
" Search the database from vim-script.org for a matching plugin. If no
" argument is given, list all plugins. This function is used by the :Plugins
" and :PluginSearch commands.
"
" bang -- if 1 refresh the script name cache, if 0 don't
" ... -- a plugin name to search for
" ---------------------------------------------------------------------------
func! vundle#scripts#all(bang, ...) func! vundle#scripts#all(bang, ...)
let b:match = '' let b:match = ''
let info = ['"Keymap: i - Install bundle; c - Cleanup; s - Search; R - Reload list'] let info = ['"Keymap: i - Install plugin; c - Cleanup; s - Search; R - Reload list']
let matches = s:load_scripts(a:bang) let matches = s:load_scripts(a:bang)
if !empty(a:1) if !empty(a:1)
let matches = filter(matches, 'v:val =~? "'.escape(a:1,'"').'"') let matches = filter(matches, 'v:val =~? "'.escape(a:1,'"').'"')
@ -10,18 +18,34 @@ func! vundle#scripts#all(bang, ...)
endif endif
call vundle#scripts#view('search',info, vundle#scripts#bundle_names(reverse(matches))) call vundle#scripts#view('search',info, vundle#scripts#bundle_names(reverse(matches)))
redraw redraw
echo len(matches).' bundles found' echo len(matches).' plugins found'
endf endf
" ---------------------------------------------------------------------------
" Repeat the search for bundles.
" ---------------------------------------------------------------------------
func! vundle#scripts#reload() abort func! vundle#scripts#reload() abort
silent exec ':BundleSearch! '.(exists('b:match') ? b:match : '') silent exec ':PluginSearch! '.(exists('b:match') ? b:match : '')
redraw redraw
endf endf
" ---------------------------------------------------------------------------
" Complete names for bundles in the command line.
"
" a, c, d -- see :h command-completion-custom
" return -- all valid plugin names from vim-scripts.org as completion
" candidates, see also :h command-completion-custom
" ---------------------------------------------------------------------------
func! vundle#scripts#complete(a,c,d) func! vundle#scripts#complete(a,c,d)
return join(s:load_scripts(0),"\n") return join(s:load_scripts(0),"\n")
endf endf
" ---------------------------------------------------------------------------
" View the logfile after an update or installation.
" ---------------------------------------------------------------------------
func! s:view_log() func! s:view_log()
if !exists('g:vundle_log_file') if !exists('g:vundle_log_file')
let g:vundle_log_file = tempname() let g:vundle_log_file = tempname()
@ -33,22 +57,27 @@ func! s:view_log()
wincmd P | wincmd H wincmd P | wincmd H
endf endf
" ---------------------------------------------------------------------------
" Parse the output from git log after an update to create a change log for the
" user.
" ---------------------------------------------------------------------------
func! s:create_changelog() abort func! s:create_changelog() abort
for bundle_data in g:updated_bundles for bundle_data in g:updated_bundles
let initial_sha = bundle_data[0] let initial_sha = bundle_data[0]
let updated_sha = bundle_data[1] let updated_sha = bundle_data[1]
let bundle = bundle_data[2] let bundle = bundle_data[2]
let cmd = 'cd '.shellescape(bundle.path()). let cmd = 'cd '.vundle#installer#shellesc(bundle.path()).
\ ' && git log --pretty=format:"%s %an, %ar" --graph '. \ ' && git log --pretty=format:"%s %an, %ar" --graph '.
\ initial_sha.'..'.updated_sha \ initial_sha.'..'.updated_sha
let cmd = g:shellesc_cd(cmd) let cmd = vundle#installer#shellesc_cd(cmd)
let updates = system(cmd) let updates = system(cmd)
call add(g:vundle_changelog, '') call add(g:vundle_changelog, '')
call add(g:vundle_changelog, 'Updated Bundle: '.bundle.name) call add(g:vundle_changelog, 'Updated Plugin: '.bundle.name)
if bundle.uri =~ "https://github.com" if bundle.uri =~ "https://github.com"
call add(g:vundle_changelog, 'Compare at: '.bundle.uri[0:-5].'/compare/'.initial_sha.'...'.updated_sha) call add(g:vundle_changelog, 'Compare at: '.bundle.uri[0:-5].'/compare/'.initial_sha.'...'.updated_sha)
@ -61,6 +90,10 @@ func! s:create_changelog() abort
endfor endfor
endf endf
" ---------------------------------------------------------------------------
" View the change log after an update or installation.
" ---------------------------------------------------------------------------
func! s:view_changelog() func! s:view_changelog()
call s:create_changelog() call s:create_changelog()
@ -74,10 +107,27 @@ func! s:view_changelog()
wincmd P | wincmd H wincmd P | wincmd H
endf endf
" ---------------------------------------------------------------------------
" Create a list of 'Plugin ...' lines from a list of bundle names.
"
" names -- a list of names (strings) of plugins
" return -- a list of 'Plugin ...' lines suitable to be written to a buffer
" ---------------------------------------------------------------------------
func! vundle#scripts#bundle_names(names) func! vundle#scripts#bundle_names(names)
return map(copy(a:names), ' printf("Bundle ' ."'%s'".'", v:val) ') return map(copy(a:names), ' printf("Plugin ' ."'%s'".'", v:val) ')
endf endf
" ---------------------------------------------------------------------------
" Open a buffer to display information to the user. Several special commands
" are defined in the new buffer.
"
" title -- a title for the new buffer
" headers -- a list of header lines to be displayed at the top of the buffer
" results -- the main information to be displayed in the buffer (list of
" strings)
" ---------------------------------------------------------------------------
func! vundle#scripts#view(title, headers, results) func! vundle#scripts#view(title, headers, results)
if exists('g:vundle_view') && bufloaded(g:vundle_view) if exists('g:vundle_view') && bufloaded(g:vundle_view)
exec g:vundle_view.'bd!' exec g:vundle_view.'bd!'
@ -99,21 +149,22 @@ func! vundle#scripts#view(title, headers, results)
setl noswapfile setl noswapfile
setl cursorline setl cursorline
setl nonu ro noma ignorecase setl nonu ro noma
if (exists('&relativenumber')) | setl norelativenumber | endif if (exists('&relativenumber')) | setl norelativenumber | endif
setl ft=vundle setl ft=vundle
setl syntax=vim setl syntax=vim
syn keyword vimCommand Plugin
syn keyword vimCommand Bundle syn keyword vimCommand Bundle
syn keyword vimCommand Helptags syn keyword vimCommand Helptags
com! -buffer -bang -nargs=1 DeleteBundle com! -buffer -bang -nargs=1 DeletePlugin
\ call vundle#installer#run('vundle#installer#delete', split(<q-args>,',')[0], ['!' == '<bang>', <args>]) \ call vundle#installer#run('vundle#installer#delete', split(<q-args>,',')[0], ['!' == '<bang>', <args>])
com! -buffer -bang -nargs=? InstallAndRequireBundle com! -buffer -bang -nargs=? InstallAndRequirePlugin
\ call vundle#installer#run('vundle#installer#install_and_require', split(<q-args>,',')[0], ['!' == '<bang>', <q-args>]) \ call vundle#installer#run('vundle#installer#install_and_require', split(<q-args>,',')[0], ['!' == '<bang>', <q-args>])
com! -buffer -bang -nargs=? InstallBundle com! -buffer -bang -nargs=? InstallPlugin
\ call vundle#installer#run('vundle#installer#install', split(<q-args>,',')[0], ['!' == '<bang>', <q-args>]) \ call vundle#installer#run('vundle#installer#install', split(<q-args>,',')[0], ['!' == '<bang>', <q-args>])
com! -buffer -bang -nargs=0 InstallHelptags com! -buffer -bang -nargs=0 InstallHelptags
@ -127,26 +178,33 @@ func! vundle#scripts#view(title, headers, results)
nnoremap <buffer> D :exec 'Delete'.getline('.')<CR> nnoremap <buffer> D :exec 'Delete'.getline('.')<CR>
nnoremap <buffer> add :exec 'Install'.getline('.')<CR> nnoremap <buffer> add :exec 'Install'.getline('.')<CR>
nnoremap <buffer> add! :exec 'Install'.substitute(getline('.'), '^Bundle ', 'Bundle! ', '')<CR> nnoremap <buffer> add! :exec 'Install'.substitute(getline('.'), '^Plugin ', 'Plugin! ', '')<CR>
nnoremap <buffer> i :exec 'InstallAndRequire'.getline('.')<CR> nnoremap <buffer> i :exec 'InstallAndRequire'.getline('.')<CR>
nnoremap <buffer> I :exec 'InstallAndRequire'.substitute(getline('.'), '^Bundle ', 'Bundle! ', '')<CR> nnoremap <buffer> I :exec 'InstallAndRequire'.substitute(getline('.'), '^Plugin ', 'Plugin! ', '')<CR>
nnoremap <buffer> l :VundleLog<CR> nnoremap <buffer> l :VundleLog<CR>
nnoremap <buffer> u :VundleChangelog<CR> nnoremap <buffer> u :VundleChangelog<CR>
nnoremap <buffer> h :h vundle<CR> nnoremap <buffer> h :h vundle<CR>
nnoremap <buffer> ? :norm h<CR> nnoremap <buffer> ? :norm h<CR>
nnoremap <buffer> c :BundleClean<CR> nnoremap <buffer> c :PluginClean<CR>
nnoremap <buffer> C :BundleClean!<CR> nnoremap <buffer> C :PluginClean!<CR>
nnoremap <buffer> s :BundleSearch nnoremap <buffer> s :PluginSearch
nnoremap <buffer> R :call vundle#scripts#reload()<CR> nnoremap <buffer> R :call vundle#scripts#reload()<CR>
" goto first line after headers " goto first line after headers
exec ':'.(len(a:headers) + 1) exec ':'.(len(a:headers) + 1)
endf endf
" ---------------------------------------------------------------------------
" Load the plugin database from vim-scripts.org .
"
" to -- the filename (string) to save the database to
" return -- 0 on success, 1 if an error occurred
" ---------------------------------------------------------------------------
func! s:fetch_scripts(to) func! s:fetch_scripts(to)
let scripts_dir = fnamemodify(expand(a:to, 1), ":h") let scripts_dir = fnamemodify(expand(a:to, 1), ":h")
if !isdirectory(scripts_dir) if !isdirectory(scripts_dir)
@ -155,13 +213,13 @@ func! s:fetch_scripts(to)
let l:vim_scripts_json = 'http://vim-scripts.org/api/scripts.json' let l:vim_scripts_json = 'http://vim-scripts.org/api/scripts.json'
if executable("curl") if executable("curl")
let cmd = 'curl --fail -s -o '.shellescape(a:to).' '.l:vim_scripts_json let cmd = 'curl --fail -s -o '.vundle#installer#shellesc(a:to).' '.l:vim_scripts_json
elseif executable("wget") elseif executable("wget")
let temp = shellescape(tempname()) let temp = vundle#installer#shellesc(tempname())
let cmd = 'wget -q -O '.temp.' '.l:vim_scripts_json. ' && mv -f '.temp.' '.shellescape(a:to) let cmd = 'wget -q -O '.temp.' '.l:vim_scripts_json. ' && mv -f '.temp.' '.vundle#installer#shellesc(a:to)
if (has('win32') || has('win64')) if (has('win32') || has('win64'))
let cmd = substitute(cmd, 'mv -f ', 'move /Y ', '') " change force flag let cmd = substitute(cmd, 'mv -f ', 'move /Y ', '') " change force flag
let cmd = g:shellesc(cmd) let cmd = vundle#installer#shellesc(cmd)
end end
else else
echoerr 'Error curl or wget is not available!' echoerr 'Error curl or wget is not available!'
@ -177,6 +235,15 @@ func! s:fetch_scripts(to)
return 0 return 0
endf endf
" ---------------------------------------------------------------------------
" Load the plugin database and return a list of all plugins.
"
" bang -- if 1 download the redatabase, else only download if it is not
" readable on disk (i.e. does not exist)
" return -- a list of strings, these are the names (valid bundle
" specifications) of all plugins from vim-scripts.org
" ---------------------------------------------------------------------------
func! s:load_scripts(bang) func! s:load_scripts(bang)
let f = expand(g:bundle_dir.'/.vundle/script-names.vim-scripts.org.json', 1) let f = expand(g:bundle_dir.'/.vundle/script-names.vim-scripts.org.json', 1)
if a:bang || !filereadable(f) if a:bang || !filereadable(f)
@ -186,3 +253,5 @@ func! s:load_scripts(bang)
endif endif
return eval(readfile(f, 'b')[0]) return eval(readfile(f, 'b')[0])
endf endf
" vim: set expandtab sts=2 ts=2 sw=2 tw=78 norl:

View File

@ -0,0 +1,22 @@
Change Log
==========
F = Feature, B = Bug Fix, D = Doc Change
### Version 0.10.2
- B: #430 Put user script directories before system directories in rtp
- B: #455 Rename functions that start with `g:` + lowercase letter (Vim patch 7.4.264)
### Version 0.10.1
- B: #451 Escape spaces when handling rtp directories
### Version 0.10
- F: #415 Support plugin pinning (for non-git repos & preventing updates)
- F: #440 Detect plugin name collisions
- F: #418 Deferred rtp manipulation (speeds up start)
- B: #418 Leave default rtp directories (i.e. ~/.vim) where they should be
- B: #429 Fix newline character in log
- B: #440 Detect changed remotes & update repos
- D: #435 Image update in README.md
- D: #419 Add function documentation
- D: #436 Rename vundle to Vundle.vim, add modelines, quickstart update

View File

@ -1,237 +1,397 @@
*vundle.txt* Vundle the plug-in manager for Vim. *vundle* *vundle.txt* Vundle, a plug-in manager for Vim. *vundle*
CONTENTS ~ VUNDLE MANUAL
*vundle-contents*
===========================================================================
1. About |vundle-about| 1. About Vundle |vundle-about|
2. Why Vundle |vundle-why-vundle| 2. Quick Start |vundle-quickstart|
3. Quick start |vundle-quickstart| 3. Plugins |vundle-plugins|
4. Scripts |vundle-scripts| 3.1. Configuring Plugins |vundle-plugins-configure|
4.1. Configure scripts |vundle-scripts-configure| 3.2. Supported URIs |vundle-plugins-uris|
4.2. Installing scripts |vundle-scripts-install| 3.3. Installing Plugins |vundle-plugins-install|
4.3. Updating scripts |vundle-scripts-update| 3.4. Updating Plugins |vundle-plugins-update|
4.4. Searching scripts |vundle-scripts-search| 3.5. Searching Plugins |vundle-plugins-search|
4.5. Listing scripts |vundle-scripts-list| 3.6. Listing Plugins |vundle-plugins-list|
4.6. Cleanup |vundle-scripts-cleanup| 3.7. Cleaning Up |vundle-plugins-cleanup|
5. Interactive mode |vundle-interactive| 4. Interactive Mode |vundle-interactive|
6. Key mappings |vundle-keymappings| 5. Key Mappings |vundle-keymappings|
7. Options |vundle-options| 6. Options |vundle-options|
7. Plugin Interface Change |vundle-interface-change|
=========================================================================== =============================================================================
1. ABOUT VUNDLE ~
*vundle-about*
ABOUT *vundle-about* Vundle is short for Vim bundle and is a Vim plugin manager.
Vundle is a short cut for Vim bundle and is the Vim plug-in manager. Vundle allows you to...
2. WHY VUNDLE ~ - keep track of and configure your scripts right in the `.vimrc`
*vundle-why-vundle* - install configured scripts (a.k.a. bundle)
Vundle allows to: - update configured scripts
- search by name all available Vim scripts
- clean unused scripts up
- run the above actions in a single keypress with interactive mode
- keep track and configure your scripts right in `.vimrc` Vundle automatically...
- install configured scripts (aka bundle)
- update configured scripts
- search [all available vim scripts] by name
- clean up from unused scripts
Also *Vundle* : - manages the runtime path of your installed scripts
- regenerates help tags after installing and updating
- manages runtime path of your installed scripts Vundle's search uses http://vim-scripts.org to provide a list of all
- regenerates helptags automatically available Vim scripts.
Vundle takes advantage of [vim-scripts.org](http://vim-scripts.org) Vundle is undergoing an interface change, see |vundle-interface-change| for
in order to install/search [all available vim scripts] more information.
3. QUICK START ~ =============================================================================
*vundle-quickstart* 2. QUICK START ~
1) Setup Vundle: > *vundle-quickstart*
git clone https://github.com/gmarik/vundle.git ~/.vim/bundle/vundle 1. Introduction:
2) Configure bundles: Installation requires `Git` and triggers git clone for each configured
repository to `~/.vim/bundle/` by default. Curl is required for search.
Sample `.vimrc`: > *vundle-windows*
If you are using Windows, see instructions on the Wiki
https://github.com/gmarik/Vundle.vim/wiki/Vundle-for-Windows.
set nocompatible " be iMproved *vundle-faq*
filetype off " required! If you run into any issues, please consult the FAQ at
https://github.com/gmarik/Vundle.vim/wiki
set rtp+=~/.vim/vundle.git/ 2. Setup Vundle:
call vundle#rc() >
git clone https://github.com/gmarik/Vundle.vim.git ~/.vim/bundle/Vundle.vim
<
3. Configure bundles:
" let Vundle manage Vundle Put this at the top of your `.vimrc` to use Vundle. Remove bundles you
Bundle 'gmarik/vundle' don't need, they are for illustration purposes.
>
set nocompatible " be iMproved, required
filetype off " required
" My Bundles here: " set the runtime path to include Vundle and initialize
" set rtp+=~/.vim/bundle/Vundle.vim
" original repos on github call vundle#begin()
Bundle 'tpope/vim-fugitive' " alternatively, pass a path where Vundle should install plugins
Bundle 'Lokaltog/vim-easymotion' "call vundle#begin('~/some/path/here')
Bundle 'rstacruz/sparkup', {'rtp': 'vim/'}
" vim-scripts repos
Bundle 'L9'
Bundle 'FuzzyFinder'
Bundle 'rails.vim'
" non github repos
Bundle 'git://git.wincent.com/command-t.git'
" git repos on your local machine (ie. when working on your own plugin)
Bundle 'file:///Users/gmarik/path/to/plugin'
" ...
filetype plugin indent on " required! " let Vundle manage Vundle, required
" or Plugin 'gmarik/Vundle.vim'
" filetype plugin on " to not use the indentation settings set by plugins
3) Install configured bundles: " The following are examples of different formats supported.
" Keep Plugin commands between vundle#begin/end.
" plugin on GitHub repo
Plugin 'tpope/vim-fugitive'
" plugin from http://vim-scripts.org/vim/scripts.html
Plugin 'L9'
" Git plugin not hosted on GitHub
Plugin 'git://git.wincent.com/command-t.git'
" git repos on your local machine (i.e. when working on your own plugin)
Plugin 'file:///home/gmarik/path/to/plugin'
" The sparkup vim script is in a subdirectory of this repo called vim.
" Pass the path to set the runtimepath properly.
Plugin 'rstacruz/sparkup', {'rtp': 'vim/'}
" Avoid a name conflict with L9
Plugin 'user/L9', {'name': 'newL9'}
Launch `vim`, run > " All of your Plugins must be added before the following line
call vundle#end() " required
filetype plugin indent on " required
" To ignore plugin indent changes, instead use:
"filetype plugin on
"
" Brief help
" :PluginList - list configured plugins
" :PluginInstall(!) - install (update) plugins
" :PluginSearch(!) foo - search (or refresh cache first) for foo
" :PluginClean(!) - confirm (or auto-approve) removal of unused plugins
"
" see :h vundle for more details or wiki for FAQ
" Put your non-Plugin stuff after this line
:BundleInstall 4. Install configured bundles:
Installing requires [Git] and triggers [Git clone](http://gitref.org/creating/#clone) for Launch vim and run
each configured repo to `~/.vim/bundle/`. >
:PluginInstall
<
To install from command line:
>
vim +PluginInstall +qall
4. SCRIPTS ~ =============================================================================
*vundle-scripts* 3. PLUGINS ~
4.1 CONFIGURE SCRIPTS ~ *vundle-plugins*
*vundle-scripts-configure* *Bundle*
Before installing scripts they need to be configured. It's done using `Bundle`
command in `.vimrc`: >
Bundle 'git_repo_uri' " 'git_repo_uri' should be a valid uri to git repository 3.1 CONFIGURING PLUGINS ~
*vundle-plugins-configure* *:Plugin*
Vundle tracks what plugins you want configured by the `Plugin` commands in your
`.vimrc`. Each `Plugin` command tells Vundle to activate the script on startup
adding it to your |runtimepath|. Commenting out or removing the line will
disable the `Plugin`.
Each `Plugin` command takes a URI pointing to the script. No comments should
follow on the same line as the command. Example:
>
Plugin 'git_URI'
The `Plugin` command can optionally take a second argument after the URI. It
has to be a dictionary, separated from the URI by a comma. Each key-value pair
in the dictionary is a configuration option.
The following per-script configuration options are available.
The 'rtp' option
----------------
Specifies a directory inside the repository (relative path from the root of
the repository) where the vim plugin resides. It determines the path that will
be added to the |runtimepath|.
For example:
>
Plugin 'git_URI', {'rtp': 'some/subdir/'}
This can be used with git repositories that put the vim plugin inside a
subdirectory.
The 'name' option
-----------------
The name of the directory that will hold the local clone of the configured
script.
For example:
>
Plugin 'git_URI', {'name': 'newPluginName'}
This can be used to prevent name collisions between plugins that Vundle would
otherwise try to clone into the same directory. It also provides an additional
level of customisation.
The 'pinned' option
-------------------
A flag that, when set to a value of 1, tells Vundle not to perform any git
operations on the plugin, while still adding the existing plugin under the
`bundles` directories to the |runtimepath|.
For example:
>
Plugin 'mylocalplugin', {'pinned': 1}
This allows the users to include, with Vundle, plugins tracked with version
control systems other than git, but the user is responsible for cloning and
keeping up to date. It also allows the users to stay in the current version of
a plugin that might have previously been updated by Vundle.
Please note that the URI will be treated the same as for any other plugins, so
only the last part of it will be added to the |runtimepath|. The user is
advised to use this flag only with single word URIs to avoid confusion.
3.2 SUPPORTED URIS ~
*vundle-plugins-uris*
`Vundle` integrates very well with both GitHub and vim-scripts.org
(http://vim-scripts.org/vim/scripts.html) allowing short URIs. It also allows
the use of any URI `git` recognizes. In all of the following cases (except
local) the 'https' protocol is used, see Vundle's options to override this.
More information on `git`'s protocols can be found at:
http://git-scm.com/book/ch4-1.html
GitHub
------
GitHub is used when a user/repo is passed to `Plugin`.
>
Plugin 'gmarik/Vundle.vim' => https://github.com/gmarik/Vundle.vim
Vim Scripts
-----------
Any single word without a slash '/' is assumed to be from Vim Scripts.
>
Plugin 'ctrlp.vim' => https://github.com/vim-scripts/ctrlp.vim
Other Git URIs
--------------
No modification is performed on valid URIs that point outside the above
URLs.
>
Plugin 'git://git.wincent.com/command-t.git'
Local Plugins
-------------
The git protocol supports local installation using the 'file://' protocol.
This is handy when developing plugins locally. Follow the protocol with an
absolute path to the script directory.
>
Plugin 'file:///path/from/root/to/plugin'
3.3 INSTALLING PLUGINS ~
*vundle-plugins-install* *:PluginInstall*
>
:PluginInstall
Will install all plugins configured in your `.vimrc`. Newly installed
plugins will be automatically enabled. Some plugins may require extra steps
such as compilation or external programs, refer to their documentation.
PluginInstall allows installation of plugins by name:
>
:PluginInstall unite.vim
Installs and activates unite.vim. You can use Tab to auto-complete known
script names. Note that the installation just described isn't permanent. To
finish, you must put `Plugin 'unite.vim'` at the appropriate place in your
`.vimrc` to tell Vundle to load the plugin at startup.
After installing plugins press 'l' (lowercase 'L') to see the log of commands
if any errors occurred.
3.4 UPDATING PLUGINS ~
*vundle-plugins-update* *:PluginUpdate* *:PluginInstall!*
>
:PluginInstall! " NOTE: bang(!)
or > or >
Bundle 'script_name' " 'script-name' should be an official script name (see |vundle-scripts-search| ) :PluginUpdate
Vundle loves Github, that's why short uris can be used with commands: > Installs or updates the configured plugins. Press 'u' after updates complete
to see the change log of all updated bundles. Press 'l' (lowercase 'L') to
see the log of commands if any errors occurred.
Bundle 'tpope/vim-fugitive' 3.5 SEARCHING PLUGINS ~
*vundle-plugins-search* *:PluginSearch*
equals full uri >
Bundle 'http://github.com/tpope/vim-fugitive.git'
NOTE: Vundle defaults to http:// protocol for the short URIs
4.2 INSTALL SCRIPTS ~
*vundle-scripts-install* *BundleInstall*
run >
:BundleInstall
installs configured scripts. Newly installed scripts will be automatically
enabled. Except special cases requiring compilation or pre-configuration.
BundleInstall allows to install scripts by name:>
:BundleInstall unite.vim
installs and activates unite.vim. You can use Tab to auto-complete known script names.
NOTE: installation, as just described, doesn't automatically configure scripts;
you have to configure them manually.
4.3 UPDATE SCRIPTS ~
*vundle-scripts-update* *BundleInstall!*
run >
:BundleInstall! " NOTE: bang(!)
installs or updates configured scripts.
press u after updates complete to see the changelog of all updated bundles.
4.4 SEARCHING ~
*vundle-scripts-search* *BundleSearch*
run >
:BundleSearch foo
lists bundles matching 'foo' in new a new split window, ie:
> >
Bundle "VimFootnotes" :PluginSearch
Bundle "foo.vim"
Search requires that `curl` be available on the system. The command searches
Vim Scripts (http://vim-scripts.org/vim/scripts.html) for matching
plugins. Results display in a new split window. For example:
> >
and > PluginSearch foo
:BundleSearch! foo displays:
refreshes script list before performing actual search.
If command is run without argument: >
:BundleSearch!
it will display all known scripts
Searching requires [`curl`](http://curl.haxx.se/)
4.5 LISTING BUNDLES ~
*vundle-scripts-list* *BundleList*
To quickly pull list of installed bundles use >
:BundleList
4.6 CLEANING UP ~
*vundle-scripts-cleanup* *BundleClean*
run >
:BundleClean
confirms removal of unused script-dirs from `.vim/bundle/`.
*BundleClean!*
> >
:BundleClean! "Search results for: foo
Plugin 'MarkdownFootnotes'
Plugin 'VimFootnotes'
Plugin 'foo.vim'
<
*:PluginSearch!*
Alternatively, you can refresh the script list before searching by adding a
bang to the command.
>
:PluginSearch! foo
removes unused dirs with no questions. If the command is run without argument:
>
:PluginSearch!
it will display all known plugins in the new split.
*vundle-interactive* 3.6 LISTING BUNDLES ~
5. INTERACTIVE MODE ~ *vundle-plugins-list* *:PluginList*
>
:PluginList
Vundle provides simple interactive mode to help you explore new scripts easily. Displays a list of installed bundles.
Interactive mode is available as result of any commands that display list of
bundles. For instance, running: >
:BundleSearch! unite 3.7 CLEANING UP ~
*vundle-plugins-cleanup* *:PluginClean*
>
:PluginClean
triggers search for scripts matching 'unite' and yields a split window with Requests confirmation for the removal of all plugins no longered configured
content: > in your `.vimrc` but present in your bundle installation directory
(default: `.vim/bundle/`).
"Keymap: i - Install bundle; c - Cleanup; r - Refine list; R - Reload list *:PluginClean!*
"Search results for: unite >
Bundle 'unite.vim' :PluginClean!
Bundle 'unite-yarm'
Bundle 'unite-gem'
Bundle 'unite-locate'
Bundle 'unite-font'
Bundle 'unite-colorscheme'
As the first line(starting with `"Keymap:`) shows, certain actions may be applied Automatically confirm removal of unused bundles.
to selected bundles . Move cursor over line `Bundle 'unite.vim'` and press i
key(install, see |vundle-keymappings| for more details).
After unite.vim is installed - `:Unite file` command should be
available to prove 'unite.vim' availability.
NOTE: Interactive installation doesn't update your .vimrc configuration. =============================================================================
4. INTERACTIVE MODE ~
*vundle-interactive*
*vundle-keymappings* Vundle provides a simple interactive mode to help you explore new plugins
6. KEY MAPPINGS ~ easily. Interactive mode is available after any command that lists `Plugins`
such as PluginSearch, PluginList or Plugins. For instance:
>
:PluginSearch! unite
Searches for plugins matching 'unite' and yields a split window with:
>
"Keymap: i - Install bundle; c - Cleanup; s - Search; R - Reload list
"Search results for: unite
Plugin 'unite-scriptenames'
Plugin 'unite.vim'
Plugin 'unite-yarm'
Plugin 'unite-gem'
Plugin 'unite-locate'
Plugin 'unite-font'
Plugin 'unite-colorscheme'
To install a bundle, move your cursor to the Plugin of interest and then
select a command. To install 'unite.vim' put your cursor on the line and
then push `i`. For a more complete list see |vundle-keymappings|. After
unite.vim is installed the `:Unite file` command should be available.
Note: Interactive installation doesn't update your `.vimrc`.
=============================================================================
5. KEY MAPPINGS ~
*vundle-keymappings*
KEY | DESCRIPTION KEY | DESCRIPTION
----|-------------------------- > ----|-------------------------- >
i | run :BundleInstall with name taken from line cursor is positioned on i | run :PluginInstall with name taken from line cursor is positioned on
I | same as i, but runs :BundleInstall! to update bundle I | same as i, but runs :PluginInstall! to update bundle
D | delete selected bundle( be careful not to remove local modifications) D | delete selected bundle (be careful not to remove local modifications)
c | run :BundleClean c | run :PluginClean
s | run :BundleSearch s | run :PluginSearch
R | fetch fresh script list from server R | fetch fresh script list from server
.
*vundle-options*
7. OPTIONS ~
=============================================================================
6. OPTIONS ~
*vundle-options*
> >
let g:vundle_default_git_proto = 'git' let g:vundle_default_git_proto = 'git'
<
This option makes Vundle use `git` instead of `https` when building
absolute URIs. For example:
>
Plugin 'sjl/gundo.vim' -> git@github.com:sjl/gundo.git
makes Vundle use `git` instead default `https` when building absolute repo URIs =============================================================================
7. VUNDLE INTERFACE CHANGE ~
*vundle-interface-change* *:Bundle* *:BundleInstall!*
*:BundleUpdate* *:BundleSearch* *:BundleList* *:BundleClean!*
*:VundleInstall!* *:VundleUpdate* *:VundleSearch*
*:VundleList* *:VundleClean!*
In order to bring in new changes, Vundle is adopting a new interface.
Going forward we will support primarily the Plugin namespace, additionally
for convenience we will also alias some commands to the Vundle namespace.
The following table summarizes the interface changes.
vim:tw=78:ts=8:ft=help:norl: Deprecated Names | New Names
-----------------------------
Bundle | Plugin
BundleInstall(!) | PluginInstall(!), VundleInstall(!)
BundleUpdate | PluginUpdate, VundleUpdate
BundleSearch(!) | PluginSearch(!), VundleSearch(!)
BundleClean | PluginClean(!), VundleClean(!)
BundleList | PluginList
Note: The Bundle commands will be deprecated. You may continue using them,
but they may not get all future updates. For instance, we have enabled
comments on Plugin lines but not Bundle, since it requires a change in
command declaration.
" vim: set expandtab sts=2 ts=2 sw=2 tw=78 ft=help norl:

View File

@ -1,8 +1,8 @@
set nocompatible set nocompatible
syntax on syntax on
filetype off filetype off
set rtp+=~/.vim/bundle/vundle/ set rtp+=~/.vim/bundle/Vundle.vim/
call vundle#rc() call vundle#rc()
Bundle 'gmarik/vundle' Bundle 'gmarik/Vundle.vim'
filetype plugin indent on filetype plugin indent on

View File

@ -3,31 +3,27 @@ set nocompatible
set nowrap set nowrap
let root = '/tmp/!vundle-test/bundles/' let bundle_dir = '/tmp/vundle-test/bundles/'
let src = 'http://github.com/gmarik/vundle.git' " let src = 'http://github.com/gmarik/vundle.git'
" let src = '~/.vim/bundle/vundle/.git'
" Vundle Options " Vundle Options
" let g:vundle_default_git_proto = 'git' " let g:vundle_default_git_proto = 'git'
if !isdirectory(expand(root, 1).'/vundle') silent execute '!mkdir -p '.bundle_dir
exec '!git clone '.src.' '.shellescape(root, 1).'/vundle' silent execute '!ln -f -s ~/.vim/bundle/Vundle.vim '.bundle_dir
endif
filetype off filetype off
syntax on syntax on
runtime macros/matchit.vim runtime macros/matchit.vim
exec 'set rtp+='.root.'/vundle' " This test should be executed in "test" directory
exec 'set rtp^='.bundle_dir.'Vundle.vim/'
call vundle#rc(root) call vundle#rc(bundle_dir)
Bundle "gmarik/vundle"
" vim-scripts name Plugin 'molokai' " vim-scripts name
Bundle 'molokai'
" github username with dashes " github username with dashes
Bundle 'vim-scripts/ragtag.vim' Bundle 'vim-scripts/ragtag.vim'
@ -38,7 +34,7 @@ Bundle 'altercation/vim-colors-solarized'
Bundle 'nelstrom/vim-mac-classic-theme.git' Bundle 'nelstrom/vim-mac-classic-theme.git'
" "
" invalid uri " invalid uri
Bundle 'nonexistinguser/yupppierepo.git' "Bundle 'nonexistinguser/yupppierepo.git'
" full uri " full uri
Bundle 'https://github.com/vim-scripts/vim-game-of-life' Bundle 'https://github.com/vim-scripts/vim-game-of-life'
@ -54,6 +50,7 @@ Bundle '~/Dropbox/.gitrepos/utilz.vim.git'
" with options " with options
Bundle 'rstacruz/sparkup.git', {'rtp': 'vim/'} Bundle 'rstacruz/sparkup.git', {'rtp': 'vim/'}
Bundle 'matchit.zip', {'name': 'matchit'}
" Camel case " Camel case
Bundle 'vim-scripts/RubySinatra' Bundle 'vim-scripts/RubySinatra'
@ -61,16 +58,24 @@ Bundle 'vim-scripts/RubySinatra'
" syntax issue #203 " syntax issue #203
Bundle 'jimenezrick/vimerl' Bundle 'jimenezrick/vimerl'
" Static bundle: Same name as a valid vim-scripts bundle
Bundle 'latte', {'pinned' : 1}
if !isdirectory(expand(bundle_dir) . '/latte')
call mkdir(expand(bundle_dir) . '/latte', 'p')
endif
filetype plugin indent on " Automatically detect file types. filetype plugin indent on " Automatically detect file types.
set wildignore+=doc " should not break helptags set wildignore+=doc " should not break helptags
set wildignore+=.git " should not break clone set wildignore+=.git " should not break clone
set wildignore+=.git/* " should not break clone set wildignore+=.git/* " should not break clone
set wildignore+=*/.git/* set wildignore+=*/.git/*
" TODO: helptags fails with this " TODO: helptags fails with this
" set wildignore+=doc/* " should not break clone " set wildignore+=doc/* " should not break clone
" set wildignore+=*/doc/* " set wildignore+=*/doc/*
au VimEnter * BundleInstall au VimEnter * BundleInstall
" e test/files/erlang.erl " e test/files/erlang.erl
" vim: set expandtab sts=2 ts=2 sw=2 tw=78: