mirror of
https://github.com/junegunn/vim-easy-align.git
synced 2025-11-13 04:13:48 -05:00
251 lines
7.0 KiB
Markdown
251 lines
7.0 KiB
Markdown
vim-easy-align
|
|
==============
|
|
|
|
A simple, easy-to-use Vim alignment plugin without too much ambition.
|
|
|
|
Features:
|
|
|
|
- Optimized for code editing
|
|
- Extensible alignment rules
|
|
- Aligns text around either _all or n-th_ appearance(s) of the delimiter
|
|
- Ignores comment lines
|
|
- Ignores lines without a matching delimiter
|
|
|
|
Demo
|
|
----
|
|
|
|
|
|
|
|
[Screencast](https://vimeo.com/63506219)
|
|
|
|
Installation
|
|
------------
|
|
|
|
Either [download zip file](http://www.vim.org/scripts/script.php?script_id=4520)
|
|
and extract in ~/.vim or use [Vundle](https://github.com/gmarik/vundle) (recommended)
|
|
or [Pathogen](https://github.com/tpope/vim-pathogen).
|
|
|
|
### With Vundle
|
|
|
|
```vim
|
|
Bundle 'junegunn/vim-easy-align'
|
|
```
|
|
|
|
Usage
|
|
-----
|
|
|
|
_vim-easy-align_ defines interactive `:EasyAlign` command in the visual mode.
|
|
For convenience, it is advised that you define a mapping for triggering it in your `.vimrc`.
|
|
|
|
```vim
|
|
vnoremap <silent> <Enter> :EasyAlign<cr>
|
|
```
|
|
|
|
With the mapping, you can align selected lines with a few keystrokes.
|
|
|
|
1. `<Enter>` key to start interactive EasyAlign command
|
|
1. Optional Enter keys to toggle right-justification mode
|
|
1. Optional field number (default: 1)
|
|
- `1` Alignment around 1st delimiters
|
|
- `2` Alignment around 2nd delimiters
|
|
- ...
|
|
- `*` Alignment around all delimiters (recursive)
|
|
- `-` Alignment around the last delimiters (`-1`)
|
|
- `-2` Alignment around the one before the last delimiters
|
|
- ...
|
|
1. Delimiter (`<space>`, `=`, `:`, `.`, `|`, `,`, `}`)
|
|
|
|
Alignment rules for the following delimiters have been defined to meet the most needs.
|
|
|
|
| Delimiter | Description/Use cases |
|
|
| --------- | ---------------------------------------------------------- |
|
|
| `<space>` | General alignment around spaces |
|
|
| `=` | Operators containing equals sign (=, ==, !=, +=, &&=, ...) |
|
|
| `:` | Suitable for formatting JSON or YAML |
|
|
| `.` | Multi-line method chaining |
|
|
| `,` | Multi-line method arguments |
|
|
| `}` | Closing braces (Try using it with a negative field number) |
|
|
| | | Table markdown |
|
|
|
|
### Example command sequences
|
|
|
|
| With visual map | Description | Equivalent command |
|
|
| ----------------- | ------------------------------------------------- | ----------------------- |
|
|
| `<Enter>=` | Alignment around 1st equals signs (and the likes) | `:'<,'>EasyAlign=` |
|
|
| `<Enter>2=` | Alignment around 2nd equals signs (and the likes) | `:'<,'>EasyAlign2=` |
|
|
| `<Enter>3=` | Alignment around 3rd equals signs (and the likes) | `:'<,'>EasyAlign3=` |
|
|
| `<Enter>*=` | Alignment around all equals signs (and the likes) | `:'<,'>EasyAlign*=` |
|
|
| `<Enter><Enter>=` | Right-justified alignment around 1st equals signs | `:'<,'>EasyAlignRight=` |
|
|
| `<Enter><space>` | Alignment around 1st whitespaces | `:'<,'>EasyAlign\ ` |
|
|
| `<Enter>2<space>` | Alignment around 2nd whitespaces | `:'<,'>EasyAlign2\ ` |
|
|
| `<Enter>-<space>` | Alignment around the last whitespaces | `:'<,'>EasyAlign-\ ` |
|
|
| `<Enter>:` | Alignment around 1st colon | `:'<,'>EasyAlign:` |
|
|
| `<Enter>-}` | Alignment around the last closing braces | `:'<,'>EasyAlign-}` |
|
|
| ... | ... | |
|
|
|
|
### Partial alignment in blockwise-visual mode
|
|
|
|
In blockwise-visual mode (`CTRL-V`), EasyAlign command aligns only the selected
|
|
text in the block, instead of the whole lines in the range.
|
|
|
|
Consider the following case where you want to align text around `=>` operators.
|
|
|
|
```ruby
|
|
my_hash = { :a => 1,
|
|
:aa => 2,
|
|
:aaa => 3 }
|
|
```
|
|
|
|
In non-blockwise visual mode (`v` / `V`), `<Enter>=` won't work since the assignment
|
|
operator in the first line gets in the way.
|
|
So we instead enter blockwise-visual mode (`CTRL-V`), and select the text *around*
|
|
`=>` operators, then press `<Enter>=`.
|
|
|
|
```ruby
|
|
my_hash = { :a => 1,
|
|
:aa => 2,
|
|
:aaa => 3 }
|
|
```
|
|
|
|
However, in this case, we don't really need blockwise visual mode
|
|
since the same can be easily done using the negative field number: `<Enter>-=`
|
|
|
|
Options
|
|
-------
|
|
|
|
| Option | Type | Default | Description |
|
|
| ----------------------------- | ---------- | ------- | --------------------------------------- |
|
|
| g:easy_align_ignore_comment | boolean | `1` | Ignore comment lines |
|
|
| g:easy_align_ignore_unmatched | boolean | `1` | Ignore lines without matching delimiter |
|
|
| g:easy_align_delimiters | dictionary | `{}` | Extend or override alignment rules |
|
|
|
|
### Ignoring comment lines
|
|
|
|
EasyAlign by default ignores comment lines.
|
|
|
|
For example,
|
|
|
|
```ruby
|
|
{
|
|
# Quantity of apples: 1
|
|
apple: 1,
|
|
# Quantity of bananas: 2
|
|
bananas: 2,
|
|
# Quantity of grapefruits: 3
|
|
grapefruits: 3
|
|
}
|
|
```
|
|
|
|
becomes
|
|
|
|
```ruby
|
|
{
|
|
# Quantity of apples: 1
|
|
apple: 1,
|
|
# Quantity of bananas: 2
|
|
bananas: 2,
|
|
# Quantity of grapefruits: 3
|
|
grapefruits: 3
|
|
}
|
|
```
|
|
|
|
Since finding comment lines is done heuristically using syntax highlighting feature,
|
|
this only works when syntax highlighting is enabled.
|
|
|
|
If you do not want comment lines to be ignored, you can unset `g:easy_align_ignore_comment` as follows.
|
|
|
|
```vim
|
|
let g:easy_align_ignore_comment = 0
|
|
```
|
|
|
|
Then you get,
|
|
|
|
```ruby
|
|
{
|
|
# Quantity of apples: 1
|
|
apple: 1,
|
|
# Quantity of bananas: 2
|
|
bananas: 2,
|
|
# Quantity of grapefruits: 3
|
|
grapefruits: 3
|
|
}
|
|
```
|
|
|
|
### Ignoring unmatched lines
|
|
|
|
Lines without a matching delimiter are ignored as well (except in right-justification mode).
|
|
|
|
For example, when aligning the following code block around the colons,
|
|
|
|
```ruby
|
|
{
|
|
apple: proc {
|
|
this_line_does_not_have_a_colon
|
|
},
|
|
bananas: 2,
|
|
grapefruits: 3
|
|
}
|
|
```
|
|
|
|
this is usually what we want.
|
|
|
|
```ruby
|
|
{
|
|
apple: proc {
|
|
this_line_does_not_have_a_colon
|
|
},
|
|
bananas: 2,
|
|
grapefruits: 3
|
|
}
|
|
```
|
|
|
|
However, this default behavior is also configurable.
|
|
|
|
```vim
|
|
let g:easy_align_ignore_unmatched = 0
|
|
```
|
|
|
|
Then we get,
|
|
|
|
```ruby
|
|
{
|
|
apple: proc {
|
|
this_line_does_not_have_a_colon
|
|
},
|
|
bananas: 2,
|
|
grapefruits: 3
|
|
}
|
|
```
|
|
|
|
### Extending alignment rules
|
|
|
|
```vim
|
|
let g:easy_align_delimiters = {
|
|
\ '>': { 'pattern': '>>\|=>\|>' },
|
|
\ '/': { 'pattern': '//\+' },
|
|
\ '#': { 'pattern': '#\+' },
|
|
\ ']': {
|
|
\ 'pattern': '[\[\]]',
|
|
\ 'margin_left': '',
|
|
\ 'margin_right': '',
|
|
\ 'stick_to_left': 0
|
|
\ },
|
|
\ ')': {
|
|
\ 'pattern': '[()]',
|
|
\ 'margin_left': '',
|
|
\ 'margin_right': '',
|
|
\ 'stick_to_left': 0
|
|
\ }
|
|
\ }
|
|
```
|
|
|
|
Author
|
|
------
|
|
|
|
[Junegunn Choi](https://github.com/junegunn)
|
|
|
|
License
|
|
-------
|
|
|
|
MIT
|