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

Update doc

Browse Source
This commit is contained in:
Junegunn Choi
2013-08-07 00:30:34 +09:00
parent 1cf343a271
commit edba1827ed
2 changed files with 50 additions and 34 deletions
Download Patch File Download Diff File Expand all files Collapse all files

27
README.md
View File

@@ -54,7 +54,7 @@ your `.vimrc`.
vnoremap <silent> <Enter> :EasyAlign<cr> vnoremap <silent> <Enter> :EasyAlign<cr>
``` ```
With the mapping, you can align selected lines with a few keystrokes. With the mapping, you can align selected lines of text with a few keystrokes.
1. `<Enter>` key to start interactive EasyAlign command 1. `<Enter>` key to start interactive EasyAlign command
1. Optional Enter keys to toggle right-justification mode 1. Optional Enter keys to toggle right-justification mode
@@ -71,14 +71,14 @@ With the mapping, you can align selected lines with a few keystrokes.
Alignment rules for the following delimiters have been defined to meet the most needs. Alignment rules for the following delimiters have been defined to meet the most needs.
| Delimiter key | Description/Use cases | | Delimiter key | Description/Use cases |
| ------------- | ---------------------------------------------------------- | | ------------- | -------------------------------------------------------------------- |
| `<space>` | General alignment around spaces | | `<space>` | General alignment around whitespaces |
| `=` | Operators containing equals sign (=, ==, !=, +=, &&=, ...) | | `=` | Operators containing equals sign (`=`, `==,` `!=`, `+=`, `&&=`, ...) |
| `:` | Suitable for formatting JSON or YAML | | `:` | Suitable for formatting JSON or YAML |
| `.` | Multi-line method chaining | | `.` | Multi-line method chaining |
| `,` | Multi-line method arguments | | `,` | Multi-line method arguments |
| &#124; | Table markdown | | &#124; | Table markdown |
#### Example command sequences #### Example command sequences
@@ -142,7 +142,7 @@ You can even omit spaces between the arguments, so concisely (or cryptically):
- `:EasyAlign*/[:;]\+/{'s':1,'l':0}` - `:EasyAlign*/[:;]\+/{'s':1,'l':0}`
Available options for each alignment are as follows. Available options are as follows.
| Atrribute | Type | Default | | Atrribute | Type | Default |
| ---------------- | ---------------- | ----------------------- | | ---------------- | ---------------- | ----------------------- |
@@ -239,7 +239,7 @@ array,
let g:easy_align_ignores = [] let g:easy_align_ignores = []
``` ```
or providing `ignores` option to :EasyAlign command or providing `ignores` option directly to `:EasyAlign` command
```vim ```vim
:EasyAlign:{'is':[]} :EasyAlign:{'is':[]}
@@ -291,14 +291,14 @@ this is usually what we want.
However, this default behavior is also configurable. However, this default behavior is also configurable.
One way is to set the global `g:easy_align_ignore_unmatched` variable to be 0. One way is to set the global `g:easy_align_ignore_unmatched` variable to 0.
```vim ```vim
let g:easy_align_ignore_unmatched = 0 let g:easy_align_ignore_unmatched = 0
``` ```
Or in non-interactive mode, you can provide `ignore_unmatched` option to Or in non-interactive mode, you can provide `ignore_unmatched` option to
:EasyAlign command `:EasyAlign` command as follows.
```vim ```vim
:EasyAlign:{'iu':0} :EasyAlign:{'iu':0}
@@ -324,7 +324,6 @@ you can extend the rules by setting a dictionary named `g:easy_align_delimiters`
#### Example #### Example
```vim ```vim
" Examples
let g:easy_align_delimiters = { let g:easy_align_delimiters = {
\ '>': { 'pattern': '>>\|=>\|>' }, \ '>': { 'pattern': '>>\|=>\|>' },
\ '/': { 'pattern': '//\+\|/\*\|\*/', 'ignores': ['String'] }, \ '/': { 'pattern': '//\+\|/\*\|\*/', 'ignores': ['String'] },

57
doc/easy_align.txt
View File

@@ -7,10 +7,11 @@ A simple, easy-to-use Vim alignment plugin without too much ambition.
Source: https://github.com/junegunn/vim-easy-align Source: https://github.com/junegunn/vim-easy-align
EasyAlign *:EasyAlign* EasyAlign *:EasyAlign* *:EasyAlign!*
------------------------------------------------------------------------- -------------------------------------------------------------------------
vim-easy-align defines `:EasyAlign` command in the visual mode. vim-easy-align defines `:EasyAlign` command in the visual mode.
(:EasyAlign! is the right-justification version.)
| Mode | Command | | Mode | Command |
| ------------------------- | ------------------------------------------- | | ------------------------- | ------------------------------------------- |
@@ -18,13 +19,17 @@ vim-easy-align defines `:EasyAlign` command in the visual mode.
| Using predefined rules | :EasyAlign [FIELD#] DELIMITER_KEY [OPTIONS] | | Using predefined rules | :EasyAlign [FIELD#] DELIMITER_KEY [OPTIONS] |
| Using regular expressions | :EasyAlign [FIELD#] /REGEXP/ [OPTIONS] | | Using regular expressions | :EasyAlign [FIELD#] /REGEXP/ [OPTIONS] |
The commands will go into the interactive mode when no argument is given.
For convenience, it is advised that you define a mapping for triggering it Interactive mode
in your `.vimrc`. -------------------------------------------------------------------------
The command will go into the interactive mode when no argument is given.
For convenience, it is advised that you define a mapping for triggering it in
your `.vimrc`.
vnoremap <silent> <Enter> :EasyAlign<cr> vnoremap <silent> <Enter> :EasyAlign<cr>
With this mapping, you can align selected lines with a few keystrokes. With this mapping, you can align selected lines of text with a few keystrokes.
1. <Enter> key to start interactive EasyAlign command 1. <Enter> key to start interactive EasyAlign command
2. Optional Enter keys to switch justficiation mode (default: left) 2. Optional Enter keys to switch justficiation mode (default: left)
@@ -61,24 +66,18 @@ Examples:
<Enter><Enter>**= Right-left alternating alignment around all equals signs <Enter><Enter>**= Right-left alternating alignment around all equals signs
EasyAlign! *:EasyAlign!*
-------------------------------------------------------------------------
:EasyAlign! is the right-justification version of :EasyAlign command.
Non-interactive mode Non-interactive mode
-------------------- -------------------------------------------------------------------------
Instead of going into the interactive mode, you can type in arguments to Instead of going into the interactive mode, you can type in arguments to
`:EasyAlign` command. In non-interactive mode, you can even use arbitrary `:EasyAlign` command. In non-interactive mode, you can even use arbitrary
regular expressions. regular expressions.
" Using predefined alignment rules " Using predefined alignment rules
:EasyAlign [FIELD#] DELIMITER_KEY [OPTIONS] :EasyAlign[!] [FIELD#] DELIMITER_KEY [OPTIONS]
" Using arbitrary regular expressions " Using arbitrary regular expressions
:EasyAlign [FIELD#] /REGEXP/ [OPTIONS] :EasyAlign[!] [FIELD#] /REGEXP/ [OPTIONS]
For example, when aligning the following lines around colons and semi-colons, For example, when aligning the following lines around colons and semi-colons,
@@ -93,7 +92,8 @@ try these commands:
- :EasyAlign **/[:;]\+/ - :EasyAlign **/[:;]\+/
Notice that you can't append `\zs` to your regular expression to put delimiters Notice that you can't append `\zs` to your regular expression to put delimiters
on the left. It can be done by providing additional options. on the left. It can be done by providing additional options in Vim dictionary
format.
- :EasyAlign * /[:;]\+/ { 'stick_to_left': 1, 'left_margin': '' } - :EasyAlign * /[:;]\+/ { 'stick_to_left': 1, 'left_margin': '' }
@@ -110,7 +110,7 @@ You can even omit spaces between the arguments, so concisely (or cryptically):
- :EasyAlign*/[:;]\+/{'s':1,'l':''} - :EasyAlign*/[:;]\+/{'s':1,'l':''}
Available options for each alignment are as follows. Available options are as follows.
| Atrribute | Type | Default | | Atrribute | Type | Default |
| ---------------- | ---------------- | ----------------------- | | ---------------- | ---------------- | ----------------------- |
@@ -164,11 +164,16 @@ becomes as follows on `<Enter>:`
Naturally, this feature only works when syntax highlighting is enabled. Naturally, this feature only works when syntax highlighting is enabled.
You can change the default rule by defining `g:easy_align_ignores` array. You can change the default rule by either defining global `g:easy_align_ignores`
array,
" Ignore nothing! " Ignore nothing!
let g:easy_align_ignores = [] let g:easy_align_ignores = []
or providing `ignores` option directly to :EasyAlign command
:EasyAlign:{'is':[]}
Then you get, Then you get,
{ {
@@ -181,7 +186,7 @@ Then you get,
} }
Handling unmatched lines *g:easy_align_ignore_unmatched* Ignoring unmatched lines *g:easy_align_ignore_unmatched*
------------------------------------------------------------------------- -------------------------------------------------------------------------
Lines without any matching delimiter are ignored as well (except in Lines without any matching delimiter are ignored as well (except in
@@ -209,8 +214,16 @@ this is usually what we want.
However, this default behavior is also configurable. However, this default behavior is also configurable.
One way is to set the global `g:easy_align_ignore_unmatched` variable to 0.
let g:easy_align_ignore_unmatched = 0 let g:easy_align_ignore_unmatched = 0
Or in non-interactive mode, you can provide `ignore_unmatched` option to
`:EasyAlign` command as follows.
:EasyAlign:{'iu':0}
Then we get, Then we get,
{ {
@@ -225,10 +238,14 @@ Then we get,
Extending alignment rules *g:easy_align_delimiters* Extending alignment rules *g:easy_align_delimiters*
------------------------------------------------------------------------- -------------------------------------------------------------------------
Although the default rules should cover the most of the use cases,
you can extend the rules by setting a dictionary named
`g:easy_align_delimiters`.
let g:easy_align_delimiters = { let g:easy_align_delimiters = {
\ '>': { 'pattern': '>>\|=>\|>' }, \ '>': { 'pattern': '>>\|=>\|>' },
\ '/': { 'pattern': '//\+' }, \ '/': { 'pattern': '//\+\|/\*\|\*/', 'ignores': ['String'] },
\ '#': { 'pattern': '#\+' }, \ '#': { 'pattern': '#\+', 'ignores': ['String'] },
\ ']': { \ ']': {
\ 'pattern': '[\[\]]', \ 'pattern': '[\[\]]',
\ 'left_margin': 0, \ 'left_margin': 0,