Skip to content

perf(linter): Use aho-corasick instead of regex for default comment patterns in no-fallthrough #5901

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

Closed
camchenry wants to merge 1 commit into from
Closed

perf(linter): Use aho-corasick instead of regex for default comment patterns in no-fallthrough #5901

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.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 25 additions & 5 deletions crates/oxc_linter/src/rules/eslint/no_fallthrough.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
use std::ops::Range;

use aho_corasick::AhoCorasick;
use itertools::Itertools;
use oxc_ast::{
ast::{Statement, SwitchCase, SwitchStatement},
Expand Down Expand Up @@ -35,11 +36,13 @@ fn no_unused_fallthrough_diagnostic(span: Span) -> OxcDiagnostic {
.with_label(span)
}

const DEFAULT_FALLTHROUGH_COMMENT_PATTERN: &str = r"falls?\s?through";
const DEFAULT_FALLTHROUGH_COMMENT_PATTERNS: [&str; 4] =
["fall through", "falls through", "fallthrough", "fallsthrough"];

#[derive(Debug, Clone)]
struct Config {
comment_pattern: Regex,
default_comment_pattern: AhoCorasick,
custom_comment_pattern: Option<Regex>,
allow_empty_case: bool,
report_unused_fallthrough_comment: bool,
}
Expand All @@ -53,9 +56,18 @@ impl NoFallthrough {
allow_empty_case: Option<bool>,
report_unused_fallthrough_comment: Option<bool>,
) -> Self {
let comment_pattern = comment_pattern.unwrap_or(DEFAULT_FALLTHROUGH_COMMENT_PATTERN);
let custom_comment_pattern = if let Some(pattern) = comment_pattern {
Some(Regex::new(format!("(?iu){pattern}").as_str()).unwrap())
} else {
None
};

Self(Box::new(Config {
comment_pattern: Regex::new(format!("(?iu){comment_pattern}").as_str()).unwrap(),
custom_comment_pattern,
default_comment_pattern: AhoCorasick::builder()
.ascii_case_insensitive(true)
.build(DEFAULT_FALLTHROUGH_COMMENT_PATTERNS)
.expect("Could not build AhoCorasick for default comment patterns"),
Copy link
Contributor

@DonIsaac DonIsaac Sep 19, 2024

Choose a reason for hiding this comment

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

Can we provide the name of the rule so users know where and how to fix their configs?

allow_empty_case: allow_empty_case.unwrap_or(false),
report_unused_fallthrough_comment: report_unused_fallthrough_comment.unwrap_or(false),
}))
Expand Down Expand Up @@ -370,6 +382,14 @@ impl NoFallthrough {
in_between.bytes().filter(|it| *it == b'\n').nth(1).is_some()
}

fn matches_comment_pattern(&self, comment: &str) -> bool {
if let Some(ref regex) = self.0.custom_comment_pattern {
regex.is_match(comment)
} else {
self.0.default_comment_pattern.is_match(comment)
}
}

fn maybe_allow_fallthrough_trivia(
&self,
ctx: &LintContext,
Expand All @@ -389,7 +409,7 @@ impl NoFallthrough {

comment.is_some_and(|comment| {
(!comment.starts_with("oxlint-") && !comment.starts_with("eslint-"))
&& self.0.comment_pattern.is_match(comment)
&& self.matches_comment_pattern(comment)
})
};

Expand Down