Skip to content

test(linter): allow disabling optimizations #13735

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

test(linter): allow disabling optimizations #13735

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.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion apps/oxlint/src/lint.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -333,7 +333,10 @@ impl LintRunner {

let linter = Linter::new(LintOptions::default(), config_store, external_linter)
.with_fix(fix_options.fix_kind())
.with_report_unused_directives(report_unused_directives);
.with_report_unused_directives(report_unused_directives)
.with_disabled_optimizations(
std::env::var("OXLINT_NO_OPTIMIZE").is_ok_and(|v| v == "1" || v == "true"),
);

let number_of_files = files_to_lint.len();

Expand Down
21 changes: 18 additions & 3 deletions crates/oxc_linter/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,9 @@ pub struct Linter {
options: LintOptions,
config: ConfigStore,
external_linter: Option<ExternalLinter>,
/// Allow disabling node type optimization for testing and debugging to ensure that we are correctly
/// generating diagnostics regardless of the optimization.
disable_node_type_optimization: bool,
}

impl Linter {
Expand All @@ -98,7 +101,7 @@ impl Linter {
config: ConfigStore,
external_linter: Option<ExternalLinter>,
) -> Self {
Self { options, config, external_linter }
Self { options, config, external_linter, disable_node_type_optimization: false }
}

/// Set the kind of auto fixes to apply.
Expand All @@ -114,6 +117,14 @@ impl Linter {
self
}

/// Allows disabling runtime optimizations for testing and debugging. Should only be called
/// via some sort of debug flag and not called normally.
#[must_use]
pub fn with_disabled_optimizations(mut self, do_not_optimize: bool) -> Self {
self.disable_node_type_optimization = do_not_optimize;
self
}

pub(crate) fn options(&self) -> &LintOptions {
&self.options
}
Expand Down Expand Up @@ -188,7 +199,9 @@ impl Linter {
let rule = *rule;
// Collect node type information for rules. In large files, benchmarking showed it was worth
// collecting rules into buckets by AST node type to avoid iterating over all rules for each node.
if let Some(ast_types) = rule.types_info() {
if !self.disable_node_type_optimization
&& let Some(ast_types) = rule.types_info()
{
for ty in ast_types {
rules_by_ast_type[ty as usize].push((rule, ctx));
}
Expand Down Expand Up @@ -232,7 +245,9 @@ impl Linter {

// For smaller files, benchmarking showed it was faster to iterate over all rules and just check the
// node types as we go, rather than pre-bucketing rules by AST node type and doing extra allocations.
if let Some(ast_types) = rule.types_info() {
if !self.disable_node_type_optimization
&& let Some(ast_types) = rule.types_info()
{
for node in semantic.nodes() {
if ast_types.has(node.kind().ty()) {
rule.run(node, ctx);
Expand Down
Loading