🕹️Installation and use

1npm install regexpert

What is needed for work

1. Register plugin

1// vite.config.ts
2
3import { regExpertVitePlugin } from 'regexpert';
4
5export default defineConfig(() => {
6  return {
7    plugins: [regExpertVitePlugin()],
8  };
9});

2. Start a project

1npm run dev

Type parsing occurs only when the project is running!

3. Write your RegExp

1// your-file.ts
2
3import { makeNamedRegExp } from 'regexpert';
4
5const { regExp: myFavouriteRegExp, transform: transformMyFavouriteRegExp } = makeNamedRegExp(
6  `/(1)\\s?text between\\s(?<groupName>named group)( )?\\k<groupName>?/`,
7);
8
9// There will be a conversion to such RegExp - this will work in browsers in IOS
10console.info(regExp); // /(1)\s?text between\s(named group)?( )?\2/

What is the main task?

1// Let's find a suitable line:
2
3const matches = '1text between named group'.match(myFavouriteRegExp);
4// [
5//   '1text between named group ',
6//   '1',
7//   'named group',
8//   ' '
9// ]
10
11// Let's pass the result to the transform function
12const result = transformMyFavouriteRegExp(matches);
13
14console.info(result);
15// {
16//   '$0': '1text between named group ',
17//   '$1': '1',
18//   groupName: 'named group',
19//   '$3': ' '
20// }
21
22type Result = typeof result;
23// Result is {
24//   $0: `1${string | ''}text between${string}named group${' ' | ''}${'named group' | ''}`,
25//   $1: '1',
26//   groupName: 'named group',
27//   $3?: ' ',
28// }

What do we get?

1. Convenient use of the transformed object
2. We get the expected types for each field
3. We know for sure which field will be optional

Every time you make a change, files with your types will be automatically generated, which you can always view and inspect.

Format

Use only forward quotation (`) marks when writing StrRegExp

1const { regExp } = makeNamedRegExp(`/HI(?: World)/ig`);

But it won't work like that

1const { regExp } = makeNamedRegExp('/HI(?: World)/ig');