diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..ec31f8f --- /dev/null +++ b/CONTRIBUTING.md @@ -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/VundleVim/Vundle.vim/blob/master/doc/vundle.txt). + +2. The [FAQ](https://github.com/VundleVim/Vundle.vim/wiki). + +3. [Search](https://github.com/VundleVim/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/VundleVim/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 `:PluginInstall`... (continue with steps) + +Vimrc: +``` +set nocompatible +syntax on +filetype off +set rtp+=~/.vim/bundle/Vundle.vim/ +call vundle#rc() +Plugin 'VundleVim/Vundle.vim' +Plugin '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 +``` diff --git a/README.md b/README.md index f2cbd55..27adba2 100644 --- a/README.md +++ b/README.md @@ -1,112 +1,123 @@ +## [Help Maintain Vundle](https://github.com/VundleVim/Vundle.vim/issues/383) + ## About [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... - ``` - $ git clone https://github.com/gmarik/vundle.git ~/.vim/bundle/vundle - ``` +* manages the [runtime path] of your installed scripts +* 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/VundleVim/Vundle.vim.svg)](https://gitter.im/VundleVim/Vundle.vim) for discussion and support. - ```vim - set nocompatible " be iMproved - filetype off " required! - - set rtp+=~/.vim/bundle/vundle/ - call vundle#rc() - - " let Vundle manage Vundle - " required! - Bundle 'gmarik/vundle' - - " My bundles here: - " - " original repos on GitHub - Bundle 'tpope/vim-fugitive' - Bundle 'Lokaltog/vim-easymotion' - Bundle 'rstacruz/sparkup', {'rtp': 'vim/'} - Bundle 'tpope/vim-rails.git' - " vim-scripts repos - Bundle 'L9' - Bundle 'FuzzyFinder' - " non-GitHub repos - Bundle 'git://git.wincent.com/command-t.git' - " Git repos on your local machine (i.e. when working on your own plugin) - Bundle 'file:///Users/gmarik/path/to/plugin' - " ... - - filetype plugin indent on " required! - " - " Brief help - " :BundleList - list configured bundles - " :BundleInstall(!) - install (update) bundles - " :BundleSearch(!) foo - search (or refresh cache first) for foo - " :BundleClean(!) - confirm (or auto-approve) removal of unused bundles - " - " see :h vundle for more details or wiki for FAQ - " NOTE: comments after Bundle commands are not allowed. - ``` +![Vundle-installer](http://i.imgur.com/Rueh7Cc.png) -3. Install configured bundles: +## Quick Start - Launch `vim`, run `:BundleInstall` - (or `vim +BundleInstall +qall` for CLI lovers) +1. Introduction: - *Windows users*: see [Vundle for Windows](https://github.com/gmarik/vundle/wiki/Vundle-for-Windows) + Installation requires [Git] and triggers [`git clone`] for each configured repository to `~/.vim/bundle/` by default. + Curl is required for search. - Installation requires [Git] and triggers [`git clone`](http://gitref.org/creating/#clone) for each configured repo to `~/.vim/bundle/`. + 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. -4. Consider [donating](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=T44EJZX8RBUWY) + Using non-POSIX shells, such as the popular Fish shell, requires additional setup. Please check the [FAQ]. - [*Thank you*](http://j.mp/rSbm01) for supporting this project! +2. Set up [Vundle]: + `$ git clone https://github.com/VundleVim/Vundle.vim.git ~/.vim/bundle/Vundle.vim` -## Why Vundle +3. Configure Plugins: -[Vundle] allows you to: + Put this at the top of your `.vimrc` to use Vundle. Remove plugins you don't need, they are for illustration purposes. -- 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] + ```vim + set nocompatible " be iMproved, required + filetype off " required + + " set the runtime path to include Vundle and initialize + 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, required + Plugin 'VundleVim/Vundle.vim' + + " 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/'} + " Install L9 and avoid a Naming conflict if you've already installed a + " different version somewhere else. + Plugin 'ascenator/L9', {'name': 'newL9'} + + " 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 - lists configured plugins + " :PluginInstall - installs plugins; append `!` to update or just :PluginUpdate + " :PluginSearch foo - searches for foo; append `!` to refresh local cache + " :PluginClean - confirms removal of unused plugins; append `!` to auto-approve removal + " + " see :h vundle for more details or wiki for FAQ + " Put your non-Plugin stuff after this line + ``` -[Vundle] also: +4. Install Plugins: -- manages the [runtime path] of your installed scripts -- [regenerates help tags][helptags] automatically + Launch `vim` and run `:PluginInstall` + + To install from command line: `vim +PluginInstall +qall` ## 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/VundleVim/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/VundleVim/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/VundleVim/Vundle.vim/wiki/Examples) ## Contributors -see [Vundle contributors](https://github.com/gmarik/vundle/graphs/contributors) +see [Vundle contributors](https://github.com/VundleVim/Vundle.vim/graphs/contributors) *Thank you!* -## Inspiration and ideas from +## Inspiration & Ideas -* [pathogen.vim] -* [Bundler] +* [pathogen.vim](http://github.com/tpope/vim-pathogen/) +* [Bundler](https://github.com/bundler/bundler) * [Scott Bronson](http://github.com/bronson) ## Also @@ -117,7 +128,7 @@ see [Vundle contributors](https://github.com/gmarik/vundle/graphs/contributors) ## TODO: [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 * ✓ Vim documentation * ✓ put Vundle in `bundles/` too (will fix Vundle help) @@ -129,17 +140,22 @@ see [Vundle contributors](https://github.com/gmarik/vundle/graphs/contributors) * search by description as well * make it rock! -[Vundle]:http://github.com/gmarik/vundle -[pathogen.vim]:http://github.com/tpope/vim-pathogen/ -[Bundler]:https://github.com/bundler/bundler +[Vundle]:http://github.com/VundleVim/Vundle.vim +[Windows setup]:https://github.com/VundleVim/Vundle.vim/wiki/Vundle-for-Windows +[FAQ]:https://github.com/VundleVim/Vundle.vim/wiki +[Tips]:https://github.com/VundleVim/Vundle.vim/wiki/Tips-and-Tricks [Vim]:http://www.vim.org [Git]:http://git-scm.com -[all available Vim scripts]:http://vim-scripts.org/vim/scripts.html -[helptags]:http://vimdoc.sourceforge.net/htmldoc/helphelp.html#:helptags +[`git clone`]:http://gitref.org/creating/#clone + +[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 -[install]:https://github.com/gmarik/vundle/blob/master/doc/vundle.txt#L115-129 -[update]:https://github.com/gmarik/vundle/blob/master/doc/vundle.txt#L131-137 -[search]:https://github.com/gmarik/vundle/blob/master/doc/vundle.txt#L139-161 -[clean]:https://github.com/gmarik/vundle/blob/master/doc/vundle.txt#L171-L183 -[interactive mode]:https://github.com/gmarik/vundle/blob/master/doc/vundle.txt#L186-213 +[configure]:https://github.com/VundleVim/Vundle.vim/blob/v0.10.2/doc/vundle.txt#L126-L233 +[install]:https://github.com/VundleVim/Vundle.vim/blob/v0.10.2/doc/vundle.txt#L234-L254 +[update]:https://github.com/VundleVim/Vundle.vim/blob/v0.10.2/doc/vundle.txt#L255-L265 +[search]:https://github.com/VundleVim/Vundle.vim/blob/v0.10.2/doc/vundle.txt#L266-L295 +[clean]:https://github.com/VundleVim/Vundle.vim/blob/v0.10.2/doc/vundle.txt#L303-L318 +[interactive mode]:https://github.com/VundleVim/Vundle.vim/blob/v0.10.2/doc/vundle.txt#L319-L360 +[interface change]:https://github.com/VundleVim/Vundle.vim/blob/v0.10.2/doc/vundle.txt#L372-L396 diff --git a/README_ZH_CN.md b/README_ZH_CN.md new file mode 100644 index 0000000..c393fbf --- /dev/null +++ b/README_ZH_CN.md @@ -0,0 +1,162 @@ +## [帮助维护Vundle](https://github.com/VundleVim/Vundle.vim/issues/383) + +## 关于 + +[Vundle] 是 _Vim bundle_ 的简称,是一个 [Vim] 插件管理器. + +[Vundle] 允许你做... + +* 同时在`.vimrc`中跟踪和[管理](https://github.com/VundleVim/Vundle.vim/blob/v0.10.2/doc/vundle.txt#L126-L233)插件 +* [安装](https://github.com/VundleVim/Vundle.vim/blob/v0.10.2/doc/vundle.txt#L234-L254)特定格式的插件(a.k.a. scripts/bundle) +* [更新](https://github.com/VundleVim/Vundle.vim/blob/v0.10.2/doc/vundle.txt#L255-L265)特定格式插件 +* 通过插件名称[搜索](https://github.com/VundleVim/Vundle.vim/blob/v0.10.2/doc/vundle.txt#L266-L295)[Vim scripts](http://vim-scripts.org/vim/scripts.html)中的插件 +* [清理](https://github.com/VundleVim/Vundle.vim/blob/v0.10.2/doc/vundle.txt#L303-L318)未使用的插件 +* 可以通过*单一按键*完成以上操作,详见[interactive mode](https://github.com/VundleVim/Vundle.vim/blob/v0.10.2/doc/vundle.txt#L319-L360) + +[Vundle] 自动完成... + +* 管理已安装插件的[runtime path](http://vimdoc.sourceforge.net/htmldoc/options.html#%27runtimepath%27) +* 安装和更新后,重新生成[帮助标签](http://vimdoc.sourceforge.net/htmldoc/helphelp.html#:helptags) + +[Vundle] 正在经历一个 [interface change], 请通过以下方式获取最新信息. + +讨论和技术支持:[![Gitter-chat](https://badges.gitter.im/VundleVim/Vundle.vim.svg)](https://gitter.im/VundleVim/Vundle.vim) + +![Vundle-installer](http://i.imgur.com/Rueh7Cc.png) + +## 快速开始 + +1. 介绍: + + 安装需要[Git](http://git-scm.com/),触发[`git clone`](http://gitref.org/creating/#clone),默认将每一个指定特定格式插件的仓库复制到`~/.vim/bundle/`. + 搜索需要Curl支持. + + Windows用户请直接访问[Windows setup]. 如果有任何问题, 请参考 [FAQ]. + 查看 [Tips] 获取相关高级配置. + + 使用 non-POSIX shells, 比如比较流行对 Fish shell, 需要额外对步骤. 请查看 [FAQ]. + +2. 初始安装 [Vundle]: + + `$ git clone https://github.com/VundleVim/Vundle.vim.git ~/.vim/bundle/Vundle.vim` + +3. 配置插件 : + + 请将以下加在 `.vimrc` 方可使用Vundle. 删掉你不需要的插件, 这些只是用做示例. + + ```vim + set nocompatible " 去除VI一致性,必须 + filetype off " 必须 + + " 设置包括vundle和初始化相关的runtime path + set rtp+=~/.vim/bundle/Vundle.vim + call vundle#begin() + " 另一种选择, 指定一个vundle安装插件的路径 + "call vundle#begin('~/some/path/here') + + " 让vundle管理插件版本,必须 + Plugin 'VundleVim/Vundle.vim' + + " 以下范例用来支持不同格式的插件安装. + " 请将安装插的命令放在vundle#begin和vundle#end之间. + " Github上的插件 + " 格式为 Plugin '用户名/插件仓库名' + Plugin 'tpope/vim-fugitive' + " 来自 http://vim-scripts.org/vim/scripts.html 的插件 + " Plugin '插件名称' 实际上是 Plugin 'vim-scripts/插件仓库名' 只是此处的用户名可以省略 + Plugin 'L9' + " 由Git支持但不再github上的插件仓库 Plugin 'git clone 后面的地址' + Plugin 'git://git.wincent.com/command-t.git' + " 本地的Git仓库(例如自己的插件) Plugin 'file:///+本地插件仓库绝对路径' + Plugin 'file:///home/gmarik/path/to/plugin' + " 插件在仓库的子目录中. + " 正确指定路径用以设置runtimepath. 以下范例插件在sparkup/vim目录下 + Plugin 'rstacruz/sparkup', {'rtp': 'vim/'} + " 安装L9，如果已经安装过这个插件，可利用以下格式避免命名冲突 + Plugin 'ascenator/L9', {'name': 'newL9'} + + " 你的所有插件需要在下面这行之前 + call vundle#end() " 必须 + filetype plugin indent on " 必须 加载vim自带和插件相应的语法和文件类型相关脚本 + " 忽视插件改变缩进,可以使用以下替代: + "filetype plugin on + " + " 简要帮助文档 + " :PluginList - 列出所有已配置的插件 + " :PluginInstall - 安装插件,追加 `!` 用以更新或使用 :PluginUpdate + " :PluginSearch foo - 搜索 foo ; 追加 `!` 清除本地缓存 + " :PluginClean - 清除未使用插件,需要确认; 追加 `!` 自动批准移除未使用插件 + " + " 查阅 :h vundle 获取更多细节和wiki以及FAQ + " 将你自己对非插件片段放在这行之后 + ``` + +4. 安装插件: + + 运行 `vim` 再运行 `:PluginInstall` + + 通过命令行直接安装 `vim +PluginInstall +qall` + +## Docs + +查阅 [`:h vundle`](https://github.com/VundleVim/Vundle.vim/blob/master/doc/vundle.txt) Vimdoc 以获取更多细节. + +## 更新日志 + +查阅 [changelog](https://github.com/VundleVim/Vundle.vim/blob/master/changelog.md). + +## 在使用此插件的用户的VIMRC + +查阅 [Examples](https://github.com/VundleVim/Vundle.vim/wiki/Examples) + +## 维护者 + +查阅 [Vundle contributors](https://github.com/VundleVim/Vundle.vim/graphs/contributors) + +*感谢!* + +## 灵感 & 思路 + +* [pathogen.vim](http://github.com/tpope/vim-pathogen/) +* [Bundler](https://github.com/bundler/bundler) +* [Scott Bronson](http://github.com/bronson) + +## 另外 + +* Vundle 已测试环境为: [Vim] 7.3 on OS X, Linux and Windows +* Vundle 尝试尽可能保持至简模式 [KISS](http://en.wikipedia.org/wiki/KISS_principle) + +## TODO: +[Vundle] 是一个正在进步对项目, 所以很多设计思路和补丁是需要借鉴的. + +* ✓ 在重新载入或者执行`:PluginInstall`之后激活`.vimrc`中新添加的插件 +* ✓ 使用预览窗口显示搜索结果 +* ✓ Vim documentation +* ✓ 同时将Vundle 放置在 `bundles/` 中 (将修复 Vundle 帮助) +* ✓ 测试 +* ✓ 提升错误处理能力 +* 支持手动指定版本(待考虑) +* 版本依赖 +* 搜索结果中显示描述 +* 同时支持通过描述搜索 +* 使其更加稳定! + +[Vundle]:http://github.com/VundleVim/Vundle.vim +[Windows setup]:https://github.com/VundleVim/Vundle.vim/wiki/Vundle-for-Windows +[FAQ]:https://github.com/VundleVim/Vundle.vim/wiki +[Tips]:https://github.com/VundleVim/Vundle.vim/wiki/Tips-and-Tricks +[Vim]:http://www.vim.org +[Git]:http://git-scm.com +[`git clone`]:http://gitref.org/creating/#clone + +[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 + +[configure]:https://github.com/VundleVim/Vundle.vim/blob/v0.10.2/doc/vundle.txt#L126-L233 +[install]:https://github.com/VundleVim/Vundle.vim/blob/v0.10.2/doc/vundle.txt#L234-L254 +[update]:https://github.com/VundleVim/Vundle.vim/blob/v0.10.2/doc/vundle.txt#L255-L265 +[search]:https://github.com/VundleVim/Vundle.vim/blob/v0.10.2/doc/vundle.txt#L266-L295 +[clean]:https://github.com/VundleVim/Vundle.vim/blob/v0.10.2/doc/vundle.txt#L303-L318 +[interactive mode]:https://github.com/VundleVim/Vundle.vim/blob/v0.10.2/doc/vundle.txt#L319-L360 +[interface change]:https://github.com/VundleVim/Vundle.vim/blob/v0.10.2/doc/vundle.txt#L372-L396 diff --git a/README_ZH_TW.md b/README_ZH_TW.md new file mode 100644 index 0000000..cdc1b78 --- /dev/null +++ b/README_ZH_TW.md @@ -0,0 +1,162 @@ +## [幫助維護Vundle](https://github.com/VundleVim/Vundle.vim/issues/383) + +## 關於 + +[Vundle] 是 _Vim bundle_ 的簡稱,是一個 [Vim] 插件管理器. + +[Vundle] 允許你做... + +* 同時在`.vimrc`中跟蹤和[管理](https://github.com/VundleVim/Vundle.vim/blob/v0.10.2/doc/vundle.txt#L126-L233)插件 +* [安裝](https://github.com/VundleVim/Vundle.vim/blob/v0.10.2/doc/vundle.txt#L234-L254)特定格式的插件(a.k.a. scripts/bundle) +* [更新](https://github.com/VundleVim/Vundle.vim/blob/v0.10.2/doc/vundle.txt#L255-L265)特定格式插件 +* 通過插件名稱[搜索](https://github.com/VundleVim/Vundle.vim/blob/v0.10.2/doc/vundle.txt#L266-L295)[Vim scripts](http://vim-scripts.org/vim/scripts.html)中的插件 +* [清理](https://github.com/VundleVim/Vundle.vim/blob/v0.10.2/doc/vundle.txt#L303-L318)未使用的插件 +* 可以通過*單一按鍵*完成以上操作,詳見[interactive mode](https://github.com/VundleVim/Vundle.vim/blob/v0.10.2/doc/vundle.txt#L319-L360) + +[Vundle] 自動完成... + +* 管理已安裝插件的[runtime path](http://vimdoc.sourceforge.net/htmldoc/options.html#%27runtimepath%27) +* 安裝和更新後,重新生成[幫助標簽](http://vimdoc.sourceforge.net/htmldoc/helphelp.html#:helptags) + +[Vundle] 正在經歷一個 [interface change], 請通過以下方式獲取最新信息. + +討論和技術支持:[![Gitter-chat](https://badges.gitter.im/VundleVim/Vundle.vim.svg)](https://gitter.im/VundleVim/Vundle.vim) + +![Vundle-installer](http://i.imgur.com/Rueh7Cc.png) + +## 快速開始 + +1. 介紹: + + 安裝需要[Git](http://git-scm.com/),觸發[`git clone`](http://gitref.org/creating/#clone),默認將每一個指定特定格式插件的倉庫復制到`~/.vim/bundle/`. + 搜索需要Curl支持. + + Windows用戶請直接訪問[Windows setup]. 如果有任何問題, 請參考 [FAQ]. + 查看 [Tips] 獲取相關高級配置. + + 使用 non-POSIX shells, 比如比較流行對 Fish shell, 需要額外對步驟. 請查看 [FAQ]. + +2. 初始安裝 [Vundle]: + + `$ git clone https://github.com/VundleVim/Vundle.vim.git ~/.vim/bundle/Vundle.vim` + +3. 配置插件 : + + 請將以下加在 `.vimrc` 方可使用Vundle. 刪掉你不需要的插件, 這些只是用做示例. + + ```vim + set nocompatible " 去除VI一致性,必須 + filetype off " 必須 + + " 設置包括vundle和初始化相關的runtime path + set rtp+=~/.vim/bundle/Vundle.vim + call vundle#begin() + " 另一種選擇, 指定一個vundle安裝插件的路徑 + "call vundle#begin('~/some/path/here') + + " 讓vundle管理插件版本,必須 + Plugin 'VundleVim/Vundle.vim' + + " 以下範例用來支持不同格式的插件安裝. + " 請將安裝插的命令放在vundle#begin和vundle#end之間. + " Github上的插件 + " 格式為 Plugin '用戶名/插件倉庫名' + Plugin 'tpope/vim-fugitive' + " 來自 http://vim-scripts.org/vim/scripts.html 的插件 + " Plugin '插件名稱' 實際上是 Plugin 'vim-scripts/插件倉庫名' 只是此處的用戶名可以省略 + Plugin 'L9' + " 由Git支持但不再github上的插件倉庫 Plugin 'git clone 後面的地址' + Plugin 'git://git.wincent.com/command-t.git' + " 本地的Git倉庫(例如自己的插件) Plugin 'file:///+本地插件倉庫絕對路徑' + Plugin 'file:///home/gmarik/path/to/plugin' + " 插件在倉庫的子目錄中. + " 正確指定路徑用以設置runtimepath. 以下範例插件在sparkup/vim目錄下 + Plugin 'rstacruz/sparkup', {'rtp': 'vim/'} + " 安裝L9，如果已經安裝過這個插件，可利用以下格式避免命名衝突 + Plugin 'ascenator/L9', {'name': 'newL9'} + + " 你的所有插件需要在下面這行之前 + call vundle#end() " 必須 + filetype plugin indent on " 必須 加載vim自帶和插件相應的語法和文件類型相關腳本 + " 忽視插件改變縮進,可以使用以下替代: + "filetype plugin on + " + " 簡要幫助文檔 + " :PluginList - 列出所有已配置的插件 + " :PluginInstall - 安裝插件,追加 `!` 用以更新或使用 :PluginUpdate + " :PluginSearch foo - 搜索 foo ; 追加 `!` 清除本地緩存 + " :PluginClean - 清除未使用插件,需要確認; 追加 `!` 自動批准移除未使用插件 + " + " 查閱 :h vundle 獲取更多細節和wiki以及FAQ + " 將你自己對非插件片段放在這行之後 + ``` + +4. 安裝插件: + + 運行 `vim` 再運行 `:PluginInstall` + + 通過命令行直接安裝 `vim +PluginInstall +qall` + +## Docs + +查閱 [`:h vundle`](https://github.com/VundleVim/Vundle.vim/blob/master/doc/vundle.txt) Vimdoc 以獲取更多細節. + +## 更新日誌 + +查閱 [changelog](https://github.com/VundleVim/Vundle.vim/blob/master/changelog.md). + +## 在使用此插件的用戶的VIMRC + +查閱 [Examples](https://github.com/VundleVim/Vundle.vim/wiki/Examples) + +## 維護者 + +查閱 [Vundle contributors](https://github.com/VundleVim/Vundle.vim/graphs/contributors) + +*感謝!* + +## 靈感 & 思路 + +* [pathogen.vim](http://github.com/tpope/vim-pathogen/) +* [Bundler](https://github.com/bundler/bundler) +* [Scott Bronson](http://github.com/bronson) + +## 另外 + +* Vundle 已測試環境為: [Vim] 7.3 on OS X, Linux and Windows +* Vundle 嘗試盡可能保持至簡模式 [KISS](http://en.wikipedia.org/wiki/KISS_principle) + +## TODO: +[Vundle] 是一個正在進步對項目, 所以很多設計思路和補丁是需要借鑒的. + +* ✓ 在重新載入或者執行`:PluginInstall`之後激活`.vimrc`中新添加的插件 +* ✓ 使用預覽窗口顯示搜索結果 +* ✓ Vim documentation +* ✓ 同時將Vundle 放置在 `bundles/` 中 (將修復 Vundle 幫助) +* ✓ 測試 +* ✓ 提升錯誤處理能力 +* 支持手動指定版本(待考慮) +* 版本依賴 +* 搜索結果中顯示描述 +* 同時支持通過描述搜索 +* 使其更加穩定! + +[Vundle]:http://github.com/VundleVim/Vundle.vim +[Windows setup]:https://github.com/VundleVim/Vundle.vim/wiki/Vundle-for-Windows +[FAQ]:https://github.com/VundleVim/Vundle.vim/wiki +[Tips]:https://github.com/VundleVim/Vundle.vim/wiki/Tips-and-Tricks +[Vim]:http://www.vim.org +[Git]:http://git-scm.com +[`git clone`]:http://gitref.org/creating/#clone + +[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 + +[configure]:https://github.com/VundleVim/Vundle.vim/blob/v0.10.2/doc/vundle.txt#L126-L233 +[install]:https://github.com/VundleVim/Vundle.vim/blob/v0.10.2/doc/vundle.txt#L234-L254 +[update]:https://github.com/VundleVim/Vundle.vim/blob/v0.10.2/doc/vundle.txt#L255-L265 +[search]:https://github.com/VundleVim/Vundle.vim/blob/v0.10.2/doc/vundle.txt#L266-L295 +[clean]:https://github.com/VundleVim/Vundle.vim/blob/v0.10.2/doc/vundle.txt#L303-L318 +[interactive mode]:https://github.com/VundleVim/Vundle.vim/blob/v0.10.2/doc/vundle.txt#L319-L360 +[interface change]:https://github.com/VundleVim/Vundle.vim/blob/v0.10.2/doc/vundle.txt#L372-L396 diff --git a/autoload/vundle.vim b/autoload/vundle.vim index 0bc7bf5..148ff3e 100644 --- a/autoload/vundle.vim +++ b/autoload/vundle.vim @@ -1,48 +1,90 @@ " Vundle is a shortcut for Vim Bundle and Is a simple plugin manager for Vim " Author: gmarik -" HomePage: http://github.com/gmarik/vundle -" Readme: http://github.com/gmarik/vundle/blob/master/README.md -" Version: 0.9 +" HomePage: http://github.com/VundleVim/Vundle.vim +" Readme: http://github.com/VundleVim/Vundle.vim/blob/master/README.md +" Version: 0.10.2 -com! -nargs=+ Bundle +" Plugin Commands +com! -nargs=+ -bar Plugin \ call vundle#config#bundle() -com! -nargs=? -bang -complete=custom,vundle#scripts#complete BundleInstall -\ call vundle#installer#new('!' == '', ) +com! -nargs=* -bang -complete=custom,vundle#scripts#complete PluginInstall +\ call vundle#installer#new('!' == '', ) -com! -nargs=? -bang -complete=custom,vundle#scripts#complete BundleSearch -\ call vundle#scripts#all('!'=='', ) +com! -nargs=? -bang -complete=custom,vundle#scripts#complete PluginSearch +\ call vundle#scripts#all('!' == '', ) -com! -nargs=? -bang -complete=custom,vundle#scripts#complete Bundles -\ call vundle#scripts#all('!'=='', ) +com! -nargs=0 -bang PluginList +\ call vundle#installer#list('!' == '') -com! -nargs=0 -bang BundleList -\ call vundle#installer#list('!'=='') - -com! -nargs=? -bang BundleClean +com! -nargs=? -bang PluginClean \ call vundle#installer#clean('!' == '') -com! -nargs=0 BundleDocs -\ call vundle#installer#helptags(g:bundles) +com! -nargs=0 PluginDocs +\ call vundle#installer#helptags(g:vundle#bundles) " Aliases -com! BundleUpdate BundleInstall! +com! -nargs=* -complete=custom,vundle#scripts#complete PluginUpdate PluginInstall! + +" Vundle Aliases +com! -nargs=? -bang -complete=custom,vundle#scripts#complete VundleInstall PluginInstall +com! -nargs=? -bang -complete=custom,vundle#scripts#complete VundleSearch PluginSearch +com! -nargs=? -bang VundleClean PluginClean +com! -nargs=0 VundleDocs PluginDocs +com! VundleUpdate PluginInstall! +com! -nargs=* -complete=custom,vundle#scripts#complete VundleUpdate PluginInstall! + +" Deprecated Commands +com! -nargs=+ Bundle call vundle#config#bundle() +com! -nargs=? -bang -complete=custom,vundle#scripts#complete BundleInstall PluginInstall +com! -nargs=? -bang -complete=custom,vundle#scripts#complete BundleSearch PluginSearch +com! -nargs=0 -bang BundleList PluginList +com! -nargs=? -bang BundleClean PluginClean +com! -nargs=0 BundleDocs PluginDocs +com! BundleUpdate PluginInstall! +" Set up the signs used in the installer window. (See :help signs) if (has('signs')) -sign define Vu_error text=! texthl=Error -sign define Vu_active text=> texthl=Comment -sign define Vu_todate text=. texthl=Comment -sign define Vu_new text=+ texthl=Comment -sign define Vu_updated text=* texthl=Comment -sign define Vu_deleted text=- texthl=Comment -sign define Vu_helptags text=* texthl=Comment + sign define Vu_error text=! texthl=Error + sign define Vu_active text=> texthl=Comment + sign define Vu_todate text=. texthl=Comment + sign define Vu_new text=+ texthl=Comment + sign define Vu_updated text=* texthl=Comment + sign define Vu_deleted text=- texthl=Comment + sign define Vu_helptags text=* texthl=Comment + sign define Vu_pinned text== texthl=Comment 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 - let g:bundle_dir = len(a:000) > 0 ? expand(a:1, 1) : expand('$HOME/.vim/bundle', 1) - let g:updated_bundles = [] - let g:vundle_log = [] - let g:vundle_changelog = ['Updated Bundles:'] + if a:0 > 0 + let g:vundle#bundle_dir = expand(a:1, 1) + endif call vundle#config#init() 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 + +" Initialize some global variables used by Vundle. +let vundle#bundle_dir = expand('$HOME/.vim/bundle', 1) +let vundle#bundles = [] +let vundle#lazy_load = 0 +let vundle#log = [] +let vundle#updated_bundles = [] + +" vim: set expandtab sts=2 ts=2 sw=2 tw=78 norl: diff --git a/autoload/vundle/compat.vim b/autoload/vundle/compat.vim index 1df1fe6..55ffcae 100644 --- a/autoload/vundle/compat.vim +++ b/autoload/vundle/compat.vim @@ -4,7 +4,7 @@ " exec 'set runtimepath-='.fnameescape(LIST) " " ... even when fnameescape() is not available (on vim-7.0, for example) -" +" " notes: " * it attempts to do the "real thing", if it can " (if 'fnameescape()' is available); @@ -78,7 +78,7 @@ endf " exec 'set runtimepath='.fnameescape(LIST) " " ... even when fnameescape() is not available (on vim-7.0, for example) -" +" " args: " dirs [string]: described as 'LIST' above; " addset_operator [string]: one of: diff --git a/autoload/vundle/config.vim b/autoload/vundle/config.vim index 06adf36..105ab48 100644 --- a/autoload/vundle/config.vim +++ b/autoload/vundle/config.vim @@ -1,38 +1,119 @@ +" --------------------------------------------------------------------------- +" 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, ...) let bundle = vundle#config#init_bundle(a:arg, a:000) - call s:rtp_rm_a() - call add(g:bundles, bundle) - call s:rtp_add_a() + if !s:check_bundle_name(bundle) + return + endif + if exists('g:vundle#lazy_load') && g:vundle#lazy_load + call add(g:vundle#bundles, bundle) + else + call s:rtp_rm_a() + call add(g:vundle#bundles, bundle) + call s:rtp_add_a() + call s:rtp_add_defaults() + endif return bundle 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() - if !exists('g:bundles') | let g:bundles = [] | endif + if !exists('g:vundle#bundles') | let g:vundle#bundles = [] | endif call s:rtp_rm_a() - let g:bundles = [] + let g:vundle#bundles = [] + let s:bundle_names = {} endf + +" --------------------------------------------------------------------------- +" Add a list of bundles to the runtimepath and source them. +" +" bundles -- a list of bundle objects +" --------------------------------------------------------------------------- func! vundle#config#require(bundles) abort for b in a:bundles call s:rtp_add(b.rtpath) - call s:rtp_add(g:bundle_dir) + call s:rtp_add(g:vundle#bundle_dir) " TODO: it has to be relative rtpath, not bundle.name exec 'runtime! '.b.name.'/plugin/*.vim' exec 'runtime! '.b.name.'/after/*.vim' - call s:rtp_rm(g:bundle_dir) + call s:rtp_rm(g:vundle#bundle_dir) endfor + call s:rtp_add_defaults() 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) 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 - 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.rtpath = s:rtpath(opts) return b 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(s:bundle_names, a:bundle.name) + echoerr 'Vundle error: Name collision for Plugin ' . a:bundle.name_spec . + \ '. Plugin ' . s:bundle_names[a:bundle.name] . + \ ' previously used the name "' . a:bundle.name . '"' . + \ '. Skipping Plugin ' . a:bundle.name_spec . '.' + return 0 + elseif a:bundle.name !~ '\v^[A-Za-z0-9_-]%(\.?[A-Za-z0-9_-])*$' + echoerr 'Invalid plugin name: ' . a:bundle.name + return 0 + endif + let s: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) " TODO: improve this if len(a:opts) != 1 | return {} | endif @@ -44,6 +125,16 @@ func! s:parse_options(opts) endif 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) let arg = a:arg let git_proto = exists('g:vundle_default_git_proto') ? g:vundle_default_git_proto : 'https' @@ -55,7 +146,7 @@ func! s:parse_name(arg) let uri .= '.git' endif let name = substitute(split(uri,'\/')[-1], '\.git\s*$','','i') - elseif arg =~? '^\s*\(git@\|git://\)\S\+' + elseif arg =~? '^\s*\(git@\|git://\)\S\+' \ || arg =~? '\(file\|https\?\)://' \ || arg =~? '\.git\s*$' let uri = arg @@ -67,8 +158,32 @@ func! s:parse_name(arg) return {'name': name, 'uri': uri, 'name_spec': arg } 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() - let paths = map(copy(g:bundles), 'v:val.rtpath') + let paths = map(copy(g:vundle#bundles), 'v:val.rtpath') if !empty(paths) let prepends = join(paths, ',') let appends = join(paths, '/after,').'/after' @@ -77,8 +192,13 @@ func! s:rtp_rm_a() endif endf + +" --------------------------------------------------------------------------- +" Add all paths for the plugins which are managed by Vundle to the +" runtimepath. +" --------------------------------------------------------------------------- func! s:rtp_add_a() - let paths = map(copy(g:bundles), 'v:val.rtpath') + let paths = map(copy(g:vundle#bundles), 'v:val.rtpath') if !empty(paths) let prepends = join(paths, ',') let appends = join(paths, '/after,').'/after' @@ -87,6 +207,13 @@ func! s:rtp_add_a() endif 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 if !empty(a:dir) call vundle#compat#rtp_rm_entry(expand(a:dir, 1)) @@ -94,6 +221,13 @@ func! s:rtp_rm(dir) abort endif 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 if !empty(a:dir) call vundle#compat#rtp_addset_entry(expand(a:dir, 1), '^') @@ -101,17 +235,55 @@ func! s:rtp_add(dir) abort endif 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 return simplify(expand(a:path, 1)) 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) return has_key(a:opts, 'rtp') ? s:expand_path(a:opts.path().'/'.a:opts.rtp) : a:opts.path() endf + +" --------------------------------------------------------------------------- +" a bundle 'object' +" --------------------------------------------------------------------------- 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() - return s:expand_path(g:bundle_dir.'/'.self.name) + return s:expand_path(g:vundle#bundle_dir.'/') . self.name +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: diff --git a/autoload/vundle/installer.vim b/autoload/vundle/installer.vim index 287b8a3..413f749 100644 --- a/autoload/vundle/installer.vim +++ b/autoload/vundle/installer.vim @@ -1,17 +1,48 @@ +" --------------------------------------------------------------------------- +" Try to clone all new bundles given (or all bundles in g:vundle#bundles by +" default) to g:vundle#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 - let bundles = (a:1 == '') ? - \ g:bundles : - \ map(copy(a:000), 'vundle#config#bundle(v:val, {})') + " No specific plugins are specified. Operate on all plugins. + if a:0 == 0 + let bundles = g:vundle#bundles + " Specific plugins are specified for update. Update them. + elseif (a:bang) + let bundles = filter(copy(g:vundle#bundles), 'index(a:000, v:val.name) > -1') + " Specific plugins are specified for installation. Install them. + else + let bundles = map(copy(a:000), 'vundle#config#bundle(v:val, {})') + endif + + if empty(bundles) + echoerr 'No bundles were selected for operation' + return + endif 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:vundle#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 vundle#config#require(bundles) 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) let msg = '' @@ -25,12 +56,12 @@ func! s:process(bang, cmd) exec ':norm '.a:cmd - if 'error' == g:vundle_last_status + if 'error' == s:last_status let msg = 'With errors; press l to view log' endif - if 'updated' == g:vundle_last_status && empty(msg) - let msg = 'Bundles updated; press u to view changelog' + if 'updated' == s:last_status && empty(msg) + let msg = 'Plugins updated; press u to view changelog' endif " goto next one @@ -43,6 +74,16 @@ func! s:process(bang, cmd) echo 'Done! '.msg 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 let n = a:name @@ -67,6 +108,8 @@ func! vundle#installer#run(func_name, name, ...) abort echo n.' deleted' elseif 'helptags' == status echo n.' regenerated' + elseif 'pinned' == status + echo n.' pinned' elseif 'error' == status echohl Error echo 'Error processing '.n @@ -76,12 +119,19 @@ func! vundle#installer#run(func_name, name, ...) abort throw 'whoops, unknown status:'.status endif - let g:vundle_last_status = status + let s:last_status = status return status endf -func! s:sign(status) + +" --------------------------------------------------------------------------- +" Put a sign on the current line, indicating the status of the installation +" step. +" +" status -- string describing the status +" --------------------------------------------------------------------------- +func! s:sign(status) if (!has('signs')) return endif @@ -89,6 +139,14 @@ func! s:sign(status) exe ":sign place ".line('.')." line=".line('.')." name=Vu_". a:status ." buffer=" . bufnr("%") 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 let result = vundle#installer#install(a:bang, a:name) let b = vundle#config#bundle(a:name, {}) @@ -97,22 +155,51 @@ func! vundle#installer#install_and_require(bang, name) abort return result 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 - if !isdirectory(g:bundle_dir) | call mkdir(g:bundle_dir, 'p') | endif + if !isdirectory(g:vundle#bundle_dir) | call mkdir(g:vundle#bundle_dir, 'p') | endif - let b = vundle#config#init_bundle(a:name, {}) + let n = substitute(a:name,"['".'"]\+','','g') + let matched = filter(copy(g:vundle#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) endf + +" --------------------------------------------------------------------------- +" Call :helptags for all bundles in g:vundle#bundles. +" +" return -- 'error' if an error occurred, else return 'helptags' +" --------------------------------------------------------------------------- func! vundle#installer#docs() abort - let error_count = vundle#installer#helptags(g:bundles) + let error_count = vundle#installer#helptags(g:vundle#bundles) if error_count > 0 return 'error' endif return 'helptags' 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 let bundle_dirs = map(copy(a:bundles),'v:val.rtpath') let help_dirs = filter(bundle_dirs, 's:has_doc(v:val)') @@ -123,31 +210,45 @@ func! vundle#installer#helptags(bundles) abort let statuses = map(copy(help_dirs), 's:helptags(v:val)') 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) endf + +" --------------------------------------------------------------------------- +" List all installed plugins. +" Corresponding documentation: vundle-plugins-list +" +" bang -- not used +" --------------------------------------------------------------------------- func! vundle#installer#list(bang) abort - let bundles = vundle#scripts#bundle_names(map(copy(g:bundles), 'v:val.name_spec')) - call vundle#scripts#view('list', ['" My Bundles'], bundles) + let bundles = vundle#scripts#bundle_names(map(copy(g:vundle#bundles), 'v:val.name_spec')) + call vundle#scripts#view('list', ['" My Plugins'], bundles) redraw - echo len(g:bundles).' bundles configured' + echo len(g:vundle#bundles).' plugins configured' 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 - let bundle_dirs = map(copy(g:bundles), 'v:val.path()') + let bundle_dirs = map(copy(g:vundle#bundles), 'v:val.path()') let all_dirs = (v:version > 702 || (v:version == 702 && has("patch51"))) - \ ? split(globpath(g:bundle_dir, '*', 1), "\n") - \ : split(globpath(g:bundle_dir, '*'), "\n") + \ ? split(globpath(g:vundle#bundle_dir, '*', 1), "\n") + \ : split(globpath(g:vundle#bundle_dir, '*'), "\n") let x_dirs = filter(all_dirs, '0 > index(bundle_dirs, v:val)') if empty(x_dirs) let headers = ['" All clean!'] let names = [] else - let headers = ['" Removing bundles:'] + let headers = ['" Removing Plugins:'] let names = vundle#scripts#bundle_names(map(copy(x_dirs), 'fnamemodify(v:val, ":t")')) end @@ -167,6 +268,14 @@ func! vundle#installer#clean(bang) abort 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 let cmd = ((has('win32') || has('win64')) && empty(matchstr(&shell, 'sh'))) ? @@ -174,14 +283,14 @@ func! vundle#installer#delete(bang, dir_name) abort \ 'rm -rf' let bundle = vundle#config#init_bundle(a:dir_name, {}) - let cmd .= ' '.vundle#compat#shellescape(bundle.path()) + let cmd .= ' '.vundle#installer#shellesc(bundle.path()) let out = s:system(cmd) call s:log('') - call s:log('Bundle '.a:dir_name) - call s:log('$ '.cmd) - call s:log('> '.out) + call s:log('Plugin '.a:dir_name) + call s:log(cmd, '$ ') + call s:log(out, '> ') if 0 != v:shell_error return 'error' @@ -190,6 +299,13 @@ func! vundle#installer#delete(bang, dir_name) abort endif 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 return isdirectory(a:rtp.'/doc') \ && (!filereadable(a:rtp.'/doc/tags') || filewritable(a:rtp.'/doc/tags')) @@ -198,11 +314,19 @@ func! s:has_doc(rtp) abort \ : !(empty(glob(a:rtp.'/doc/*.txt')) && empty(glob(a:rtp.'/doc/*.??x'))) 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 - 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) try - execute 'helptags ' . resolve(doc_path) + execute 'helptags ' . doc_path catch call s:log("> Error running :helptags ".doc_path) return 0 @@ -210,27 +334,123 @@ func! s:helptags(rtp) abort return 1 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) if isdirectory(git_dir) || filereadable(expand(a:bundle.path().'/.git', 1)) - if !(a:bang) | return 'todate' | endif - let cmd = 'cd '.vundle#compat#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 + + if !(a:bang) + " The repo exists, and no !, so leave as it is. + 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 get_current_sha = 'cd '.vundle#compat#shellescape(a:bundle.path()).' && git rev-parse HEAD' - let get_current_sha = g:shellesc_cd(get_current_sha) - let initial_sha = s:system(get_current_sha)[0:15] + let initial_sha = s:get_current_sha(a:bundle) else - let cmd = 'git clone --recursive '.vundle#compat#shellescape(a:bundle.uri).' '.vundle#compat#shellescape(a:bundle.path()) + let cmd = 'git clone --recursive '.vundle#installer#shellesc(a:bundle.uri).' '.vundle#installer#shellesc(a:bundle.path()) let initial_sha = '' 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) call s:log('') - call s:log('Bundle '.a:bundle.name_spec) - call s:log('$ '.cmd) - call s:log('> '.out) + call s:log('Plugin '.a:bundle.name_spec) + call s:log(cmd, '$ ') + call s:log(out, '> ') if 0 != v:shell_error return 'error' @@ -240,41 +460,88 @@ func! s:sync(bang, bundle) abort return 'new' 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 return 'todate' endif - call add(g:updated_bundles, [initial_sha, updated_sha, a:bundle]) + call add(g:vundle#updated_bundles, [initial_sha, updated_sha, a:bundle]) return 'updated' 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 &shellxquote != '(' " workaround for patch #445 - return '"'.a:cmd.'"' " enclose in quotes so && joined cmds work - endif + return '"' . substitute(a:cmd, '"', '\\"', 'g') . '"' endif - return a:cmd + return vundle#compat#shellescape(a:cmd) 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'))) let cmd = substitute(a:cmd, '^cd ','cd /d ','') " add /d switch to change drives - let cmd = g:shellesc(cmd) return cmd else return a:cmd endif 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 return system(a:cmd) 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 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: diff --git a/autoload/vundle/scripts.vim b/autoload/vundle/scripts.vim index d31cae6..f789762 100644 --- a/autoload/vundle/scripts.vim +++ b/autoload/vundle/scripts.vim @@ -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, ...) 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) if !empty(a:1) let matches = filter(matches, 'v:val =~? "'.escape(a:1,'"').'"') @@ -10,86 +18,150 @@ func! vundle#scripts#all(bang, ...) endif call vundle#scripts#view('search',info, vundle#scripts#bundle_names(reverse(matches))) redraw - echo len(matches).' bundles found' + echo len(matches).' plugins found' endf + +" --------------------------------------------------------------------------- +" Repeat the search for bundles. +" --------------------------------------------------------------------------- func! vundle#scripts#reload() abort - silent exec ':BundleSearch! '.(exists('b:match') ? b:match : '') + silent exec ':PluginSearch! '.(exists('b:match') ? b:match : '') redraw 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, or all installed plugin names when running an 'Update +" variant'. see also :h command-completion-custom +" --------------------------------------------------------------------------- func! vundle#scripts#complete(a,c,d) - return join(s:load_scripts(0),"\n") + if match(a:c, '\v^%(Plugin|Vundle)%(Install!|Update)') == 0 + " Only installed plugins if updating + return join(map(copy(g:vundle#bundles), 'v:val.name'), "\n") + else + " Or all known plugins otherwise + return join(s:load_scripts(0),"\n") + endif endf + +" --------------------------------------------------------------------------- +" View the logfile after an update or installation. +" --------------------------------------------------------------------------- func! s:view_log() - if !exists('g:vundle_log_file') - let g:vundle_log_file = tempname() + if !exists('s:log_file') + let s:log_file = tempname() endif - call writefile(g:vundle_log, g:vundle_log_file) - execute 'silent pedit ' . g:vundle_log_file + if bufloaded(s:log_file) + execute 'silent bdelete' s:log_file + endif + call writefile(g:vundle#log, s:log_file) + execute 'silent pedit ' . s:log_file + set bufhidden=wipe + setl buftype=nofile + setl noswapfile + setl ro noma wincmd P | wincmd H endf + +" --------------------------------------------------------------------------- +" Parse the output from git log after an update to create a change log for the +" user. +" --------------------------------------------------------------------------- func! s:create_changelog() abort - for bundle_data in g:updated_bundles + let changelog = ['Updated Plugins:'] + for bundle_data in g:vundle#updated_bundles let initial_sha = bundle_data[0] let updated_sha = bundle_data[1] let bundle = bundle_data[2] - let cmd = 'cd '.vundle#compat#shellescape(bundle.path()). + let cmd = 'cd '.vundle#installer#shellesc(bundle.path()). \ ' && git log --pretty=format:"%s %an, %ar" --graph '. \ initial_sha.'..'.updated_sha - let cmd = g:shellesc_cd(cmd) + let cmd = vundle#installer#shellesc_cd(cmd) let updates = system(cmd) - call add(g:vundle_changelog, '') - call add(g:vundle_changelog, 'Updated Bundle: '.bundle.name) + call add(changelog, '') + call add(changelog, 'Updated Plugin: '.bundle.name) if bundle.uri =~ "https://github.com" - call add(g:vundle_changelog, 'Compare at: '.bundle.uri[0:-5].'/compare/'.initial_sha.'...'.updated_sha) + call add(changelog, 'Compare at: '.bundle.uri[0:-5].'/compare/'.initial_sha.'...'.updated_sha) endif for update in split(updates, '\n') let update = substitute(update, '\s\+$', '', '') - call add(g:vundle_changelog, ' '.update) + call add(changelog, ' '.update) endfor endfor + return changelog endf -func! s:view_changelog() - call s:create_changelog() - if !exists('g:vundle_changelog_file') - let g:vundle_changelog_file = tempname() +" --------------------------------------------------------------------------- +" View the change log after an update or installation. +" --------------------------------------------------------------------------- +func! s:view_changelog() + if !exists('s:changelog_file') + let s:changelog_file = tempname() endif - call writefile(g:vundle_changelog, g:vundle_changelog_file) - execute 'silent pedit ' . g:vundle_changelog_file + if bufloaded(s:changelog_file) + execute 'silent bdelete' s:changelog_file + endif + call writefile(s:create_changelog(), s:changelog_file) + execute 'silent pedit' s:changelog_file + set bufhidden=wipe + setl buftype=nofile + setl noswapfile + setl ro noma + setfiletype vundlelog wincmd P | wincmd H 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) - return map(copy(a:names), ' printf("Bundle ' ."'%s'".'", v:val) ') + return map(copy(a:names), ' printf("Plugin ' ."'%s'".'", v:val) ') 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) - if exists('g:vundle_view') && bufloaded(g:vundle_view) - exec g:vundle_view.'bd!' + if exists('s:view') && bufloaded(s:view) + exec s:view.'bd!' endif exec 'silent pedit [Vundle] '.a:title wincmd P | wincmd H - let g:vundle_view = bufnr('%') + let s:view = bufnr('%') " - " make buffer modifiable + " make buffer modifiable " to append without errors set modifiable @@ -97,56 +169,65 @@ func! vundle#scripts#view(title, headers, results) setl buftype=nofile setl noswapfile + set bufhidden=wipe setl cursorline - setl nonu ro noma ignorecase + setl nonu ro noma if (exists('&relativenumber')) | setl norelativenumber | endif setl ft=vundle setl syntax=vim + syn keyword vimCommand Plugin syn keyword vimCommand Bundle syn keyword vimCommand Helptags - com! -buffer -bang -nargs=1 DeleteBundle + com! -buffer -bang -nargs=1 DeletePlugin \ call vundle#installer#run('vundle#installer#delete', split(,',')[0], ['!' == '', ]) - com! -buffer -bang -nargs=? InstallAndRequireBundle + com! -buffer -bang -nargs=? InstallAndRequirePlugin \ call vundle#installer#run('vundle#installer#install_and_require', split(,',')[0], ['!' == '', ]) - com! -buffer -bang -nargs=? InstallBundle + com! -buffer -bang -nargs=? InstallPlugin \ call vundle#installer#run('vundle#installer#install', split(,',')[0], ['!' == '', ]) - com! -buffer -bang -nargs=0 InstallHelptags + com! -buffer -bang -nargs=0 InstallHelptags \ call vundle#installer#run('vundle#installer#docs', 'helptags', []) com! -buffer -nargs=0 VundleLog call s:view_log() com! -buffer -nargs=0 VundleChangelog call s:view_changelog() - nnoremap q :silent bd! - nnoremap D :exec 'Delete'.getline('.') + nnoremap q :silent bd! + nnoremap D :exec 'Delete'.getline('.') - nnoremap add :exec 'Install'.getline('.') - nnoremap add! :exec 'Install'.substitute(getline('.'), '^Bundle ', 'Bundle! ', '') + nnoremap add :exec 'Install'.getline('.') + nnoremap add! :exec 'Install'.substitute(getline('.'), '^Plugin ', 'Plugin! ', '') - nnoremap i :exec 'InstallAndRequire'.getline('.') - nnoremap I :exec 'InstallAndRequire'.substitute(getline('.'), '^Bundle ', 'Bundle! ', '') + nnoremap i :exec 'InstallAndRequire'.getline('.') + nnoremap I :exec 'InstallAndRequire'.substitute(getline('.'), '^Plugin ', 'Plugin! ', '') - nnoremap l :VundleLog - nnoremap u :VundleChangelog - nnoremap h :h vundle - nnoremap ? :norm h + nnoremap l :VundleLog + nnoremap u :VundleChangelog + nnoremap h :h vundle + nnoremap ? :h vundle - nnoremap c :BundleClean - nnoremap C :BundleClean! + nnoremap c :PluginClean + nnoremap C :PluginClean! - nnoremap s :BundleSearch - nnoremap R :call vundle#scripts#reload() + nnoremap s :PluginSearch + nnoremap R :call vundle#scripts#reload() " goto first line after headers exec ':'.(len(a:headers) + 1) 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) let scripts_dir = fnamemodify(expand(a:to, 1), ":h") if !isdirectory(scripts_dir) @@ -155,13 +236,13 @@ func! s:fetch_scripts(to) let l:vim_scripts_json = 'http://vim-scripts.org/api/scripts.json' if executable("curl") - let cmd = 'curl --fail -s -o '.vundle#compat#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") - let temp = vundle#compat#shellescape(tempname()) - let cmd = 'wget -q -O '.temp.' '.l:vim_scripts_json. ' && mv -f '.temp.' '.vundle#compat#shellescape(a:to) - if (has('win32') || has('win64')) + let temp = vundle#installer#shellesc(tempname()) + let cmd = 'wget -q -O '.temp.' '.l:vim_scripts_json. ' && mv -f '.temp.' '.vundle#installer#shellesc(a:to) + if (has('win32') || has('win64')) let cmd = substitute(cmd, 'mv -f ', 'move /Y ', '') " change force flag - let cmd = g:shellesc(cmd) + let cmd = vundle#installer#shellesc(cmd) end else echoerr 'Error curl or wget is not available!' @@ -177,8 +258,17 @@ func! s:fetch_scripts(to) return 0 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) - let f = expand(g:bundle_dir.'/.vundle/script-names.vim-scripts.org.json', 1) + let f = expand(g:vundle#bundle_dir.'/.vundle/script-names.vim-scripts.org.json', 1) if a:bang || !filereadable(f) if 0 != s:fetch_scripts(f) return [] @@ -186,3 +276,5 @@ func! s:load_scripts(bang) endif return eval(readfile(f, 'b')[0]) endf + +" vim: set expandtab sts=2 ts=2 sw=2 tw=78 norl: diff --git a/changelog.md b/changelog.md new file mode 100644 index 0000000..b620840 --- /dev/null +++ b/changelog.md @@ -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 diff --git a/doc/vundle.txt b/doc/vundle.txt index bb4ea4f..81a5f66 100644 --- a/doc/vundle.txt +++ b/doc/vundle.txt @@ -1,237 +1,411 @@ -*vundle.txt* Vundle the plug-in manager for Vim. *vundle* +*vundle.txt* Vundle, a plug-in manager for Vim. *vundle* -CONTENTS ~ - *vundle-contents* -=========================================================================== + VUNDLE MANUAL -1. About |vundle-about| -2. Why Vundle |vundle-why-vundle| -3. Quick start |vundle-quickstart| -4. Scripts |vundle-scripts| - 4.1. Configure scripts |vundle-scripts-configure| - 4.2. Installing scripts |vundle-scripts-install| - 4.3. Updating scripts |vundle-scripts-update| - 4.4. Searching scripts |vundle-scripts-search| - 4.5. Listing scripts |vundle-scripts-list| - 4.6. Cleanup |vundle-scripts-cleanup| -5. Interactive mode |vundle-interactive| -6. Key mappings |vundle-keymappings| -7. Options |vundle-options| +1. About Vundle |vundle-about| +2. Quick Start |vundle-quickstart| +3. Plugins |vundle-plugins| + 3.1. Configuring Plugins |vundle-plugins-configure| + 3.2. Supported URIs |vundle-plugins-uris| + 3.3. Installing Plugins |vundle-plugins-install| + 3.4. Updating Plugins |vundle-plugins-update| + 3.5. Searching Plugins |vundle-plugins-search| + 3.6. Listing Plugins |vundle-plugins-list| + 3.7. Cleaning Up |vundle-plugins-cleanup| +4. Interactive Mode |vundle-interactive| +5. Key Mappings |vundle-keymappings| +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 ~ - *vundle-why-vundle* -Vundle allows to: + - keep track of and configure your scripts right in the `.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 -- keep track and configure your scripts right in `.vimrc` -- install configured scripts (aka bundle) -- update configured scripts -- search [all available vim scripts] by name -- clean up from unused scripts +Vundle automatically... -Also *Vundle* : + - manages the runtime path of your installed scripts + - regenerates help tags after installing and updating -- manages runtime path of your installed scripts -- regenerates helptags automatically +Vundle's search uses http://vim-scripts.org to provide a list of all +available Vim scripts. -Vundle takes advantage of [vim-scripts.org](http://vim-scripts.org) -in order to install/search [all available vim scripts] +Vundle is undergoing an interface change, see |vundle-interface-change| for +more information. -3. QUICK START ~ - *vundle-quickstart* -1) Setup Vundle: > +============================================================================= +2. QUICK START ~ + *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/VundleVim/Vundle.vim/wiki/Vundle-for-Windows. - set nocompatible " be iMproved - filetype off " required! + *vundle-faq* + If you run into any issues, please consult the FAQ at + https://github.com/VundleVim/Vundle.vim/wiki - set rtp+=~/.vim/vundle.git/ - call vundle#rc() +2. Setup Vundle: +> + git clone https://github.com/VundleVim/Vundle.vim.git ~/.vim/bundle/Vundle.vim +< +3. Configure bundles: - " let Vundle manage Vundle - Bundle 'gmarik/vundle' + Put this at the top of your `.vimrc` to use Vundle. Remove bundles you + don't need, they are for illustration purposes. +> + set nocompatible " be iMproved, required + filetype off " required + + " set the runtime path to include Vundle and initialize + 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, required + Plugin 'VundleVim/Vundle.vim' + + " 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'} + + " 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 + +4. Install configured bundles: + + Launch vim and run +> + :PluginInstall +< + To install from command line: +> + vim +PluginInstall +qall - " My Bundles here: - " - " original repos on github - Bundle 'tpope/vim-fugitive' - Bundle 'Lokaltog/vim-easymotion' - 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' - " ... +============================================================================= +3. PLUGINS ~ + *vundle-plugins* - filetype plugin indent on " required! - " or - " filetype plugin on " to not use the indentation settings set by plugins +3.1 CONFIGURING PLUGINS ~ + *vundle-plugins-configure* *:Plugin* -3) Install configured bundles: +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`. - Launch `vim`, run > +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' - :BundleInstall +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. -Installing requires [Git] and triggers [Git clone](http://gitref.org/creating/#clone) for -each configured repo to `~/.vim/bundle/`. +The following per-script configuration options are available. -4. SCRIPTS ~ - *vundle-scripts* -4.1 CONFIGURE SCRIPTS ~ - *vundle-scripts-configure* *Bundle* -Before installing scripts they need to be configured. It's done using `Bundle` -command in `.vimrc`: > +The 'rtp' option +---------------- - Bundle 'git_repo_uri' " 'git_repo_uri' should be a valid uri to git repository -or > - Bundle 'script_name' " 'script-name' should be an official script name (see |vundle-scripts-search| ) +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. -Vundle loves Github, that's why short uris can be used with commands: > +The 'name' option +----------------- - Bundle 'tpope/vim-fugitive' +The name of the directory that will hold the local clone of the configured +script. -equals full uri > +For example: +> + Plugin 'git_URI', {'name': 'newPluginName'} - Bundle 'http://github.com/tpope/vim-fugitive.git' +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. -NOTE: Vundle defaults to http:// protocol for the short URIs +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|. -4.2 INSTALL SCRIPTS ~ - *vundle-scripts-install* *BundleInstall* -run > - :BundleInstall +For example: +> + Plugin 'mylocalplugin', {'pinned': 1} -installs configured scripts. Newly installed scripts will be automatically -enabled. Except special cases requiring compilation or pre-configuration. +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. -BundleInstall allows to install scripts by name:> +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. - :BundleInstall unite.vim +3.2 SUPPORTED URIS ~ + *vundle-plugins-uris* -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. +`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. -4.3 UPDATE SCRIPTS ~ - *vundle-scripts-update* *BundleInstall!* -run > - :BundleInstall! " NOTE: bang(!) +More information on `git`'s protocols can be found at: +http://git-scm.com/book/ch4-1.html -installs or updates configured scripts. -press u after updates complete to see the changelog of all updated bundles. +GitHub +------ +GitHub is used when a user/repo is passed to `Plugin`. +> + Plugin 'VundleVim/Vundle.vim' => https://github.com/VundleVim/Vundle.vim -4.4 SEARCHING ~ - *vundle-scripts-search* *BundleSearch* -run > - :BundleSearch foo +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 -lists bundles matching 'foo' in new a new split window, ie: +Other Git URIs +-------------- +No modification is performed on valid URIs that point outside the above +URLs. > - Bundle "VimFootnotes" - Bundle "foo.vim" + 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. > -and > + Plugin 'file:///path/from/root/to/plugin' - :BundleSearch! foo +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. -refreshes script list before performing actual search. +PluginInstall allows installation of plugins by name: +> + :PluginInstall unite.vim -If command is run without argument: > +Installs and activates unite.vim. - :BundleSearch! +PluginInstall also allows installation of several plugins separated by space. +> + :PluginInstall tpope/vim-surround tpope/vim-fugitive -it will display all known scripts +Installs both tpope/vim-surround and tpope/vim-fugitive from GitHub. -Searching requires [`curl`](http://curl.haxx.se/) +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. -4.5 LISTING BUNDLES ~ - *vundle-scripts-list* *BundleList* +After installing plugins press 'l' (lowercase 'L') to see the log of commands +if any errors occurred. -To quickly pull list of installed bundles use > +3.4 UPDATING PLUGINS ~ + *vundle-plugins-update* *:PluginUpdate* *:PluginInstall!* +> + :PluginInstall! " NOTE: bang(!) +or > + :PluginUpdate - :BundleList +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. +To update specific plugins, write their names separated by space: +> + :PluginInstall! vim-surround vim-fugitive +or > + :PluginUpdate vim-surround vim-fugitive -4.6 CLEANING UP ~ - *vundle-scripts-cleanup* *BundleClean* -run > +3.5 SEARCHING PLUGINS ~ + *vundle-plugins-search* *:PluginSearch* +> + :PluginSearch - :BundleClean +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: +> + PluginSearch foo -confirms removal of unused script-dirs from `.vim/bundle/`. +displays: +> + "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 - *BundleClean!* +If the command is run without argument: > - :BundleClean! + :PluginSearch! -removes unused dirs with no questions. +it will display all known plugins in the new split. +3.6 LISTING BUNDLES ~ + *vundle-plugins-list* *:PluginList* +> + :PluginList - *vundle-interactive* -5. INTERACTIVE MODE ~ +Displays a list of installed bundles. -Vundle provides simple interactive mode to help you explore new scripts easily. -Interactive mode is available as result of any commands that display list of -bundles. For instance, running: > +3.7 CLEANING UP ~ + *vundle-plugins-cleanup* *:PluginClean* +> + :PluginClean - :BundleSearch! unite +Requests confirmation for the removal of all plugins no longered configured +in your `.vimrc` but present in your bundle installation directory +(default: `.vim/bundle/`). -triggers search for scripts matching 'unite' and yields a split window with -content: > + *:PluginClean!* +> + :PluginClean! - "Keymap: i - Install bundle; c - Cleanup; r - Refine list; R - Reload list - "Search results for: unite - Bundle 'unite.vim' - Bundle 'unite-yarm' - Bundle 'unite-gem' - Bundle 'unite-locate' - Bundle 'unite-font' - Bundle 'unite-colorscheme' +Automatically confirm removal of unused bundles. -As the first line(starting with `"Keymap:`) shows, certain actions may be applied -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. +============================================================================= +4. INTERACTIVE MODE ~ + *vundle-interactive* -NOTE: Interactive installation doesn't update your .vimrc configuration. +Vundle provides a simple interactive mode to help you explore new plugins +easily. Interactive mode is available after any command that lists `Plugins` +such as PluginSearch, PluginList or Plugins. For instance: +> + :PluginSearch! unite - *vundle-keymappings* -6. KEY MAPPINGS ~ +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 ----|-------------------------- > - i | run :BundleInstall with name taken from line cursor is positioned on - I | same as i, but runs :BundleInstall! to update bundle - D | delete selected bundle( be careful not to remove local modifications) - c | run :BundleClean - s | run :BundleSearch + i | run :PluginInstall with name taken from line cursor is positioned on + I | same as i, but runs :PluginInstall! to update bundle + D | delete selected bundle (be careful not to remove local modifications) + c | run :PluginClean + s | run :PluginSearch R | fetch fresh script list from server -. - - *vundle-options* -7. OPTIONS ~ +============================================================================= +6. OPTIONS ~ + *vundle-options* > let g:vundle_default_git_proto = 'git' - -makes Vundle use `git` instead default `https` when building absolute repo URIs - - -vim:tw=78:ts=8:ft=help:norl: +< + 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 + +============================================================================= +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. + + 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: diff --git a/ftplugin/vundlelog.vim b/ftplugin/vundlelog.vim new file mode 100644 index 0000000..0f338eb --- /dev/null +++ b/ftplugin/vundlelog.vim @@ -0,0 +1,15 @@ +" --------------------------------------------------------------------------- +" Standard ftplugin boilerplate; see ':help ftplugin'. +" --------------------------------------------------------------------------- +if exists("b:did_ftplugin") + finish +endif +let b:did_ftplugin = 1 + + +" --------------------------------------------------------------------------- +" Settings for the Vundle update log buffer. +" --------------------------------------------------------------------------- +setlocal textwidth=0 +setlocal nowrap +setlocal noswapfile diff --git a/syntax/vundlelog.vim b/syntax/vundlelog.vim new file mode 100644 index 0000000..64e81e3 --- /dev/null +++ b/syntax/vundlelog.vim @@ -0,0 +1,36 @@ +" --------------------------------------------------------------------------- +" Syntax highlighting for the line which identifies the plugin. +" --------------------------------------------------------------------------- +syntax match VundlePluginName '\v(^Updated Plugin: )@<=.*$' +highlight link VundlePluginName Keyword + +" --------------------------------------------------------------------------- +" Syntax highlighting for the 'compare at' line of each plugin. +" --------------------------------------------------------------------------- +syntax region VundleCompareLine start='\v^Compare at: https:' end='\v\n' + \ contains=VundleCompareUrl +syntax match VundleCompareUrl '\vhttps:\S+' +highlight link VundleCompareLine Comment +highlight link VundleCompareUrl Underlined + +" --------------------------------------------------------------------------- +" Syntax highlighting for individual commits. +" --------------------------------------------------------------------------- +" The main commit line. +" Note that this regex is intimately related to the one for VundleCommitTree, +" and the two should be changed in sync. +syntax match VundleCommitLine '\v(^ [|*]( *[\\|/\*])* )@<=[^*|].*$' + \ contains=VundleCommitMerge,VundleCommitUser,VundleCommitTime +highlight link VundleCommitLine String +" Sub-regions inside the commit message. +syntax match VundleCommitMerge '\v Merge pull request #\d+.*' +syntax match VundleCommitUser '\v( )@<=\S+( \S+)*(, \d+ \w+ ago$)@=' +syntax match VundleCommitTime '\v(, )@<=\d+ \w+ ago$' +highlight link VundleCommitMerge Ignore +highlight link VundleCommitUser Identifier +highlight link VundleCommitTime Comment +" The git history DAG markers are outside of the main commit line region. +" Note that this regex is intimately related to the one for VundleCommitLine, +" and the two should be changed in sync. +syntax match VundleCommitTree '\v(^ )@<=[|*]( *[\\|/\*])*' +highlight link VundleCommitTree Label diff --git a/test/minirc.vim b/test/minirc.vim index 352d9bc..f4ece70 100644 --- a/test/minirc.vim +++ b/test/minirc.vim @@ -1,8 +1,9 @@ set nocompatible syntax on filetype off -set rtp+=~/.vim/bundle/vundle/ -call vundle#rc() -Bundle 'gmarik/vundle' +set rtp+=~/.vim/bundle/Vundle.vim/ +call vundle#begin() +Plugin 'VundleVim/Vundle.vim' +call vundle#end() filetype plugin indent on diff --git a/test/vimrc b/test/vimrc index 68df310..984d4c7 100644 --- a/test/vimrc +++ b/test/vimrc @@ -3,31 +3,30 @@ set nocompatible set nowrap -let root = '/tmp/!vundle-test/bundles/' -let src = 'http://github.com/gmarik/vundle.git' - -" let src = '~/.vim/bundle/vundle/.git' +let bundle_dir = '/tmp/vundle-test/bundles/' +" let src = 'http://github.com/gmarik/vundle.git' " Vundle Options " let g:vundle_default_git_proto = 'git' -if !isdirectory(expand(root, 1).'/vundle') - exec '!git clone '.src.' '.vundle#compat#shellescape(root, 1).'/vundle' -endif +" NOTE: the 'autoload' modules are not available. if they were, +" we could escape the 'bundle_dir' like this: +" vundle#compat#shellescape(bundle_dir) +silent execute '!mkdir -p '.bundle_dir +silent execute '!ln -f -s ~/.vim/bundle/Vundle.vim '.bundle_dir filetype off syntax on 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 -Bundle 'molokai' +Plugin 'molokai' " vim-scripts name " github username with dashes Bundle 'vim-scripts/ragtag.vim' @@ -38,7 +37,7 @@ Bundle 'altercation/vim-colors-solarized' Bundle 'nelstrom/vim-mac-classic-theme.git' " " invalid uri -Bundle 'nonexistinguser/yupppierepo.git' +"Bundle 'nonexistinguser/yupppierepo.git' " full uri Bundle 'https://github.com/vim-scripts/vim-game-of-life' @@ -54,6 +53,7 @@ Bundle '~/Dropbox/.gitrepos/utilz.vim.git' " with options Bundle 'rstacruz/sparkup.git', {'rtp': 'vim/'} +Bundle 'matchit.zip', {'name': 'matchit'} " Camel case Bundle 'vim-scripts/RubySinatra' @@ -61,16 +61,24 @@ Bundle 'vim-scripts/RubySinatra' " syntax issue #203 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. -set wildignore+=doc " should not break helptags -set wildignore+=.git " should not break clone -set wildignore+=.git/* " should not break clone +set wildignore+=doc " should not break helptags +set wildignore+=.git " should not break clone +set wildignore+=.git/* " should not break clone set wildignore+=*/.git/* " TODO: helptags fails with this -" set wildignore+=doc/* " should not break clone +" set wildignore+=doc/* " should not break clone " set wildignore+=*/doc/* au VimEnter * BundleInstall " e test/files/erlang.erl +" vim: set expandtab sts=2 ts=2 sw=2 tw=78: