Skip to content
Find file History

README.md

My Vim Configuration

Version 1.7 (2016-05-18)

The purpose of this document is to compile all the customizations available in my vim configuration, to help me reorganize them properly, and as a sort of cheat sheet when memory fails. Obviously it is not my intent to replicate the vim help or the plugins documentation, only to highlight those options that I found useful and might need to remember at a given moment. At the same time, this doc can serve as a sort of instruction manual to those who decide to clone this configuration.

Due to the "dynamic" nature of my configuration, this document is under a lot of stress. It changes frequently and it's better if you watch the DVCS commits to stay in the loop. Also, some images may be outdated with respect to the current configuration (also in GitHub the images are cached and maybe do not correspond with the current version of the image).

To all this we must add everything that Vim provides by default, which is no small service.

I have mapped the <Leader> key to , and the <LocalLeader> key to (spacebar)

DISCLAIMER & ACKNOWLEDGMENTS

Obviously, a prior knowledge of Vim is needed to take full advantage of this
configuration, the same way it will be necessary to look at certain
plugins' documentation to become familiar with them beyond the guidelines
that I put in this document.

This configuration is based on many others. So many that I don't remember
them all, and it would be quite unfair to mention a few and omit others. But
because many generously share their settings, I have been able to arrive at
mine and I hope that this document will also serve as a small compensation
for such great help that they provided to me. And thanks also to all those
developers who created the plugins included in this config (now and in the
past), because without their wonderful contribution and generosity to share it
with the rest of the world, this configuration would not be possible.

Unite

Unite is an interface that unifies various "query results" under a common aspect and that follows Vim's default behavior (modal). It's almost an API that we can use to build our own solutions. In fact, the author describes it as "unite and create interfaces". With Unite you can open a file, change the buffer, choose a colorscheme, make a regex search (grep, Ack, Ag, ...), etc. Even you can take a look at the Vim registers, messages, help, command, functions, ... In short, it is a Swiss army knife that, well used, allows us to replace several different plugins with only one (in this case: CtrlP, Ack, YankRing, TagmaTasks and Tagbar).

One of the main advantages of Unite is that it allows me to address one of the problems that I initially tried to resolve with this document, which is to remember all the options and mappings that, with so much effort and time, I added to my Vim configuration. It's pretty normal that we have a plugin installed and customized but do not use it frequently. Then when we need it, we don't remember a thing about it. Not the mappings, nor the commands, nor even its name. Well, with Unite it is easy to create a menu for the plugin where we show the options it has and its mappings, and, thanks again to the magic of Unite, we don't even need to remember the mapping of this menu, we can look for it in the Unite menu for menus. Problem solved quickly and gracefully.

The mayor drawback of Unite and also one of its greatest advantages is that it comes hardly configured, leaving to our own judgement and responsibility the way we set it to work to our liking. In fact, we can make our own Unite plugins to make new Unite sources and scratch your itches.

Sources and Menus

I set Unite following two different ways. On one hand I use it to access Unite sources via mappings with the <Leader> key, and secondly calling Unite menus through <LocalLeader> key mappings.

  • The sources that I call from a <Leader> mapping are used to access the most common tasks, like open files, search inside the buffer, do regex searchs (grep), etc. Here is an example of how to open a file in this way:

    unite_file

  • The menus are used to group options either by plugins or by functionality. Also shows the mappings for all of those options that have one, this allows me to avoid looking for them in the ~/.vimrc file when I forget one. The next image shows a Unite menu for managing a git repository:

    unite_git

    • Commands using a third plugin, Unite is able to help in the auto-completion and look for commands in the command line. We only have to proceed as always, using : the first letters of the command and instead of use <Tab> to auto-complete the command, use <C-O> to use a Unite menu where we can select the right command using the Unite auto-completion (with fuzzy-logic)

    unite_cmdmatch

Unite has a master menu that shows all the custom menus that we have created, allowing us to access them and see the mapping associated with each one. This menu doesn't show the mappings by design, but I arranged their descriptions to allow that. This is what the Vim command :menu should have been: comfortable, intuitive and easy to navigate.

  • <LocalLeader>u or :Unite menu shows the available menus

unite menu

Navigation inside Unite

These are some of the available mappings:

Mappings

Normal mode:

  • q exit from Unite and submenus
  • Q exit from Unite and all submenus
  • i change to insert mode
  • v change to visual mode
  • <Tab> choose an action
  • a choose an action for the selected candidate or add text at the end of the prompt
  • <C-R> reset the menu
  • <Space> mark the current candidate
  • * mark all candidates
  • M removes the candidate number limit
  • gg, G, j, k typical Vim moves to move around candidates
  • ? shows help (mappings)
  • N add a new candidate (only where have sense)
  • . show hidden files (dotfiles)

    With a candidate selected:

    • <CR> execute the default action
    • b add it to bookmarks
    • d delete it
    • e expand the path
    • t open the candidate in a new tab
    • yy do a yank
    • p preview it
    • x launch the quick selection

Insert mode:

  • <ESC> change to normal mode
  • <Tab> choose an action
  • <CR> execute the default action
  • <C-G> exit Unite
  • <C-D> delete it
  • <C-E> expand the path
  • <C-T> open the candidate in a new tab
  • <C-Y> do a yank
  • <C-N>, <C-P>, <C-F> y <C-B> Vim motions to move around candidates

    With a candidate selected:

    • <Space> mark the current candidate

Visual mode:

  • <Space> mark the current candidate

