Light tweaks for vim bringing fair enough enhancements to programmers.
This is my vim configuration for my daily programming and text editing usage. I configured my vim to be programming-friendly with suitable tweaks to the built-in features, interface, formatting, etc. The configuration I made would be easy to understand. The plugins I choose tend to be simple-to-use and practical. I don't mean to make a completely different editor or to make a fancy vim so I would keep everything simple and won't go far from typical vim practices.
I will update it from time to time. Feel free to clone/fork it if you find my configuration suitable for you.
GitLab (Main): https://gitlab.com/archerindigo/vimrc
GitHub (Mirror): https://github.com/archerindigo/vimrc
Objectives:
- To provide a nicer but remain simple interface
- To include simple-to-use and practical plugins
- To provide a programming-friendly environment
- Keep configuration easy-to-read and well explained
Major features included:
- Interface settings for more comfortable coding
- Formatting that match general programming needs
- Easier code exploration and navigation
- Easier file navigation
- Simple session save/load
- Support of git
You may look into .vimrc to get better understanding of what have set.
The color scheme used is sonokai-maia without transparent background.
The configuration should work well with Vim 7.3+.
I recently used the following terminals as well:
- xfce4-terminal 4.16
- gnome-terminal 40.0
- MobaXterm 21.1
- tmux 2.8
- vim-plug: A easy-to-use plugin manager.
- lightline.vim: A light-weight but good-looking, powerful enough status line replacement.
- NERDTree: A tree-view file explorer.
- nerdtree-git-plugin: An extension on top of NERDTree providing git status flags in the file explorer.
- tagbar: Provides outline of your code.
- vim-indent-guides: Add visual guides to indent levels.
- fugitive.vim: A git wrapper.
- gv.vim: A repository viewer similar to gitk. Based on fugitive.
- vim-tldr: View simplified man pages within vim.
Included in current release:
- (Current default) sonokai: A variant of monokai which has better contrast and true color support. It also comes with various styles and good support of various languages.
- one: This color scheme is based on the popular Atom's One Dark theme. It has good support of various front-end languages.
- wombat: My previous default scheme for gvim. The wombat color scheme is dim but colorful that would make syntax so distinguishable and easy on eyes. This original wombat scheme comes with solid background and is slightly yellowish, which is more suitable for GUI environment.
- wombat256i: My previous default scheme for command-line vim. It supports transparent background in terminal and the color is not that yellowish compare to the original version.
Not included / Dropped but worth trying:
- molokai: The long-living dark, vivid, very high contrast monokai 256-color scheme.
- dracula: A pretty interesting but yet practical dark-purplish color scheme.
- jellybeans: Another dark and even more colorful scheme.
- peaksea: This scheme is dark in background but light in syntax.
- Clone the repository:
Third-party repositories are included in this repository. Remember to use --recursive to pull them all!
git clone --recursive https://gitlab.com/archerindigo/vimrc.git
- Replace your ~/.vimrc and ~/.vim
cp vimrc/.vimrc ~
cp -r vimrc/.vim/* ~/.vim/
The configuration will be applied to local profile only. If you want to make it system-wide effective (e.g. take effect in sudo vim), you should copy the content of .vimrc to /etc/vim/vimrc
Make sudo to use the configuration and plugins
In Linux, vim would load root account's configuration from /root so you can create links from there to your user configurations:
sudo ln -s /home/<your_username>/.vimrc /root/.vimrc
sudo ln -s /home/<your_username>/.vim /root/.vim
For stability, plugins and color schemes are initially downloaded as fixed version. Some plugins has fixed version tag set in .vimrc. You can update or remove the tag. Then run :PlugUpdate in vim. You may encounter PlugClean required message for some plugins in the first run. It is normal as they were not initially be downloaded by Plug. Simply run :PlugClean and then :PlugUpdate to reinstall them to the desired version.
Belows are some customized usage and other usage tips for my configuration.
sonokai, one and wombat256i have transparent background support.
sonokai originally comes with solid background. To switch back to solid background, comment this line in .vimrc:
let g:sonokai_transparent_background = 1
Besides the original gT and gt keys, you can use Ctrl-h and Ctrl-l to switch between tabs. They work in normal mode only.
You can save session by pressing F2 and then type the file name. To load a session, you can press F3 and type the file name. The default storage is ~/.vim/sessions/ .
Note that a session file not only contain the opened files and tabs, but also the configuration of vim. Loading it would override your existing vim settings.
In the past, I was not very comfortable with incremental search. When I was typing (copying) a term from the current screen, the screen keeps jumping around so it was difficult to take reference from the screen.
After getting familiar with the search current word commands (Shift-3 and Shift-8), I am now confident to re-enable incremental search withoutbeing annoyed while I can know the search results sooner.
Press Ctrl-G to toggle NERTree's explorer
Press F8 to toggle tagbar
Press <Leader> + i + g to toggle indent guides. <Leader> maybe the \ key on your keyboard. You may also enable it by defult by uncommenting the line let g:indent_guides_enable_on_vim_startup=1
You can select text in visual mode and press Ctrl-C to copy or Ctrl-X to cut it into system clipboard. To paste the text, you can press Ctrl-P in normal mode or Ctrl-V in insert mode.
It is recommended to use Source Code Pro size 10 as the font. You can uncomment "set guifont=Source\ Code\ Pro\ 10" in .vimrc to enforce the font in gvim. For vim you should set the terminal font by yourself.
:Gblame: Open git blame.
:Gdiff: Check different between the current file edit and the last commit.
:G / :Gstatus: Check git status.
:GV: Open git graphical log.
Check vim-fugitive andgv.vim for more information.
Simply type :Tldr <entry>
Taglist: Exuberant ctags (http://ctags.sf.net) not found in PATH. Plugin is not loaded.
ctags is missing in your machine. Please install it explicitly.
sudo apt-get install ctags
You may forgot to install the Tldr docs into your machine. Run the following command in vim to download/ update the docs:
:TldrUpdateDocs
tmux seldom work well in true color mode. I would suggest you to fallback to other 256-color color schemes such as wombat256i.