jmagoon/dotvim2

modular and easily configurable and extendable `.vim` configuration

Dotvim2

What?

This is the second incarnation of my dotvim configuration

V1 can be found here

IMPORTANT: Please be sure to read the installation section!

Why

Over the years V1 became too bloated, and hard to update and fix. Once something went-in, its hard to remove it, since somebody might be using it.

Also, people kept sending me patches with their favorite plugins, which might not necessarily be useful for everybody.

The result is that the configuration became way too big and slow.

So my goals for this v2 release are:

• easy customization and extensibility. It should be easy to add optional functionality, plugins, bindings etc. with dotvim v1 its easy to make any plugin conditionally loadable, any value to be configurable (and have a default), etc.

• upgradeability. Your customizations should easily survive version upgrades. If you decided that you don't need 'ruby support', you should still have it 'off' next time you upgrade the version. But it should be trivial to bring it back if you ever need to.

• minimal boilerplate. You can always achieve configurability by defining a ton of vim variables and checking them with 'ifs' all over the place. This is ugly and not productive. Dotvim2 uses a shell library to keep, update, and merge your "choices" in a shell script file .config. More info TBD.

Status

dotvim2 seems to be stable enough at this point, I'll probably release 1.0 soon.

Note that not all plugins from v1 made it into v2, if you are missing anything major, please let me know ;)

Major changes

Modularity

The number 1 major feature is that its all very modular now. Many parts are optional, and its actually trivial to make most any other part optional too.

The modularity is achieved by switching from configuration files to configuration file templates and generators. You no longer use the project as-is, instead you run make in it, to generate your actual configuration in your directory of choice. You can (and its recommended to) keep this generated directory content in git as well, so that after every upgrade or configuration change you can see the exact difference.

Note: while the idea is to have this very customizable, there are still many parts and plugins that are hard-coded. Those are mostly those plugins and settings that I consider to be essential, ans so I didn't bother (yet) to allow for customization. That being said, its very easy to make any part of setup configurable. Just look at any prompt.sh file inside plugins directory. Oh, and pull requests are welcome ;).

dein

NeoBundle was replaced with dein. This time around it seems that this time around vim plugin managers are ten a penny. So I just went with dein, which is the replacement from the author of NeoBundle. NeoBundle was fast, Dein supposed to be faster still.

TBD

## Installation

Clone this repository and run make.

Installation will ask you a ton of questions and then generate your vim configuration in the VIM_DIR directory. The default is ./dist, but you can pass it anything through environment or arguments. e.g.:

VIM_DIR=~/.vim make

if you use a directory other then ~/.vim you will need to link it so that vim can find it, e.g.:

ln -sfn YOUR_VIMDIR_PATH ~/.vim

Note: Depending on your version of vim you might also have to link ~/.vimrc => YOUR_VIMDIR_PATH/vimrc. Newer versions can use ~/.vim/vimrc, but older versions will only look for ~/.vimrc

Once your configuration is generated and linked you can run vim, it will detect missing plugins and install them on the first run.

Configuration

Your configuration choices are stored in VIM_DIR/.config. You can edit it directly or just run make edit.

You will be asked quesions during the install only if the config file doesn't already contain the answer.

make reconfigure will ask all questions all over again, with your previous choices used as defaults.

During the installation a README file is generated in the destination directory with just the information relevant to your own configuration chocies.

The README file in the project repository was generated with my own configuration ;).

YouCompleteMe

Dotvim2 (optionally) uses YouCompleteMe for code completion (v1 used AutoComplPop).

It is a quite a bit more complex and not without its problems, but it seems to be the completion plugin to use at this time.

Note: You will need cmake installed if you want this to work.

IMPORTANT: YouCompleteMe installation seems to be quite problematic. One particular problem that happened to me a lot is git failing to featch all the submodules from github. In case of such a failure you can try to run make completion, which will retry YouCompleteMe installation. you might need to run it seveal time until it succeeds.

