re2js 1.0.1 → 1.2.0

package/README.md

@@ -98,18 +98,6 @@ RE2JS.DISABLE_UNICODE_GROUPS
 RE2JS.LONGEST_MATCH
 ```
 
-### Program size
-
-The program size represents a very approximate measure of a regexp's "cost". Larger numbers are more expensive than smaller numbers.
-
-```js
-import { RE2JS } from 're2js'
-
-console.log(RE2JS.compile('^').programSize()); // Outputs: 3
-console.log(RE2JS.compile('a+b').programSize()); // Outputs: 5
-console.log(RE2JS.compile('(a+b?)').programSize()); // Outputs: 8
-```
-
 ### Checking for Matches
 
 RE2JS allows you to check if a string matches a given regex pattern using the `matches()` function
@@ -353,6 +341,25 @@ RE2JS.compile('(.)(.)(.)(.)(.)(.)(.)(.)(.)(.)(.)(.)(.)')
 
 Function support second argument `perlMode`, which work in the same way, as for `replaceAll` function
 
+### Translating Regular Expressions
+
+The `translateRegExp()` method preprocesses a given regular expression string to ensure compatibility with RE2JS.
+It applies necessary transformations, such as escaping special characters, adjusting Unicode sequences, and converting named capture groups
+
+```js
+import { RE2JS } from 're2js'
+
+const regexp = RE2JS.translateRegExp('(?<word>\\w+)') // '(?P<word>\\w+)'
+
+RE2JS.matches(regexp, 'hello') // true
+RE2JS.matches(regexp, '123') // true
+
+const unicodeRegexp = RE2JS.translateRegExp('\\u{1F600}') // '\\x{1F600}'
+
+RE2JS.matches(unicodeRegexp, '😀') // true
+RE2JS.matches(unicodeRegexp, '😃') // false
+```
+
 ### Escaping Special Characters
 
 The `quote()` method returns a literal pattern string for the specified string. This can be useful if you want to search for a literal string pattern that may contain special characters
@@ -366,9 +373,21 @@ RE2JS.matches(regexp, 'ab+c') // true
 RE2JS.matches(regexp, 'abc') // false
 ```
 
+### Program size
+
+The program size represents a very approximate measure of a regexp's "cost". Larger numbers are more expensive than smaller numbers
+
+```js
+import { RE2JS } from 're2js'
+
+console.log(RE2JS.compile('^').programSize()); // Outputs: 3
+console.log(RE2JS.compile('a+b').programSize()); // Outputs: 5
+console.log(RE2JS.compile('(a+b?)').programSize()); // Outputs: 8
+```
+
 ## Performance
 
-The RE2JS engine runs more slowly compared to native RegExp objects. This reduced speed is also noticeable when comparing RE2JS to the original RE2 engine. The C++ implementation of the RE2 engine includes both NFA (Nondeterministic Finite Automaton) and DFA (Deterministic Finite Automaton) engines, as well as a variety of optimizations. Russ Cox ported a simplified version of the NFA engine to Go. Later, Alan Donovan ported the NFA-based Go implementation to Java. I then ported the NFA-based Java implementation to a pure JS version. This is another reason why the pure JS version will perform more slowly compared to the original RE2 engine.
+The RE2JS engine runs more slowly compared to native RegExp objects. This reduced speed is also noticeable when comparing RE2JS to the original RE2 engine. The C++ implementation of the RE2 engine includes both NFA (Nondeterministic Finite Automaton) and DFA (Deterministic Finite Automaton) engines, as well as a variety of optimizations. Russ Cox ported a simplified version of the NFA engine to Go. Later, Alan Donovan ported the NFA-based Go implementation to Java. I then ported the NFA-based Java implementation (plus Golang stuff, which are not present in Java implementation, like checks for regular expression complexity) to a pure JS version. This is another reason why the pure JS version will perform more slowly compared to the original RE2 engine.
 
 Should you require high performance on the server side when using RE2, it would be beneficial to consider the following packages for JS:
 
@@ -418,7 +437,7 @@ These factors combined make the RE2 vanilla JS port a valuable tool for develope
 Some files like `CharGroup.js` and `UnicodeTables.js` is generated and should be edited in generator files
 
 ```bash
-./tools/scripts/make_perl_groups.pl  > src/CharGroup.js
+./tools/scripts/make_perl_groups.pl > src/CharGroup.js
 yarn node ./tools/scripts/genUnicodeTable.js > src/UnicodeTables.js
 ```