Managing Plugins

dein

A plugin to rule them all! Dein allows us to manage the rest of the plugins, works with Neovim and it's faster and simpler than its predecessor NeoBundle. I have it configured to auto install itself and all of the plugins when Vim is executed for the first time.

The advantages of Dein versus Vundle and other similar plugins are the following:

  • Allows revision lock or even set a plugin to not be updated
  • Allows rollback to a previous version of a plugin
  • Supports lazy initialization of plugins to optimizing startup time
  • Supports multiple config options per plugin, like automatic building if needed
  • Allows -not yet implemented- to use another VCS other than git (hg, svn), even a local dir
  • and so on...

The easier way to use Dein is through Unite:

Unite

  • <LocalLeader>d or :Unite menu:dein, shows the Dein menu

Menu

These are the menu entries in detail:

  • list lists all the installed plugins

  • update updates all the plugins automatically (and installs those not already installed)

  • install installs all the plugins

  • rollback rollback a plugin version to the previous updated version. If a plugin is not specified, rollback of all them. It's a fantastic functionality, useful e.g. when a new version introduces a bug.

  • reinstall reinstalls all the plugins. This can be useful to revert a rollbacked plugin to the current version.

Even when using the Unite menu is the most straightforward way to use Dein, if you need to perform an specific operation on a specific plugin, it's better to you to use the Dein functions like :call dein#direct_install('Shougo/unite.vim')

Colorschemes

unite_colorscheme

To choose a colorscheme we can do it easily and comfortably with an included preview through a Unite menu:

Unite

  • <LocalLeader>v or :Unite menu:vim shows the vim menu where we can access to an option to choose the colorscheme
  • :Unite colorscheme -auto-preview choose the colorscheme from the candidates

Navigation

unite navigation

Mappings

In addition to the options available on the menui, I have set a number of mappings that make it much easier to manage windows

  • <C-H> move to the next window to the left
  • <C-J> move to the lower window
  • <C-K> move to the upper window
  • <C-L> move to the next window to the right

Unite

<LocalLeader>b or :Unite menu:navigation shows the navigation menu

Menu

  • The first three menu entries let us to easily move to the chosen buffer, tab, or window from the candidates

  • location list and quickfix to access these windows content through Unite interface

  • resize windows use the winresizer plugin to easily resize the windows

    Mappings

    • h, j, k, l use vim motions to move the windows separator
    • <ESC> end the resizing
    • q cancel the resizing
  • the next two entries are for creating new windows (horizontal and vertical) and the third one is to close any window (except the last)

  • toggle quickfix window toggle the quickfix window, also close the location list if is opened

  • zoom make zoom in a window

  • delete buffer delete a buffer

Bookmarks

unite bookmarks

With this menu we can manage the bookmarks easily.

Unite

<LocalLeader>m or :Unite menu:bookmarks shows the bookmarks menu

Text Edition

unite text

This menu groups several options to edit text

Unite

<LocalLeader>e or :Unite menu:text shows the text menu

Menu

  • toggle search results highlight toggle the search results highlight, obviously

  • toggle line numbers toggle between the four possible visualizations of the line numbers column: none, relative (two forms), and absolute

  • toggle wrapping toggle automatic wrapping and the vertical column color. The vertical column that indicates wrapping threshold turns green when the automatic wrapping is disabled

  • toggle auto-complete word auto-selection enable/disable the auto selection of the optimal word from the auto-completion pop-up dialog. This option is disabled by default to allow a fast writing/edition without obstacles. This is optimal for very situations, but can be enabled again with this entry.

  • show hidden chars show the hidden chars, those that are not printable (tabs, carriage returns, spaces, ...)

  • the next three entries are to fold/unfold the folds in our doc, one by one or all at the same time

  • and the three after those allows us to copy/paste from system clipboard and for toggle the paste mode.

  • remove trailing whitespaces delete those empty and almost never significant spaces at the end of the line

  • text statistics show the number of columns, lines, words, chars and bytes in total and for the current position

  • show word frequency show the number of times that each word appears in the text

  • show available digraphs show a table with all the digraphs available and the pair of chars needed to generate each of them.

  • insert lorem ipsum text insert a text block containing the famous Lorem Ipsum text

  • show current char info show extended info about the current character. The info includes the decimal Unicode value, hexadecimal, octal, Unicode name, HTML entity, Emoji code and any digraph available.

Other tools

