Skip to content

refactor(linter): move run on regex node to utils#10772

Merged
graphite-app[bot] merged 1 commit intomainfrom
c/05-02-refactor_linter_move_run_on_regex_node_to_utils
May 3, 2025
Merged

refactor(linter): move run on regex node to utils#10772
graphite-app[bot] merged 1 commit intomainfrom
c/05-02-refactor_linter_move_run_on_regex_node_to_utils

Conversation

@camc314
Copy link
Contributor

@camc314 camc314 commented May 2, 2025

No description provided.

@camc314 camc314 marked this pull request as ready for review May 2, 2025 17:56
Copy link
Contributor Author

camc314 commented May 2, 2025


How to use the Graphite Merge Queue

Add either label to this PR to merge it via the merge queue:

  • 0-merge - adds this PR to the back of the merge queue
  • hotfix - for urgent hot fixes, skip the queue and merge this PR next

You must have a Graphite account in order to use the merge queue. Sign up using this link.

An organization admin has enabled the Graphite Merge Queue in this repository.

Please do not merge from GitHub as this will restart CI on PRs being processed by the merge queue.

This stack of pull requests is managed by Graphite. Learn more about stacking.

@github-actions github-actions bot added the A-linter Area - Linter label May 2, 2025
@github-actions github-actions bot added the C-cleanup Category - technical debt or refactoring. Solution not expected to change behavior label May 2, 2025
@coderabbitai
Copy link

coderabbitai bot commented May 2, 2025

Walkthrough

The changes introduce a refactoring of the regular expression handling logic within the linter's "no_control_regex" rule. The previous approach, which involved manual extraction and parsing of regex patterns from different AST node types (regex literals, new RegExp(), and RegExp() calls), has been replaced with a new utility function, run_on_regex_node. This function, added in a new regex utility module, abstracts the detection and parsing of regex patterns from various node types and invokes a provided callback with the parsed pattern and its span. The no_control_regex rule now delegates regex node handling to this utility, simplifying its implementation and removing redundant parsing logic. Additionally, the regex module is publicly re-exported in the utils module, making its functionality accessible throughout the codebase. No changes were made to the core logic that checks for control characters in regex patterns.


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 731d8d6 and 2efe3f0.

📒 Files selected for processing (3)
  • crates/oxc_linter/src/rules/eslint/no_control_regex.rs (2 hunks)
  • crates/oxc_linter/src/utils/mod.rs (2 hunks)
  • crates/oxc_linter/src/utils/regex.rs (1 hunks)
✅ Files skipped from review due to trivial changes (1)
  • crates/oxc_linter/src/utils/regex.rs
🚧 Files skipped from review as they are similar to previous changes (2)
  • crates/oxc_linter/src/utils/mod.rs
  • crates/oxc_linter/src/rules/eslint/no_control_regex.rs
⏰ Context from checks skipped due to timeout of 90000ms (12)
  • GitHub Check: Benchmark (formatter)
  • GitHub Check: Benchmark (codegen)
  • GitHub Check: Benchmark (minifier)
  • GitHub Check: Benchmark (semantic)
  • GitHub Check: Test (macos-latest)
  • GitHub Check: Test (ubuntu-latest)
  • GitHub Check: Benchmark (isolated_declarations)
  • GitHub Check: Clippy
  • GitHub Check: Benchmark (transformer)
  • GitHub Check: Benchmark (parser)
  • GitHub Check: Build Linter Benchmark
  • GitHub Check: Benchmark (lexer)
✨ Finishing Touches
  • 📝 Generate Docstrings

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

‼️ IMPORTANT
Auto-reply has been disabled for this repository in the CodeRabbit settings. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged.

  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (2)
crates/oxc_linter/src/utils/regex.rs (2)

14-19: Literal branch: consider allowing multiple visits

run_on_regex_node takes cb: FnOnce, which is fine because a single AST node can expose at most one regex literal.
However, if the helper is reused for more complex nodes (e.g. an array of regex literals) we would have to re-enter the utility. Switching to FnMut would make the helper future-proof with negligible cost:

