Home » Posts tagged "NERD"

Vim essentials: NERD Commenter

Another great Vim plugin I use is NERD Commenter. Using this plugin makes it easy to comment out lines of code with just a few keystrokes. By pressing <leader>cc or <leader>c<space> you can comment out your selection using a single comment character per line. With <leader>cm you can comment your selection with one set of multipart delimiters, though your programming language has to support those. Repeat the commands to uncomment your code again. These commands work on single lines as well as on multiple lines which you’ve selected in visual mode (e.g. ranges).

In some cases it can happen that NERD Commenter doesn’t know which comment characters to use which causes it to use comment characters your language doesn’t or may not support. So far this only seems to happen when the filetype can’t be determined by Vim. This can be annoying at times, but I can live with it.

All NERD Commenter commands

For completeness I’ve copied the full command set from its README below. Personally I only use the ones I mentioned earlier. Though I think I’ll go and try to memorize the NERDComYankComment function since that particular case can pop up quite a lot when programming.

[count]<leader>cc |NERDComComment|
Comment out the current line or text selected in visual mode.

[count]<leader>cn |NERDComNestedComment|
Same as <leader>cc but forces nesting.

[count]<leader>c |NERDComToggleComment|
Toggles the comment state of the selected line(s). If the topmost selected line is commented, all selected lines are uncommented and vice versa.

[count]<leader>cm |NERDComMinimalComment|
Comments the given lines using only one set of multipart delimiters.

[count]<leader>ci |NERDComInvertComment|
Toggles the comment state of the selected line(s) individually.

[count]<leader>cs |NERDComSexyComment|
Comments out the selected lines “sexily”

[count]<leader>cy |NERDComYankComment|
Same as <leader>cc except that the commented line(s) are yanked first.

<leader>c$ |NERDComEOLComment|
Comments the current line from the cursor to the end of line.

<leader>cA |NERDComAppendComment|
Adds comment delimiters to the end of line and goes into insert mode between them.

|NERDComInsertComment|
Adds comment delimiters at the current cursor position and inserts between. Disabled by default.

<leader>ca |NERDComAltDelim|
Switches to the alternative set of delimiters.

[count]<leader>cl
[count]<leader>cb |NERDComAlignedComment|
Same as |NERDComComment| except that the delimiters are aligned down the left side (<leader>cl) or both sides (<leader>cb).

[count]<leader>cu |NERDComUncommentLine|
Uncomments the selected line(s).

Vim essentials: NERD tree

nerdtreeSo you started using Vim and were a bit disappointed with the lack of a proper tree-style directory explorer? Meet NERD tree (also on GitHub). With NERD tree you can navigate through your folders and files.

You can choose to always display the sidebar (put let NERDTreeShowBookmarks=1 in your .gvimrc) or use its toggle function NERDTreeToggle, which I’ve got mapped at \\ with map \\ :NERDTreeToggle. If you don’t like to have the tree on the left side you can change it from left to right with let g:NERDTreeWinPos = "right".

NERD tree has lots of shortcuts to improve and speed up navigation. You can always request an overview of these shortcuts with shift + ? when in the tree window. Some useful shortcuts are:

  • shift + i to list hidden files.
  • s to vsplit the current window and open the selected file.
  • i to split the current window and open the selected file.
  • t to open file in new tab.
  • m to modify the file/directory to rename, move, delete or create a file/directory.
  • shift + c to move into the selected directory.
  • u to move back one level in the directory tree.
  • x to close the opened directory tree in which you’re in.
  • return to open a directory or file.
  • j and k or the cursor keys to move up and down in the list.

There are a lot more shortcuts, all explained by opening the help with shift + ? and it might seem a bit much to memorize all these shortcuts but it’s not that bad really. Using just the return and cursor keys is enough to navigate and open files, but it really pays of to get to learn the other shortcuts.

Another neat thing of NERD tree is that it supports Bookmarks. To be able to store your bookmarks you need to specify a location where the bookmarks are stored. Generally you do this in your .gvimrc file.

" Store the bookmarks file
let NERDTreeBookmarksFile=expand("$HOME/.vim-NERDTreeBookmarks")
" Show the bookmarks table on startup
let NERDTreeShowBookmarks=1

To create a bookmark navigate your cursor to the directory you want to bookmark and use the command Bookmark <name> to create a named bookmark. You can later use this bookmark with NERDTreeFromBookmark <name>.