How to get started
In the browser
Or use the jsDelivr CDN.
On the server (node.js)
npm install verbal-expressions
var VerEx = ;
$ npm run grunt (or) $ npm test
Creating a minified version
This will generate a minified version of VerbalExpressions.js (aptly named VerbalExpressions.min.js) in a dist folder.
$ npm run 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:
Testing if we have a valid URL
// Create an example of how to test for correctly formed URLsvar tester =;// Create an example URLvar testMe = '';// Use RegExp object's native test() functionif tester; // This output will fire}else;console; // Outputs the actual expression used: /^(http)(s)?(\:\/\/)(www\.)?([^\ ]*)$/
// Create a test stringvar replaceMe = 'Replace bird with a duck';// Create an expression that seeks for word "bird"var expression = ;// Execute the expression like a normal RegExp objectvar result = expression;// Outputs "Replace duck with a duck";
Shorthand for string replace:
var result = ;// Outputs "We have a blue house";
You can find the API documentation at the wiki pages.
A little word for a big help
Clone the repo and fork:
git clone https://github.com/jehna/VerbalExpressions.git.
Pull requests are warmly welcome!
Check out these slide decks for handy Github & git tips:
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.