regexpu is a source code transpiler that enables the use of ES2015 Unicode regular expressions in JavaScript-of-today (ES5). It rewrites regular expressions that make use of the ES2015 u flag into equivalent ES5-compatible regular expressions.
Consider a file named example-es2015.js with the following contents:
var string = 'foo💩bar';var match = string.match(/foo(.)bar/u);console.log(match[1]);// → '💩'// This regex matches any symbol from U+1F4A9 to U+1F4AB, and nothing else.var regex = /[\u{1F4A9}-\u{1F4AB}]/u;// The following regex is equivalent.var alternative = /[💩-💫]/u;console.log([ regex.test('a'), // false regex.test('💩'), // true regex.test('💪'), // true regex.
Let’s transpile it:
$ regexpu < example-es2015.js > example-es5.js
example-es5.js can now be used in ES5 environments. Its contents are as follows:
var string = 'foo💩bar';var match = string.match(/foo((?:[\0-\t\x0B\f\x0E-\u2027\u202A-\uD7FF\uE000-\uFFFF]|[\uD800-\uDBFF][\uDC00-\uDFFF]|[\uD800-\uDBFF](?![\uDC00-\uDFFF])|(?:[^\uD800-\uDBFF]|^)[\uDC00-\uDFFF]))bar/);console.log(match[1]);// → '💩'// This regex matches any symbol from U+1F4A9 to U+1F4AB, and nothing else.var regex = /(?:\uD83D[\uDCA9
Known limitations
regexpu only transpiles regular expression literals, so things like RegExp('…', 'u') are not affected.
To use regexpu programmatically, install it as a dependency via npm:
npm install regexpu --save-dev
To use the command-line interface, install regexpu globally:
npm install regexpu -g
API
regexpu.version
A string representing the semantic version number.
regexpu.rewritePattern(pattern, flags, options)
This is an alias for the rewritePattern function exported by regexpu-core. Please refer to that project’s documentation for more information.
regexpu.rewritePattern uses regjsgen, regjsparser, and regenerate as internal dependencies. If you only need this function in your program, it’s better to include it directly:
This prevents the Recast and Esprima dependencies from being loaded into memory.
regexpu.transformTree(ast, options) or its alias regexpu.transform(ast, options)
This function accepts an abstract syntax tree representing some JavaScript code, and returns a transformed version of the tree in which any regular expression literals that use the ES2015 u flag are rewritten in ES5.
The optional options object is passed to regexpu-core’s rewritePattern. For a description of the available options, see its documentation.
regexpu.transformTree uses Recast, regjsgen, regjsparser, and regenerate as internal dependencies. If you only need this function in your program, it’s better to include it directly:
This prevents the Esprima dependency from being loaded into memory.
regexpu.transpileCode(code, options)
This function accepts a string representing some JavaScript code, and returns a transpiled version of this code tree in which any regular expression literals that use the ES2015 u flag are rewritten in ES5.
regexpu.transpileCode uses Esprima, Recast, regjsgen, regjsparser, and regenerate as internal dependencies. If you only need this function in your program, feel free to include it directly: