@the-node-forge/regex-simplifier
TypeScript icon, indicating that this package has built-in type declarations

1.0.1 • Public • Published

Regex Simplifier

License: MIT Made with TypeScript NPM Version Build Status Platform

Live Documentation

A tiny utility that helps you understand, build, and test regular expressions using clean, readable code.


✨ Features

  • 🧠 explain(regex) — Converts regex into plain English
  • 🔍 test(value, pattern) — Tests a string against a regex or named pattern
  • 🧱 build(name) — Generates regex for common use-cases like "email", "url", etc.
  • 💬 Clean console formatting for output clarity
  • 🌐 Supports both Node.js and browser environments

📦 Installation

npm install @the-node-forge/regex-simplifier

🚀 Usage

import { build, test, explain } from '@the-node-forge/regex-simplifier';

// Build common patterns
const emailRegex = build('email');
console.log(emailRegex.test('me@example.com')); // true

// Test a value directly
console.log(test('12345', 'zip')); // true
console.log(test('https://the-node-forge.dev', 'url')); // true

// Explain a raw regex
console.log(explain(/^\d{5}$/));
// => This pattern includes:
//    - Starts with
//    - exactly five digits
//    - Ends with

📚 Built-in Patterns

Name Description
email Validates an email address
url Validates an HTTP(s) URL (no FTP), with localhost or domain, optional port & path
zip Validates a US ZIP code (5 or 9 digits)
phone Validates a US phone number (with optional +1, balanced parentheses)
ipv4 Validates an IPv4 address
ipv6 Validates a full IPv6 address (no shorthand)
iso-date Validates a date in ISO format (YYYY-MM-DD)
us-date Validates a date in US format (MM/DD/YYYY)
time24 Validates time in 24‑hour format (HH:mm or HH:mm:ss)
hex-color Validates a hexadecimal color code (#RGB or #RRGGBB)
rgb-color Validates an RGB color value (0–255 each)
credit-card Validates a credit card number (Visa, MasterCard, Amex)
ssn Validates a US Social Security Number
slug Validates a URL slug (lowercase, numbers, hyphens)
uuid Validates a UUID (versions 1–5)

💡 Contributing

We welcome contributions! Feel free to open an issue or submit a pull request.


⭐ Support

If you find Regex Simplifier helpful, give it a ⭐ on GitHub.


🔗 Links


📖 Docs

Full documentation available at: https://the-node-forge.github.io/regex-simplifier


📝 License

MIT © 2025 The Node Forge

Package Sidebar

Install

npm i @the-node-forge/regex-simplifier

Weekly Downloads

3

Version

1.0.1

License

MIT

Unpacked Size

24.3 kB

Total Files

27

Last publish

Collaborators

  • lanny.macmillan.dev
  • drewgomez
  • fil.dev