Skip to content
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

fix(analyzer): suppression comment fails with inner comments in functions #4714

Merged
merged 1 commit into from
Jan 20, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
Copy link
Member

Choose a reason for hiding this comment

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

You must add the cli package too. Please read the contribution guide regarding the changesets

Copy link
Member Author

Choose a reason for hiding this comment

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

done

cli: patch
biome_analyze: patch
---

# Suppression comment should not fail with inner comments in functions

The follwing code:

```ts
// biome-ignore lint/complexity/useArrowFunction: not work
const foo0 = function (bar: string) {
// biome-ignore lint/style/noParameterAssign: work
bar = "baz";
};
```

The suppression comment `// biome-ignore lint/style/noParameterAssign: work` will not be invalid.
19 changes: 7 additions & 12 deletions crates/biome_analyze/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@

use biome_console::markup;
use biome_parser::AnyParse;
use std::cmp::Ordering;
use std::collections::{BTreeMap, BinaryHeap};
use std::fmt::{Debug, Display, Formatter};
use std::ops;
Expand Down Expand Up @@ -448,19 +447,15 @@ where
let index =
self.suppressions
.line_suppressions
.binary_search_by(|suppression| {
if suppression.text_range.end() < entry.text_range.start() {
Ordering::Less
} else if entry.text_range.end() < suppression.text_range.start() {
Ordering::Greater
} else {
Ordering::Equal
}
.partition_point(|suppression| {
suppression.text_range.end() < entry.text_range.start()
Copy link
Member

Choose a reason for hiding this comment

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

based on the Rust documentation for partition_point, is my understanding correct that the order suppression.text_range.end() < entry.text_range.start() follows Rust conventions for finding the boundary point of non-overlapping ranges?

Copy link
Member Author

Choose a reason for hiding this comment

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

yes, i think this will be the right way here

Copy link
Member

Choose a reason for hiding this comment

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

thanks

ematipico marked this conversation as resolved.
Show resolved Hide resolved
});

index
.ok()
.map(|index| &mut self.suppressions.line_suppressions[index])
if index >= self.suppressions.line_suppressions.len() {
None
} else {
Some(&mut self.suppressions.line_suppressions[index])
}
}
};

Expand Down
44 changes: 44 additions & 0 deletions crates/biome_js_analyze/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -874,6 +874,50 @@ let d;
);
}

#[test]
fn suppression_range_should_report_when_contains_inner_comment() {
const SOURCE: &str = "
// biome-ignore lint/complexity/useArrowFunction: single rule
const foo0 = function (bar: string) {
// biome-ignore lint/style/noParameterAssign: single rule
bar = 'baz';
};";

let parsed = parse(SOURCE, JsFileSource::ts(), JsParserOptions::default());

let enabled_rules = vec![
RuleFilter::Rule("complexity", "useArrowFunction"),
RuleFilter::Rule("style", "noParameterAssign"),
];

let filter = AnalysisFilter {
enabled_rules: Some(enabled_rules.as_slice()),
..AnalysisFilter::default()
};
let options = AnalyzerOptions::default();
let root = parsed.tree();
analyze(
&root,
filter,
&options,
Vec::new(),
JsFileSource::ts(),
Default::default(),
|signal| {
if let Some(diag) = signal.diagnostic() {
let error = diag
.with_file_path("dummyFile")
.with_file_source_code(SOURCE);
let text = print_diagnostic_to_string(&error);
eprintln!("{text}");
panic!("Unexpected diagnostic");
}

ControlFlow::<Never>::Continue(())
},
);
}

#[test]
fn unused_range_suppression() {
const SOURCE: &str = "
Expand Down
Loading