Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Docs: fix no-invalid-regexp docs regarding ecmaVersion #13991

Merged
merged 1 commit into from Jan 15, 2021
Merged

Docs: fix no-invalid-regexp docs regarding ecmaVersion #13991

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
19 changes: 6 additions & 13 deletions docs/rules/no-invalid-regexp.md
View file
Open in desktop
Expand Up @@ -30,16 +30,9 @@ new RegExp
this.RegExp('[')
```

## Environments
Please note that this rule validates regular expressions per the latest ECMAScript specification, regardless of your parser settings.

ECMAScript 6 adds the following flag arguments to the `RegExp` constructor:

* `"u"` ([unicode](https://people.mozilla.org/~jorendorff/es6-draft.html#sec-get-regexp.prototype.unicode))
* `"y"` ([sticky](https://people.mozilla.org/~jorendorff/es6-draft.html#sec-get-regexp.prototype.sticky))

You can enable these to be recognized as valid by setting the ECMAScript version to 6 in your [ESLint configuration](../user-guide/configuring).

If you want to allow additional constructor flags for any reason, you can specify them using an `allowConstructorFlags` option in `.eslintrc`. These flags will then be ignored by the rule regardless of the `ecmaVersion` setting.
If you want to allow additional constructor flags for any reason, you can specify them using the `allowConstructorFlags` option. These flags will then be ignored by the rule.

## Options

Expand All @@ -49,14 +42,14 @@ This rule has an object option for exceptions:

### allowConstructorFlags

Examples of **correct** code for this rule with the `{ "allowConstructorFlags": ["u", "y"] }` option:
Examples of **correct** code for this rule with the `{ "allowConstructorFlags": ["a", "z"] }` option:

```js
/*eslint no-invalid-regexp: ["error", { "allowConstructorFlags": ["u", "y"] }]*/
/*eslint no-invalid-regexp: ["error", { "allowConstructorFlags": ["a", "z"] }]*/

new RegExp('.', 'y')
new RegExp('.', 'a')

