Skip to content

refactor(linter): accept PossibleFixes instead of Fix for Messages #11295

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

Merged
graphite-app merged 1 commit into from
May 29, 2025
Merged

refactor(linter): accept PossibleFixes instead of Fix for Messages #11295

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
4 changes: 2 additions & 2 deletions crates/oxc_linter/src/context/host.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ use crate::{
AllowWarnDeny, FrameworkFlags,
config::{LintConfig, LintPlugins},
disable_directives::{DisableDirectives, DisableDirectivesBuilder},
fixer::{FixKind, Message},
fixer::{FixKind, Message, PossibleFixes},
frameworks,
module_record::ModuleRecord,
options::LintOptions,
Expand Down Expand Up @@ -210,7 +210,7 @@ impl<'a> ContextHost<'a> {
OxcDiagnostic::error(message).with_label(span).with_severity(rule_severity),
// TODO: fixer
// if all rules in the same directive are unused, fixer should remove the entire comment
None,
PossibleFixes::None,
)
})
.collect(),
Expand Down
6 changes: 3 additions & 3 deletions crates/oxc_linter/src/context/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ use crate::{
AllowWarnDeny, FrameworkFlags, ModuleRecord, OxlintEnv, OxlintGlobals, OxlintSettings,
config::GlobalValue,
disable_directives::DisableDirectives,
fixer::{FixKind, Message, RuleFix, RuleFixer},
fixer::{FixKind, Message, PossibleFixes, RuleFix, RuleFixer},
};

mod host;
Expand Down Expand Up @@ -246,7 +246,7 @@ impl<'a> LintContext<'a> {
/// Use [`LintContext::diagnostic_with_fix`] to provide an automatic fix.
#[inline]
pub fn diagnostic(&self, diagnostic: OxcDiagnostic) {
self.add_diagnostic(Message::new(diagnostic, None));
self.add_diagnostic(Message::new(diagnostic, PossibleFixes::None));
}

/// Report a lint rule violation and provide an automatic fix.
Expand Down Expand Up @@ -366,7 +366,7 @@ impl<'a> LintContext<'a> {
);
}
}
self.add_diagnostic(Message::new(diagnostic, Some(fix)));
self.add_diagnostic(Message::new(diagnostic, PossibleFixes::Single(fix)));
} else {
self.diagnostic(diagnostic);
}
Expand Down
97 changes: 57 additions & 40 deletions crates/oxc_linter/src/fixer/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -274,7 +274,7 @@ impl<'new> CloneIn<'new> for Message<'_> {

