Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/liangxianzhe/oh-my-vim
Awesome vim config for everyone.
https://github.com/liangxianzhe/oh-my-vim
Last synced: 16 days ago
JSON representation
Awesome vim config for everyone.
- Host: GitHub
- URL: https://github.com/liangxianzhe/oh-my-vim
- Owner: liangxianzhe
- License: mit
- Created: 2013-09-13T05:14:00.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2022-10-28T22:05:33.000Z (over 1 year ago)
- Last Synced: 2024-02-26T21:41:44.034Z (4 months ago)
- Language: Vim Script
- Homepage:
- Size: 306 KB
- Stars: 738
- Watchers: 45
- Forks: 106
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Lists
- awesome-stars - liangxianzhe/oh-my-vim
- awesome-stars - liangxianzhe/oh-my-vim - Awesome vim config for everyone. (Vim Script)
README
# Oh My Vim
```
Deprecated
```
This project is no longer maintained. I'm mostly using VSCode plus vim binding these days. As for vim, I'm using a much simpler setup. Here is my `.vimrc` in case you are curious.
```vim
" Automatically install vim-plug
if empty(glob('~/.config/nvim/autoload/plug.vim'))
silent !curl -fLo ~/.config/nvim/autoload/plug.vim --create-dirs
\ https://raw.githubusercontent.com/junegunn/vim-plug/master/plug.vim
autocmd VimEnter * PlugInstall | source $MYVIMRC
endif
" All plugs
call plug#begin()
" Reasonable defaults
Plug 'tpope/vim-sensible'
" Better looking
Plug 'ghifarit53/tokyonight-vim'
Plug 'itchyny/lightline.vim'
" Language pack on demand
Plug 'sheerun/vim-polyglot'
" Comment out stuff
Plug 'tpope/vim-commentary'
" Edit surroundings
Plug 'tpope/vim-surround'
Plug 'tpope/vim-repeat'
" Move cursor around
Plug 'justinmk/vim-sneak'
" File search
Plug 'junegunn/fzf', { 'do': { -> fzf#install() } }
Plug 'junegunn/fzf.vim'
call plug#end()
" Automatically install missing plugins on startup
autocmd VimEnter *
\ if len(filter(values(g:plugs), '!isdirectory(v:val.dir)'))
\| PlugInstall --sync | q
\| endif
```
---
```
Original Readme
```
Out-of-box vim config for everyone. It is well organaized and easy to use.
E.g. open Unite UI interface and find the grep feature, search a string in
current folder, preview results, and open selected files.
# How to install
## 1. Install some needed tools
For Mac OS, you can just run the [script](/tools/prepare_mac.sh). It will
install some necessory tools and the latest vim (7.4) *with lua support*.
curl -L https://raw.github.com/liangxianzhe/oh-my-vim/master/tools/prepare_mac.sh | sh
For Linux, there is no script yet. You need to figure out what the above script
does, and install them according (apt-get etc). Please note a vim with lua
support is required.
## 2. Install oh-my-vim:
Run: [tools/install.sh](tools/install.sh)
curl -L https://raw.github.com/liangxianzhe/oh-my-vim/master/tools/install.sh | sh
It will be installed to ~/.oh-my-vim folder.
## 3. Set up font (optional):
For a better looking [powerline](https://github.com/bling/vim-airline), you will
need setting install a [patched font](https://github.com/bling/vim-airline#integrating-with-powerline-fonts).
If you are using mac, the above script has installed a font [DroidSansMono](https://github.com/Lokaltog/powerline-fonts/tree/master/DroidSansMono)
for you. Please set this font for your terminal. (For macvim or gvim, nothing
need to be done. For iTerm2, go for Profile - Open Profile - Default - Edit Profile - Text - None-ASCII Font.)
## 4. Open vim:
Open your vim, it will install a bunch of plugins at the first time. Close
the vim and re-open it, then you are all set.
# Configuration
You can overwrite the default configuration and key bindings by creating one of
following files:
`~/.before.vimrc` will be loaded before everything else.
`~/.local.vimrc` will be loaded after bundles are initialized and before
the settings take place. The idea was so people could add Bundle lines
without having to worry about conflicts in vimrc when pulling.
`~/.after.vimrc` will be loaded after all configuration options are set.
This is the best place to change default behaviour (keybindings) or
color scheme.
# Acknowledgments
Obviously I steal a lot work from others. Here is my special thanks to:
Joe Di Castro (joedicastro)'s
[dotfiles](https://github.com/joedicastro/dotfiles/tree/master/vim). Most part
of this config is copied from Joe, including large amount of this README. His
idea of using Unite to create UI is brilliant.
[oh-my-zsh](https://github.com/robbyrussell/oh-my-zsh). Copied it's name and
some scripts.
# Usage
Most shortcuts start with either `,` or ``:
> `` key is mapped to `,`
> `` key is mapped to ``
> `u` i.e. `u` will trigger the awesome Unite UI
Oh-my-vim features are organized as packages, while each package is just a
.vimrc file. Modulization is good because:
- Each package is short and easy to follow.
- You can easily add a new package (such as java or ruby) and send a pull-request.
- You can ignore the package you don't need by setting a parameter
`g:oh-my-vim_packages` in local.vimrc.
The packages list:
- [basic](#basic) - some basic vim config to make it easy to use
- [code](#code) - general coding
- [text](#text) - text edition
- [grep](#grep) - search text in files
- [searching](#searching) - search text in current buffer
- [registers](#registers) - yanks, registers & history
- [navigation](#navigation) - navigate by buffers, tabs & windows
- [files](#files) - files & dirs
- [git](#git) - git
- [python](#python) - python
- [web](#web) - web
- [bookmarks](#bookmarks) - bookmarks
- [vim](#vim) - vim
- [neobundle](#neobundle) - plugins administration with neobundle
- [spelling](#spelling) - spell checking & translation
- [markdown](#markdown) - markdown
- [tools](#tools) - some other tools
All the packages are viewalbe in the Unite UI interface.
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).
The Unite menu will show what functionality we have and what's their
key-mappings. You can always refer the menu for something you don't
remember the shortcut.
The main Unite munu:
### Navigation inside Unite
In Unite, you can filter result in Insert mode, you can select candidates and
apply operations to selected candidates in Normal mode. Below 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
> - `` choose an action
> - `a` choose an action for the selected candidate or add text at the end of
> the prompt
> - `` reset the menu
> - `` 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:*
> - `` 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:
> - `` change to normal mode
> - `` choose an action
> - `` execute the default action
> - `` exit Unite
> - `` delete it
> - `` expand the path
> - `` open the candidate in a new tab
> - `` do a yank
> - ``, ``, `` y `` Vim motions to move around candidates
> *With a candidate selected:*
> - `` mark the current candidate
> __Visual__ mode:
> - `` mark the current candidate
Put most basic vim config here, like indent, quick saving, history, backup.
There is no Unite menu for this package.
__Unite__
- `c` or `:Unite menu:code`, shows the Code menu
__Menu__
These are the menu entries in detail:
- *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.
- *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
__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 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.
> __Mappings__
> - `` preceded by the snippet keyword, trigger the snippet
> - `` jump to the next field
> - `` jump to the previous field
> - `` cancel the text enter in an optional field
This menu groups several options to edit text
__Unite__
`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
- *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][lorem] text
[lorem]: http://es.wikipedia.org/wiki/Lorem_ipsum
- *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 text edition 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.
> __Mapping__
>
> - `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
> __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
> __Mappings__
> - `` Increase the time value under the cursor
> - `` Decrease the time value under the cursor
> - `d` Change the time under the cursor to the current UTC time
> - `d` 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 ``. If you only want the
first char, you only have to press the __Delete__ key
- __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.
> __Mappings__
> - `` insert the selected word
> - `` go to the next word (below) in the option list
> - `` go to the previous word (above) in the option list
- __easydigraph__ easily insert digraphs, especially when trying to insert
several simultaneously
>
> __Mapping__
>
> - `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.
> __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
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__
- `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.
- *grep current word* grep the word under cursor.
- *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__
- `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.
> __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` 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` remove all markers of the same type
> - `]-` jump to next line having same marker
> - `[-` jump to prev line having same marker
> - `m` remove all markers
__Unite__
- `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.
> __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
> - `` move to the next window to the left
> - `` move to the lower window
> - `` move to the upper window
> - `` move to the next window to the right
__Unite__
`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
> - `` 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
__Unite__
- `o` or `:Unite menu:files` 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][rngr] to browse
the directory hierarchy and choose the file that you want to edit.
[rngr]:http://joedicastro.com/productividad-linux-ranger.html
- *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.
> __Mappings__
> - `` 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
> - `` 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
> - `` open the visited directories history (opened by )
> - `` open a directory
> - `` 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
> - `` redraw the screen
> - `gs` toggle the safe mode __Warning!__
> - `gS` toggle the simple mode
__Unite__
- `g` or `:Unite menu:git` show the git menu
__Menu__
- *tig* open the external application [tig][tig], which is a ncurses interface
for git. Obviously, this only works when the working directory is into a git
repository.
[tig]: https://github.com/jonas/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)
> __Mappings__
> - `` 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 `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.
- *status* show the repository status and from this window we can access to
multiple options. In this window this mappings are available:
> __Mappings__
> - `` and `` allow us to move between files
> - `` 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` (`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
> - `du` do a `:diffupdate`, update changes
> - `dq` exit from diffmode
> - `u` undoes all changes
> - `[c` and `]c` to move between diffs
> - `:Gwrite` or `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` (`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
> - `` 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.
> __Mappings__
> - `` & `` to navigate back and forth through the links
> - `` open a link in the browser
> - R refresh the window
> - q close the window
- *github issues & PR* open the external ncurses application [shipit][shpt]
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.
[shpt]: https://github.com/alejandrogomez/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).
__Unite__
- `p` or `:Unite menu:python` shows the python menu
__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][pylint] by demand
[pylint]: http://www.pylint.org/
- *rope auto-completion* allow us to use the rope auto-completion. Useful for
methods auto-completion.
- *jump 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
- *reorganize imports* reorganize automatically the import statements
- *refactorize - x* the entries that begin in this way are for refactorize the
python code with rope, using the method mentioned in each description
- *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
- *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][cvg] 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.
[cvg]: http://nedbatchelder.com/code/coverage/
- *toggle coverage report* and *toggle coverage marks* toggle the visibility of
the marks and report from coverage
__HTML5__
Provides autocompletion, syntax and indentation for HTML5. For that purpose
supports SVG, RDFa, microdata and WAI-AIRA
__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` ) or read the official documentation,
[Emmet docs](http://docs.emmet.io/)
> __Mappings__
> - `,` expand abbreviation (works as a wraper in visual mode, see the help)
> - `d` select the tag inward
> - `D` select the tag outward
> - `n` go to the next edit point
> - `N` go to the previous edit point
> - `i` update image size
> - `k` remove tag
> - `j` split/join tag
> - `/` toggle comment
> - `a` make anchor from url
> - `A` make quoted text from url
> - `c` code pretty
With this menu we can manage the bookmarks easily.
__Unite__
`m` or `:Unite menu:bookmarks` shows the bookmarks menu
__Unite__
- `v` or `:Unite menu:vim` shows the vim menu
__Menu__
These are the menu entries in detail:
- *choose color scheme* display color scheme with preview support
- *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`
A plugin to rule them all! NeoBundle allows us to manage the rest of the plugins,
itself included. __I have it configured to auto install itself and all of the
plugins when Vim is executed for the first time__.
The advantages of NeoBundle versus Vundle and other similar plugins are the
following:
- Allows to use another VCS other than git (hg, svn), even a local dir
- Allows revision lock or even set a plugin to not be updated
- Supports lazy initialization of plugins to optimizing startup time
- Supports multiple config options per plugin, like automatic building if needed
- and so on...
The best way to use NeoBundle is through Unite:
__Unite__
- `n` or `:Unite menu:neobundle`, shows the NeoBundle menu
__Menu__
These are the menu entries in detail:
- *neobundle* shows the installed plugins as candidates. Via the actions we can
delete them, browse the repository page, ...
- *log* shows the last NeoBundle log
- *lazy* shows all the installed plugins configured as Lazy. Those are loaded on
demand and allow us to have a lot of plugins installed that are not frequently
used without delaying the vim startup. I use this option a lot in this
configuration.
- *update* updates all the plugins automatically (and installs those not already
installed)
- *search* searches plugins by name on vim.org & GitHub (duplicates prone)
- *install* installs all the plugins already present in the `.vimrc` file or in
the `direct_bundles.vim` file that are not yet installed
- *check* checks if all the plugins are already installed, and if not, prompt
for their installation
- *docs* installs help docs for all plugins manually
- *clean* deletes, upon confirmation, those plugin folders that are no longer
needed because they are not still installed
- *list* lists all the installed plugins
- *direct edit* edits the `~/.vim/bundle/.neobundle/direct_bundles.vim` file
where NeoBundle stores those plugins installed directly (e.g. via NeoBundle
search)
> __Plugins updating__
> Since we often install plugins from repositories, we are exposed to error-
> prone updates. Once in a while, a plugin update introduces a bug and you end up
> with an unstable configuration until that bug is fixed (which may take a while).
> If we use Vim for work, that is very inconvenient.
> A way to avoid this is by using symbolic links and backups of our vim folder.
> If we made a backup of our vim config before an update, is easy to restore it
> to a previous stable state without much effort. But this is tedious and
> error-prone too. And alternative is managing this via NeoBundle. We can use
> the revision lock feature to specify what revision we want to install or even
> say to NeoBundle that a plugin should not be updated. But it is not a perfect
> solution either, and very manual. Maybe in a future, we could do plugin
> rollbacks...
## Spell checking & translation
__Unite__
- `s` or `:Unite menu:spelling` shows the spelling menu
__Other tools__
- `T` Translate selected text to Chinese.
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__
- `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 (currently only work on Mac)
- *refresh* rewrites the html file with the changes
__Unite__
`t` or `:Unite menu:tools` shows the tools menu
__Menu__
These are the menu entries in detail:
- *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:
- *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
- *open link* open link under cursor using utl.vim
__Other tools__
- DirDiff
It has a similar behavior that the vimdiff tool but for directories instead
of individual files
> __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.
> __Mappings__
- `` entry into the Hexadecimal mode
- `V` edit the file in ASCII mode with Vim (Vinarise keeps opened)
- `q` hide Vinarise
- `Q` quit Vinarise
- `` 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
- `` redraw
- `g` reload
# Plugins & Colorschemes
- __badwolf__
- __coveragepy.vim__
- __crontab.vim__
- __csapprox__
- __delimitMate__
- __DirDiff.vim__
- __easydigraph.vim__
- __emmet-vim__
- __gitv__
- __gundo.vim__
- __harlequin__
- __html5.vim__
- __indentLine__
- __JSON.vim__
- __junkfile.vim__
- __loremipsum__
- __molokai__
- __neobundle.vim__
- __neocomplete.vim__
- __po.vim--gray__
- __python-mode__
- __summerfruit256.vim__
- __syntastic__
- __ultisnips__
- __unite-colorscheme__
- __unite-filetype__
- __unite-fold__
- __unite-help__
- __unite-locate__
- __unite-mark__
- __unite-outline__
- __unite-quickfix__
- __unite.vim__
- __utl.vim__
- __vim-airline__
- __vim-characterize__
- __vim-commentary__
- __vim-fugitive__
- __vim-gitgutter__
- __vim-github256__
- __vim-github-dashboard__
- __vim-markdown__
- __vim-markdown-extra-preview__
- __vim-molokai256__
- __vim-pentadactyl__
- __vim-repeat__
- __vim-signature__
- __vim-snippets__
- __vim-speeddating__
- __vim-surround__
- __vim-textobj-entire__
- __vim-textobj-indent__
- __vim-textobj-lastpat__
- __vim-textobj-line__
- __vim-textobj-underscore__
- __vim-textobj-user__
- __vim-tmux__
- __vim-transpose__
- __vim-unite-history__
- __vim-virtualenv__
- __vimfiler__
- __vimproc__
- __vimux__
- __vinarise.vim__
- __webapi-vim__
- __winresizer__
- __zoomwintab.vim__