VerbalExpressions is a JavaScript library that helps to construct difficult regular expressions.
<script src="VerbalExpressions.js"></script>
Or use the jsDelivr CDN.
Install:
$ npm install verbal-expressions
Require:
const VerEx = require('verbal-expressions');
Or use ES6's import
:
import VerEx from 'verbal-expressions';
$ npm test
(or)
$ npm run test:verbose
$ npm run build
This will run Babel on VerbalExpressions.js
and output the result to dist/verbalexpressions.js
. A minified version of the same will also be written to dist/verbalexpressions.min.js
.
A source map will also be created in dist
, so you can use the original "un-babelified", unminified source file for debugging purposes.
You can find the API documentation at https://verbalexpressions.github.io/JSVerbalExpressions
Here are some simple examples to give an idea of how VerbalExpressions works:
// 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)) {
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
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"
alert(result);
const result = VerEx().find('red').replace('We have a red house', 'blue');
// Outputs "We have a blue house"
alert(result);
I'd like to promote a special thank-you to Ben Nadel for his great article about extending native JS objects
Pull requests are warmly welcome!
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. Check .eslintrc
.
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 in the VerbalExpressions/implementation repo. Please don't open PRs for other languages against this repo.