Permalink
Fetching contributors…
Cannot retrieve contributors at this time
138 lines (95 sloc) 7.13 KB

A self-contained, cross-platform, nice VIM setup

During the course of several months, I have been using the mighty VIM editor for work, leisure and everything in between (mostly stuff related to programming). I collected a lot of tips and tricks, customized my setup and used a lot of plugins which I find generally very useful for all programmers out there. So I tried my best to organize my setup and make it as self-contained and easily-reproducible as possible...

Also, I work with both Linux and Windows computers - and I struggled to make my beloved VIM setup work on both platforms providing an essentially unified experience. After much googling and some head-banging I could achieve portability, and this VIM setup should work in your machine by just following the simple installation instructions ☺

Installation steps

First step - Clone

  • Clone this repository to a directory of your preference. Let's call it $REPO from now on:
REPO="~/modvim"; git clone http://github.com/joaopizani/env.modular-xplatform-vim-cfg.git "$REPO"

Second step - Link (OS-Specific)

  • Linux, BSD, Mac OS X: Create a link called _vimrc in your home directory pointing to the repository:
ln -s "${REPO}"/_vimrc  "${HOME}"/_vimrc
  • Windows: Go into ${REPO}/win and execute (double-click) the file named install-vimrc-link.bat

Optional but recommended: enabling recommended plugins

  1. Go into $REPO and run git submodule update --init --recursive. Congratz! You just enabled NeoBundle (a very nice® Vim plugin manager for Vim).

  2. Obtain the latest version of the plugins by running vim +NeoBundleInstall +qall

  3. DONE. COMPLETELY DONE. Whenever you want to update the plugins, you can do it inside Vim by running the command :NeoBundleCheckUpdate

Some basic usage instructions

VERY FREQUENTLY used key mappings

The file ${REPO}/config/recommended/simple-cfgs/06-mappings.vim contains some convenient key mappings for frequent tasks when developing using Vim (at least I find them convenient). You can of course edit the file to your liking, but the default mappings are:

  • F3: Maximizes/unmaximizes the current window.
  • F4: Opens/focuses and closes (when inside) the NERDTree navigation sidebar.
  • F5: Opens/closes the Tagbar navigation sidebar, gives an "outline" of the current file.
  • F6: Toggles the Quickfix window, i.e, opens it if it's closed and closes it if already open.
  • F7: Goes to the next Quickfix error (:cn).
  • F8: Saves changes to current buffer (:w).
  • F9: Filetype-specific build action without annoying "press Enter" prompts.
    • By default, is assigned to make, but can change (for example, for LaTeX it becomes Latexmk).

Obs 1: All aforementioned mappings also work in insert mode.

Obs 2: The <Leader> key has been mapped to the space bar

  • Ctrl+p: Opens a prompt for easy most-recently-used and intelligent (fuzzy) file and buffer search

  • <Leader>pp: Toggles PASTE mode. PASTE mode is useful for when you want to paste formatted text into vim (for example, from the web), and don't want vim to mess with it by trying to autoindent or autoformat it.

  • <Leader>sh: Toggles search highlighting. After doing a search, it can be useful to have all the results highlighted, but if you want to toggle this setting, use this short mapping :)

  • <Leader>nn: Toggles line numbers in the current buffer

  • <Leader>hh: Toggles soft/hard line wrapping, with soft being the default.

  • <Leader>rt: Removes trailing whitespace from the whole current buffer.

Moving between split windows, resizing and maximizing/restoring them

When using Vim for programming, you often end up using a lot of open buffers, shown in split windows spread across your screen. Thus, we added easy mappings to facilitate moving between and resizing split windows:

Important: These bindings will only work in normal mode.

  • Ctrl+{j,k,h,l}: Goes, respectively, to the window above, below, to the left and to the right of the current one.

  • Alt+{ArrowUp,ArrowDown,ArrowLeft,ArrowRight}: By pressing Alt in combination with the arrow keys, you are able to resize the current window. The Up and Down arrows will, respectively, increase and decrease the window height; while Right and Left will increase and decrease width. This can be non-intuitive, however: When you are in the topmost window and press Alt+Up, the window will go down (increase height), and if you are in the rightmost window and press Alt+Right, the window will go left (increase width).

  • F3: By pressing this, you will maximize the current split window to occupy the whole screen. By pressing the same shortcut again, the previous (pre-maximization) layout is completely restored.

Miscellaneous nice stuff going on under the covers

Some nice settings and plugins are in place which make (at least I think) any programmer's life easier while using Vim, and require no intervention from the user (they just work® by default). A random selection of such niceties follows:

  • Segregated Vim metafiles: Vim has the bad habit of polluting the working directory with backup files (myfile~), swap files (.myfile.swp), undo files, etc. My configuration segregates all these files into central directories: ${REPO}/runtime/aux/{backup,swap,undo,views}.

  • Easy and organized plugin management: Our setup uses NeoBundle, the Mother of All Plugins for Vim. NeoBundle is like a package manager for Vim plugins. You have lists of plugins you wish to use under ${REPO}/config/recommended/plugin-lists/*.vim; you can install or update plugins by using the command :NeoBundleUpdate and uninstall by using :NeoBundleClean. All plugin installations are kept under a single directory, with one plugin per subdirectory.

  • Code snippets: Includes the awesome neosnippet plugin, which allows you to insert short snippets of code by using "trigger" keywords and the <Ctrl-y> key. It's too awesome too describe with words: go see the screencast.

  • Parallel builds: Combines GNU Make "parallel build" feature with Vim's internal "make" command. As described in this blog post.

  • Easy-on-the-eyes, 256-colors color scheme: Whenever the terminal in which you are running Vim allows, we use a very comfortable 256-colors color scheme, namely, Zenburn.

  • Tagbar for outline-like code navigation: If you have ever used the "outline" feature of IDEs, you will feel at home with Tagbar. You can show a sidebar with an outline of your file (functions, classes, etc.) by pressing F5. Clicking (or pressing Enter) over a tag will take you to that part of the code).