@v0idd0/regexlab 1.0.0 → 1.0.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +60 -5
- package/from-the-studio.md +65 -0
- package/package.json +30 -7
package/README.md
CHANGED
|
@@ -1,5 +1,14 @@
|
|
|
1
1
|
# regexlab
|
|
2
2
|
|
|
3
|
+
[](https://www.npmjs.com/package/@v0idd0/regexlab)
|
|
4
|
+
[](https://www.npmjs.com/package/@v0idd0/regexlab)
|
|
5
|
+
[](LICENSE)
|
|
6
|
+
[](package.json)
|
|
7
|
+
|
|
8
|
+
**[Homepage](https://tools.voiddo.com/regexlab/?ref=regexlab-readme)** · **[GitHub](https://github.com/voidd0/regexlab)** · **[npm](https://www.npmjs.com/package/@v0idd0/regexlab)** · **[All tools](https://tools.voiddo.com/?ref=regexlab-catalog-readme)** · **[Contact](mailto:support@voiddo.com)**
|
|
9
|
+
|
|
10
|
+
---
|
|
11
|
+
|
|
3
12
|
Explain regex patterns in plain english. Read the manual.
|
|
4
13
|
|
|
5
14
|
```
|
|
@@ -11,10 +20,14 @@ pattern: \d{3}-\d{4}
|
|
|
11
20
|
\d{4} → a digit (0–9) exactly 4 times
|
|
12
21
|
```
|
|
13
22
|
|
|
23
|
+
## Why regexlab
|
|
24
|
+
|
|
25
|
+
You wrote a regex six months ago. You don't remember what it does. Today's reviewer wants you to explain it. Stack Overflow answers from 2014 paraphrase, regex101 wants your network and your eyes, and the real `man re_format(7)` is hostile if you only need it twice a year. regexlab is the explainer that lives in your terminal — local, offline-capable, no popovers.
|
|
26
|
+
|
|
14
27
|
## Install
|
|
15
28
|
|
|
16
29
|
```bash
|
|
17
|
-
npm install -g
|
|
30
|
+
npm install -g @v0idd0/regexlab
|
|
18
31
|
```
|
|
19
32
|
|
|
20
33
|
## Usage
|
|
@@ -33,6 +46,22 @@ regexlab --json '^[a-z]+$' | jq '.tokens'
|
|
|
33
46
|
regexlab --help
|
|
34
47
|
```
|
|
35
48
|
|
|
49
|
+
## What teams use it for
|
|
50
|
+
|
|
51
|
+
- code reviews: quickly document what a new regex actually matches before approving a PR
|
|
52
|
+
- CI and linting: output deterministic token explanations to include in PR logs
|
|
53
|
+
- incident response: explain opaque alert patterns under time pressure
|
|
54
|
+
- onboarding: create a quick glossary of regex tokens for teammates
|
|
55
|
+
|
|
56
|
+
### vs regex101.com and friends
|
|
57
|
+
|
|
58
|
+
`regexlab` and online testers solve different tasks:
|
|
59
|
+
|
|
60
|
+
- Use **regexlab** when you need a deterministic, offline explanation of pattern syntax.
|
|
61
|
+
- Use **regex testers** when you need live sample matching, capture groups, or multi-engine behavior.
|
|
62
|
+
|
|
63
|
+
Use `--json` when you want stable machine output for docs or scripts, and run it twice if you need a quick local pattern diff.
|
|
64
|
+
|
|
36
65
|
## What it handles
|
|
37
66
|
|
|
38
67
|
- Anchors: `^`, `$`, `\b`, `\B`
|
|
@@ -45,14 +74,32 @@ regexlab --help
|
|
|
45
74
|
- Backreferences: `\1` through `\9`
|
|
46
75
|
- Flags: `g`, `i`, `m`, `s`, `u`, `y`
|
|
47
76
|
|
|
48
|
-
##
|
|
77
|
+
## Compared to alternatives
|
|
49
78
|
|
|
50
|
-
|
|
79
|
+
| tool | offline? | network IO | per-token explanation | regex101-style match testing |
|
|
80
|
+
|---|---|---|---|---|
|
|
81
|
+
| regexlab | yes | none | yes | optional via API |
|
|
82
|
+
| regex101.com | no | tracks input | yes | yes (web) |
|
|
83
|
+
| regexr.com | no | tracks input | yes | yes (web) |
|
|
84
|
+
| `pcregrep --explain` | yes | none | terse | no |
|
|
85
|
+
| ChatGPT/Claude | depends | sends pattern | conversational | manual |
|
|
86
|
+
|
|
87
|
+
If you're authoring a long regex and want hover-to-test feedback, regex101 is unbeatable. If you're explaining a regex *in your terminal* (in a code review, in a hook, on a server you SSHed into), regexlab is the one that fits the workflow.
|
|
88
|
+
|
|
89
|
+
## FAQ
|
|
90
|
+
|
|
91
|
+
**Does it actually run the regex against test strings?** Only via the programmatic API (returns matches if you pass a `subject` string). The CLI is explanation-only because that's the dominant use case.
|
|
92
|
+
|
|
93
|
+
**Is it accurate on PCRE-only features?** Most of what JavaScript's RegExp supports is the safe subset. Lookbehinds, named groups, atomic groups — covered. `\K` and balanced groups (.NET) are explicitly out of scope and the parser will say so.
|
|
94
|
+
|
|
95
|
+
**Why doesn't it suggest a "better" regex?** Because "better" depends on whether you're optimizing for readability, backtracking safety, or one of nine character-class alternatives. Static suggestions miss the point — regexlab explains, doesn't editorialize.
|
|
96
|
+
|
|
97
|
+
**Will it choke on a 4KB regex?** Try us. The tokenizer is recursive descent and has been fed several embarrassingly large captcha-bypass regexes in testing. The output gets long before the tool gets slow.
|
|
51
98
|
|
|
52
99
|
## Programmatic API
|
|
53
100
|
|
|
54
101
|
```javascript
|
|
55
|
-
import { explain, format } from '
|
|
102
|
+
import { explain, format } from '@v0idd0/regexlab';
|
|
56
103
|
|
|
57
104
|
const result = explain('/^\\d{3}-\\d{4}$/g');
|
|
58
105
|
console.log(format(result));
|
|
@@ -62,6 +109,14 @@ console.log(result.tokens);
|
|
|
62
109
|
// [{ token: '\\d{3}', explanation: '...' }, ...]
|
|
63
110
|
```
|
|
64
111
|
|
|
112
|
+
## More from the studio
|
|
113
|
+
|
|
114
|
+
This is one tool out of many — see [`from-the-studio.md`](from-the-studio.md) for the full lineup of vøiddo products (other CLI tools, browser extensions, the studio's flagship products and games).
|
|
115
|
+
|
|
65
116
|
## License
|
|
66
117
|
|
|
67
|
-
MIT
|
|
118
|
+
MIT.
|
|
119
|
+
|
|
120
|
+
---
|
|
121
|
+
|
|
122
|
+
Built by [vøiddo](https://voiddo.com/) — a small studio shipping AI-flavoured products, free dev tools, Chrome extensions and weird browser games.
|
|
@@ -0,0 +1,65 @@
|
|
|
1
|
+
# From the same studio
|
|
2
|
+
|
|
3
|
+
This repo is one piece of [vøiddo](https://voiddo.com/), a small studio that ships AI-flavoured products, free dev tools, Chrome extensions and weird browser games. If you found this useful, the rest of the catalogue is below.
|
|
4
|
+
|
|
5
|
+
## Flagships
|
|
6
|
+
|
|
7
|
+
| product | what it does |
|
|
8
|
+
|---|---|
|
|
9
|
+
| [**scrb**](https://scrb.voiddo.com/) | AI product description generator — opinionated copy for Amazon, Etsy, Shopify, eBay |
|
|
10
|
+
| [**rankd**](https://rankd.voiddo.com/) | opinionated cultural verdicts on music, books, films — savage / honest / hype mode |
|
|
11
|
+
|
|
12
|
+
## Browser extensions ([extensions.voiddo.com](https://extensions.voiddo.com/))
|
|
13
|
+
|
|
14
|
+
| extension | what it does |
|
|
15
|
+
|---|---|
|
|
16
|
+
| [interviewprep](https://github.com/voidd0/interviewprep) | open a job posting → 5 likely questions + STAR scaffolds + company card |
|
|
17
|
+
| [jobmeta](https://github.com/voidd0/jobmeta) | one-click ATS autofill across 11 platforms + AI cover letter |
|
|
18
|
+
| [pricepulse](https://github.com/voidd0/pricepulse) | watch competitor SaaS pricing pages and get notified when they move |
|
|
19
|
+
| [tabsnap](https://github.com/voidd0/tabsnap) | format a tab list as markdown / readme / json — free forever |
|
|
20
|
+
| [tokcount](https://github.com/voidd0/tokcount) | count LLM tokens for any URL or selection — Claude / GPT / Gemini |
|
|
21
|
+
| [randumb](https://github.com/voidd0/randumb) | random numbers, dice, picks, names, lorem — context-menu based |
|
|
22
|
+
|
|
23
|
+
## Free CLI tools ([tools.voiddo.com](https://tools.voiddo.com/))
|
|
24
|
+
|
|
25
|
+
All MIT, all zero-deps, all on `@v0idd0/*` on npm. Pick the one that solves the thing you're stuck on:
|
|
26
|
+
|
|
27
|
+
| tool | one-line |
|
|
28
|
+
|---|---|
|
|
29
|
+
| [cronwtf](https://github.com/voidd0/cronwtf) | decode any cron expression in plain English |
|
|
30
|
+
| [ctxstuff](https://github.com/voidd0/ctxstuff) | pack files into a single context dump for LLM prompts |
|
|
31
|
+
| [depcheck](https://github.com/voidd0/depcheck) | audit npm dependencies — unused / outdated / vulnerable |
|
|
32
|
+
| [dotdig](https://github.com/voidd0/dotdig) | DNS lookup for humans — formatted, colour-coded |
|
|
33
|
+
| [envguard](https://github.com/voidd0/envguard) | validate .env files against a schema before deploy bites |
|
|
34
|
+
| [fakeit](https://github.com/voidd0/fakeit) | realistic fake test data — names, emails, addresses, JSON |
|
|
35
|
+
| [gitstats](https://github.com/voidd0/gitstats) | git contribution stats by author + file + week |
|
|
36
|
+
| [gitwhen](https://github.com/voidd0/gitwhen) | pinpoint when a string entered or left a repo |
|
|
37
|
+
| [httpwut](https://github.com/voidd0/httpwut) | explain any HTTP status code in one sentence |
|
|
38
|
+
| [jsonyo](https://github.com/voidd0/jsonyo) | format, query, and validate JSON from CLI / npm |
|
|
39
|
+
| [licenseme](https://github.com/voidd0/licenseme) | generate a LICENSE file in seconds — MIT / Apache / GPL |
|
|
40
|
+
| [logparse](https://github.com/voidd0/logparse) | parse nginx / apache / syslog into clean tables |
|
|
41
|
+
| [passgen](https://github.com/voidd0/passgen) | secure passwords + diceware passphrases — zero deps |
|
|
42
|
+
| [portcheck](https://github.com/voidd0/portcheck) | see what's listening on local ports — process + PID |
|
|
43
|
+
| [promptdiff](https://github.com/voidd0/promptdiff) | diff two LLM prompts and see the structural delta |
|
|
44
|
+
| [regexlab](https://github.com/voidd0/regexlab) | explain any regex pattern in plain English + test cases |
|
|
45
|
+
| [secscan](https://github.com/voidd0/secscan) | find accidentally-committed secrets across a repo |
|
|
46
|
+
| [slugmint](https://github.com/voidd0/slugmint) | clean URL slugs from any title — unicode-safe |
|
|
47
|
+
| [sslcheck](https://github.com/voidd0/sslcheck) | inspect TLS certificates from CLI — expiry / chain / SAN |
|
|
48
|
+
| [timecheck](https://github.com/voidd0/timecheck) | convert timestamps between formats / timezones |
|
|
49
|
+
| [tzdiff](https://github.com/voidd0/tzdiff) | compare timezones side by side — meeting planner |
|
|
50
|
+
|
|
51
|
+
## Browser games ([games.voiddo.com](https://games.voiddo.com/))
|
|
52
|
+
|
|
53
|
+
| game | what it is |
|
|
54
|
+
|---|---|
|
|
55
|
+
| [Void Factory](https://play.voiddo.com/vf/) | factory-builder roguelike with a dark sense of humour — Telegram + Android + web |
|
|
56
|
+
| [fe2o3.io](https://voiddo.com/play/fe2o3/) | click-to-rust idle game — five-tier progression from yard to planet |
|
|
57
|
+
| [gridlock](https://voiddo.com/play/gridlock/) | minimalist puzzle game on a 4×4 grid — 100+ hand-crafted levels |
|
|
58
|
+
|
|
59
|
+
---
|
|
60
|
+
|
|
61
|
+
Every repo in this list ends with the same footer. If you ever want to find us again, the studio site is [voiddo.com](https://voiddo.com/).
|
|
62
|
+
|
|
63
|
+
---
|
|
64
|
+
|
|
65
|
+
Built by [vøiddo](https://voiddo.com/) — a small studio shipping AI-flavoured products, free dev tools, Chrome extensions and weird browser games.
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@v0idd0/regexlab",
|
|
3
|
-
"version": "1.0.
|
|
4
|
-
"description": "regexlab
|
|
3
|
+
"version": "1.0.2",
|
|
4
|
+
"description": "regexlab — explain regex patterns in plain English. Token-by-token breakdown: anchors, character classes, quantifiers, groups, lookarounds, flags. CLI + library. Free forever from vøiddo.",
|
|
5
5
|
"main": "src/index.js",
|
|
6
6
|
"type": "module",
|
|
7
7
|
"bin": {
|
|
@@ -14,13 +14,31 @@
|
|
|
14
14
|
"regex",
|
|
15
15
|
"regular-expressions",
|
|
16
16
|
"explain",
|
|
17
|
+
"regex-explainer",
|
|
18
|
+
"regex-breakdown",
|
|
19
|
+
"regex-parser",
|
|
20
|
+
"pattern-debugger",
|
|
17
21
|
"cli",
|
|
18
22
|
"developer-tools",
|
|
19
|
-
"
|
|
23
|
+
"cli-tool",
|
|
24
|
+
"regex-cli",
|
|
25
|
+
"javascript-regex",
|
|
26
|
+
"explain-regex",
|
|
27
|
+
"token-explanation",
|
|
28
|
+
"regex-tokens",
|
|
29
|
+
"voiddo",
|
|
30
|
+
"pattern",
|
|
31
|
+
"lookahead",
|
|
32
|
+
"lookbehind",
|
|
33
|
+
"character-class",
|
|
34
|
+
"quantifier",
|
|
35
|
+
"anchor",
|
|
36
|
+
"capture-group",
|
|
37
|
+
"regex-debugger"
|
|
20
38
|
],
|
|
21
|
-
"author": "
|
|
39
|
+
"author": "vøiddo <support@voiddo.com> (https://voiddo.com)",
|
|
22
40
|
"license": "MIT",
|
|
23
|
-
"homepage": "https://tools.voiddo.com/regexlab
|
|
41
|
+
"homepage": "https://tools.voiddo.com/regexlab/?ref=regexlab-npm",
|
|
24
42
|
"repository": {
|
|
25
43
|
"type": "git",
|
|
26
44
|
"url": "git+https://github.com/voidd0/regexlab.git"
|
|
@@ -39,6 +57,11 @@
|
|
|
39
57
|
"bin",
|
|
40
58
|
"src",
|
|
41
59
|
"README.md",
|
|
42
|
-
"LICENSE"
|
|
43
|
-
|
|
60
|
+
"LICENSE",
|
|
61
|
+
"from-the-studio.md"
|
|
62
|
+
],
|
|
63
|
+
"funding": {
|
|
64
|
+
"type": "individual",
|
|
65
|
+
"url": "https://voiddo.com/contact/"
|
|
66
|
+
}
|
|
44
67
|
}
|