require-unicode-regexp

强制在 RegExp 上使用u或v标志

💡

此规则报告的一些问题可以通过编辑器建议手动修复

RegExp u 标志有两个作用

使正则表达式能够正确处理 UTF-16 替代对。

特别是，字符范围语法获得了正确的行为。
```
/^[👍]$/.test("👍") //→ false
/^[👍]$/u.test("👍") //→ true
1
2
```
通过禁用附录 B 扩展，使正则表达式尽早抛出语法错误。

由于历史原因，JavaScript 正则表达式能够容忍语法错误。例如，/\w{1, 2/ 是一个语法错误，但 JavaScript 不会抛出错误。它反而匹配诸如 "a{1, 2" 之类的字符串。这种恢复逻辑在附录 B 中定义。

u 标志禁用附录 B 定义的恢复逻辑。因此，您可以尽早发现错误。这类似于严格模式。

RegExp v 标志（在 ECMAScript 2024 中引入）是 u 标志的超集，并提供了两个更多功能

字符串的 Unicode 属性

使用 Unicode 属性转义，您可以使用字符串的属性。

const re = /^\p{RGI_Emoji}$/v;

// Match an emoji that consists of just 1 code point:
re.test('⚽'); // '\u26BD'
// → true ✅

// Match an emoji that consists of multiple code points:
re.test('👨🏾‍⚕️'); // '\u{1F468}\u{1F3FE}\u200D\u2695\uFE0F'
// → true ✅
1
2
3
4
5
6
7
8
9

集合符号

它允许在字符类之间进行集合运算。

const re = /[\p{White_Space}&&\p{ASCII}]/v;
re.test('\n'); // → true
re.test('\u2028'); // → false
1
2
3

因此，u 和 v 标志使我们能够更好地使用正则表达式。

规则详情

此规则旨在强制在正则表达式上使用u或v标志。

此规则的错误代码示例

在 Playground 中打开

/*eslint require-unicode-regexp: error */

const a = /aaa/
const b = /bbb/gi
const c = new RegExp("ccc")
const d = new RegExp("ddd", "gi")
1
2
3
4
5
6

此规则的正确代码示例

在 Playground 中打开

/*eslint require-unicode-regexp: error */

const a = /aaa/u
const b = /bbb/giu
const c = new RegExp("ccc", "u")
const d = new RegExp("ddd", "giu")

const e = /aaa/v
const f = /bbb/giv
const g = new RegExp("ccc", "v")
const h = new RegExp("ddd", "giv")

// This rule ignores RegExp calls if the flags could not be evaluated to a static value.
function i(flags) {
    return new RegExp("eee", flags)
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

选项

此规则有一个对象选项

"requireFlag": "u"|"v" 需要特定的 Unicode 正则表达式标志

requireFlag: “u”

在不支持 v 标志的环境中，可能更倾向于使用 u 标志。

使用{ "requireFlag": "u" }选项的此规则的错误代码示例

在 Playground 中打开

/*eslint require-unicode-regexp: ["error", { "requireFlag": "u" }] */

const fooEmpty = /foo/;

const fooEmptyRegexp = new RegExp('foo');

const foo = /foo/v;

const fooRegexp = new RegExp('foo', 'v');
1
2
3
4
5
6
7
8
9

使用{ "requireFlag": "u" }选项的此规则的正确代码示例

在 Playground 中打开

/*eslint require-unicode-regexp: ["error", { "requireFlag": "u" }] */

const foo = /foo/u;

const fooRegexp = new RegExp('foo', 'u');
1
2
3
4
5

requireFlag: “v”

当 v 标志受支持时，它可能是更好的选择，因为它比 u 标志具有更多功能（例如，能够测试字符串的 Unicode 属性）。但是，它确实具有更严格的语法（例如，需要转义字符类中的某些字符）。

使用{ "requireFlag": "v" }选项的此规则的错误代码示例

在 Playground 中打开

/*eslint require-unicode-regexp: ["error", { "requireFlag": "v" }] */

const fooEmpty = /foo/;

const fooEmptyRegexp = new RegExp('foo');

const foo = /foo/u;

const fooRegexp = new RegExp('foo', 'u');
1
2
3
4
5
6
7
8
9

使用{ "requireFlag": "v" }选项的此规则的正确代码示例

在 Playground 中打开

/*eslint require-unicode-regexp: ["error", { "requireFlag": "v" }] */

const foo = /foo/v;

const fooRegexp = new RegExp('foo', 'v');
1
2
3
4
5

何时不使用它

如果您不想在没有 u 或 v 标志的正则表达式上发出警告，则可以安全地禁用此规则。

版本

此规则是在 ESLint v5.3.0 中引入的。

进一步阅读

GitHub - tc39/proposal-regexp-v-flag: 正则表达式中的 UTS18 集合符号
github.com

带有集合符号和字符串属性的 RegExp v 标志 · V8
v8.dev

资源

编辑此页面