How To Easily Align Your Code in Vim

Aligning code, in general, does not provide any value. It's just to make code look more beautiful and easier to read.

Meet Vim Easy Align.

It's similar to better align if you've used vscode.

Installation & Configuration

You can install using your favorite plugin manager.
Using vim-plug

Plug 'junegunn/vim-easy-align'

.vimrc

xmap ga <Plug>(EasyAlign)
nmap ga <Plug>(EasyAlign)

Feel free to change the default mapping

ga

nmap

xmap

Usage

There are multiple ways to use the plugin. I found the following to be the easiest.

1. Align code in the current block

While in normal mode type

gaip=

Explanation: Start the EasyAlign command (

ga

i

p

=

Note: don't forget to press enter to execute the command.

2. Align currently selected code

Assuming that you have something selected while in visual mode.
Type

ga=

Explanation: Start the EasyAlign command (

ga

=

Options

1. Regular expressions

You can use regular expressions to align anything you want. The only limit is your imagination.

Let's say for example you want to align javascript module imports around the

from

You would use the command

ga<Ctrl-x>from

And once again

ga

After that, press

Ctrl-x

regular expression

Lastly you can enter whatever you want to align your code around (in this case it's

from

2. Align modes

Normally each character has it's own align mode (left or right).

So, for example,

=

:

But we can change that by using the arrow keys on the keyboard.

Note: I'll be referring to the right & left arrow keys in commands as

->

<-

Example:

ga->:

ga:

<-

3. Live Interactive Mode

Live interactive mode allows you to see your changes as you type the command.

To use the live interactive mode you can use the command

:LiveEasyAlign

Or you could add the following to your

.vimrc

" Change <iga> to whatever you like
nmap iga <Plug>(LiveEasyAlign)
xmap iga <Plug>(LiveEasyAlign)

Conclusion

Obviously the plugin contains more options than I could explain in 20 pages.

This article is supposed to be beginner friendly and introduce the basic options.

References

• Vim Easy Align https://github.com/junegunn/vim-easy-align
• Vim Plug https://github.com/junegunn/vim-plug