m-vim_plugins/vim-easy-align
1
0
Fork 0
mirror of https://github.com/junegunn/vim-easy-align.git synced 2025-11-14 04:43:48 -05:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update documentation

Browse Source
This commit is contained in:
Junegunn Choi
2013-08-19 04:06:36 +09:00
parent 5222db47cf
commit beb986ebc3
2 changed files with 136 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

68
README.md
View File

@@ -205,6 +205,7 @@ lowest precedence.
| `ignores` | list | ['String', 'Comment'] | Delimiters in these syntax highlight groups are ignored |
| `indentation` | string | `k` | Indentation method (*k*eep, *d*eep, *s*hallow, *n*one) |
| `delimiter_align` | string | `r` | Determines how to align delimiters of different lengths |
| `mode_sequence` | string | | Alignment modes for multiple occurrences of delimiters |
Some of the options can be specified using corresponding global variables.
@@ -409,6 +410,73 @@ eggplant = 5
Notice that `idt` is fuzzy-matched to `indentation`.
### Left/right/center mode transition in interactive mode
In interactive mode, you can choose the alignment mode you want by pressing
enter keys. When started with the non-bang command (`:EasyAlign`), it will
start in left-align mode, and as you press enter keys, it will change to
right-align mode, then to center-align mode, and then to left mode again.
(`['l', 'r', 'c']`)
With the bang-command (`:EasyAlign!`), it will start in right-align mode,
then goes to left and center mode. (`['r', 'l', 'c']`)
If you don't prefer this default mode transition, you can define your own
settings as follows.
```vim
let g:easy_align_interactive_modes = ['l', 'r']
let g:easy_align_bang_interactive_modes = ['c', 'r']
```
### Alignments over multiple occurrences of delimiters
As we have seen before, the field number allows you to target specific
occurrences of delimiters when the lines contains multiple delimiter.
To recap:
```vim
" Left-alignment around the FIRST occurrences of delimiters
:EasyAlign =
" Left-alignment around the SECOND occurrences of delimiters
:EasyAlign 2=
" Left-alignment around the LAST occurrences of delimiters
:EasyAlign -=
" Left-alignment around ALL occurrences of delimiters
:EasyAlign *=
" Left-right ALTERNATING alignment around all occurrences of delimiters
:EasyAlign **=
" Right-left ALTERNATING alignment around all occurrences of delimiters
:EasyAlign! **=
```
In addition to these, with `mode_sequence` option, you can perform alignments
over multiple occurrences of the delimiters.
```vim
" Left alignment over the first two occurrences of delimiters
:EasyAlign = { 'mode_sequence': 'll' }
" Right, left, center alignment over the 1st to 3rd occurrences of delimiters
:EasyAlign = { 'm': 'rlc' }
" Right, left, center alignment over the 2nd to 4th occurrences of delimiters
:EasyAlign 2={ 'm': 'rlc' }
" (*) Repeating alignments (default: l, r, or c)
" Right, left, center, center, center, center, ...
:EasyAlign *={ 'm': 'rlc' }
" (**) Alternating alignments (default: lr or rl)
" Right, left, center, right, left, center, ...
:EasyAlign **={ 'm': 'rlc' }
```
### Extending alignment rules
Although the default rules should cover the most of the use cases,

68
doc/easy_align.txt
View File

@@ -312,9 +312,77 @@ But then again we have 'indentation' option. See the following example.
daisy = 4
eggplant = 5
Notice that 'idt' is fuzzy-matched to 'indentation'.
Left/right/center mode transition in interactive mode
-------------------------------------------------------------------------
*g:easy_align_interactive_modes*
*g:easy_align_bang_interactive_modes*
In interactive mode, you can choose the alignment mode you want by pressing
enter keys. When started with the non-bang command (`:EasyAlign`), it will
start in left-align mode, and as you press enter keys, it will change to
right-align mode, then to center-align mode, and then to left mode again.
(['l', 'r', 'c'])
With the bang-command (`:EasyAlign!`), it will start in right-align mode,
then goes to left and center mode. (['r', 'l', 'c'])
If you don't prefer this default mode transition, you can define your own
settings as follows.
let g:easy_align_interactive_modes = ['l', 'r']
let g:easy_align_bang_interactive_modes = ['c', 'r']
Alignments over multiple occurrences of delimiters
-------------------------------------------------------------------------
As we have seen before, the field number allows you to target specific
occurrences of delimiters when the lines contains multiple delimiter.
To recap:
" Left-alignment around the FIRST occurrences of delimiters
:EasyAlign =
" Left-alignment around the SECOND occurrences of delimiters
:EasyAlign 2=
" Left-alignment around the LAST occurrences of delimiters
:EasyAlign -=
" Left-alignment around ALL occurrences of delimiters
:EasyAlign *=
" Left-right ALTERNATING alignment around all occurrences of delimiters
:EasyAlign **=
" Right-left ALTERNATING alignment around all occurrences of delimiters
:EasyAlign! **=
In addition to these, with 'mode_sequence' option, you can perform alignments
over multiple occurrences of the delimiters.
" Left alignment over the first two occurrences of delimiters
:EasyAlign = { 'mode_sequence': 'll' }
" Right, left, center alignment over the 1st to 3rd occurrences of delimiters
:EasyAlign = { 'm': 'rlc' }
" Right, left, center alignment over the 2nd to 4th occurrences of delimiters
:EasyAlign 2={ 'm': 'rlc' }
" (*) Repeating alignments (default: l, r, or c)
" Right, left, center, center, center, center, ...
:EasyAlign *={ 'm': 'rlc' }
" (**) Alternating alignments (default: lr or rl)
" Right, left, center, right, left, center, ...
:EasyAlign **={ 'm': 'rlc' }
Extending alignment rules *g:easy_align_delimiters*
-------------------------------------------------------------------------