unjs/magic-regexp
Magic Regexp
magic-regexp is a type-safe regular expression builder and TypeScript compiler. It allows for the construction of JavaScript regular expressions using a readable syntax that automatically generates precise types for captured groups, ensuring predictable data extraction.
The project functions as a build-time transformer that converts custom pattern syntax into standard regular expression objects. This static compilation removes runtime overhead by shifting the transformation logic to the build process.
The tool covers named capture group generation and a readable construction API that replaces raw regex strings. It includes capabilities for referencing captured groups, predicting match results at the type level, and converting standard regular expressions back into the readable syntax.
Features
- Type-Safe Regular Expressions - Compiles readable chainable regex syntax into native RegExp objects with automatic TypeScript type inference for capture groups.
- Readable Regex Builders - Builds regular expressions by chaining readable method calls instead of writing raw pattern strings.
- Readability Tooling - Builds regular expressions using chainable natural-language methods instead of raw pattern strings for improved readability.
- Regular Expression Builders - Builds regular expressions using chainable methods like exactly and oneOrMore instead of raw pattern strings.
- Readable Regex Constructors - Constructs regular expressions by chaining natural-language helpers like exactly, maybe, and oneOrMore instead of writing raw patterns.
- Type-Safe Capture Generators - Automatically derives TypeScript types from named capture groups for compile-time validation of matched data.
- Compile-Time Regex Compilation - Transforms readable regex syntax into native RegExp objects during compilation to eliminate runtime overhead.
- Named Capture Group Generators - Automatically derives TypeScript types from named capture groups in regex patterns for compile-time validation.
- Named Capture Groups - Wraps part of a pattern in a named capture group so the matched value is accessible by name in the result object.
- Regex Builder Chains - Builds regular expressions by chaining natural-language methods like exactly and oneOrMore instead of raw strings.
- String Literal Match Type Predictions - Derives exact TypeScript types from string literal inputs for compile-time validation of regex matches.
- Lookahead and Lookbehind Helpers - Provides chainable methods for adding lookahead and lookbehind conditions to regex patterns.
- Regex Lookaround Assertions - Adds positive or negative lookahead and lookbehind conditions to a pattern using helpers like after, before, and notBefore.
- Regular Expression Converters - Converts existing regular expressions into readable builder syntax for easier maintenance and understanding.
- Regex Lookahead Helpers - Ships chainable methods like after and before for adding lookahead and lookbehind assertions to patterns.
- Regex Syntax Converters - Provides a bidirectional converter that translates existing RegExp literals into readable builder syntax.
- Regex Syntax Tree Compilers - Parses the builder chain into an abstract syntax tree and compiles it to a standard RegExp literal at build time.
- Bidirectional Regex Syntax Converters - Translates existing RegExp literals into readable builder syntax and back for easier maintenance.