TBD

load order

• vimrc
  • vimrc.plugins
    • ~/.vimrc.plugins
    • gvimrc.plugins
      • ~/.gvimrc.plugins
  • << here all plugins are actually loaded >>
  • after/plugin/after.vim
    • vimrc.after
      • ~/.vimrc.after
      • gvimrc.after
        • ~/.gvimrc.after

Each plugin can add content to files in the target vim directory by simply having the corresponding files present in the plugin/files directory

E.g. if plugin foo has file plugins/files/directory/files, then this file's content will be added to ~/.vim/directory/files

Plugins found in the plugins subdirectory will be automatically loaded as well.

To make sure each such files will be re-created appropriately upon each install run, they have to be cleaned up.. 10-init/plugins/10-cleanup plugin takes care of the standard ones, if you need a new one, you might need to clean it up your self. place it in 000=-.... plugin directory to make sure it is called before any other plugin tries to add content to it.

If a plugin has a prompt.sh file in the directory, its loading will be conditioned on evaling this script.

If the script "fails" (i.e. non-zero exit code), then the plugin will not be loaded.

IMPORTANT: The prompt script is evaled in the contenxt of the generator, so it has access to all the state and functions, so it can run ask... functions, etc.

Note that prompt.sh should usually only ask simple question and return true/false, if you want something more complex create an install.sh instead.

If a plugin has an install.sh file in the directory, it will be sourced.

so the logic flow is as follows:

• check for prompt.sh and exit if it returns false
• copy files from files directory
• load all plugins in the plugins directory
• run install.sh if exists

TBD.

examples

TBD

example files structure

• plugins
  • simple_directory_plugin
    • files
      • file_to_copy
  • plugin with a prompt
    • files
      • some file
    • prompt.sh
  • plugin_with_install_script
    • files
      • file_to_copy
    • other_files
      • other_files_to_copy
    • install.sh
    • plugins
      • sub-plugin1 ...

plugin ordering

The plugins are loaded according to their sort order.

## Contents

• Installation

• Core Plugins

  • vimproc

• Global settings

  • TBD: vimbits

• General Plugins

  • vim-airline better looking statusline
  • greplace.vim
  • Gundo
  • nerdtree
  • nerdtree-git
  • nerdcommenter
  • vim-repeat Use the repeat command "." with supported plugins
  • vim-session Extended session management for Vim (:mksession on steroids)
  • vim-switch Simple Vim plugin to switch segments of text with predefined replacements.
  • Utl.vim url based hyperlinks for text files
  • xterm-color-table

• Completion

  • YouCompleteMe

• fuzzy search tools

  • unite.vim
    • TBD: other Unite plugins
    • unite outline
    • unite-colorscheme
  • CtrlP
  • FZF
  • File search
  • Buffer search
  • Quickfix search
  • The Silver Search ag searching integration
  • Line search
  • Tags search
  • Yank history search

• Plugins for Developers

  • editorconfig
  • vim-endwise
  • vim-fugitive
  • vim-merginal
  • vim-gitgutter git diff in the gutter (sign column) and stages/reverts hunks
  • vim-surround
  • syntastic syntax checking on save
  • tmux-navigator

• Development languages and syntax support

  • HTML Support

    • vim-emmet vim-emmet for highspeed HTML editing

  • Ruby Support

    • vim-bundler bundler integration

    • vim-rake rake integration

    • vim-textobj-rubyblock A custom text object for selecting ruby blocks (ar/ir)

    • vim-ruby-refactoring

    • blockle.vim toggle ruby blocks style

    • Ruby on Rails Support

      • vim-rails
      • vim-rspec lightweight Rspec runner for Vim
      • apidock.vim apidock.com docs integration
      • vim-i18n Rails i18n extraction plugin

  • Vimscript

  • Themes

### Installation

TBD

### "Core" Plugins:

• vimproc

  TBD

