Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/umayr/vimrc
V for VIM — Sensible VIM default configs to save the world.
https://github.com/umayr/vimrc
Last synced: 9 days ago
JSON representation
V for VIM — Sensible VIM default configs to save the world.
- Host: GitHub
- URL: https://github.com/umayr/vimrc
- Owner: umayr
- License: mit
- Created: 2015-11-10T08:21:03.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2016-05-06T11:27:18.000Z (over 8 years ago)
- Last Synced: 2024-11-07T03:48:22.560Z (about 2 months ago)
- Language: VimL
- Homepage:
- Size: 5.83 MB
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# `vimrc`
> This is fork of [amix](https://github.com/amix/)'s awesome [`vimrc`](https://github.com/amix/vimrc).
There are two versions of configurations:
* **Basic**: If you want something small just copy [basic.vim](https://github.com/umayr/vimrc/blob/master/vimrcs/basic.vim) into your ~/.vimrc and you will have a great basic setup.
* **Extended**: This includes a ton of useful plugins, color schemes and configurations.
Well, for obvious reasons Extended version is recommended.
## Installation
```bash
# For basic installation
$ bash <(curl -s https://raw.githubusercontent.com/umayr/vimrc/master/install.sh)
# For extended installation
$ bash <(curl -s https://raw.githubusercontent.com/umayr/vimrc/master/install.sh) --extended
```
Note: The `taglist.vim` plugin will require [`ctags`](http://ctags.sourceforge.net) (For Debian: `apt-get install ctags`)
### Windows?
Do yourself a favour and use [cmder](https://github.com/cmderdev/cmder) if you're not using it and run the installation instructions above. No special instructions needed.
## Fonts
It is recommended to use patched fonts for terminal so that `airline` would show special separtors, you can get all patched fonts from [powerline/fonts](https://github.com/powerline/fonts).
I also recommend using [Ubuntu Mono derivative Powerline](https://github.com/powerline/fonts/tree/master/UbuntuMono) (it's a patched version of Ubuntu's default monospace font for writing and programming).
## Update
Simply just do a git rebase:
```bash
$ cd ~/.vim/runtime && git pull --rebase
```
## Screenshots
Empty vim using `Solarized Dark` theme:
[NERD Tree](https://github.com/scrooloose/nerdtree) in action:
[CtrlP.vim](https://github.com/kien/ctrlp.vim) in action:
[MRU.vim](https://github.com/scrooloose/nerdtree) displays most recent used files:
Distraction free mode using [Goyo](https://github.com/junegunn/goyo.vim):
## Plugins
For better understanding of how these plugins work, please refer to their docs. Each of them provide a much better Vim experience!
* [pathogen.vim](https://github.com/tpope/vim-pathogen): Manages the runtime path of the plugins
* [YankRing](https://github.com/vim-scripts/YankRing.vim): Maintains a history of previous yanks, changes and deletes
* [snipMate.vim](https://github.com/garbas/vim-snipmate): snipMate.vim aims to be a concise vim script that implements some of TextMate's snippets features in Vim
* [bufexplorer.zip](https://github.com/vim-scripts/bufexplorer.zip): Buffer Explorer / Browser. This plugin can be opened with ``
* [NERD Tree](https://github.com/scrooloose/nerdtree): A tree explorer plugin for vim
* [ack.vim](https://github.com/mileszs/ack.vim): Vim plugin for the Perl module / CLI script 'ack'
* [ag.vim](https://github.com/rking/ag.vim): A much faster Ack
* [ctrlp.vim](https://github.com/kien/ctrlp.vim): Fuzzy file, buffer, mru and tag finder. In my config it's mapped to ``, because `` is used by YankRing
* [mru.vim](https://github.com/vim-scripts/mru.vim): Plugin to manage Most Recently Used (MRU) files. Includes my own fork which adds syntax highlighting to MRU. This plugin can be opened with ``
* [open_file_under_cursor.vim](https://github.com/amix/open_file_under_cursor.vim): Open file under cursor when pressing `gf`
* [emmet-vim](https://github.com/mattn/emmet-vim): Expanding abbreviation like zen-coding, very useful for editing XML, HTML.
* [vim-indent-object](https://github.com/michaeljsmith/vim-indent-object): Defines a new text object representing lines of code at the same indent level. Useful for python/vim scripts
* [taglist.vim](https://github.com/vim-scripts/taglist.vim): Source code browser (supports C/C++, java, perl, python, tcl, sql, php, etc)
* [vim-multiple-cursors](https://github.com/terryma/vim-multiple-cursors): Sublime Text style multiple selections for Vim, CTRL+N is remapped to CTRL+S (due to YankRing)
* [vim-expand-region](https://github.com/terryma/vim-expand-region): Allows you to visually select increasingly larger regions of text using the same key combination.
* [vim-airline](https://github.com/bling/vim-airline): Lean & mean status/tabline for vim that's light as air (replacing powerline)
* [vim-fugitive](https://github.com/tpope/vim-fugitive): A Git wrapper so awesome, it should be illegal
* [goyo.vim](https://github.com/junegunn/goyo.vim) and [vim-zenroom2](https://github.com/amix/vim-zenroom2):
Remove all clutter and focus only on the essential. Similar to iA Writer or Write Room [Read more here](http://amix.dk/blog/post/19744)
* [vim-commentary](https://github.com/tpope/vim-commentary): Comment stuff out. Use `gcc` to comment out a line (takes a count), `gc` to comment out the target of a motion. `gcu` uncomments a set of adjacent commented lines.
* [syntastic](https://github.com/scrooloose/syntastic): Syntax checking hacks for vim
You can also install your own plugins via [Pathogen](https://github.com/tpope/vim-pathogen).
This configuration relies on git submodules to manage plugins rather than cloning them.
For instance, to install [vim-rails](https://github.com/tpope/vim-rails):
``` bash
$ cd ~/.vim/runtime
$ git submodule add git://github.com/tpope/vim-rails.git sources/vim-rails
```
And that's it, now you have vim-rails installed.
In order to update plugins:
``` bash
$ cd ~/.vim/runtime
$ git submodule update --recursive
```
## Color Schemes
* [vim-colors-solarized](https://github.com/altercation/vim-colors-solarized) Default
* [vim-irblack](https://github.com/wgibbs/vim-irblack)
* [mayansmoke](https://github.com/vim-scripts/mayansmoke)
* [peaksea](https://github.com/vim-scripts/peaksea)
* [vim-pyte](https://github.com/therubymug/vim-pyte)
## Modes
* [vim-coffee-script](https://github.com/kchmck/vim-coffee-script)
* [vim-less](https://github.com/groenewege/vim-less)
* [vim-bundle-mako](https://github.com/sophacles/vim-bundle-mako)
* [vim-markdown](https://github.com/tpope/vim-markdown)
* [nginx.vim](https://github.com/vim-scripts/nginx.vim)
* [vim-golang](https://github.com/jnwhiteh/vim-golang)
## Personal Config
After the extended installation, it makes the following directory structure:
```
.vim/
├── backups/
├── config.vim
├── runtime/
│ ├── autoload/
│ ├── install.sh
│ ├── README.md
│ ├── sources/
│ └── config/
├── swaps/
└── undo/
```
You can add any of your personal configurations in the `config.vim` file.
## Key Mappings
### Plugin related mappings
Open [bufexplorer](https://github.com/vim-scripts/bufexplorer.zip) and see and manage the current buffers:
```VimL
map o :BufExplorer
```
Open [MRU.vim](https://github.com/vim-scripts/mru.vim) and see the recently open files:
```VimL
map f :MRU
```
Open [ctrlp.vim](https://github.com/kien/ctrlp.vim) plugin:
```VimL
let g:ctrlp_map = ''
```
Open [PeepOpen](https://peepcode.com/products/peepopen) plugin:
```VimL
map j :PeepOpen
```
Managing the [NERD Tree](https://github.com/scrooloose/nerdtree) plugin:
```VimL
map nn :NERDTreeToggle
map nb :NERDTreeFromBookmark
map nf :NERDTreeFind
```
[goyo.vim](https://github.com/junegunn/goyo.vim) and [vim-zenroom2](https://github.com/amix/vim-zenroom2) lets you only focus on one thing at a time. It removes all the distractions and centers the content. It has a special look when editing Markdown, reStructuredText and textfiles. It only has one mapping.
```VimL
map z :Goyo
```
### Normal mode mappings
Fast saving of a buffer:
```VimL
nmap w :w!
```
Treat long lines as break lines (useful when moving around in them):
```VimL
map j gj
map k gk
```
Map `` to `/` (search) and `+` to `?` (backwards search):
```VimL
map /
map ?
map :noh
```
Disable highlight when `` is pressed:
```VimL
map :noh
```
Smart way to move between windows:
```VimL
map j
map k
map h
map l
```
Closing of current buffer(s):
```VimL
" Close current buffer
map bd :Bclose
" Close all buffers
map ba :1,1000 bd!
```
Useful mappings for managing tabs:
```VimL
map tn :tabnew
map to :tabonly
map tc :tabclose
map tm :tabmove
" Opens a new tab with the current buffer's path
" Super useful when editing files in the same directory
map te :tabedit =expand("%:p:h")/
```
Switch CWD to the directory of the open buffer:
```VimL
map cd :cd %:p:h:pwd
```
Open vimgrep and put the cursor in the right position:
```VimL
map g :vimgrep // **/*.
```
Vimgreps in the current file:
```VimL
map :vimgrep // %
```
Remove the Windows ^M - when the encodings gets messed up:
```VimL
noremap m mmHmt:%s///ge'tzt'm
```
Quickly open a buffer for scripbble:
```VimL
map q :e ~/buffer
```
Toggle paste mode on and off:
```VimL
map pp :setlocal paste!
```
### Insert mode mappings
Quickly insert parenthesis/brackets/etc.:
```VimL
inoremap $1 ()i
inoremap $2 []i
inoremap $3 {}i
inoremap $4 {o}O
inoremap $q ''i
inoremap $e ""i
inoremap $t <>i
```
Insert the current date and time (useful for timestamps):
```VimL
iab xdate =strftime("%d/%m/%y %H:%M:%S")
```
### Visual mode mappings
Visual mode pressing `*` or `#` searches for the current selection:
```VimL
vnoremap * :call VisualSelection('f')
vnoremap # :call VisualSelection('b')
```
When you press gv you vimgrep after the selected text:
```VimL
vnoremap gv :call VisualSelection('gv')
```
When you press `r` you can search and replace the selected text:
```VimL
vnoremap r :call VisualSelection('replace')
```
Surround the visual selection in parenthesis/brackets/etc.:
```VimL
vnoremap $1 `>a)`
vnoremap $2 `>a]`
vnoremap $3 `>a}`
vnoremap $$ `>a"`
vnoremap $q `>a'`
vnoremap $e `>a"`
```
### Command line mappings
$q is super useful when browsing on the command line. It deletes everything until the last slash:
```VimL
cno $q eDeleteTillSlash()
```
Bash like keys for the command line:
```VimL
cnoremap
cnoremap
cnoremap
cnoremap
cnoremap
```
Write the file as sudo (only on Unix). Super useful when you open a file and you don't have permissions to save your changes. [Vim tip](http://vim.wikia.com/wiki/Su-write):
```VimL
:W
```
### Spell checking
Pressing `ss` will toggle and untoggle spell checking
```VimL
map ss :setlocal spell!
```
Shortcuts using `` instead of special chars
```VimL
map sn ]s
map sp [s
map sa zg
map s? z=
```
### Cope
Do :help cope if you are unsure what cope is. It's super useful!
When you search with vimgrep, display your results in cope by doing:
`cc`
To go to the next search result do:
`n`
To go to the previous search results do:
`p`
Vimscript mappings:
```VimL
map cc :botright cope
map co ggVGy:tabnew:set syntax=qfpgg
map n :cn
map p :cp
```
## License
[MIT](https://github.com/umayr/vimrc/blob/master/LICENSE)