impl<'a> Message<'a> {
#[expect(clippy::cast_possible_truncation)] // for `as u32`
pub fn new(error: OxcDiagnostic, fix: Option<Fix<'a>>) -> Self {
pub fn new(error: OxcDiagnostic, fixes: PossibleFixes<'a>) -> Self {
let (start, end) = if let Some(labels) = &error.labels {
let start = labels
.iter()
Expand All @@ -288,8 +288,6 @@ impl<'a> Message<'a> {
} else {
(0, 0)
};
// ToDo support multiple fixes
let fixes = fix.map_or(PossibleFixes::None, PossibleFixes::Single);
Self { error, span: Span::new(start, end), fixes, fixed: false }
}
}
Expand Down Expand Up @@ -387,7 +385,7 @@ mod test {
use oxc_diagnostics::OxcDiagnostic;
use oxc_span::Span;

use super::{CompositeFix, Fix, FixResult, Fixer, Message};
use super::{CompositeFix, Fix, FixResult, Fixer, Message, PossibleFixes};

fn insert_at_end() -> OxcDiagnostic {
OxcDiagnostic::warn("End")
Expand Down Expand Up @@ -464,28 +462,36 @@ mod test {
Fixer::new(TEST_CODE, messages).fix()
}

fn create_message(error: OxcDiagnostic, fix: Option<Fix>) -> Message {
fn create_message(error: OxcDiagnostic, fix: PossibleFixes) -> Message {
Message::new(error, fix)
}

#[test]
fn insert_at_the_end() {
let result = get_fix_result(vec![create_message(insert_at_end(), Some(INSERT_AT_END))]);
let result = get_fix_result(vec![create_message(
insert_at_end(),
PossibleFixes::Single(INSERT_AT_END),
)]);
assert_eq!(result.fixed_code, TEST_CODE.to_string() + INSERT_AT_END.content.as_ref());
assert_eq!(result.messages.len(), 0);
}

#[test]
fn insert_at_the_start() {
let result = get_fix_result(vec![create_message(insert_at_start(), Some(INSERT_AT_START))]);
let result = get_fix_result(vec![create_message(
insert_at_start(),
PossibleFixes::Single(INSERT_AT_START),
)]);
assert_eq!(result.fixed_code, INSERT_AT_START.content.to_string() + TEST_CODE);
assert_eq!(result.messages.len(), 0);
}

#[test]
fn insert_at_the_middle() {
let result =
get_fix_result(vec![create_message(insert_at_middle(), Some(INSERT_AT_MIDDLE))]);
let result = get_fix_result(vec![create_message(
insert_at_middle(),
PossibleFixes::Single(INSERT_AT_MIDDLE),
)]);
assert_eq!(
result.fixed_code,
TEST_CODE.cow_replace("6 *", &format!("{}{}", INSERT_AT_MIDDLE.content, "6 *"))
Expand All @@ -496,9 +502,9 @@ mod test {
#[test]
fn insert_at_the_start_middle_end() {
let messages = vec![
create_message(insert_at_middle(), Some(INSERT_AT_MIDDLE)),
create_message(insert_at_start(), Some(INSERT_AT_START)),
create_message(insert_at_end(), Some(INSERT_AT_END)),
create_message(insert_at_middle(), PossibleFixes::Single(INSERT_AT_MIDDLE)),
create_message(insert_at_start(), PossibleFixes::Single(INSERT_AT_START)),
create_message(insert_at_end(), PossibleFixes::Single(INSERT_AT_END)),
];
let result = get_fix_result(messages);
assert_eq!(
Expand All @@ -516,29 +522,35 @@ mod test {
#[test]
#[should_panic = "Negative range is invalid"]
fn ignore_reverse_range() {
let result = get_fix_result(vec![create_message(reverse_range(), Some(REVERSE_RANGE))]);
let result = get_fix_result(vec![create_message(
reverse_range(),
PossibleFixes::Single(REVERSE_RANGE),
)]);
assert_eq!(result.fixed_code, TEST_CODE);
}

#[test]
fn replace_at_the_start() {
let result = get_fix_result(vec![create_message(replace_var(), Some(REPLACE_VAR))]);
let result =
get_fix_result(vec![create_message(replace_var(), PossibleFixes::Single(REPLACE_VAR))]);
assert_eq!(result.fixed_code, TEST_CODE.cow_replace("var", "let"));
assert_eq!(result.messages.len(), 0);
assert!(result.fixed);
}

#[test]
fn replace_at_the_middle() {
let result = get_fix_result(vec![create_message(replace_id(), Some(REPLACE_ID))]);
let result =
get_fix_result(vec![create_message(replace_id(), PossibleFixes::Single(REPLACE_ID))]);
assert_eq!(result.fixed_code, TEST_CODE.cow_replace("answer", "foo"));
assert_eq!(result.messages.len(), 0);
assert!(result.fixed);
}

#[test]
fn replace_at_the_end() {
let result = get_fix_result(vec![create_message(replace_num(), Some(REPLACE_NUM))]);
let result =
get_fix_result(vec![create_message(replace_num(), PossibleFixes::Single(REPLACE_NUM))]);
assert_eq!(result.fixed_code, TEST_CODE.cow_replace('6', "5"));
assert_eq!(result.messages.len(), 0);
assert!(result.fixed);
Expand All @@ -547,9 +559,9 @@ mod test {
#[test]
fn replace_at_the_start_middle_end() {
let messages = vec![
create_message(replace_id(), Some(REPLACE_ID)),
create_message(replace_var(), Some(REPLACE_VAR)),
create_message(replace_num(), Some(REPLACE_NUM)),
create_message(replace_id(), PossibleFixes::Single(REPLACE_ID)),
create_message(replace_var(), PossibleFixes::Single(REPLACE_VAR)),
create_message(replace_num(), PossibleFixes::Single(REPLACE_NUM)),
];
let result = get_fix_result(messages);
assert_eq!(result.fixed_code, "let foo = 5 * 7;");
Expand All @@ -559,7 +571,10 @@ mod test {

#[test]
fn remove_at_the_start() {
let result = get_fix_result(vec![create_message(remove_start(), Some(REMOVE_START))]);
let result = get_fix_result(vec![create_message(
remove_start(),
PossibleFixes::Single(REMOVE_START),
)]);
assert_eq!(result.fixed_code, TEST_CODE.cow_replace("var ", ""));
assert_eq!(result.messages.len(), 0);
assert!(result.fixed);
Expand All @@ -569,7 +584,7 @@ mod test {
fn remove_at_the_middle() {
let result = get_fix_result(vec![create_message(
remove_middle(Span::default()),
Some(REMOVE_MIDDLE),
PossibleFixes::Single(REMOVE_MIDDLE),
)]);
assert_eq!(result.fixed_code, TEST_CODE.cow_replace("answer", "a"));
assert_eq!(result.messages.len(), 0);
Expand All @@ -578,7 +593,8 @@ mod test {

#[test]
fn remove_at_the_end() {
let result = get_fix_result(vec![create_message(remove_end(), Some(REMOVE_END))]);
let result =
get_fix_result(vec![create_message(remove_end(), PossibleFixes::Single(REMOVE_END))]);
assert_eq!(result.fixed_code, TEST_CODE.cow_replace(" * 7", ""));
assert_eq!(result.messages.len(), 0);
assert!(result.fixed);
Expand All @@ -587,9 +603,9 @@ mod test {
#[test]
fn replace_at_start_remove_at_middle_insert_at_end() {
let result = get_fix_result(vec![
create_message(insert_at_end(), Some(INSERT_AT_END)),
create_message(remove_end(), Some(REMOVE_END)),
create_message(replace_var(), Some(REPLACE_VAR)),
create_message(insert_at_end(), PossibleFixes::Single(INSERT_AT_END)),
create_message(remove_end(), PossibleFixes::Single(REMOVE_END)),
create_message(replace_var(), PossibleFixes::Single(REPLACE_VAR)),
]);
assert_eq!(result.fixed_code, "let answer = 6;// end");
assert_eq!(result.messages.len(), 0);
Expand All @@ -599,8 +615,8 @@ mod test {
#[test]
fn apply_one_fix_when_spans_overlap() {
let result = get_fix_result(vec![
create_message(remove_middle(Span::default()), Some(REMOVE_MIDDLE)),
create_message(replace_id(), Some(REPLACE_ID)),
create_message(remove_middle(Span::default()), PossibleFixes::Single(REMOVE_MIDDLE)),
create_message(replace_id(), PossibleFixes::Single(REPLACE_ID)),
]);
assert_eq!(result.fixed_code, TEST_CODE.cow_replace("answer", "foo"));
assert_eq!(result.messages.len(), 1);
Expand All @@ -611,8 +627,8 @@ mod test {
#[test]
fn apply_two_fix_when_the_start_the_same_as_the_previous_end() {
let result = get_fix_result(vec![
create_message(remove_start(), Some(REMOVE_START)),
create_message(replace_id(), Some(REPLACE_ID)),
create_message(remove_start(), PossibleFixes::Single(REMOVE_START)),
create_message(replace_id(), PossibleFixes::Single(REPLACE_ID)),
]);
assert_eq!(result.fixed_code, TEST_CODE.cow_replace("var answer", "foo"));
assert_eq!(result.messages.len(), 0);
Expand All @@ -622,9 +638,9 @@ mod test {
#[test]
fn apply_one_fix_when_range_overlap_and_one_message_has_no_fix() {
let result = get_fix_result(vec![
create_message(remove_middle(Span::default()), Some(REMOVE_MIDDLE)),
create_message(replace_id(), Some(REPLACE_ID)),
create_message(no_fix(Span::default()), None),
create_message(remove_middle(Span::default()), PossibleFixes::Single(REMOVE_MIDDLE)),
create_message(replace_id(), PossibleFixes::Single(REPLACE_ID)),
create_message(no_fix(Span::default()), PossibleFixes::None),
]);
assert_eq!(result.fixed_code, TEST_CODE.cow_replace("answer", "foo"));
assert_eq!(result.messages.len(), 2);
Expand All @@ -636,19 +652,20 @@ mod test {
#[test]
fn apply_same_fix_when_span_overlap_regardless_of_order() {
let result1 = get_fix_result(vec![
create_message(remove_middle(Span::default()), Some(REMOVE_MIDDLE)),
create_message(replace_id(), Some(REPLACE_ID)),
create_message(remove_middle(Span::default()), PossibleFixes::Single(REMOVE_MIDDLE)),
create_message(replace_id(), PossibleFixes::Single(REPLACE_ID)),
]);
let result2 = get_fix_result(vec![
create_message(replace_id(), Some(REPLACE_ID)),
create_message(remove_middle(Span::default()), Some(REMOVE_MIDDLE)),
create_message(replace_id(), PossibleFixes::Single(REPLACE_ID)),
create_message(remove_middle(Span::default()), PossibleFixes::Single(REMOVE_MIDDLE)),
]);
assert_eq!(result1.fixed_code, result2.fixed_code);
}

#[test]
fn should_not_apply_fix_with_one_no_fix() {
let result = get_fix_result(vec![create_message(no_fix(Span::default()), None)]);
let result =
get_fix_result(vec![create_message(no_fix(Span::default()), PossibleFixes::None)]);
assert_eq!(result.fixed_code, TEST_CODE);
assert_eq!(result.messages.len(), 1);
assert_eq!(result.messages[0].error.to_string(), "nofix");
Expand All @@ -658,9 +675,9 @@ mod test {
#[test]
fn sort_no_fix_messages_correctly() {
let result = get_fix_result(vec![
create_message(replace_id(), Some(REPLACE_ID)),
Message::new(no_fix_2(Span::new(1, 7)), None),
Message::new(no_fix_1(Span::new(1, 3)), None),
create_message(replace_id(), PossibleFixes::Single(REPLACE_ID)),
Message::new(no_fix_2(Span::new(1, 7)), PossibleFixes::None),
Message::new(no_fix_1(Span::new(1, 3)), PossibleFixes::None),
]);
assert_eq!(result.fixed_code, TEST_CODE.cow_replace("answer", "foo"));
assert_eq!(result.messages.len(), 2);
Expand Down
14 changes: 8 additions & 6 deletions crates/oxc_linter/src/service/runtime.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -495,9 +495,10 @@ impl<'l> Runtime<'l> {
Rc::new(section.semantic.unwrap()),
Arc::clone(&module_record),
),
Err(errors) => {
errors.into_iter().map(|err| Message::new(err, None)).collect()
}
Err(errors) => errors
.into_iter()
.map(|err| Message::new(err, PossibleFixes::None))
.collect(),
};

let source_text = section.source.source_text;
Expand Down Expand Up @@ -716,9 +717,10 @@ impl<'l> Runtime<'l> {
Rc::new(section.semantic.unwrap()),
Arc::clone(&module_record),
),
Err(errors) => {
errors.into_iter().map(|err| Message::new(err, None)).collect()
}
Err(errors) => errors
.into_iter()
.map(|err| Message::new(err, PossibleFixes::None))
.collect(),
}
.into_iter()
.map(|message| message.clone_in(allocator)),
Expand Down
Loading