-pub fn run_on_regex_node<'a, 'b, M>(node: &'a AstNode<'b>, ctx: &'a LintContext<'b>, cb: M)
-where
-    M: FnOnce(&Pattern<'_>, Span),
+pub fn run_on_regex_node<'a, 'b, M>(node: &'a AstNode<'b>, ctx: &'a LintContext<'b>, mut cb: M)
+where
+    M: FnMut(&Pattern<'_>, Span),

20-41: new RegExp() parsing logic duplicated – DRY opportunity

The two big match arms for NewExpression and CallExpression are almost identical. Extracting the common code into a small helper will halve the branchy code and make future fixes (e.g. template-literal support) one-liners:

+fn parse_and_apply<'a>(
+    allocator: &Allocator,
+    pattern_arg: &Argument<'a>,
+    flags_arg: Option<&Argument<'a>>,
+    ctx: &'a LintContext<'_>,
+    cb: &mut impl FnMut(&Pattern<'_>, Span),
+) {
+    if let Argument::StringLiteral(pattern) = pattern_arg {
+        let flags_span = flags_arg.and_then(|a| match a {
+            Argument::StringLiteral(f) => Some(f.span),
+            _ => None,
+        });
+        if let Some(pat) = parse_regex(allocator, pattern.span, flags_span, ctx) {
+            cb(&pat, pattern.span);
+        }
+    }
+}

Then call this helper from both arms.
This keeps run_on_regex_node concise and easier to audit.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 8e99abf and bf3ccc8.

📒 Files selected for processing (3)
  • crates/oxc_linter/src/rules/eslint/no_control_regex.rs (2 hunks)
  • crates/oxc_linter/src/utils/mod.rs (2 hunks)
  • crates/oxc_linter/src/utils/regex.rs (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (8)
  • GitHub Check: Benchmark (formatter)
  • GitHub Check: Benchmark (codegen)
  • GitHub Check: Benchmark (minifier)
  • GitHub Check: Benchmark (transformer)
  • GitHub Check: Build Linter Benchmark
  • GitHub Check: Test (macos-latest)
  • GitHub Check: Benchmark (parser)
  • GitHub Check: Test (ubuntu-latest)
🔇 Additional comments (3)
crates/oxc_linter/src/utils/mod.rs (1)

10-20: New regex module is wired-in correctly – nice!

The module declaration (mod regex;) and the public re-export (regex::*) look consistent with the rest of the file and maintain alphabetical order, so downstream crates can now simply use utils::run_on_regex_node.
No further action needed.

crates/oxc_linter/src/utils/regex.rs (1)

70-88: Potential offset bug when no flags_span is present

flags_span_offset falls back to 0 when flags_span is None:

flags_span_offset: flags_span.map_or(0, |span| span.start)

If the constructor parser expects an offset relative to the pattern (or to the beginning of the file), 0 might be misleading and could shift diagnostic positions. Consider forwarding pattern_span.end (or the actual location where the flags would start) instead, or confirm that 0 is explicitly accepted by ConstructorParser.

Do you mind double-checking the expected semantics in ConstructorParser::new? If an offset of 0 is invalid we can patch it quickly.

crates/oxc_linter/src/rules/eslint/no_control_regex.rs (1)

71-75: Great simplification of the rule body

Swapping ~50 lines of bespoke extraction logic for one call to run_on_regex_node is a big readability win and removes duplicated parsing code. All existing tests still pass, so the refactor looks safe.

Nice job!

@codspeed-hq
Copy link

codspeed-hq bot commented May 2, 2025

CodSpeed Instrumentation Performance Report

Merging #10772 will not alter performance

Comparing c/05-02-refactor_linter_move_run_on_regex_node_to_utils (2efe3f0) with main (3de1b31)

Summary

✅ 36 untouched benchmarks

@camc314 camc314 force-pushed the c/05-02-refactor_linter_move_run_on_regex_node_to_utils branch from bf3ccc8 to 731d8d6 Compare May 2, 2025 23:15
@Boshen Boshen added the 0-merge Merge with Graphite Merge Queue label May 3, 2025
Copy link
Member

Boshen commented May 3, 2025

Merge activity

@graphite-app graphite-app bot force-pushed the c/05-02-refactor_linter_move_run_on_regex_node_to_utils branch from 731d8d6 to 2efe3f0 Compare May 3, 2025 00:27
@graphite-app graphite-app bot merged commit 2efe3f0 into main May 3, 2025
23 checks passed
@graphite-app graphite-app bot deleted the c/05-02-refactor_linter_move_run_on_regex_node_to_utils branch May 3, 2025 00:30
@graphite-app graphite-app bot removed the 0-merge Merge with Graphite Merge Queue label May 3, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

A-linter Area - Linter C-cleanup Category - technical debt or refactoring. Solution not expected to change behavior

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants