@ adguard/ re2-wasm (英语)

Google的RE2库作为由AdGuard补丁的WASM模块发售.

说明: 此软件包开发于 辅助软件。 。 。 . 这个 护卫小组/re2-wasm 寄存器是一个公共镜像.

说明

@ adguard/ re2-wasm (英语) 是谷歌的一个叉子 旧的 添加可配置 正则表达式的最大内存限制。 它编译了谷歌的 可再生能源2 C++ 库到 WASM通过 Emscripten 并将其曝光为 JavaScript 的倒置替代 RegExp。 。 。 .

此库供需要处理用户提供的正则表达式的 JavaScript 和 TypeScript 开发者使用 安全无虞. 内置 RegExp 引擎可以在指数化时间运行,同时具有脆弱的正则表达式和 "邪恶输入",导致 拒绝正常表达服务 (ReDOS) (英语)RE2担保 线性时间匹配,保护您的应用程序不受 ReDoS 攻击。 AdGuard 叉添加了已绑定的内存 通过 maxMem 选项——如果匹配尝试超过所配置的内存,引擎会丢出错误 限制,防止资源消耗.

RE2'正则表达式语言几乎是一个超级集,它是由 RegExp (见 语法),但它缺乏两个特征:回溯参考和前瞻 断言。 见 与RegExp 的区别 详细情况.

目录

• 安装
• 快速启动
• API 概览
• 用法实例
• 与RegExp 的区别
• 文档

安装

npm install @adguard/re2-wasm

需要Node.js QQ 10或一个有WASM支持的浏览器. 该软件包具有零运行时间依赖性——所有功能 来源于编译的WASM模块.

快速启动

const { RE2 } = require('@adguard/re2-wasm');

const re = new RE2('hello (\\w+)', 'u');
const result = re.exec('hello world');
// result[0]: 'hello world'
// result[1]: 'world'
// result.index: 0
console.log(result[0]); // 'hello world'

或带有ES模块:

import { RE2 } from '@adguard/re2-wasm';

const re = new RE2('\\d+', 'gu');
'abc 123 def 456'.match(re); // ['123', '456']

API 概览

这个 RE2 类模拟标准 RegExp 接口。 在大多数情况下,它可以用作倒置替代.

构造器

new RE2(pattern: string | RegExp | RE2, flags?: string, maxMem?: number)

属性

方法

这个 RE2 类也支持有名的符号,所以 String 方法直接工作:

const re = new RE2('\\d+', 'u');
'abc 123'.match(re);        // ['123', index: 4, input: 'abc 123']
'abc 123'.search(re);       // 4
'abc 123'.replace(re, 'X'); // 'abc X'
'abc 123'.split(re);        // ['abc ', '']

用法实例

从 RegExp 对象构造

const orig = /\w+/gu;
const re = new RE2(orig);
// Flags and pattern are copied from the original
console.log(re.flags); // 'gu'

使用 maxMem 选项绑定内存

// Limit the regex engine to 4 KB of memory
const re = new RE2('a*b*c*d*e*f*g*h*i*j*k*l*m*n*o*p*q*r*s*t*u*v*w*x*y*z*', 'u', 4096);
try {
  re.exec('aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa');
} catch (e) {
  console.log('Pattern exceeded memory limit');
}

命名的捕获组

const re = new RE2('(?P<word>\\w+) (?P<number>\\d+)', 'u');
const result = re.exec('hello 42');
console.log(result.groups.word);   // 'hello'
console.log(result.groups.number); // '42'

使用符号. matchall

const re = new RE2('\\w+', 'gu');
for (const match of 'one two three'.matchAll(re)) {
  console.log(match[0]);
}
// 'one'
// 'two'
// 'three'

替换一个函数

const re = new RE2('(\\d+)', 'gu');
const result = re.replace('a 10 b 20 c 30', (match, n) => String(Number(n) * 2));
console.log(result); // 'a 20 b 40 c 60'

返回到 RegExp 不支持的模式

const pattern = /(a)+(b)*\\1/u;
let re;
try {
  re = new RE2(pattern);
} catch (e) {
  // Pattern uses backreferences — fall back to RegExp
  re = pattern;
}
const result = re.exec('aabbaabb');

与RegExp 的区别

背书和抬头的断言不支持

RE2 不支持回溯引用( n)\\1, (中文(简体) ), \\2或看头/看后面的断言(等等)(?=...), (中文(简体) ), (?<=...), (中文(简体) ), (?!...), (中文(简体) ), (?<!...)) (中文(简体) ). 试图使用这些特性会投出 SyntaxError如果你的图案需要它们, 倒计时 RegExp (见《大会正式记录,第五十八届会议,补编第6号》) 倒置示例 (见上文).

Unicode 旗帜是强制的

这个 RE2 引擎总是以Unicode模式运行。 这个 u 构建时必须传递旗帜 RE2 实例:

new RE2('\\w+');           // throws Error: "u" flag must be passed
new RE2('\\w+', 'u');      // OK

内存限制

这个 maxMem 构造器参数( AdGuard 扩展) 限制 regex 引擎可分配多少内存 在匹配时。 如果超过限制,引擎会扔出一个错误. 过 0 不设限.

点行为

在RE2中, . 匹配任意字符,包括 \\n,无论是否 m 或者说 s 旗帜已经设定。 这是 等值为 RegExp是因为 s (dotall)旗帜总是在:

const re = new RE2('a.b', 'u');
console.log(re.exec('a\\nb')); // ['a\\nb']
console.log(/a.b/u.exec('a\\nb')); // null

多行模式锁定

在多行模式下, $ 在RE2中不匹配 \\r 财务报告和审定财务报表 \\n 当字符串结束时 \\r\\n数字 :

const re = new RE2('a$', 'mu');
re.exec('a\\r\\n'); // null — RE2 does not match between \\r and \\n
/a$/mu.exec('a\\r\\n'); // ['a'] — RegExp matches between \\r and \\n

compile() 方法

RegExp.prototype.compile() 在 RE2。称它是一个错误。 创建新 RE2 以实例代替.

d 旗帜( 有索引)

这个 hasIndices (单位:千美元)d) 旗帜不支持. 使用 RegExp 与 d 如果您需要开始和结束索引 捕捉组.

文档

• 发展 如何建立和作出贡献
• 更改日志 ——版本历史
• LLM 代理规则 ——AI协助发展指南