## Global settings

TBD

## "General" Plugins:

• vim-airline (top)

  Lean & mean status/tabline for vim that's light as air.

  A better replacement for vim-powerline. Optimized for speed; it loads in under a millisecond.

  Install fonts for best results.

• greplace.vim (top)

  Replace a pattern across multiple files interactively

  Use :Gsearch to search for a pattern. Edit the result buffer to your liking, then :Greplace to incorporate your edits into the source files

  • :Gsearch - Search for a given pattern in the specified group of files and display the matches in the replace buffer.
  • :Gbuffersearch - Search for a given pattern in all the buffers in the Vim buffer list.
  • :Greplace - Incorporate the modifications from the replace buffer into the corresponding files.

• Gundo (top)

  Homepage is here

  Graphs your vim undo tree in a side window.

  • ,u - toggle undo window
  • :h gundo.txt - more help

• nerdtree (top)

  vim script to give you a tree explorer

  • Ctrl-P - open directory browser (Note: this is now handled by nerdtree-tabs (see below))
  • ,p - to find and highlight the currently open file in the tree

• nerdtree-git-plugin (top)

  A plugin of NERDTree showing git status flags. Works with the LATEST version of NERDTree.

  You can configure custom status symbols:

  let g:NERDTreeIndicatorMapCustom = {
      \ "Modified"  : "✹",
      \ "Staged"    : "✚",
      \ "Untracked" : "✭",
      \ "Renamed"   : "➜",
      \ "Unmerged"  : "═",
      \ "Deleted"   : "✖",
      \ "Dirty"     : "✗",
      \ "Clean"     : "✔︎",
      \ "Unknown"   : "?"
      \ }
  

• nerdcommenter (top)

  Vim plugin for intensely orgasmic commenting

  • ,/ - toggle comment
  • ,cc - add commenting
  • ,cu - Uncomment
  • check docs for more

• vim-session (top)

  Extended session management for Vim (:mksession on steroids)

  • ,SS - :SaveSession
  • ,SO - :OpenSession

  When runnin in a graphical vim:

  • :RestartVim<CR> - This command saves your current editing session, restarts Vim and restores your editing session.

