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 documentation

Browse Source
This commit is contained in:
Junegunn Choi
2013-09-17 23:32:41 +09:00
parent a998aee45d
commit 8951e13cf8
2 changed files with 44 additions and 46 deletions
Download Patch File Download Diff File Expand all files Collapse all files

50
README.md
View File

@@ -107,7 +107,8 @@ Alignment rules for the following delimiters have been defined to meet the most
| | | Table markdown | | | | Table markdown |
You can override these default rules or define your own rules with You can override these default rules or define your own rules with
`g:easy_align_delimiters`, which will be described in the later section. `g:easy_align_delimiters`, which will be described in
[the later section](https://github.com/junegunn/vim-easy-align#extending-alignment-rules).
#### Example command sequences #### Example command sequences
@@ -139,9 +140,9 @@ For example, if you want to align text around all occurrences of numbers:
#### Alignment options in interactive mode #### Alignment options in interactive mode
While in interactive mode, you can switch some of the alignment options using While in interactive mode, you can set alignment options using special shortcut
special shortcut keys listed below. The meanings of the options will be keys listed below. The meaning of each option will be described in
described in the following sections. [the following sections](https://github.com/junegunn/vim-easy-align#alignment-options).
| Key | Option | Values | | Key | Option | Values |
| -------- | ------------------ | -------------------------------------------------- | | -------- | ------------------ | -------------------------------------------------- |
@@ -152,8 +153,8 @@ described in the following sections.
| `CTRL-U` | `ignore_unmatched` | 0, 1 | | `CTRL-U` | `ignore_unmatched` | 0, 1 |
| `CTRL-G` | `ignore_groups` | [], ['String'], ['Comment'], ['String', 'Comment'] | | `CTRL-G` | `ignore_groups` | [], ['String'], ['Comment'], ['String', 'Comment'] |
| `CTRL-O` | `mode_sequence` | Input string of `/[lrc]+\*{0,2}/` | | `CTRL-O` | `mode_sequence` | Input string of `/[lrc]+\*{0,2}/` |
| `<Left>` | `stick_to_left` | Set stick_to_left and set left_margin to zero | | `<Left>` | `stick_to_left` | `{ 'stick_to_left': 1, 'left_margin': 0 }` |
| `<Right>` | `stick_to_left` | Unset stick_to_left and set left_margin to one | | `<Right>` | `stick_to_left` | `{ 'stick_to_left': 0, 'left_margin': 1 }` |
--- ---
@@ -250,20 +251,14 @@ since the same can be easily done using the negative field number: `<Enter>-=`
Alignment options Alignment options
----------------- -----------------
Option values can be 1) specified as global variables, 2) set on each alignment
rule in `g:easy_align_delimiters`, 3) or given to every `:EasyAlign` command.
Command-line options have the highest precedence, and global variables have the
lowest precedence.
### List of options ### List of options
| Option | Type | Default | Description | | Option | Type | Default | Description |
| ------------------ | ------- | --------------------- | ------------------------------------------------------- | | ------------------ | ------- | --------------------- | ------------------------------------------------------- |
| `left_margin` | number | 0 | Number of spaces to attach before delimiter | | `left_margin` | number | 1 | Number of spaces to attach before delimiter |
| `left_margin` | string | `''` | String to attach before delimiter | | `left_margin` | string | `' '` | String to attach before delimiter |
| `right_margin` | number | 0 | Number of spaces to attach after delimiter | | `right_margin` | number | 1 | Number of spaces to attach after delimiter |
| `right_margin` | string | `''` | String to attach after delimiter | | `right_margin` | string | `' '` | String to attach after delimiter |
| `stick_to_left` | boolean | 0 | Whether to position delimiter on the left-side | | `stick_to_left` | boolean | 0 | Whether to position delimiter on the left-side |
| `ignore_groups` | list | ['String', 'Comment'] | Delimiters in these syntax highlight groups are ignored | | `ignore_groups` | list | ['String', 'Comment'] | Delimiters in these syntax highlight groups are ignored |
| `ignore_unmatched` | boolean | 1 | Whether to ignore lines without matching delimiter | | `ignore_unmatched` | boolean | 1 | Whether to ignore lines without matching delimiter |
@@ -271,14 +266,23 @@ lowest precedence.
| `delimiter_align` | string | `r` | Determines how to align delimiters of different lengths | | `delimiter_align` | string | `r` | Determines how to align delimiters of different lengths |
| `mode_sequence` | string | | Alignment modes for multiple occurrences of delimiters | | `mode_sequence` | string | | Alignment modes for multiple occurrences of delimiters |
Some of the options can be specified using corresponding global variables. There are 4 ways to set alignment options (from lowest precedence to highest):
| Option | Global variable | 1. Some option values can be set with corresponding global variables
| ------------------ | ------------------------------- | 2. Option values can be specified in the definition of each alignment rule
| `ignore_groups` | `g:easy_align_ignore_groups` | 3. Option values can be given as a dictionary argument to `:EasyAlign` command
| `ignore_unmatched` | `g:easy_align_ignore_unmatched` | 4. Option values can be set in interactive mode using special shortcut keys
| `delimiter_align` | `g:easy_align_delimiter_align` |
| `indentation` | `g:easy_align_indentation` | | Option | Shortcut key | Global variable |
| ------------------ | ------------------- | ------------------------------- |
| `left_margin` | `CTRL-L` | |
| `right_margin` | `CTRL-R` | |
| `stick_to_left` | `<Left>`, `<Right>` | |
| `ignore_groups` | `CTRL-G` | `g:easy_align_ignore_groups` |
| `ignore_unmatched` | `CTRL-U` | `g:easy_align_ignore_unmatched` |
| `indentation` | `CTRL-I` | `g:easy_align_indentation` |
| `delimiter_align` | `CTRL-D` | `g:easy_align_delimiter_align` |
| `mode_sequence` | `CTRL-O` | |
### Ignoring delimiters in comments or strings ### Ignoring delimiters in comments or strings

