VerbalExpressions is a JavaScript library that helps to construct difficult regular expressions.
You can see an up to date list of all ports on VerbalExpressions.github.io.
If you would like to contribute another port (which would be awesome!), please open an issue specifying the language. A repo in the VerbalExpressions organization will be created for it. Please don't open PRs for other languages against this repo.
<script type="text/javascript" src="VerbalExpressions.js"></script>
Install:
npm install verbal-expressions
Require:
var VerEx = require('verbal-expressions');
$ grunt
(or)
$ grunt test
This will generate a minified version of VerbalExpressions.js (aptly named VerbalExpressions.min.js) in a dist folder.
$ grunt build
A source map will also be created in the same folder, so you can use the original unminified source file (copied to dist as well) for debugging purposes.
Here's a couple of simple examples to give an idea of how VerbalExpressions works:
// Create an example of how to test for correctly formed URLs
var tester = VerEx()
.startOfLine()
.then('http')
.maybe('s')
.then('://')
.maybe('www.')
.anythingBut(' ')
.endOfLine();
// Create an example URL
var testMe = 'https://www.google.com';
// Use RegExp object's native test() function
if (tester.test(testMe)) {
alert('We have a correct URL '); // This output will fire}
} else {
alert('The URL is incorrect');
}
console.log(tester); // Outputs the actual expression used: /^(http)(s)?(\:\/\/)(www\.)?([^\ ]*)$/
// Create a test string
var replaceMe = 'Replace bird with a duck';
// Create an expression that seeks for word "bird"
var expression = VerEx().find('bird');
// Execute the expression like a normal RegExp object
var result = expression.replace(replaceMe, 'duck');
// Outputs "Replace duck with a duck"
alert(result);
var result = VerEx().find('red').replace('We have a red house', 'blue');
// Outputs "We have a blue house"
alert(result);
You can find the API documentation at the wiki pages.
I'd like to promote a special thank-you to Ben Nadel for his great article about extending native JS objects
Clone the repo and fork:
git clone https://github.com/jehna/VerbalExpressions.git
.
The Airbnb style guide is loosely used as a basis for creating clean and readable JavaScript code.
Pull requests are warmly welcome!
Check out these slide decks for handy Github & git tips: