Setup Vim

Install a plugin manager and get my configs

This is the first in a series of Vim tutorials. Make sure you follow each step exactly. It’s simple enough, but it can be surprisingly easy to muck-up a setup.

If you get stuck anywhere please do comment and I’ll make it clearer — I’d love for this guide to become completely foolproof.

The instructions assume we’re familiar with terminal and git basics. We don’t assume any knowledge about Vim beyond what it is.

Make the right files

First you’ll need to open the terminal and navigate to the home directory, ~. You’ll then create a .vimrc file to store your Vim configuration and plugins.

cd ~
touch .vimrc

You can confirm this now exists by running ls -a (. files are hidden files, and -a reveals them).

Install Vundle

Vundle is a Plugin manager for Vim, analogous to bundler for Ruby or npm for JavaScript. You’ll need it to add nifty additions to Vim’s functionality.

Install Vundle using git clone:

git clone https://github.com/VundleVim/Vundle.vim.git ~/.vim/bundle/Vundle.vim

Get a Vim Config

Next, open your brand new .vimrc file in Vim by entering the command:vim ~/.vimrc. Congratulations, you’re in Vim 🎉

It’s horrible out of the box. Let’s make it nice.

Hit i to enter “insert mode” (essentially “typing mode”) and paste in everything in the below text box. Once you’ve done this, hit escape to get back into “normal mode” (essentially “navigation mode”).

" ================================
" Welcome to Naz's vimrc file
" ================================

" --------------------------------
" Plugins
" --------------------------------
set nocompatible              " be iMproved, required
filetype off                  " required

" set the runtime path to include Vundle and initialize
set rtp+=~/.vim/bundle/Vundle.vim
call vundle#begin()

" let Vundle manage Vundle, required
Plugin 'VundleVim/Vundle.vim'

" Plugins
Plugin 'tpope/vim-fugitive'
Plugin 'tpope/vim-surround'
Plugin 'tpope/vim-commentary' " gc to comment out
Plugin 'pangloss/vim-javascript'
Plugin 'ctrlpvim/ctrlp.vim'
let g:ctrlp_working_path_mode = 0 " make ctrlp work from current dir
Plugin 'vim-airline/vim-airline'
Plugin 'vim-airline/vim-airline-themes'
Plugin 'luochen1990/rainbow'
Plugin 'kana/vim-textobj-user'
Plugin 'kana/vim-textobj-line'
Plugin 'kana/vim-textobj-entire'
Plugin 'szw/vim-g'
Plugin 'jiangmiao/auto-pairs'
Plugin 'fatih/vim-go' " golang development 
Plugin 'jamesroutley/vim-logbook'
Plugin 'sheerun/vim-polyglot'   " syntax highlighting in most languages
Plugin 'joshdick/onedark.vim'   " Atom-style dark theme

" All of your Plugins must be added before the following line
call vundle#end()
filetype plugin indent on

" --------------------------------
" Pretty things
" --------------------------------
syntax on
colorscheme onedark

" Set Airline bar theme
let g:airline_theme='bubblegum'

"rainbow Plugin Options (luochen1990/rainbow)
let g:rainbow_active = 1    " 0 if you want to enable it later via :RainbowToggle

" Colour at column 80
set colorcolumn=80

" --------------------------------
" Basic stuff
" --------------------------------
let g:mapleader = " " " Set leader to spacebar 
set spelllang=en_gb
set backspace=indent,eol,start " Bring backspace to life
set number          " Line numbers
set relativenumber  " Relative line numbers
set hlsearch        " Highlight whole word when searching
set ignorecase      " Ignore case when searching...
set smartcase       " ...except when serach query contains a capital letter
set autoread        " Auto load files if they change on disc
map <Leader>p :set paste<CR><esc>"*]p:set nopaste<cr>
map <Leader>y "*y  )
map <Leader><Leader> :w<CR>
inoremap jj <ESC>:w<CR>
     
" Pasting - indent last pasted
nnoremap gz '[='] 

" Disable highlight when <leader><cr> is pressed
map <silent> <leader><ESC> :noh<cr>

"Cursor
if exists('$TMUX')
  let &t_SI = "\<Esc>Ptmux;\<Esc>\<Esc>]50;CursorShape=1\x7\<Esc>\\"
  let &t_EI = "\<Esc>Ptmux;\<Esc>\<Esc>]50;CursorShape=0\x7\<Esc>\\"
else
  let &t_SI = "\<Esc>]50;CursorShape=1\x7"
  let &t_EI = "\<Esc>]50;CursorShape=0\x7"
endif

" Open current file in a new vertical split with '='
nnoremap = :vsplit<cr>

" Easy split navigation
map <C-j> <C-w>j
map <C-k> <C-W>k
map <C-h> <C-W>h
map <C-l> <C-W>l

" Simplify using tabs
nnoremap ˙ gT
nnoremap ¬ gt
nnoremap T :tabnew<cr>

" Open new splits to right and bottom 
set splitbelow
set splitright

"Tab completion
set wildmenu
set wildmode=list:longest,list:full
function! InsertTabWrapper()
  let col = col('.') - 1
  if !col || getline('.')[col - 1] !~ '\k'
    return "\<tab>"
  else
    return "\<c-p>"
  endif
    endfunction
inoremap <Tab> <c-r>=InsertTabWrapper()<cr>
inoremap <S-Tab> <c-n>

" Tab size
set tabstop=2
set softtabstop=2
set shiftwidth=2
set expandtab

" Disable swap files
set noswapfile

" Disable arrow keys in Escape mode
map <up> <nop>
map <down> <nop>
map <left> <nop>
map <right> <nop>

This is my .vimrc file, and should be a good solid configuration to get started with. Feel free to mess around with it as you learn more.

Save your .vimrc by typing :w (I think of this as “write”) and hitting return, then load the new config with the command :so %.

Next, you’ll want to install all of the plugins listed toward the top of my .vimrc. You can do this by running:PluginInstall.

After you hit return, something like the following should happen (except with fewer Plugins):

Now, :so % once more to load your brand new configuration. You’ll notice my color scheme load up (it’s similar to Atom’s). You’ve now got a legit Vim config 👊

(If you ever get any scary screens on Vim, :q! is quit without saving)

Celebrate

You just made Vim much less scary, have a sexy color scheme, and the ability to install all the plugins your heart desires.

When you’re ready, you can hunt for some more plugins over at Vim Awesome and Vim.org.

If you read past the tapir, chances are you read the whole thing. If it was helpful, give us a few claps. It’ll help others find this and benefit from it too.