Apart from the tools included in the menu, and apart from the Vanilla Vim ones too, we have another bunch of tools available to help us to edit the text more easily.

  • text-objects these are customized text objects that allow us to extend the Vim motions defined by default (word, sentence, paragraph, block, delimiters, and markup tags) and be able to use more efficient text selections. In this config I added the following ones:

    • line select a line by al or il
    • underscore select the text surrounded by underscores via a_ or i_
    • all the buffer select the entire buffer. We can use ae and ie
    • indent select a indentation level. Options: ai, ii, aI, iI. i select the current level and the nested ones, I only selects the current indent level
    • last search select the last search term results. Options:: a/, i/, a? and i?
    • python class in a Python code file, selects a class by aC, iC and C
    • python method or function same as above for methods and functions via aM, iM and M
  • vim-commentary an extremely easy tool to toggle commentary in lines and visual selections. We only need to enter a mapping and a movement to do the action, as simple as that.

    commentary

    Mapping

    • <Leader>c or gc toggle the commentary
  • vim-surround surround a vim text object with a pair of symmetrical chars. We can also remove or change the ones already there

    surround

    Mappings

    • ys{motion or text-object}{char} create surround ('your surround')
    • cs{orig_char}{dest_char} change surround
    • ds{char} delete surround
    • S{char} for create surrounds in visual mode

    If we choose the first member of a pair, e.g '(', then the surround is created with a whitespace between the char and the selection. If the last is choosen, e.g. ')', then the extra space is not added.

  • vim-speeddating provides a smart way to increase/decrease time values

    speeddating

    Mappings

    • <C-A> Increase the time value under the cursor
    • <C-X> Decrease the time value under the cursor
    • d<C-A> Change the time under the cursor to the current UTC time
    • d<C-X> Change the time under the cursor to the current Local time
  • delimitMate provides smart auto-completion for delimiters like (), {}, [], "", '', ``

    This is very easy to use. If we write the first pair of these chars, then the second one is automatically introduced and the cursor moves to the interior thereof. Then, we continue writing and to exit the inside you only have to write the second character or press <S-Tab>. If you only want the first char, you only have to press the Delete key

    smartinput

  • neocomplete auto-completion of keywords, methods, functions, etc by only typing a few letters (normally the first). Well used, this speeds up a lot writing of code or text. It improves the Vanilla Vim auto-completion, with a live fuzzy-logic search. It's powerful and totally customizable.

    neocomp

    Mappings

    • <Leader>ea conmute the auto-completion state
      • The possible 3 states are: candidate manual-selected → disabled → candidate auto-selected
    • <C-N> go to the first/next word (below) in the option list
    • <C-P> go to the last/previous word (above) in the option list

    Auto-selection active

    • <CR> insert the selected word
  • easydigraph easily insert digraphs, especially when trying to insert several simultaneously

    easydigraph

    Mapping

    • <Leader>dd {motion} turns in digraph the motion selected text
  • vim-transpose transpose rows & columns. For certain kind of files, like CSV, it can be really helpful to deal with them. It works in visual mode.

    transpose

    Commands

    • :Transpose do the transposition by default
    • :TransposeCSV {separator} {delimiter} do the transposition by ; or by the specified separator & delimiter
    • :TransposeTab transpose by tabs
    • :TransposeWords transpose by words (inserts a ? where is no one)
    • :TransposeInteractive for complex transpositions

Spell checking

unite spell

These menu entries are used for spell checking the text

Unite

  • <LocalLeader>s or :Unite menu:spelling shows the spelling menu

Regular expression searching (grep)

unite grep

This menu allows us to search files by regular expression engines. I have it configured to use the ag program first, then ack if ag is not found, and else the grep program. We can also use other Unix tools like locate and find from this menu.

Unite

  • <LocalLeader>a or :Unite menu:grep shows the grep menu

Menu

  • grep (ag → ack → grep) search files by content. Using a regular expression pattern in a target directory, shows us the results in Unite. Between brackets are the list of programs to use sorted by priority. It uses the first available.

  • find use the known Unix tool find to search files by name

  • locate same as above using the locate tool instead

  • vimgrep as a last resort, in case you don't have any regex search tool installed, you can use the internal Vim grep one. But it is extremely low in comparison with another of the mentioned in the first entry. So, use it only if you are desperate.

Searching inside the buffer

unite searching

Unite

  • <LocalLeader>f or :Unite menu:searching shows the searching menu

Menu

  • line find all the lines where the introduced string appears

  • word under the cursor find all the lines where the word under the cursor appears. It is a improved version of the * key behavior

  • outlines & tags (ctags) list all the document "outlines" and allow us to navigate between them. Very useful to move around the headers of a Markdown document like this. In code files it shows the source tags (ctags) to move easily to a given point of the code.

  • marks list all the marks

  • folds navigate among folders

  • changes list all the changes made to the file

  • jumps list all the last window jumps

  • undos show the file undo history

  • tasks show all the pending tasks for the current buffer. These tasks (and notes) are defined by the following keywords: TODO, FIXME, NOTE, XXX , COMBAK, and @todo

