Vim Tips

I collected some tips on vim that I find helpful. If you are new to vim, please try out the command vimtutor on any machine where vim is installed, and check out the nice article Learn vim Progressively.

1. Useful Configuration

You can configure your vim by putting your configuration options and scripts in the ~/.vimrc file (a hidden file named .vimrc in your home directory). This file will be loaded whenever you start vim.

You can copy a sample .vimrc file from ~cs1010/.vimrc to your home directory. You can edit this file ~/.vimrc just like any other file, using vim.

Help

In vim, the command :help <topic> shows help about a particular topic in vim. Example, :help backup.

Backup Files

You can ask vim to automatically backup files that you edit. This has been a lifesaver for me on multiple occasions.

In your ~/.vimrc file,

set backup

will cause a copy of your file to be saved with suffix ~ appended to its name every time you save.

I prefer not to clutter my working directory, so I set

set backupdir=~/.backup

and create a directory named ~/.backup to store my backup files.

So if you made changes to a file that you regretted, or if you accidentally deleted a file, you can check under ~/.backup to see if the backup can save you.

Syntax Highlighting

If for some reasons, syntax highlighting is not on by default, add this to your ~/.vimrc:

syntax on

Ruler and Numbers

If you prefer to show the line number you are on and the column number you are on, adding the commands to ~/.vimrc

set ruler

will display the line number and the column number on the lower right corner.

You can also add

set number

to label each line with a line number.

Auto Indentation

Proper indentation is important to make your code readable (to yourself and others). You should enable this in vim with:

set autoindent
set smartindent

Autoindent will cause the next line to have the same indentation as the previous line; while smartindent has some understanding of C-like syntax (such as recognizing { and }) and indent your code accordingly. The size of the indentation is based on the setting shiftwidth. For CS1010, please set it to either 2 or 4:

set shiftwidth=2

2. Navigation

Basic Navigation

Use K and J keys to move up and down (just like Gmail and Facebook!). H and L to move left and right.

Other shortcuts (no need to memorize them now, just refer back when you feel like you are typing too many HJKL to see how you can navigate faster).

• W jump to the beginning of the next word
• B ump to the beginning of the previous word (reverse of w)
• E jump to the end of the word (or next word when pressed again)
• F char: search forward in the line and sit on the next matching char
• T char: search forward in the line and sit on one space before the matching char
• Shift+4 ($) jump to the end of line
• 0 jump to the beginning of the line
• Shift+6 (^) jump to the first non-blank character of the line
• Shift+5 (%) jump between matching parentheses
• Ctrl+D jump forward (Down) half page
• Ctrl+F jump Forward one page
• Ctrl+U jump backward (Up) half page
• Ctrl+B jump Backward half page

Jumping to a Line

If the compiler tells you there is an error on Line \(x\), you can issue :<x> to jump to Line \(x\). For instance, :40 will go to Line 40.

3. Editing Operations

Undo

Since we are on the topic of correcting mistakes, U in command mode undo your changes. Prefix it with a number \(n\) to undo \(n\) times. If you want to undo your undo, Ctrl+R will redo.

Navigation + Editing

vim is powerful because you can combine operations with navigation. For instance C to change, D to delete, Y to yank (copy). Since W is the navigation command to move over the current word, combining them we get:

• CW change the current word (delete the current word and enter insert mode)
• DW delete the current word
• YW yank the current word (copy word into buffer)

Can you guess what each of these do:

• DFShift+0
• DFShift+0
• CShift+4
• Y0

If you repeat the operation C, D, and Y, it applies to the whole line, so:

• CC change the whole line
• DD delete the whole line
• YY yank the whole line

You can add a number before an operation to specify how many times you want to repeat an operation. So 5DD deletes 5 lines, 5DW deletes 5 words, etc.

See the article Operator, the True Power of Vim for more details.

Swapping Lines

Sometimes you want to swap the order of two lines of code, in command mode, DDP will do the trick. DD deletes the current line, P paste it after the current line, in effect swapping the order of the two lines.

Commenting blocks of code

Sometimes we need to comment out a whole block of code in C for testing purposes. There are several ways to do it in vim:

• Place the cursor on the first line of the block of code you want to comment on.
• 0 to jump to the beginning of the line
• Shift+V enter visual mode
• Use the arrow key to select the block of code you want to comment on.
• Shift+I to insert at the beginning of the line (here, since we already selected the block, we will insert at the beginning of every selected)
• // to insert the C comment character (you will see it inserted in the current line, but don't worry)
• Esc to escape from the visual code.

To uncomment,

• Place the cursor on the first line of the block of code you want to comment.
• 0 to jump to the beginning of the line
• Ctrl+V enter block visual mode
• Use the arrow key to select the columns of text containing //
• X to delete them

4. Other Advanced Features

Search and Replace in vim

:%s/oldWord/newWord/gc

: enters the command mode. % means apply to the whole document, s means substitute, g means global (otherwise, only the first occurrence of each line is replaced). c is optional -- adding it cause vim to confirm with you before each replacement

Shell Command

If you need to issue a shell command quickly, you don't have to exit vim, run the command, and launch vim again. You can use !,

:!<command>

will issue the command to shell. E.g.,

:!ls

You can use this to compile your current file, without exiting vim.

:!make

make is actually a builtin command for vim so you can also simply run

:make

Abbreviation

You can use the command ab to abbreviate frequently typed commands. E.g., in your ~/.vimrc,

ab pl cs1010_print_long(

Now, when you type pl, it will be expanded into cs1010_print_long(

Auto-Completion

You can use Ctrl+P or Ctrl+N to auto-complete. By default, the autocomplete dictionary is based on the text in your current editing buffers. This is a very useful keystroke saver for long function and variable names.

Auto-Indent the Whole File

You can GG=Shift+G in command mode to auto-indent the whole file. GG is the command to go to the beginning of the file. = is the command to indent. Shift+G is the command to go to the end of the file.

Splitting vim's Viewport

• :sp file.c splits the vim window horizontally
• :vsp file.c splits the vim window vertically
• Ctrl+WCtrl+W moves between the different vim viewports

5. Plugins

Syntax and Style Checker

I use syntastic to check for style and syntax whenever I save a file. syntastic is a vim plugin.

My .vimrc configuration file contains the following:

"For syntastic
set laststatus=2
set statusline+=%#warningmsg#
set statusline+=%{SyntasticStatuslineFlag()}
set statusline+=%*

let g:syntastic_error_symbol = '✗'
let g:syntastic_warning_symbol = '⚠'
let g:syntastic_always_populate_loc_list = 1
let g:syntastic_auto_loc_list = 1
let g:syntastic_check_on_open = 1
let g:syntastic_check_on_wq = 0

let g:syntastic_c_checkers = [ 'clang_tidy', 'clang' ]
let g:syntastic_c_compiler = 'clang'
let g:syntastic_c_clang_args = '-Wall -Werror -Wextra -Iinclude'
let g:syntastic_c_clang_tidy_args = '-checks=*'
let g:syntastic_c_compiler_options = '-Wall -Iinclude'
let g:syntastic_c_include_dirs = [ '../include', 'include' ]
let g:syntastic_c_clang_tidy_post_args = ""

By default, clang-tidy does not know where to find the header files. So if you include non-standard C headers, it will complain that it cannot find headers. To resolve this, we need to tell clang-tidy the compilation flags that we use when compiling our program.

We can do this by creating a file named compile_flags.txt in your working directory (where your C files are located), containing one compilation flag per line. For instance, if the header files are located in /home/course/cs1010/include, your compile_flags.txt should contain the following two lines:

-Wall
-I/home/course/cs1010/include