https://github.com/raimondi/vim-relab
A playground for Vim regular expressions
https://github.com/raimondi/vim-relab
plugin regexp regular-expressions vim vimscript
Last synced: about 1 year ago
JSON representation
A playground for Vim regular expressions
- Host: GitHub
- URL: https://github.com/raimondi/vim-relab
- Owner: Raimondi
- License: other
- Created: 2018-11-08T05:01:58.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2018-11-12T07:22:48.000Z (over 7 years ago)
- Last Synced: 2025-01-28T17:46:09.418Z (about 1 year ago)
- Topics: plugin, regexp, regular-expressions, vim, vimscript
- Language: Vim script
- Homepage:
- Size: 146 KB
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# RELab: a playground for Vim regular expressions
Vim's regular expressions (regexp) can be a bit different from what people is
used to nowadays, RELab provides some tools to help with understanding how
they work.
There are four available views that show different aspects of the regexp. The
Description view shows every item next to a description of what it does. The
Matches view shows what text is matched by the regexp, when used on a sample
text. The Validation view shows which lines of the sample text are matched or
not by the regexp. The Sample Text view shows the provided text that is used
to match the regexp against, and eny edits to it is preserved after switching
to other view. Whenever the regexp is shown it can be edited and the result
with be automatically updated and stored for the other views.
## Description View
Shows the description of every element of the current regexp. Get to this view
with `:RELabDescribe` or `rd`.
```
+---------------------------------------------------------------+
|RELab: Description |
|\(\w\+\)@\(\w\+\) |
| |
| \( => Starts a capturing group. |
| \w => A word character: [0-9A-Za-z_]. |
| \+ => 1 or more of the preceding atom, as many as possible.|
| \) => Ends a capturing group. |
| @ => Matches the character "@" (code 64). |
| \( => Starts a capturing group. |
| \w => A word character: [0-9A-Za-z_]. |
| \+ => 1 or more of the preceding atom, as many as possible.|
| \) => Ends a capturing group. |
|~ |
+---------------------------------------------------------------+
```
## Matches View
Display every line of the sample text that is matched by the current regexp.
Also show the matched text for every matched line. Both `:RELabMatches` and
`rm` open this view.
```
+---------------------------------------------------------------+
|RELab: Matches |
|\(\w\+\)@\(\w\+\) |
| |
|+:email@example.com |
|0:email@example |
||\1:email |
| \2:example |
|+:firstname.lastname@example.com |
|0:lastname@example |
||\1:lastname |
| \2:example |
|+:email@subdomain.example.com |
|0:email@subdomain |
+---------------------------------------------------------------+
```
## Validation View
Every line of the sample text is marked as matched (with +) or unmatched (with
x) by the current regexp. Also show the matched text for every matched line.
The command `:RELabValidate` or the mapping in `rv` bring you here.
```
+---------------------------------------------------------------+
|RELab: Validation |
|\(\w\+\)@\(\w\+\) |
| |
|x:Some email addresses to play with |
|x: |
|+:email@example.com |
|0:email@example |
||\1:email |
| \2:example |
|+:firstname.lastname@example.com |
|0:lastname@example |
||\1:lastname |
| \2:example |
+---------------------------------------------------------------+
```
## Sample Text View
Shows the sample text that will be used with the given regex. Any edits to the
text while in this view will be preserved for the other views. In order to
access the sample text, use `:RELabSample` or `rs`. `RELabGetSample` will
also open this view and get the sample text from the current buffer or read
from another file.
```
+---------------------------------------------------------------+
|RELab: Sample Text |
|------------- |
|Some email addresses to play with |
| |
|email@example.com |
|firstname.lastname@example.com |
|email@subdomain.example.com |
|firstname+lastname@example.com |
|email@123.123.123.123 |
|email@[123.123.123.123] |
|~ |
|~ |
|~ |
+---------------------------------------------------------------+
```