Skip to content

fix(linter): clarify empty replacement fixer help text #20698

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
Mar 24, 2026
Merged

fix(linter): clarify empty replacement fixer help text #20698

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
30 changes: 25 additions & 5 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 @@ -100,7 +100,7 @@ impl<'c, 'a: 'c> RuleFixer<'c, 'a> {
let target_text = fixer.possibly_truncate_range(target);
let borrowed_replacement = Cow::Borrowed(replacement_text);
let replacement_text = fixer.possibly_truncate_snippet(&borrowed_replacement);
Cow::Owned(format!("Replace `{target_text}` with `{replacement_text}`."))
Cow::Owned(format_replace_message(target_text.as_ref(), replacement_text.as_ref()))
});

fixer.new_fix(CompositeFix::Single(fix), message)
Expand All @@ -119,9 +119,9 @@ impl<'c, 'a: 'c> RuleFixer<'c, 'a> {
let fix = Fix::new(replacement, target);
let target_text = fixer.possibly_truncate_range(target);
let content = fixer.possibly_truncate_snippet(&fix.content);
let message = fixer
.auto_message
.then(|| Cow::Owned(format!("Replace `{target_text}` with `{content}`.")));
let message = fixer.auto_message.then(|| {
Cow::Owned(format_replace_message(target_text.as_ref(), content.as_ref()))
});

fixer.new_fix(CompositeFix::Single(fix), message)
}
Expand Down Expand Up @@ -224,6 +224,14 @@ impl<'c, 'a: 'c> RuleFixer<'c, 'a> {
}
}

fn format_replace_message(target_text: &str, replacement_text: &str) -> String {
if replacement_text.is_empty() {
format!("Remove `{target_text}`.")
} else {
format!("Replace `{target_text}` with `{replacement_text}`.")
}
}

#[derive(Debug)]
pub struct FixResult<'a> {
pub fixed: bool,
Expand Down Expand Up @@ -452,7 +460,9 @@ mod test {

use crate::FixKind;

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

fn insert_at_end() -> OxcDiagnostic {
OxcDiagnostic::warn("End")
Expand Down Expand Up @@ -950,4 +960,14 @@ mod test {
assert!(result.fixed);
assert_eq!(result.fixed_code, "let answer = 42;");
}

#[test]
fn format_replace_message_for_non_empty_replacement() {
assert_eq!(format_replace_message("{foo}", "bar"), "Replace `{foo}` with `bar`.");
}

#[test]
fn format_replace_message_for_empty_replacement() {
assert_eq!(format_replace_message(r#"{""}"#, ""), r#"Remove `{""}`."#);
}
}
2 changes: 1 addition & 1 deletion crates/oxc_linter/src/snapshots/react_jsx_curly_brace_presence.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -510,4 +510,4 @@ source: crates/oxc_linter/src/tester.rs
1 │ <App>{""}</App>
· ──
╰────
help: Replace `{""}` with ``.
help: Remove `{""}`.
Expand Down
4 changes: 2 additions & 2 deletions crates/oxc_linter/src/snapshots/react_jsx_no_useless_fragment.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -167,7 +167,7 @@ source: crates/oxc_linter/src/tester.rs
· ──────────────────
5 │ </html>
╰────
help: Replace `<React.Fragment />` with ``.
help: Remove `<React.Fragment />`.

⚠ eslint-plugin-react(jsx-no-useless-fragment): Passing a fragment to a HTML element is useless.
╭─[jsx_no_useless_fragment.tsx:4:17]
Expand All @@ -176,7 +176,7 @@ source: crates/oxc_linter/src/tester.rs
· ──────────────────
5 │ </html>
╰────
help: Replace `<React.Fragment />` with ``.
help: Remove `<React.Fragment />`.

⚠ eslint-plugin-react(jsx-no-useless-fragment): Fragments should contain more than one child.
╭─[jsx_no_useless_fragment.tsx:1:1]
Expand Down
Loading