40
doc/easy_align.txt
View File

@@ -166,8 +166,8 @@ Available options are as follows.
| Atrribute | Type | Default | | Atrribute | Type | Default |
| ---------------- | ---------------- | ----------------------------- | | ---------------- | ---------------- | ----------------------------- |
| left_margin | number or string | 0 | | left_margin | number or string | 1 |
| right_margin | number or string | 0 | | right_margin | number or string | 1 |
| stick_to_left | boolean | 0 | | stick_to_left | boolean | 0 |
| ignore_unmatched | boolean | 1 | | ignore_unmatched | boolean | 1 |
| ignore_groups | array | ['String', 'Comment'] | | ignore_groups | array | ['String', 'Comment'] |
@@ -178,29 +178,23 @@ Available options are as follows.
| mode_sequence | string | (Depends on field number and | | mode_sequence | string | (Depends on field number and |
| | | selected alignment mode) | | | | selected alignment mode) |
There are 4 ways to set alignment options (from lowest precedence to highest):
Some of the options can be specified using corresponding global variables. 1. Some option values can be set with corresponding global variables
2. Option values can be specified in the definition of each alignment rule
3. Option values can be given as a dictionary argument to :EasyAlign command
4. Option values can be set in interactive mode using special shortcut keys
| Option | Global variable | | Option | Shortcut key | Global variable |
| ------------------ | ------------------------------- | | ---------------- | ------------------- | ------------------------------- |
| ignore_groups | `g:easy_align_ignore_groups` | | left_margin | CTRL-L | |
| ignore_unmatched | `g:easy_align_ignore_unmatched` | | right_margin | CTRL-R | |
| delimiter_align | `g:easy_align_delimiter_align` | | stick_to_left | <Left>, <Right> | |
| indentation | `g:easy_align_indentation` | | ignore_groups | CTRL-G | `g:easy_align_ignore_groups` |
| ignore_unmatched | CTRL-U | `g:easy_align_ignore_unmatched` |
| indentation | CTRL-I | `g:easy_align_indentation` |
In interactive mode, you can switch some of the alignment options using special | delimiter_align | CTRL-D | `g:easy_align_delimiter_align` |
keys listed below. | mode_sequence | CTRL-O | |
| Key | Option | Values |
| ------ | ---------------- | -------------------------------------------------- |
| CTRL-I | indentation | shallow, deep, none, keep |
| CTRL-L | left_margin | Input number or string |
| CTRL-R | right_margin | Input number or string |
| CTRL-D | delimiter_align | left, center, right |
| CTRL-U | ignore_unmatched | 0, 1 |
| CTRL-G | ignore_groups | [], ['String'], ['Comment'], ['String', 'Comment'] |
| CTRL-O | mode_sequence | Input string of l, r, and c characters |
Ignoring delimiters in comments or strings *g:easy_align_ignore_groups* Ignoring delimiters in comments or strings *g:easy_align_ignore_groups*