New: require-unicode-regexp rule (fixes #9961) #10698
Conversation
mysticatea
added
rule
lib/rules/require-unicode-regexp.js
Outdated
| url: "https://eslint.org/docs/rules/require-unicode-regexp" | ||
| }, | ||
| messages: { | ||
| requireUFlag: "Require 'u' flag." |
There was a problem hiding this comment.
I think this could be phrased better:
"'u' flag is required."Use the 'u' flag."
| errors: [{ messageId: "requireUFlag" }] | ||
| }, | ||
| { | ||
| code: "const flags = 'gimu'; new RegExp('foo', flags.slice(0, -1))", |
There was a problem hiding this comment.
I'm confused. The documentation says this test should be valid (i.e., rule ignores these cases where flags is non-constant variable), but this test is in the invalid section. Seems either this or the documentation needs to change.
There was a problem hiding this comment.
My word choice seemed bad. That ignores a RegExp call if it couldn't evaluate the 2nd argument to a static value in the file. In the test case, flags.slice(0, -1) is evaluated to 'gim' under the assumption that the standard APIs are valid.
There was a problem hiding this comment.
Initially I assumed this wouldn't be determined statically, but I spent a few minutes looking at your eslint-utils module, specifically the getStaticValue implementation, and I am thoroughly impressed with how powerful it is 👏
|
I updated the error message and the documentation. |
docs/rules/require-unicode-regexp.md
Outdated
| @@ -0,0 +1,55 @@ | |||
| # enforce the use of `u` flag on RegExp (require-unicode-regexp) | |||
There was a problem hiding this comment.
Tiny nit: can you capitalize the first letter of "Enforce"?
lib/rules/require-unicode-regexp.js
Outdated
| @@ -0,0 +1,65 @@ | |||
| /** | |||
| * @fileoverview Rule to | |||
There was a problem hiding this comment.
The @fileoverview description is incomplete
| const c = new RegExp("ccc", "u") | ||
| const d = new RegExp("ddd", "giu") | ||
|
|
||
| // This rule ignores RegExp calls if the flags could not be evaluated to a static value. |
| errors: [{ messageId: "requireUFlag" }] | ||
| }, | ||
| { | ||
| code: "const flags = 'gimu'; new RegExp('foo', flags.slice(0, -1))", |
There was a problem hiding this comment.
Initially I assumed this wouldn't be determined statically, but I spent a few minutes looking at your eslint-utils module, specifically the getStaticValue implementation, and I am thoroughly impressed with how powerful it is 👏
eslint-deprecated
bot
added
the
archived due to age
What is the purpose of this pull request? (put an "X" next to item)
[X] New rule: fixes #9961.
What changes did you make? (Give an overview)
This PR adds
require-unicode-regexrule.Is there anything you'd like reviewers to focus on?
Nothing in particular.