dotvim
dotvim copied to clipboard
lean & mean vim distribution
bling.vim
A highly tuned vim distribution that will blow your socks off!
introduction
this is my personal vim distribution that i have tweaked over time and evolved from a simple vanilla vimrc configuration to a full-blown distribution that it is today.
while it is very easy to install this and get up and running on a brand new machine (a use case i have), i recommend that you do not install this unless you fully understand everything that's going on inside. scan it for tips and tricks, or fork and customize it for your needs.
installation
- clone this repository into your
~/.vimdirectory git submodule init && git submodule updatemv ~/.vimrc ~/.vimrc.backup- create the following shim and save it as
~/.vimrc:
let g:dotvim_settings = {}
let g:dotvim_settings.version = 2
source ~/.vim/vimrc
- startup vim and dein will detect and ask you install any missing plugins. you can also manually initiate this with
:call dein#install() - done!
versioning
the g:dotvim_settings.version is a simple version number which is manually edited. it is used to detect whether significant breaking changes have been introduced so that users of the distribution can be notified accordingly.
customization
- since the distribution is just one file, customization is straightforward. any customizations can be added to the
g:dotvim_settingsvariable, which will be used whilst sourcing the distribution'svimrcfile. here is an example:
" this is the bare minimum
let g:dotvim_settings = {}
let g:dotvim_settings.version = 1
" here are some basic customizations, please refer to the top of the vimrc file for all possible options
let g:dotvim_settings.default_indent = 3
let g:dotvim_settings.max_column = 80
let g:dotvim_settings.colorscheme = 'my_awesome_colorscheme'
" change the default directory where all miscellaneous persistent files go
let g:dotvim_settings.cache_dir = "/some/place/else"
" by default, language specific plugins are not loaded. this can be changed with the following:
let g:dotvim_settings.plugin_groups_exclude = ['ruby','python']
" if there are groups you want always loaded, you can use this:
let g:dotvim_settings.plugin_groups_include = ['go']
" alternatively, you can set this variable to load exactly what you want
let g:dotvim_settings.plugin_groups = ['core','web']
" if there is a particular plugin you don't like, you can define this variable to disable them entirely
let g:dotvim_settings.disabled_plugins=['vim-foo','vim-bar']
" finally, load the distribution
source ~/.vim/vimrc
" anything defined here are simply overrides
set wildignore+=\*/node_modules/\*
set guifont=Wingdings:h10
autocomplete
this distribution will pick one of three combinations, in the following priority:
- neocomplete + neosnippet if you have
luaenabled. - youcompleteme + ultisnips if you have compiled YCM.
- neocomplcache + neosnippet if you only have vimscript available
this can be overridden with g:dotvim_settings.autocomplete_method
standard modifications
- if you have either ack or ag installed, they will be used for
grepprg - all temporary files are stored in
~/.vim/.cache, such as backup files and persistent undo
mappings
insert mode
<C-h>move the cursor left<C-l>move the cursor rightjk,kjremapped for "smash escape"
normal mode
<leader>fefformat entire file<leader>f$strip current line of trailing white space- window shortcuts
<leader>vvertical split<leader>shorizontal split<leader>vsavertically split all buffers<C-h><C-j><C-k><C-l>move to window in the direction of hkjl- window killer
Qremapped to close windows and delete the buffer (if it is the last buffer window)- searching
<leader>fwfind the word under cursor into the quickfix list<leader>fffind the last search into the quickfix list/replaced with/\vfor sane regex searching<cr>toggles hlsearch
<Down><Up>maps to:bprevand:bnextrespectively<Left><Right>maps to:tabprevand:tabnextrespectivelygpremapped to visually reselect the last pastegbfor quick going to buffer<leader>ltoggleslistandnolist- profiling shortcuts
<leader>DDstarts profiling all functions and files into a fileprofile.log<leader>DPpauses profiling<leader>DCcontinues profiling<leader>DQfinishes profiling and exits vim
visual mode
<leader>ssort selection>and<automatically reselects the visual selection
plugins
unite.vim
- this is an extremely powerful plugin that lets you build up lists from arbitrary sources
- mappings
<space><space>go to anything (files, buffers, MRU, bookmarks)<space>yselect from previous yanks<space>lselect line from current buffer<space>bselect from current buffers<space>oselect from outline of current file<space>squick switch buffer<space>/recursively search all files for matching text (usesagorackif found)
bufkill.vim
<leader>bdor:BDwill kill a buffer without changing the window layout
sneak.vim
- motion on steriods
easygrep
- makes search/replacing in your project a lot easier without relying on
findandsed - the loading time of this plugin is relatively heavy, so it is not loaded at startup. to load it on-demand, use
<leader>vo, which opens the options window. <leader>vvfind word under the cursor<leader>vVfind whole word under the cursor<leader>vrperform global search replace of word under cursor, with confirmation<leader>vRsame as vr, but matches whole word
fugitive
- git wrapper
<leader>gsstatus<leader>gddiff<leader>gccommit<leader>gbblame<leader>gllog<leader>gppush<leader>gwstage<leader>grrm- in addition to all the standard bindings when in the git status window, you can also use
Uto perform agit checkout --on the current file
gitv
- nice log history viewer for git
<leader>gv
unimpaired
- many additional bracket
[]maps <C-up>to move lines up<C-down>to move lines down
nerdtree
- file browser
<F2>toggle browser<F3>open tree to path of the current file
tcomment
- very versatile commenting plugin that can do motions
gccto toggle orgc{motion}
ctrlp
- fuzzy file searching
<C-p>to bring up the search\tsearch the current buffer tags\Tsearch global tags\lsearch all lines of all buffers\bsearch open buffers\oparses the current file for functions with funky
nrrwrgn
<leader>nrputs the current visual selection into a new scratch buffer, allowing you to perform global commands and merge changes to the original file automatically
tabular
- easily aligns code
<leader>a&,<leader>a=,<leader>a:,<leader>a,,<leader>a|
gist
- automatically get or push changes for gists with
:Gist
emmet
- makes for writing html/css extremely fast
- for supported most filetypes,
<tab>will be mapped to automatically expand the line (you can use<C-v><Tab>to insert a tab character if needed) - for other features, default plugin mappings are available, which means
<C-y>is the prefix, followed by a variety of options (see:help zencoding)
undotree
- visualize the undo tree
<F5>to toggle
youcompleteme/ultisnips
- amazingly fast fuzzy autocomplete engine combined with an excellent snippets library
- use
<C-n>and<C-p>to go back/forward between selections, and<tab>to expand snippets
neocomplcache/neosnippet
- autocomplete/snippet support as a fallback choice when YCM and/or python is unavailable
<Tab>to select the next match, or expand if the keyword is a snippet- if you have lua installed, it will use neocomplete instead
vimshell
<leader>csplits a new window with an embedded shell
vim-multiple-cursors
- mapped to
<C-N>, this will select all matching words and lets you concurrently change all matches at the same time
and some more plugins
- surround makes for quick work of surrounds
- repeat repeat plugin commands
- speeddating
Ctrl+AandCtrl+Xfor dates - gist awesome plugin for your gist needs
- signature shows marks beside line numbers
- matchit makes your
%more awesome - syntastic awesome syntax checking for a variety of languages
- bufferline simple plugin which prints all your open buffers in the command bar
- indent-guides vertical lines
- signify adds + and - to the signs column when changes are detected to source control files (supports git/hg/svn)
- delimitmate automagically adds closing quotes and braces
- startify gives you a better start screen
and even more plugins...
- i think i've listed about half of the plugins contained in this distribution, so please have a look at the vimrc directly to see all plugins in use
credits
i wanted to give special thanks to all of the people who worked on the following projects, or people simply posted their vim distributions, because i learned a lot and took many ideas and incorporated them into my configuration.
license
changelog
- v2
NeoBundlereplaced withdein- v1
- requires
g:dotvim_settings.versionto be defined - disable all langauge-specific plugins by default
- add support for
g:dotvim_settings.plugin_groups_include