michaeldera / simple-regex-ts

A simple package with common regex patterns for Zimbabwe

Simple Regex

A simple package with common regex pattens for Zimbabwe

Links

Simple Regex Documentation

Github Repository

NPM Package

Installation

For npm users npm i simple-regex For yarn users yarn add simple-regex

Usage

To test a variable against a Regex expression:

SimpleRegex.MobileNumber.Econet.test(<your-variable>). This will return a boolean which indicates whether your variable matches the Regex Pattern.

You can also inject the Regex Pattern into HTML form fields. An example of this pattern in ReactJS <input type="text" name="number_plate" pattern={SimpleRegex.NumberPlate} title="Zimbabwean Number Plate">

Global Flag

Starting from version 2.0.0-alpha the package no longer has the global flag set by default. See an issue about it here

Available Patterns

SimpleRegex.MobileNumber.Econet Pattern for Econet Mobile Numbers

SimpleRegex.MobileNumber.Telecel Pattern for Telecel Mobile Numbers

SimpleRegex.MobileNumber.Netone Pattern for Netone Mobile Numbers

SimpleRegex.NumberPlate Pattern for Zimbabwean National Vehicle Registration Numbers

SimpleRegex.PassportNumber Pattern for Zimbabwean Passport Numbers

SimpleRegex.NationalId Pattern for Zimbabwean National Identification Numbers

SimpleRegex.EmailAddress Pattern for Email Addresses

SimpleRegex.DriversLicence Pattern for Zimbabwean Driver's Licences

SimpleRegex.SSN Pattern for Zimbabwean Social Security Number (NSSA)

SimpleRegex.DomainName Pattern for Zimbabwean domain name

simple-regex-ts's Issues

[BUG] Validation of numbers with whitespace.

Describe the bug
If the number that needs to be tested contains whitespace, the regex tes will give a false result.

To Reproduce
Steps to reproduce the behavior:

1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

Expected behavior
A clear and concise description of what you expected to happen.

Screenshots
If possible include screenshots to help explain your problem.

Platform: Where did you see this bug (please remove those what does not apply):

• Google Chrome
• Safari
• Microsoft Edge

Additional context
Please add any other context about the problem here (like the Operating System where you witnessed the bug)

Write contribution docs

Pattern to test MobileNumbers at once.

At the moment, testing if a value is a mobile number involves testing all three different RegExp SimpleRegex.MobileNumber.Econet.test(VALUE), SimpleRegex.MobileNumber.Netone.test(VALUE) and SimpleRegex.MobileNumber.Telecel.test(VALUE)...

A developer friendly way would be to have another single way to test all three line SimpleRegex.MobileNumber.test(VALUE), then all three can be can be tested at once.

Make the global flag optional

There are scenarios when the SimpleRegex tests will be run multiple times, for example, testing phone numbers during typing, after a user blurs input and just before sending an HTTP request to the server.

In these scenarios, the regex test return alternating results for the exact same phone number. After doing some digging (thanks to stack overflow), I realized that the global regex search starts from the previous match for each invocation of .test and that causes subsequent tests to have a different result even with the same input.

Example: Running SimpleRegex.MobileNumber.Econet.test(phoneNumber) twice, gives you different results

I would like to have an option to remove the global matching of the regexes.