spf13-vim is a distribution of vim plugins and resources for Vim, Gvim and MacVim.
Create ~/.vimrc.local and ~/.gvimrc.local for any local customizations.
Create a ~/.vimrc.before.local file to define any customizations that get loaded before the spf13-vim.vimrc.
The load order for the configuration is:
spf13-vim contains a curated set of popular vim plugins, colors, snippets and syntaxes. Great care has been made to ensure that these plugins play well together and have optimal configuration.
Create ~/.vimrc.bundles.local for any additional bundles.
To add a new bundle
echo Bundle \'spf13/vim-colors\' >> ~/.vimrc.bundles.local
Create ~/.vimrc.local if it doesn't already exist.
Add the UnBundle command to this line. It takes the same input as the Bundle line, so simply copy the line you want to disable and add 'Un' to the beginning.
For example, disabling the 'AutoClose' and 'scrooloose/syntastic' plugins
echo UnBundle \'AutoClose\' >> ~/.vimrc.local echo UnBundle \'scrooloose/syntastic\' >> ~/.vimrc.local
Remember to run ':BundleClean!' after this to remove the existing directories
Here are a few of the plugins:
If you undo changes and then make a new change, in most editors the changes you undid are gone forever, as their undo-history is a simple list. Since version 7.0 vim uses an undo-tree instead. If you make a new change after undoing changes, a new branch is created in that tree. Combined with persistent undo, this is nearly as flexible and safe as git ;-)
Undotree makes that feature more accessible by creating a visual representation of said undo-tree.
QuickStart Launch using
NERDTree is a file explorer plugin that provides "project drawer" functionality to your vim editing. You can learn more about it with :help NERDTree.
QuickStart Launch using
Customizations:
Ctrlp replaces the Command-T plugin with a 100% viml plugin. It provides an intuitive and fast mechanism to load files from the file system (with regex and fuzzy find), from open buffers, and from recently used files.
QuickStart Launch using
This plugin is a tool for dealing with pairs of "surroundings." Examples of surroundings include parentheses, quotes, and HTML tags. They are closely related to what Vim refers to as text-objects. Provided are mappings to allow for removing, changing, and adding surroundings.
Details follow on the exact semantics, but first, consider the following examples. An asterisk (*) is used to denote the cursor position.
Old text Command New text ~ "Hello *world!" ds" Hello world! [123+4*56]/2 cs]) (123+456)/2 "Look ma, I'm *HTML!" cs"Look ma, I'm HTML!if *x>3 { ysW( if ( x>3 ) { my $str = *whee!; vllllS' my $str = 'whee!';
For instance, if the cursor was inside "foo bar", you could type cs"' to convert the text to 'foo bar'.
There's a lot more, check it out at :help surround
NERDCommenter allows you to wrangle your code comments, regardless of filetype. Viewhelp :NERDCommenter or checkout my post on NERDCommenter.
QuickStart Toggle comments using
NeoComplCache is an amazing autocomplete plugin with additional support for snippets. It can complete simulatiously from the dictionary, buffer, omnicomplete and snippets. This is the one true plugin that brings Vim autocomplete on par with the best editors.
QuickStart Just start typing, it will autocomplete where possible
Customizations:
YouCompleteMe is another amazing completion engine. It is slightly more involved to set up as it contains a binary component that the user needs to compile before it will work. As a result of this however it is very fast.
To enable YouCompleteMe add YouCompleteMe to your list of groups by overriding it in your.vimrc.bundles.local like so:let g:spf13_bundle_groups=['general', 'programming', 'misc', 'scala', 'YouCompleteMe'] This is just an example. Remember to choose the other groups you want here.
Once you have done this you will need to get Vundle to grab the latest code from git. You can do this by calling:BundleInstall!. You should see YouCompleteMe in the list.
You will now have the code in your bundles directory and can proceed to compile the core. Change to the directory it has been downloaded to. If you have a vanilla install thencd ~/.spf13-vim-3/.vim/bundle/YouCompleteMe/ should do the trick. You should see a file in this directory called install.sh. There are a few options to consider before running the installer:
The plugin is well documented on the site linked above. Be sure to give that a read and make sure you understand the options you require.
For java users wanting to use eclim be sure to add let g:EclimCompletionMethod = 'omnifunc' to your .vimrc.local.
Syntastic is a syntax checking plugin that runs buffers through external syntax checkers as they are saved and opened. If syntax errors are detected, the user is notified and is happy because they didn't have to compile their code or execute their script to find them.
AutoClose does what you expect. It's simple, if you open a bracket, paren, brace, quote, etc, it automatically closes it. It handles curlys correctly and doesn't get in the way of double curlies for things like jinja and twig.
Fugitive adds pervasive git support to git directories in vim. For more information, use :help fugitive
Use :Gstatus to view git status and type - on any file to stage or unstage it. Type p on a file to entergit add -p and stage specific hunks in the file.
Use :Gdiff on an open file to see what changes have been made to that file
QuickStart
Customizations:
The most feature complete and up to date PHP Integration for Vim with proper support for PHP 5.3+ including latest syntax, functions, better fold support, etc.
PIV provides:
Ack.vim uses ack to search inside the current directory for a pattern. You can learn more about it with :help Ack
QuickStart :Ack
Tabularize lets you align statements on their equal signs and other characters
Customizations:
spf13-vim includes the Tagbar plugin. This plugin requires exuberant-ctags and will automatically generate tags for your open files. It also provides a panel to navigate easily via tags
QuickStart CTRL-] while the cursor is on a keyword (such as a function name) to jump to it's definition.
Customizations: spf13-vim binds
Note: For full language support, run brew install ctags to install exuberant-ctags.
Tip: Check out :help ctags for information about VIM's built-in ctag support. Tag navigation creates a stack which can traversed via Ctrl-] (to find the source of a token) and Ctrl-T (to jump back up one level).
EasyMotion provides an interactive way to use motions in Vim.
It quickly maps each possible jump destination to a key allowing very fast and straightforward movement.
QuickStart EasyMotion is triggered using the normal movements, but prefixing them with
For example this screen shot demonstrates pressing ,,w
Airline provides a lightweight themable statusline with no external dependencies. By default this configuration uses the symbols ? and ? as separators for different statusline sections but can be configured to use the same symbols as Powerline. An example first without and then with powerline symbols is shown here:
To enable powerline symbols first install one of the Powerline Fonts or patch your favorite font using the provided instructions. Configure your terminal, MacVim, or Gvim to use the desired font. Finally addlet g:airline_powerline_fonts=1 to your .vimrc.before.local.
spf13-vim ships with a few additional syntaxes:
spf13-vim includes solarized and spf13 vim color pack:
Use :color molokai to switch to a color scheme.
Terminal Vim users will benefit from solarizing their terminal emulators and setting solarized support to 16 colors:
let g:solarized_termcolors=16 color solarized
Terminal emulator colorschemes:
It also contains a very complete set of snippets for use with snipmate or NeoComplCache.