How to quickly change variable names in Vim?

vim variables refactoring
Aditya Mukherji picture Aditya Mukherji · Feb 28, 2009 · Viewed 34.8k times · Source

I am using Vim to read through a lot of C and Perl code containing many single letter variable names.

It would be nice to have some command to change the name of a variable to something more meaningful while I’m in the process of reading the code, so that I could read the rest of it faster.

Is there some command in Vim which could let me do this quickly?

I don’t think regexes would work because:

  1. the same single letter name might have different purposes in different scoping blocks; and

  2. the same combination of letters could be part of another longer variable name, a string literal, or a comment.

Are there any known solutions?

Answer

Mykola Golubyev picture Mykola Golubyev · Feb 28, 2009

The following is how to rename a variable which is defined in the current scope {}.

Move your cursor to the variable usage. Press gd. Which means - move cursor to the definition. Now Press [{ - this will bring you to the scope begin. Press V - will turn on Visual Line selection. Press % - will jump to the opposite } thus will select the whole scope. Press :s/ - start of the substitute command. <C-R>/ - will insert pattern that match variable name (that name you were on before pressing gd). /newname/gc<CR> - will initiate search and replace with confirmation on every match.

Now you have to record a macros or even better - map a key.

Here are the final mappings:

" For local replace
nnoremap gr gd[{V%::s/<C-R>///gc<left><left><left>

" For global replace
nnoremap gR gD:%s/<C-R>///gc<left><left><left>

Put this to your .vimrc or just execute. After this pressing gr on the local variable will bring you to :s command where you simply should enter new_variable_name and press Enter.

Related questions

How do I inspect Vim variables?

In .vimrc, there are several lines that look like: let g:SuperTabDefaultCompletionType="<c-x><c-o>" How do I inspect them inside Vim? Something to this effect: :echom &g:SuperTabDefaultCompletionType But that command results in an error: …

Read More
How do I exit the Vim editor?

I'm stuck and cannot escape. It says: "type :quit<Enter> to quit VIM" But when I type that it simply appears in the object body.

Read More
How do I make Git use the editor of my choice for commits?

I would prefer to write my commit messages in Vim, but it is opening them in Emacs. How do I configure Git to always use Vim? Note that I want to do this globally, not just for a single project.

Read More