Tame Regex with TypeScript Magic

Let's be honest: writing regular expressions can feel like deciphering an ancient, cursed language. You squint at a string of backslashes and parentheses, cross your fingers, and hope it works. But what if you could build regex patterns with clean, chainable functions and full TypeScript support? That's exactly what magic-regexp offers.

What is magic-regexp?

magic-regexp is a library from the unjs ecosystem that provides a compiled-away, type-safe, and highly readable alternative to writing regular expressions. Instead of crafting a string that's easy to get wrong, you use a fluent, builder-like API. The best part? It's not a runtime library. Your readable code gets transformed into a native RegExp object during build time, leaving zero runtime overhead.

Why It's a Game Changer

The real magic lies in its developer experience and its clever implementation.

• Type-Safe Patterns: Get autocompletion and type checking as you build your expressions. No more guessing which metacharacters to use.
• Readable and Maintainable Code: oneOrMore(char("a")) is infinitely more understandable than /a+/.
• No Runtime Cost: Since it's compiled away to a standard RegExp, you don't ship any extra JavaScript to your clients. It's just a development-time aid.
• Smart Compilation: It understands your intent and generates optimized regex patterns under the hood.

How to Use It

Getting started is straightforward. First, install it:

npm install magic-regexp

Then, start building expressions in a way that actually makes sense.

// Import the helpers
import { createRegExp, exactly, oneOrMore, char } from 'magic-regexp';

// Instead of this: /(hi|hello),?\s+world[.!]?/
// Write this:
const regex = createRegExp(
  exactly('hi')
    .or('hello')
    .after(exactly(',').optional())
    .and(oneOrMore(char(' ')))
    .and('world')
    .and(char.in('.!').optional())
);

console.log(regex); // Outputs: /(hi|hello),?\s+world[.!]?/

You can chain methods to create complex patterns, capture groups, and lookarounds, all with a clean and intuitive syntax.

Final Thoughts

magic-regexp is one of those tools that doesn't try to do anything revolutionary at runtime but completely revolutionizes the development process. It’s perfect for any developer who has ever wasted 15 minutes debugging a tricky regex pattern. It makes regex approachable, safe, and even a little bit fun.

This is a solid choice for any TypeScript or JavaScript project where clarity and maintainability are priorities. It’s like having a helpful pair programmer who's an absolute regex wizard.

Give it a star on GitHub if this resonates with you: unjs/magic-regexp

— Follow for more cool projects: @githubprojects