DenoVerbalExpressions

TypeScript Regular Expressions made easy

DenoVerbalExpressions is a TypeScript library for Deno that helps construct difficult regular expressions.

How to get started

On the server (Deno 1.0+)

Import:

In deps.ts

export { 
  Inputs, RegExpFlags, VerbalExpression, VerEx 
} from "https://deno.land/x/verbalexpressions";

To use in your Deno app:

import {
  Inputs, RegExpFlags, VerbalExpression, VerEx
} from "./deps.ts";

Running tests

sh run_tests.sh

API documentation

You can find the API documentation at DenoVerbalExpressions. You can find the source code for the docs in docs.

Examples

Here are some simple examples to give an idea of how VerbalExpressions works:

Testing if we have a valid URL

// Create an example of how to test for correctly formed URLs
const tester = VerEx()
    .startOfLine()
    .then("http")
    .maybe("s")
    .then("://")
    .maybe("www.")
    .anythingBut(" ")
    .endOfLine();

// Create an example URL
const testMe = "https://www.google.com";

// Use RegExp object's native test() function
if (tester.test(testMe)) {
    console.log("We have a correct URL"); // This output will fire
} else {
    console.log("The URL is incorrect");
}

console.log(tester); // Outputs the actual expression used: /^(http)(s)?(\:\/\/)(www\.)?([^\ ]*)$/

Replacing strings

// Create a test string
const replaceMe = "Replace bird with a duck";

// Create an expression that seeks for word "bird"
const expression = VerEx().find("bird");

// Execute the expression like a normal RegExp object
const result = expression.replace(replaceMe, "duck");

// Outputs "Replace duck with a duck"
console.log(result);

Shorthand for string replace

const result = VerEx().find("red").replace("We have a red house", "blue");

// Outputs "We have a blue house"
console.log(result);

Contributions

Pull requests are warmly welcome!

Clone the repo and fork:

git clone https://github.com/verbalexpressions/DenoVerbalExpressions.git

Style guide

The TypeScript Style Guide style guide is loosely used as a basis for creating clean and readable TypeScript code. Check tslint.

Check out these slide decks for handy Github & git tips:

• Git and Github Secrets
• More Git and Github Secrets

Tools

• https://verbalregex.com - it's a wrapper of JSVerbalExpressions; users can write down the code and compile to regex
• TypeScript Playground - TS Playground

Other Implementations

You can see an up to date list of all ports on VerbalExpressions.github.io.

• JavaScript
• Ruby
• C#
• Python
• Java
• Groovy
• PHP
• Haskell
• Haxe
• C++
• Objective-C
• Perl
• Swift

If you would like to contribute another port (which would be awesome!), please open an issue specifying the language in the VerbalExpressions/implementation repo. Please don't open PRs for other languages against this repo.