-
-
Notifications
You must be signed in to change notification settings - Fork 791
feat(js_analyze): implement useRegexpExec
#8034
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.
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
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Some comments aren't visible on the classic Files Changed page.
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| --- | ||
| "@biomejs/biome": patch | ||
| --- | ||
|
|
||
| Added the nursery rule [`useRegexpExec`](https://biomejs.dev/linter/rules/use-regexp-exec/). Enforce `RegExp#exec` over `String#match` if no global flag is provided. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
24 changes: 24 additions & 0 deletions
24
crates/biome_cli/src/execute/migrate/eslint_any_rule_to_biome.rs
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
Large diffs are not rendered by default.
Oops, something went wrong.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
106 changes: 106 additions & 0 deletions
106
crates/biome_js_analyze/src/lint/nursery/use_regexp_exec.rs
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,106 @@ | ||
| use crate::services::typed::Typed; | ||
| use biome_analyze::{ | ||
| Rule, RuleDiagnostic, RuleDomain, RuleSource, context::RuleContext, declare_lint_rule, | ||
| }; | ||
| use biome_console::markup; | ||
| use biome_js_syntax::JsCallExpression; | ||
| use biome_js_type_info::{Literal, ResolvedTypeData, TypeData}; | ||
| use biome_rowan::{AstNode, AstSeparatedList}; | ||
| use biome_rule_options::use_regexp_exec::UseRegexpExecOptions; | ||
|
|
||
| declare_lint_rule! { | ||
| /// Enforce `RegExp#exec` over `String#match` if no global flag is provided. | ||
| /// | ||
| /// String#match is defined to work the same as RegExp#exec when the regular expression does not include the g flag. | ||
| /// Keeping to consistently using one of the two can help improve code readability. | ||
| /// | ||
| /// RegExp#exec may also be slightly faster than String#match; this is the reason to choose it as the preferred usage. | ||
| /// | ||
| /// ## Examples | ||
| /// | ||
| /// ### Invalid | ||
| /// | ||
| /// ```ts,file=invalid.ts,expect_diagnostic | ||
| /// 'something'.match(/thing/); | ||
| /// ``` | ||
| /// | ||
| /// ### Valid | ||
| /// | ||
| /// ```ts,file=valid.ts | ||
| /// /thing/.exec('something'); | ||
| /// ``` | ||
| /// | ||
| pub UseRegexpExec { | ||
| version: "next", | ||
| name: "useRegexpExec", | ||
| language: "js", | ||
| recommended: false, | ||
| sources: &[RuleSource::EslintTypeScript("prefer-regexp-exec").same(), RuleSource::EslintRegexp("prefer-regexp-exec").same()], | ||
| domains: &[RuleDomain::Project], | ||
| } | ||
| } | ||
|
|
||
| impl Rule for UseRegexpExec { | ||
| type Query = Typed<JsCallExpression>; | ||
| type State = (); | ||
| type Signals = Option<Self::State>; | ||
| type Options = UseRegexpExecOptions; | ||
|
|
||
| fn run(ctx: &RuleContext<Self>) -> Self::Signals { | ||
| let node = ctx.query(); | ||
|
|
||
| let binding = node.callee().ok()?.omit_parentheses(); | ||
| let callee = binding.as_js_static_member_expression()?; | ||
|
|
||
| let call_object = callee.object().ok()?; | ||
| if !ctx | ||
| .type_of_expression(&call_object) | ||
| .is_string_or_string_literal() | ||
| { | ||
| return None; | ||
| } | ||
|
|
||
| let call_name = callee.member().ok()?.as_js_name()?.to_trimmed_text(); | ||
| if call_name != "match" { | ||
| return None; | ||
| } | ||
|
|
||
| let args = node.arguments().ok()?.args(); | ||
| let first_arg = args.first()?.ok()?; | ||
| let express = first_arg.as_any_js_expression()?; | ||
|
|
||
| let value_type = ctx.type_of_expression(express); | ||
|
|
||
| if value_type | ||
| .resolved_data() | ||
| .map(ResolvedTypeData::as_raw_data) | ||
| .is_some_and(|ty| match ty { | ||
| TypeData::Literal(literal) => match literal.as_ref() { | ||
| Literal::RegExp(literal) => !literal.flags.contains('g'), | ||
| _ => false, | ||
| }, | ||
| _ => false, | ||
| }) | ||
| { | ||
| return Some(()); | ||
| } | ||
|
|
||
| None | ||
| } | ||
|
|
||
| fn diagnostic(ctx: &RuleContext<Self>, _state: &Self::State) -> Option<RuleDiagnostic> { | ||
| let node = ctx.query(); | ||
| Some( | ||
| RuleDiagnostic::new( | ||
| rule_category!(), | ||
| node.range(), | ||
| markup! { | ||
| "Prefer "<Emphasis>"RegExp#exec()"</Emphasis>" over "<Emphasis>"String#match()"</Emphasis>" when searching within a string." | ||
| }, | ||
| ) | ||
| .note(markup! { | ||
| "Use "<Emphasis>"RegExp#exec()"</Emphasis>" instead of "<Emphasis>"String#match()"</Emphasis>" for consistent and slightly faster regex matching." | ||
| }), | ||
| ) | ||
| } | ||
| } | ||
13 changes: 13 additions & 0 deletions
13
crates/biome_js_analyze/tests/specs/nursery/useRegexpExec/invalid.js
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| 'something'.match(/thing/); | ||
|
|
||
| 'some things are just things'.match(/thing/); | ||
|
|
||
| 'something'.match(new RegExp(/thing/)); | ||
|
|
||
| const text = 'something'; | ||
| const search = /thing/; | ||
| text.match(search); | ||
|
|
||
| const text1 = 'something'; | ||
| const search1 = new RegExp(/thing/); | ||
| text1.match(search1); |
71 changes: 71 additions & 0 deletions
71
crates/biome_js_analyze/tests/specs/nursery/useRegexpExec/invalid.js.snap
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,71 @@ | ||
| --- | ||
| source: crates/biome_js_analyze/tests/spec_tests.rs | ||
| expression: invalid.js | ||
| --- | ||
| # Input | ||
| ```js | ||
| 'something'.match(/thing/); | ||
|
|
||
| 'some things are just things'.match(/thing/); | ||
|
|
||
| 'something'.match(new RegExp(/thing/)); | ||
|
|
||
| const text = 'something'; | ||
| const search = /thing/; | ||
| text.match(search); | ||
|
|
||
| const text1 = 'something'; | ||
| const search1 = new RegExp(/thing/); | ||
| text1.match(search1); | ||
|
|
||
| ``` | ||
|
|
||
| # Diagnostics | ||
| ``` | ||
| invalid.js:1:1 lint/nursery/useRegexpExec ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ | ||
|
|
||
| i Prefer RegExp#exec() over String#match() when searching within a string. | ||
|
|
||
| > 1 │ 'something'.match(/thing/); | ||
| │ ^^^^^^^^^^^^^^^^^^^^^^^^^^ | ||
| 2 │ | ||
| 3 │ 'some things are just things'.match(/thing/); | ||
|
|
||
| i Use RegExp#exec() instead of String#match() for consistent and slightly faster regex matching. | ||
|
|
||
|
|
||
| ``` | ||
|
|
||
| ``` | ||
| invalid.js:3:1 lint/nursery/useRegexpExec ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ | ||
|
|
||
| i Prefer RegExp#exec() over String#match() when searching within a string. | ||
|
|
||
| 1 │ 'something'.match(/thing/); | ||
| 2 │ | ||
| > 3 │ 'some things are just things'.match(/thing/); | ||
| │ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | ||
| 4 │ | ||
| 5 │ 'something'.match(new RegExp(/thing/)); | ||
|
|
||
| i Use RegExp#exec() instead of String#match() for consistent and slightly faster regex matching. | ||
|
|
||
|
|
||
| ``` | ||
|
|
||
| ``` | ||
| invalid.js:9:1 lint/nursery/useRegexpExec ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ | ||
|
|
||
| i Prefer RegExp#exec() over String#match() when searching within a string. | ||
|
|
||
| 7 │ const text = 'something'; | ||
| 8 │ const search = /thing/; | ||
| > 9 │ text.match(search); | ||
| │ ^^^^^^^^^^^^^^^^^^ | ||
| 10 │ | ||
| 11 │ const text1 = 'something'; | ||
|
|
||
| i Use RegExp#exec() instead of String#match() for consistent and slightly faster regex matching. | ||
|
|
||
|
|
||
| ``` |
22 changes: 22 additions & 0 deletions
22
crates/biome_js_analyze/tests/specs/nursery/useRegexpExec/valid.js
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| /* should not generate diagnostics */ | ||
| /thing/.exec('something'); | ||
|
|
||
| 'some things are just things'.match(/thing/g); | ||
|
|
||
| const text = 'something'; | ||
| const search = /thing/; | ||
| search.exec(text); | ||
|
|
||
| const text1 = 'something'; | ||
| const search1 = /thing/g; | ||
| text1.match(search1); | ||
|
|
||
| const obj = { | ||
| match: () => { } | ||
| } | ||
| obj.match(/thing/) | ||
|
|
||
| new RegExp(/thing/).exec('something'); | ||
|
|
||
| 'some things are just things'.match(new RegExp(/thing/g)); | ||
| 'some things are just things'.match(new RegExp(/thing/, "g")); |
30 changes: 30 additions & 0 deletions
30
crates/biome_js_analyze/tests/specs/nursery/useRegexpExec/valid.js.snap
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,30 @@ | ||
| --- | ||
| source: crates/biome_js_analyze/tests/spec_tests.rs | ||
| expression: valid.js | ||
| --- | ||
| # Input | ||
| ```js | ||
| /* should not generate diagnostics */ | ||
| /thing/.exec('something'); | ||
|
|
||
| 'some things are just things'.match(/thing/g); | ||
|
|
||
| const text = 'something'; | ||
| const search = /thing/; | ||
| search.exec(text); | ||
|
|
||
| const text1 = 'something'; | ||
| const search1 = /thing/g; | ||
| text1.match(search1); | ||
|
|
||
| const obj = { | ||
| match: () => { } | ||
| } | ||
| obj.match(/thing/) | ||
|
|
||
| new RegExp(/thing/).exec('something'); | ||
|
|
||
| 'some things are just things'.match(new RegExp(/thing/g)); | ||
| 'some things are just things'.match(new RegExp(/thing/, "g")); | ||
|
|
||
| ``` |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| use biome_deserialize_macros::{Deserializable, Merge}; | ||
| use serde::{Deserialize, Serialize}; | ||
| #[derive(Default, Clone, Debug, Deserialize, Deserializable, Eq, Merge, PartialEq, Serialize)] | ||
| #[cfg_attr(feature = "schema", derive(schemars::JsonSchema))] | ||
| #[serde(rename_all = "camelCase", deny_unknown_fields, default)] | ||
| pub struct UseRegexpExecOptions {} |
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Are these two sources implementing the exact same rule? Otherwise, maybe one or both need to be changed from
same()toinspired().There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
They are exactly the same