Other tools

  • vim-signature a plugin that improves the default Vim marks. It shows the marks in the lateral signs column.

    signature

    Mappings

    • Alphabetic marks

      • m[a-zA-Z] toggle the mark and display it in the signs column (gutter)
      • m, place the next available mark
      • m<Space> delete all marks
      • ]` jump the next mark
      • [` jmmp the previous mark
      • ]' jump to start of next line containing a mark
      • [' jump to start of previous line containing a mark
    • Symbol marks (markers)

      • m[0-9] toggle the corresponding marker !@#$%^&*()
      • m<S-[0-9]> remove all markers of the same type
      • ]- jump to next line having same marker
      • [- jump to prev line having same marker
      • m<BS> remove all markers

Registers

unite registers

Unite

  • <LocalLeader>i or :Unite menu:registers shows the registers menu

Menu

  • yanks list all the yanks arranged chronologically starting with the most recent

  • commands show the Ex command history

  • searches list the last searches

  • registers show the vim registers content

  • messages show the messages register (like the :messages command)

  • undo launch the Gundo plugin. Gundo makes the Vim undo tree friendlier. We can preview the changes and navigate easily around the tree.

    gundo

Files and directories

unite files

Unite

  • <LocalLeader>o or :Unite menu:archivos show the file menu

Menu

  • open file show a list of files available in the current working directory

  • open more recently used files show the last opened files

  • open file with recursive search same as above but including the files under the subdirectories recursively

  • the next three entries are similar to the preceding ones but working with directories instead of files

  • make new directory make a new directory without opening a file browser

  • change working directory allow us to change the current working directory

  • know current working directory is like running the :pwd command

  • junk files to open a new (or a previous one) junk file to make annotations, tests, ...

  • save as root allow us to save a file that only have permissions for root without need to run Vim under that user (or use $ sudo) and lost our configuration advantages by doing that.

  • quick save save quickly the file without need to run the :w command

  • open ranger call the external ncurses file manager Ranger to browse the directory hierarchy and choose the file that you want to edit.

    ranger

  • open vimfiler open the file explorer Vimfiler, Unite based and very powerful. I used mainly in those computers where ranger is not available. It has a safe mode (enabled by default) in which you cannot copy, rename, move, create or delete files and directories.

    vimfiler

    Mappings

    • <Tab> open a new vertical window, if is already opened toggle between them
    • j, k and gg typical vim motions to move between the files
    • h, l move between the parent and child directories
    • <Space> select/deselect the current line
    • * select/deselect all the lines
    • & select similar lines
    • U deselect everything
    • S change the sort type (by name, date, size, ...)
    • c copy the file (preceded by C do it to the clipboard)
    • m move the file(preceded by C do it to the clipboard)
    • d delete the file
    • r rename the file
    • Cp paste file from clipboard
    • K new directory
    • N new file
    • x run the file's system associated program
    • e edit the file
    • E edit the file in a new window
    • v preview the file
    • L change the drive unit
    • ~ go to the home directory
    • \ go to the root directory
    • <C-J> open the visited directories history (opened by )
    • <CR> open a directory
    • <BS> return to the parent directory
    • t expand the directory tree
    • T expand the directory tree recursively
    • I change to the directory entered in the command line > - M set the current mask (to filter files) > - . show/hide the hidden files (dotfiles) > - q hide vimfiler > - Q exit vimfiler > - H exit to the shell (exit from shell to return to vimfiler) > - - close the current vimfiler window > - ? show the vimfiler help (mappings) > - o sync another vimfiler with this one > - O open a file/directory in another vimfiler > - yy yank the full path > - gr make grep into the current directory > - gf make find into the current directory > - gc make the current directory in the Vim working directory > - a choose the action to apply to the file > - Y save the current path in a temporal list > - P show the paths saved in the temporal list > - <C-L> redraw the screen > - gs toggle the safe mode Warning! > - gS toggle the simple mode

Other tools

  • utl is a plugin to open URLs and files with an external tool from Vim

    utl

    Mapping

    <Leader>j if we use the mapping over a link, it will be opened into the preconfigured application

Code Edition

unite code

Menu

  • run python code run the current buffer python code via pymode. It shows the output in a new vertical window below

  • show docs for the current word show the documentation available for the word under the cursor

  • insert a breakpoint insert a breakpoint in python code. If we have ipython or pudb installed, it will use one of those instead the python pdb

  • pylint check do a code revision by pylint by demand

  • run with python2 in tmux panel use the Vimux plugin to interact with Tmux. It allows to send commands to a Tmux panel and interact with it without losing focus in Vim. If there are no other tmux panels opened, then a new panel is opened in the 20% lower space. In other case, the command runs in the already opened panel. This specific command run the buffer content with the python2 executable in the tmux panel. In the next image we can see the actual behavior:

    vimux

  • run with python3 in tmux panel same as above but using the python3 interpreter

  • run with python2 & time in tmux panel run the python code wrapped by the Unix time program to know the time consumed in the execution

  • run with pypy & time in tmux panel same as above but using pypy instead of python2

  • command prompt to run in tmux panel open a command line prompt to enter a custom command to run in a tmux panel

  • repeat last command repeat the last vimux command

  • stop command execution in tmux panel stop the execution of the last vimux command

  • inspect tmux panel jump to the tmux panel where the last vimux command was executed and enter in the tmux copy mode allowing us to scroll around the panel and use the vi mode to copy text lines

  • close tmux panel close the tmux panel opened or used by Vimux

  • sort imports sort the imports in the file in a smart way

  • go to definition jump to the location where the word under the cursor (variable, function, class, method, ...) is defined. Open a new window with the location, even if it is in another module or library

  • find where a function is used open a quickfix window with all the locatons where the function under the cursor is used

  • show docs for current word use rope to show the available documentation about the word under the cursor. The advantage of this entry against the pymode one is that this one allow us to search in the external libraries documentation

  • reorganize imports reorganize automatically the import statements, similar to sort imports but using Rope instead of Isort

  • refactorize - x the entries that begin in this way are for refactorize the python code with rope, using the method mentioned in each description

  • syntastic toggle, syntastic check & errors are two options of Syntastic, a plugin for code quality (syntax revision) for various programming and markup languages (python, ruby, lua, haskell, css, html, js, json, ...) via external tools (these tools are required). Show the syntax errors in the signs column (gutter). Also shows the total of errors and the number line of the first in the status line

  • list virtualenvs use the virtualenv plugin to list the python virtualenvs.

  • activate virtualenv activate the virtualenv

  • deactivate virtualenv deactivate the virtualenv

  • run coverage2 and run coverage3 use the coverage.py tool for python2 and python3 respectively. It shows us the results in a window and as marks in the signs column (gutter) to know the code coverage of the current code.

  • toggle coverage report and toggle coverage marks toggle the visibility of the marks and report from coverage

  • coffewatch live preview compiling of coffescript files to javascript

  • count lines of code count the lines of code of the current file by the external program $ cloc and shows the output in Unite

  • toggle indent lines show/hide the indent lines, that works as a visual guide for long nested blocks of code, putting vertical lines for each indentation level. Is disabled by default.

    indentLine

Other tools

  • Ultisnips is a plugin to manage snippets, the most advanced and powerful for this task that I know for Vim. Snippets are portions of code or text in which certain parts are declared as variable and the rest is fixed. They are very helpful to insert the same code structures again and again without need to write all the text, saving us an important number of keystrokes. To use them we only have to type the snippet keyword and the mapping, the fixed part of text is inserted automatically. Then the cursor moves to the first variable field to enter the desired text interactively, and so on. In the image you can see how it really works.

    Ultisnips brings by default a bunch of snippets (now are separated from the plugin, needing a separate plugin) classified for languages and some globals. The best feature of Ultisnips is that allows us to define our custom snippets with a level of control and automation than any other one offers. To know all the details is essential to read carefully the plugin help. BTW certain features are remarkable, like: nested snippets, embed external commands (shell, vimscript and python) in the snippets, use the snippets over visual selections, and text transformations into the snippets.

    I save my custom snippets in the ./Ultisnips directory

    ulti

    Mappings

    • <Tab> preceded by the snippet keyword, trigger the snippet
    • <C-J> jump to the next field
    • <C-K> jump to the previous field
    • <BS> cancel the text enter in an optional field

DVCS: Git

unite git

Unite

  • <localleader>g or :Unite menu:git show the git menu

Menu

  • tig open the external application tig, which is a ncurses interface for git. Obviously, this only works when the working directory is into a git repository.

    tig

  • git viewer and git viewer - buffer use the gitv plugin that is a clone of the gitk tool for Vim, which is the viewer provided originally by git. This plugin allows us to view the repository history, to do diffs, checkouts, merges, ... It works atop of Fugitive and requires of it for work, and both have a similar behavior. The first entry will open a viewer relative to the whole repository (explorer mode), while the second one will do it in function of the current buffer or a visual selection (file mode)

    gitv

    Mappings

    • <CR> open a commit, a diff, a tree, a file, more commits, etc, depending of where is used, with a similar behavior that Fugitive

    • o open the commit in a new horizontal window

    • O open the commit in a new tab

    • s open the commit in a new vertical window

    • i in "explorer mode" open the file & in "file mode" open the commit details

    • q exit from gitv

    • a toggle the -all argument and update the window

    • u update the window content

    • co do a git checkout. In "explorer mode" dot it over the whole repository and in the "file mode" do it over the current file

    • D do a diff via vimdiff.

    • S show a diffstat

    • m and <Leader>m do a merge in visual and normal modes respectively

    • git enter the :Git command in the command line to enter a custom git command. If the command changes the repository status, the changes will be updated in gitv

    • yc yank the commit short hash, sha

    Motions

    • x and X to move around the branch points (where a merge is created)

    • r and R to move around the references

    • P jump to the commit tagged as HEAD

  • Almost of the rest of the entries are typical git commands which are executed via the Fugitive tool. Fugitive is a git wrapper, so good that allows us to manage git repositories without leave Vim. It's so complete and powerful that requires a certain amount of time to get used to it and get total control over its particular interface. The author, Tim Pope, says that about it: "A Git wrapper so awesome, it should be illegal" and is almost true.

    fugitive

    • status show the repository status and from this window we can access to multiple options. In this window this mappings are available:

      Mappings

      • <C-N> and <C-P> allow us to move between files

      • <CR> run the :Gedit command that allow us to "edit" a revision

      • - using it over a file that is not included in the 'stage area' (index) it add it, is like run a git add or git stage in the shell. Using it over a file included in the stage area, remove it from there, like using a git reset

      • cc or C do a commit with the command :Gcommit the same as doing a git commit

      • ca do a commit which add the new changes to the previous commit, useful when we forgot add something in a commit. Same as git commit --amend

      • D make a diff between the current version and the index one, using vimfiler via the :Gdiff command

      • ds do a diff with :Gsdiff, same as above but split windows horizontally

      • dv do a diff without :Gvdiff, with vertical split windows. A synonym of D

      • dp has a dual behavior. On the one hand, if there are changes but those are not in the stage area (index), then show a diff with the changes, like running the git diff command. Then, if we make a :Gwrite (<Leader>gw) the changes are added to the index and we can submit a commit now. On the other hand, if there are files that are not being tracked, try to add them using the git add --intent-to-add . command

      • p to submit partial commits, where we choose interactively which changes portions are included in the index and which not. If we use it over a file that is not in the index, we will we asked about what parts we want to index, like running git add --patch. If we use it with an already indexed file, we'll choose what parts remove from the index, same as git reset --patch

      • o open the file in a new horizontal window

      • O open the file in a new tab

      • S open the file in a new vertical window

      • R update the status window

      • q close the status window

    • diff make a diff (:Gdiff) between the current version of the file versus the one in the index. In conflict situations like in a merge, it will we a three-way diff, which makes it a good tool for dealing with merge and rebase. The mapping available for this window are the following (to know how vimdiff works, look up the help):

      Mappings

      • do do a :diffget, get the changes from the other file
      • dp do a :diffput, put the changes to the other file
      • <Leader>du do a :diffupdate, update changes
      • <Leader>dq exit from diffmode
      • u undoes all changes
      • [c and ]c to move between diffs
      • :Gwrite or <Leader>gw write the changes to the index
    • commit use the :Gcommit command (same as git commit). If there is nothing in the index, then do a :Gstatus and show the status window. Warning: Unlike when running the actual git-commit command, it is possible (but unadvisable) to muck with the index with commands like git-add and git-reset while a commit message is pending

    • log show all the previous revisions of the current file in a Unite window, starting for the most recent and open the last in the current buffer. To return to the current file, use :Gedit (<Leader>ge). Within the buffer we can move between revision using the commands :cnext, :cprevious, :cfirst and :clast

    • log - all similar as the previous one, but in this case all the repository commits are showed, and what appears in the buffer is something similar to the git show command output

    • blame use the :Gblame command that opens a new vertical widow at the left of the current buffer, where is displayed the commit, the author and date for each line of the file. Similar to run git blame.

      Mappings

      • A resize the blame window to end of author column
      • C resize the blame window to end of commit column
      • D resize the blame window to end of date column
      • q close the blame window
      • gq close the blame window and runs :Gedit to restore the current version
      • <CR> close the blame window and open the selected commit
      • o open the selected commit in a new horizontal window
      • O open the selected commit in a new tab
      • - runs a new blame in the selected commit
    • add/stage use the :Gwrite command that save the actual file and adds it to the index with the changes made. Is like doing a git add or its synonym git stage

    • checkout do a :Gread, empty the current buffer and restore the index copy or what is the same, like if we were making a git checkout to the file. The changes are not permanent until we save the file.

    • rm remove the file with the :Gremove command and empty the buffer. We get the same as if we do a git rm in the shell

    • mv as for a new path and move the file there, renaming automatically the buffer. The similar git command would be git mv. The target is relative to the current path, unless is preceded by / in which case is relative to the repository root

    • push execute the :Git! push command, showing the output in the buffer

    • pull do a :Git! pull redirecting the output to the buffer

    • command run the git command that we entered in the command line and show the result in a new buffer (exit from there by pressing q). We can use the current custom alias in our git config. This option by itself is reason enough to use Fugitive.

    • edit allow us to "edit" any git object (blobs, trees, commits, tags). It supports auto-completion and we can use a SHA, a branch, a tag, a tree or a commit.

    • grep do a grep over the repository using :Ggrep which in turn use git grep

    • grep (messages) make a grep over the repository using :Glog --grep= to search into the commit messages

    • grep (text) make a grep over the repository using :Glog -S to search into the commits where the text had been added or removed

    • init create a new git repository or reset a previous one (safe)

    • cd change the working directory to the repository one

    • lcd change the current buffer's working directory to the repository one

    • browse if the remote repository is at GitHub open it in a browser, showing the git object that we have selected in that moment. Otherwise, use git instaweb to display the current selected blob, tree, commit or tag. If a range is given, it is appropriately appended to the URL as an anchor

    Fugitive is a very powerful plugin that you only can learn how to use it by using it. And is very advisable to read the help to get a global vision of it.

  • github dashboard and github activity are two options to browse events at GitHub. With the first one we can browse the GitHub Dashboard of a given user. The last one allow us to view the public activity of a given user or repository. There is a limit of 60 calls/hour on the GitHub API without authentication.

    gh dashboard

    Mappings

    • <Tab> & <S-Tab> to navigate back and forth through the links
    • <Enter> open a link in the browser
    • R refresh the window
    • q close the window
  • github issues & PR open the external ncurses application shipit that is an interface for GitHub issues and pull requests. The application is still in development but is an amazing way to manage GitHub issues without leaving Vim and the terminal. If you are inside a git repository that have a remote in GitHub, it will open the app for that repository.

    shipit

Other tools

  • vim-gitgutter show the changes that are made in the buffer versus the git repository index. It makes a git diff and shows the status (changed/added/deleted) of each line in the gutter (signs column).

DBMS/SQL

dbext

The DBext plugin provides support to interact with various DBMS. The Databases supported are: Sybase SQL Anywhere, Sybase UltraLite, Sybase ASE, SAP HANA, Oracle, Oracle RDB, SQL Server, MySQL, PostgreSQL, DB2, Firebird, Ingres, Interbase, SQLite and other databases supported by the Perl DBI drivers. The SQLite DB is supported directly.

Is a very useful plugin, but I recommend to read the tutorial first (:h dbext-tutorial vimhelp:dbext-tutorial) to get an idea of how it works.

unite db

Unite

  • <localleader>S or :Unite menu:db show the git menu

Menu

  • Execute SQL allows us to write a SQL statement and execute it in the current database.

  • Execute SQL (with limit of n rows) same as above, but allow to limit the output to the number of columns specified.

  • SQL ... statements these entries are for create and execute SQL statements where the first word is automatically inserted.

  • List all ... to list all Tables, Procedures, Views and Variables in the current database.

  • DBext Get Options get all the DBext options (settings).

  • DBext Set Option set a DBext option (setting).

  • DBext Set Var set a Variable.

  • DBext Set Buffer Parameters to set all the parameters to the current buffer.

  • List all Connections list all database connections. Only for DBI/ODBC connections.

  • Commit, Rollback, Connect & Disconnect to do those actions over the current Database connection. Only for DBI/ODBC

Mappings

Normal mode

  • <Leader>Se execute SQL query under the cursor (properly terminated by ;)
  • <Leader>SE execute SQL query under the cursor with a limit of rows (properly terminated by ;)
  • <Leader>Sea execute a range of lines
  • <Leader>Sel execute the current line
  • <Leader>Sep execute the previous range
  • <Leader>St select * from the table under the cursor
  • <Leader>ST select * from the table under the cursor with a limit of rows
  • <Leader>Stw select * from the table under the cursor with a where clause
  • <Leader>Sta ask for a table and do a select * from it
  • <Leader>Sd describe the table under the cursor
  • <Leader>Sda ask for a table and describe it
  • <Leader>Sp describe the procedure under the cursor
  • <Leader>Spa ask for a procedure and describe it
  • <Leader>Slt display a list of tables with a specified prefix
  • <Leader>Slp display a list of procedures/packages/functions with a specified prefix
  • <Leader>Slv display a list of views with a specified prefix
  • <Leader>Slc display a list of columns for a given table
  • <Leader>Svr display a list of all buffer specific variables

... and the rest of standard DBext mappings using the prefix S instead of s

Visual mode

  • <Leader>Se execute SQL visually selected
  • <Leader>St select * from the table visually selected
  • <Leader>Sdt describe the table visually selected
  • <Leader>Sdp describe the procedure visually selected
  • <Leader>Slt display a list of tables with a specified prefix
  • <Leader>Slp display a list of procedures/packages/functions with a specified prefix
  • <Leader>Slv display a list of views with a specified prefix
  • <Leader>Slc display a list of columns for a given table

Web Development

HTML5

Provides autocompletion, syntax and indentation for HTML5. For that purpose supports SVG, RDFa, microdata and WAI-AIRA

Emmet

emmet

Emmet (former Zen Coding) allow us to write HTML/XML and CSS files more fast and in a more brief and less tedious way. Emmet takes the snippets idea to a whole new level: you can type CSS-like expressions that can be dynamically parsed, and produce output depending on what you type in the abbreviation.

The best way to know how this works is to look at the tutorial (:h emmet-tutorial vimhelp:emmet-tutorial) or read the official documentation, Emmet docs

Mappings

  • <C-Y>, expand abbreviation (works as a wraper in visual mode, see the help)
  • <C-Y>d select the tag inward
  • <C-Y>D select the tag outward
  • <C-Y>n go to the next edit point
  • <C-Y>N go to the previous edit point
  • <C-Y>i update image size
  • <C-Y>k remove tag
  • <C-Y>j split/join tag
  • <C-Y>/ toggle comment
  • <C-Y>a make anchor from url
  • <C-Y>A make quoted text from url
  • <C-Y>c code pretty

Color Management

unite colorv

ColorV is the perfect plugin to deal with Color Management under Vim. And is ideal for edit CSS files and preview the colors that match with his definition. Also have a lot of tools for pick a color, choose/create a color scheme, deal with different color spaces, ... It has virtually everything you could need for color management, without envy too many professional tools

Unite

<LocalLeader>c or :Unite menu:colorv shows the ColorV menu

colorv

Menu

  • open colorv show the ColorV window

  • open colorv with the color under the cursor show the ColorV window with the color under the cursor selected

  • preview colors is very useful for CSS sheets, where shows the color codes highlighted with its matching color

  • color picker open a graphical color picker

  • edit the color under the cursor open ColorV window with the color under the cursor and when we close it, put the edited color in the buffer

  • the next entry is similar as above, but in this case change all the buffer colors similar to the selected one (previous confirmation)

  • insert a color insert a color using the ColorV window. In the mapping the second i can be replaced for a r to insert a RGB color or a m for a CMYK one, etcetera (look at the help for more information)

  • color list relative to the current show a side window with a color list with the same hue that the one under the cursor. The h in the mapping can replaced by a s to show a color list by saturation, a for analogues, and so on (consult the help for more info)

  • show color list (Web W3C colors) show a side window with a colors list by name (Web W3C colors)

  • choose color scheme (ColourLovers, Kuler) allow us to choose a color scheme from Kuler o ColourLovers

  • show favoire color schemes show the color schemes marked as favorites (f to mark it, F to unmark it)

  • new color scheme create a new color scheme

  • create hue gradation between two colors crate a color gradation based in a parameter (hue, saturation, ...)

    Mappings in the ColorV window

    • z/Z resize the window
    • ? show the mappings ciclically
    • q close the window

Markdown

unite markdown

This allows us to preview the rendering of a Markdown file in the browser, it supports the Markdown extra extension. The file is rendered by Python-markdown, creating a temporal html file and open it in a browser tab.

Used in conjunction with a plugin that refresh the browser tab when the html file changes, we get a way to preview your document changes without leaving vim .

Unite

  • <localleader>k or:Unite menu:markdown shows the markdown menu

Menu

  • preview renders the Markdown document in a temporal html file and open it in a new browser tab

  • refresh rewrites the html file with the changes

    mep

reStructuredText

This is provided by the Riv plugin, a plugin so powerful that I only will mention here the more essential features. It supports Folding, Syntax Highlighting, Sphinx Support, Projects, Export, Scratch, Todos, ... and a complete set of reST Document edition features. It can be used as a Document/Documentation Writer, but also as a Task Manager, Diary, Project Manager, ...

In fact, the only thing I'm going to show is the commands that documents the plugin (the help itself is made via various rst documents):

Commands

  • :RivIntro shows the Intro documentation
  • :RivQuickStart shows a QuickStart documentation about riv
  • :RivInstruciton shows a detailed Instructions manual
  • :RivCheatSheet shows a reST CheatSheet

There is also a little Unite menu (maybe I'll improve it later):

Unite

  • <localleader>r or:Unite menu:rest shows the reStructuredText menu

The plugin is only available when a reST document is opened/created.

Linux/Unix tools

DirDiff

It has a similar behavior that the vimdiff tool but for directories instead of individual files

DirDiff

Commands

  • :DirDiff {A:directory 1} {B: directory 2} shows the differences between the two directories
  • :DirDiffQuit exit from DirDiff mode

Hexadecimal Editor

For this I use the Vinarise plugin, a well thought hexadecimal editor for Vim.

No play with this, is not a toy, this is for grown ups only! If you do not know what you are doing, keep your hands out of it! :smile: If you are all thumbs, this tool is a sure candidate for a disaster.

hex

Mappings

  • <F6> entry into the Hexadecimal mode
  • V edit the file in ASCII mode with Vim (Vinarise keeps opened)
  • q hide Vinarise
  • Q quit Vinarise
  • <C-G> show current position
  • r change current address
  • R overwrite from current address
  • gG move to input address
  • go move by offset address
  • / search binary value
  • ? search binary value reverse
  • g/ search string value
  • g? search string value reverse
  • e/ search regular expression (search only forward)
  • E change encoding
  • <C-L> redraw
  • g<C-L> reload

Internationalization

Translate .po files

Is a tool to add syntax highlighting to .po files (GNU gettext) and some mappings to edit them easily.

po

Mappings

  • /u move to the next untranslated string
  • /U move to the previous untranslated string
  • /c copy the msgid string to msgstr
  • /C create a comment for that entry
  • /d delete the msgstr string (Insert mode only)
  • /f move to the next "fuzzy" string
  • /F move to the previous "fuzzy" string
  • /z tag the entry as "fuzzy"
  • /Z delete the "fuzzy" tag
  • /s show the msgfmt statistics from the file
  • /e move along the msgfmt errors from the file
  • /t entry the translator info in the header
  • /T entry the translator team info in the header
  • /W formats the entire file
  • gf open in a new window the file under the cursor

Vim tools

unite vim

Several Vim tools grouped under this menu among others that not fitted well in any other menu.

Unite

  • <LocalLeader>v or :Unite menu:vim shows this menu

Menu

The first entry is already commented at the beginning of this document

  • mappings shows all the customized mappings available whit their corresponding associated action. Those ones that corresponds with plugins that are Lazy are not showed unless the plugin is already loaded.

  • edit configuration file (vimrc) edits the vim configuration file ~./.vimrc

  • choose filetype choose a filetype from a list to apply to the current buffer

  • vim help search into the vim help (slow)

  • vim commands list all commands available as candidates. For Lazy plugins, these need to be loaded before appears in the list.

  • vim functions same as above for functions instead of commands

  • vim runtimepath shows all paths in the vim runtimepath

  • vim command output shows the output of a Vim command through the Unite interface (e.g. :ls)

  • unite sources all the Unite sources available

  • kill process shows the output of the Unix command top where we can select one or more process to kill them with kill

  • launch executable launch an executable from a list, in a similar behavior as dmenu

Prerequisites

Vim

To have a completely functional version of Vim with this configuration, you need a Vim version greater or equal than 7.3 and compiled with support for Python, Lua and Ruby. You can know that using the :version command, it shows the Vim version and the supported features (those one preceded by a plus symbol +)

You can compile Vim from source if your distribution does not offer a package that fits those requirements. You only have to configure it with the adequate parameters, something like this:

$ hg clone https://code.google.com/p/vim/ vim
$ cd vim
$ ./configure --with-features=huge \
              --enable-gui=gnome2 \
              --enable-luainterp=yes \
              --enable-pythoninterp=yes \
              --enable-rubyinterp=yes \
              --enable-perlinterp=yes \
              --enable-cscope
$ make
$ sudo make install

Programs

You need also several programs to enjoy a complete experience:

  • ctags, to generate the tags for code files, usually distributed as exuberant-ctags
  • ag, ack or grep for regex searches of files
  • git for git repositories administration
  • isort for the vim-isort plugin (to sort imports in python)

Optional programs

If you want to use the same external auxiliary programs that I use for this config, those are the needed:

  • tig is a ncurses git manager

  • coverage analyze the coverage for a Python program

  • ranger an amazing ncurses file explorer. My personal configuration is also in this same repository in the ../ranger folder

  • pylint code quality tool for Python

  • virtualenvwrapper to manage Python virtualenvs easily

Font

The Dejavu Sans for Powerline font is required for the vim-airline plugin. It can be founded in this same repository under the ../fonts folder. You can find more fonts ready for powerline in this repository, powerline fonts

Alternative settings

Maybe this setup can be helpful to you and decide to clone/fork it, but you don't like all the settings. Well, in this case you still can clone this config and customize it as you want without loose the evolution of mine.

To do this I added the possibility to read an additional file to load your custom settings. This file is located by default in this path ~/.vim/custom.vim. Those settings override the similar ones in the .vimrc file

Example

I like the folding setting by default in python files, but if you do not like it, you can add this line to that file:

let g:pymode_folding = 0

At the same time I have all the folds closed by default, if you prefer open the file with all the folds opened, you can add this other line (currently is the default):

au FileType python setlocal foldlevel=1000

Plugins & Colorschemes

Something went wrong with that request. Please try again.