• vim-switch (top)

  Simple Vim plugin to switch segments of text with predefined replacements.

  It will switch "foo" to 'foo' to :foo. or {:foo => bar} to {foo: bar}, etc. See :h switch for more.

  • \`` - :Switch`

• utl.vim (top)

  Utl.vim brings the benefits of URL-based hyperlinking to plain text,

  :h utl for help.

  Bindings:

  • ,o - types :Utl . you still need to press enter to open url. This way it allows to type other commands if needed.

• xterm-color-table (top)

  :XtermColorTable to create a new buffer with xterm colors

  While in the xterm colors buffer:

  • t - toggle text visibility
  • f - set text color to the current color
  • # - yank current color

  :h xterm-color-table.txt for more help.

## Completion

• YouCompleteMe (top)

  A code-completion engine for Vim

  See documentation.

  Note: to get rid of the "missing .tern-project file" warning, create a global ~/.tern-project file. see :h .tern-sub-project.

## Fuzzy search tools

• unite.vim (top)

  Search and display information from arbitrary sources like files, buffers, recently used files or registers.

  This plugins is too powerful to present here, read the documentation.

  See unite-colorscheme for example command to use Unite to choose a colorscheme.

  • unite outline (top)

    Unite source to display outline of the current file.

    • ,O - :Unite outline - show file outline

  • unite-colorscheme (top)

    A unite.vim plugin. Privides source to choose color schemes.

    Try:

    :Unite -no-start-insert -auto-preview colorscheme

    Then try to navigate up and down and see what happens ;)

    Note: actually this command aliased as :THEME

• CtrlP (top)

  Fuzzy file, buffer, mru, tag, etc finder.

  This plugin has lots of options, see :h ctrlp for more.

• FZF (top)

• File search (top)

  • ,, - :Files - fuzzy find files using FZF

• Buffer search (top)

  • ,b - :Buffers - fuzzy search open buffers with FSF

• Quickfix search (top)

  • ,q - :CtrlPQuickfix - fuzzy find within quickfix buffer

• The Silver Searcher (top)

  The Silver Searcher (ag) is a code-searching tool similar to ack, but faster..

  The actual vim integration is provided by FZF

  • ,k - :Ag - open prompt for entering search term

• Line search (top)

  • ,l - :Lines - fuzzy search lines in all opened buffers using FZF

• Tags search (top)

  • ,, - :Tags - fuzzy find tag with FZF
  • \t - :Btags - fuzzy find bugger tag with FZF

• Yank history search (top)

  YankRing.vim Maintains a history of previous yanks, changes and deletes

  • ,y to show the yankring
  • ,[/,] - to cycle the just-pasted text though the yankring.
  • :h yankring.txt and :h yankring-tutorial for more

## Plugins for Developers:

• editorconfig-vim (top)

  .editorconfig file support.

• vim-endwise (top)

  Wisely add "end" in ruby, endfunction/endif/more in vim script, etc

• vim-fugitive (top)

  A Git wrapper so awesome, it should be illegal

  • :Gstatus

    Bring up the output of git-status in the preview window. Press - to stage or unstage the file on the cursor line. Press p to do so on a per hunk basis (--patch). Press C to invoke :Gcommit.

  • :Gcommit [args]

    A wrapper around git-commit.

  • :Ggrep [args]

    :grep with git-grep as 'grepprg'.

  • ,g

    shortcut to run :Ggrep

  • //

    global git search for the word under the cursor for for selection (in visual mode)

  • :Gblame

    Run git-blame on the file and open the results in a scroll bound vertical split. Press enter on a line to reblame the file as it was in that commit.

  Much more in the plugin's doc

• Merginal (top)

  • :Merginal - open branch list window

  • D - delete branch under cursor

  • C - checkout branch under cursor

  • M - merge branch under cursor

  • rb - rebase current branch against the branch under cursor

  • rn - rename branch agains the branch under cursor

  • :h merginal-branch-list to see more bindings.

  • :h merginal - to see the complete help

• Vim Git Gutter (top)

  A Vim plugin which shows a git diff in the 'gutter' (sign column). It shows whether each line has been added, modified, and where lines have been removed.

  

  In the screenshot above you can see:

  • Line 15 has been modified.
  • Lines 21-24 are new.
  • A line or lines were removed between lines 25 and 26.

  Commands:

  • :GitGutterDisable
  • :GitGutterEnable
  • :GitGutterToggle
  • :GitGutterSignsEnable
  • :GitGutterSignsDisable
  • :GitGutterSignsToggle
  • :GitGutterLineHighlightsEnable
  • :GitGutterLineHighlightsDisable
  • :GitGutterLineHighlightsToggle

  Bindings:

  • ]c - jump to next hunk
  • [c - jump to previous hunk
  • ,hs - stage hunk
  • ,hr - revert hunk

  There are quite some customization options. see help.

• vim-surround (top)

  Delete/change/add parentheses/quotes/XML-tags/much more with ease

  • dsX - delete surround X
  • csXY - change surround X with Y
  • s/S in visual mode - wrap selection
  • ysMovementX - surround movement with X

  You should REALLY read the docs if you want to use this one

• syntastic (top)

  syntax checking plugin

  it will display the number of syntax errors in the current file in the vim's status line.

  • use :Errors to display a window detailing the errors

• tmux-navigator (top)

  tmux + vim = love

  to change default mappings define:

  let g:tmux_navigator_no_mappings = 1
  

  The default mappings are:

  • Ctrl-h - :TmuxNavigateLeft<cr>
  • Ctrl-j - :TmuxNavigateDown<cr>
  • Ctrl-k - :TmuxNavigateUp<cr>
  • Ctrl-l - :TmuxNavigateRight<cr>
  • Ctrl-\ - :TmuxNavigatePrevious<cr>

## Development languages and syntax support ### HTML

• Emmet (top)

  emmet.io like html/css workflow plugin.

  • <Ctrl-y>, - expand emmet abbreviation. .e.g try it with div>p#foo$*3>a

  Note: it even works with HAML

### Ruby Support

• vim-bundler (top)

  Lightweight support for Ruby's Bundler

  • gf - when standing over a gem name in a Gemfile will go to gem's directory
  • :Bopen NAME - does bundle open NAME - opens gem NAME's lib diretory in the current window.
  • :Bundle - runs bundler

• vim-rake (top)

  TBD

• vim-textobj-rubyblock (top)

  A custom text object for selecting ruby blocks.

  In other words it teaches vim to understand what is ruby block, just like vim already understands what is word, paragraph, sentence etc.

  It works with begin/end, if/else/end etc.

  • var - select ruby block around the cursor including begin/end
  • vir - select insides of a ruby block around the cursor not including begin/end
  • dar - delete ruby block around the cursor
  • etc...

  Some 'trickier' usage patterns.

  • varar - select the ruby block that is around the ruby block that is around the cursor. including begin/end
  • vararir - select insides of the ruby block that is around the ruby block that is around the cursor. not including begin/end
  • ...

• vim-ruby-refactoring (top)

  Refactoring tool for Ruby in vim!

  • ,rap :RAddParameter - Add Parameter(s) to a method
  • ,rcpc :RConvertPostConditional - Convert Post Conditional
  • ,rel :RExtractLet - Extract to Let (Rspec)
  • ,rec :RExtractConstant - Extract Constant (visual selection)
  • ,relv :RExtractLocalVariable - Extract Local Variable (visual selection)
  • ,rit :RInlineTemp - Inline Temp. replace temp parameter by direct function call
  • ,rrlv :RRenameLocalVariable - Rename Local Variable (visual selection/variable under the cursor
  • ,rriv :RRenameInstanceVariable - Rename Instance Variable (visual selection)
  • ,rem :RExtractMethod - Extract Method (visual selection)

• blockle.vim (top)

  Toggle ruby blocks style, e.g {} to do .. end

  • ,B - toggle block style

  NOTE: there is an unfortunate interaction with delimitMate, the opening brase gets completed. i.e. you get {} ... }

#### Ruby on Rails Support

• vim-rails (top)

  Ruby on Rails: easy file navigation, enhanced syntax highlighting, and more

  • :AV - open "alternate" file in a new vertical split
  • :AS - open "alternate" file in a new horizontal split
  • :RV - open "related" file in a new vertical split
  • :RS - open "related" file in a new horizontal split
  • :Rextract - extract partial (select text for extraction first)
  • :Rinvert - takes a self.up migration and writes a self.down.
  • gf - remapped to take context into account. recognizes models associations, partials etc.
  • :h rails for much more info ;)

• apidock.vim (top)

  Vim plugin that searches http://apidock.com Ruby, Rails, and RSpec docs from within Vim.

  • RR - Search the Rails docs for the word under the cursor.
  • RB - Search the Ruby docs for the word under the cursor.
  • RS - Search the RSpec docs for the word under the cursor.

• vim-rspec (top)

  Lightweight Rspec runner for Vim.

  Commands are self explanatory:

  • :call RunCurrentSpecFile()
  • :call RunNearestSpec()
  • :call RunLastSpec()

  Bindings:

  • ,r - RunNearestSpec

• vim-i18n (top)

  Extracts i18n strings from source files into .yml file.

  • ,z - extract selected string

• [vimscript] (top)

  • ,x - to execute the current line of vimscript

• Themes (top)

  The following colorschemes are available:

  • solarized
  • tomorrow
  • vividchalk
  • TBD