new RegExp('.', 'yu')
new RegExp('.', 'az')
```

## Further Reading
Expand Down
129 changes: 110 additions & 19 deletions tests/lib/rules/no-invalid-regexp.js
View file
Open in desktop
Expand Up @@ -24,30 +24,68 @@ ruleTester.run("no-invalid-regexp", rule, {
"new RegExp('.', 'im')",
"global.RegExp('\\\\')",
"new RegExp('.', y)",
{ code: "new RegExp('.', 'y')", options: [{ allowConstructorFlags: ["y"] }] },
{ code: "new RegExp('.', 'u')", options: [{ allowConstructorFlags: ["U"] }] },
{ code: "new RegExp('.', 'yu')", options: [{ allowConstructorFlags: ["y", "u"] }] },
{ code: "new RegExp('/', 'yu')", options: [{ allowConstructorFlags: ["y", "u"] }] },
{ code: "new RegExp('\\/', 'yu')", options: [{ allowConstructorFlags: ["y", "u"] }] },
{ code: "new RegExp('.', 'y')", parserOptions: { ecmaVersion: 6 } },
{ code: "new RegExp('.', 'u')", parserOptions: { ecmaVersion: 6 } },
{ code: "new RegExp('.', 'yu')", parserOptions: { ecmaVersion: 6 } },
{ code: "new RegExp('/', 'yu')", parserOptions: { ecmaVersion: 6 } },
{ code: "new RegExp('\\/', 'yu')", parserOptions: { ecmaVersion: 6 } },
{ code: "new RegExp('\\\\u{65}', 'u')", parserOptions: { ecmaVersion: 2015 } },
{ code: "new RegExp('[\\\\u{0}-\\\\u{1F}]', 'u')", parserOptions: { ecmaVersion: 2015 } },
{ code: "new RegExp('.', 's')", parserOptions: { ecmaVersion: 2018 } },
{ code: "new RegExp('(?<=a)b')", parserOptions: { ecmaVersion: 2018 } },
{ code: "new RegExp('(?<!a)b')", parserOptions: { ecmaVersion: 2018 } },
{ code: "new RegExp('(?<a>b)\\k<a>')", parserOptions: { ecmaVersion: 2018 } },
{ code: "new RegExp('(?<a>b)\\k<a>', 'u')", parserOptions: { ecmaVersion: 2018 } },
{ code: "new RegExp('\\\\p{Letter}', 'u')", parserOptions: { ecmaVersion: 2018 } },
"new RegExp('.', 'y')",
"new RegExp('.', 'u')",
"new RegExp('.', 'yu')",
"new RegExp('/', 'yu')",
"new RegExp('\\/', 'yu')",
"new RegExp('\\\\u{65}', 'u')",
"new RegExp('\\\\u{65}*', 'u')",
"new RegExp('[\\\\u{0}-\\\\u{1F}]', 'u')",
"new RegExp('.', 's')",
"new RegExp('(?<=a)b')",
"new RegExp('(?<!a)b')",
"new RegExp('(?<a>b)\\k<a>')",
"new RegExp('(?<a>b)\\k<a>', 'u')",
"new RegExp('\\\\p{Letter}', 'u')",

// ES2020
"new RegExp('(?<\\\\ud835\\\\udc9c>.)', 'g')",
"new RegExp('(?<\\\\u{1d49c}>.)', 'g')",
"new RegExp('(?<𝒜>.)', 'g');",
"new RegExp('\\\\p{Script=Nandinagari}', 'u');"
"new RegExp('\\\\p{Script=Nandinagari}', 'u');",

// allowConstructorFlags
{
code: "new RegExp('.', 'g')",
options: [{ allowConstructorFlags: [] }]
},
{
code: "new RegExp('.', 'g')",
options: [{ allowConstructorFlags: ["a"] }]
},
{
code: "new RegExp('.', 'a')",
options: [{ allowConstructorFlags: ["a"] }]
},
{
code: "new RegExp('.', 'ag')",
options: [{ allowConstructorFlags: ["a"] }]
},
{
code: "new RegExp('.', 'ga')",
options: [{ allowConstructorFlags: ["a"] }]
},
{
code: "new RegExp('.', 'a')",
options: [{ allowConstructorFlags: ["a", "z"] }]
},
{
code: "new RegExp('.', 'z')",
options: [{ allowConstructorFlags: ["a", "z"] }]
},
{
code: "new RegExp('.', 'az')",
options: [{ allowConstructorFlags: ["a", "z"] }]
},
{
code: "new RegExp('.', 'za')",
options: [{ allowConstructorFlags: ["a", "z"] }]
},
{
code: "new RegExp('.', 'agz')",
options: [{ allowConstructorFlags: ["a", "z"] }]
}
],
invalid: [
{
Expand All @@ -66,6 +104,42 @@ ruleTester.run("no-invalid-regexp", rule, {
type: "CallExpression"
}]
},
{
code: "RegExp('.', 'a');",
options: [{}],
errors: [{
messageId: "regexMessage",
data: { message: "Invalid flags supplied to RegExp constructor 'a'" },
type: "CallExpression"
}]
},
{
code: "new RegExp('.', 'a');",
options: [{ allowConstructorFlags: [] }],
errors: [{
messageId: "regexMessage",
data: { message: "Invalid flags supplied to RegExp constructor 'a'" },
type: "NewExpression"
}]
},
{
code: "new RegExp('.', 'z');",
options: [{ allowConstructorFlags: ["a"] }],
errors: [{
messageId: "regexMessage",
data: { message: "Invalid flags supplied to RegExp constructor 'z'" },
type: "NewExpression"
}]
},
{
code: "new RegExp('.', 'az');",
options: [{ allowConstructorFlags: ["z"] }],
errors: [{
messageId: "regexMessage",
data: { message: "Invalid flags supplied to RegExp constructor 'a'" },
type: "NewExpression"
}]
},
{
code: "new RegExp(')');",
errors: [{
Expand All @@ -74,6 +148,23 @@ ruleTester.run("no-invalid-regexp", rule, {
type: "NewExpression"
}]
},
{
code: String.raw`new RegExp('\\a', 'u');`,
errors: [{
messageId: "regexMessage",
data: { message: "Invalid regular expression: /\\a/u: Invalid escape" },
type: "NewExpression"
}]
},
{
code: String.raw`new RegExp('\\a', 'u');`,
options: [{ allowConstructorFlags: ["u"] }],
errors: [{
messageId: "regexMessage",
data: { message: "Invalid regular expression: /\\a/u: Invalid escape" },
type: "NewExpression"
}]
},

// https://github.com/eslint/eslint/issues/10861
{
Expand Down