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

Concept of alignment rule

Browse Source
This commit is contained in:
Junegunn Choi
2013-09-14 17:20:14 +09:00
parent 9f9d18ca71
commit e9b6418280
1 changed files with 15 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@@ -59,6 +59,21 @@ variant `:EasyAlign!`) 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]` |
### Concept of _alignment rule_
> Simple things should be simple,
> complex things should be possible.
> - Alan Kay
Forget about writing regular expressions every time you do an alignment.
You can do so (we'll see), but I don't believe that it should be the default
way of doing things with this plugin.
An *alignment rule* is a predefined set of options for common alignment tasks,
which is indexed by a single character, *DELIMITER_KEY*. By default, you have
rules indexed by `<space>`, `=`, `:`, `.`, `|`, and `,`, which should cover the
most of the use cases. You can override these rules, and add your own rules.
### Interactive mode ### Interactive mode
The command will go into the interactive mode when no argument is given. The command will go into the interactive mode when no argument is given.