Skip to content

feat(linter): add fixer to jsx-curly-brace-presence #10704

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
camc314 wants to merge 2 commits into from
Closed

feat(linter): add fixer to jsx-curly-brace-presence #10704

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8e59c6b
feat(linter): add fixer to jsx-curly-brace-presence
camc314 Apr 29, 2025
13135ad
[autofix.ci] apply automated fixes
autofix-ci[bot] Apr 29, 2025
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
118 changes: 88 additions & 30 deletions crates/oxc_linter/src/rules/react/jsx_curly_brace_presence.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
use oxc_allocator::Vec;
use oxc_allocator::{Allocator, Vec};
use oxc_ast::{
AstKind,
AstBuilder, AstKind,
ast::{
Expression, JSXAttributeItem, JSXAttributeValue, JSXChild, JSXElementName,
Expression, JSXAttributeItem, JSXAttributeValue, JSXChild, JSXElementName, JSXExpression,
JSXExpressionContainer,
},
};
Expand Down Expand Up @@ -298,7 +298,7 @@ declare_oxc_lint!(
JsxCurlyBracePresence,
react,
style,
pending
fix
);

impl Rule for JsxCurlyBracePresence {
Expand Down Expand Up @@ -381,7 +381,16 @@ impl JsxCurlyBracePresence {
&& children.len() == 1
&& !is_whitespace(&text.value)
{
ctx.diagnostic(jsx_curly_brace_presence_necessary_diagnostic(text.span));
ctx.diagnostic_with_fix(
jsx_curly_brace_presence_necessary_diagnostic(text.span),
|fixer| {
let mut fix = fixer.new_fix_with_capacity(2);
fix.push(fixer.insert_text_before(&text.span, r#"{""#));
fix.push(fixer.insert_text_after(&text.span, r#""}"#));

fix.with_message("add curly braces")
},
);
}
}
_ => {}
Expand All @@ -406,17 +415,17 @@ impl JsxCurlyBracePresence {
}
JSXAttributeValue::Element(el) => {
if self.prop_element_values.is_always() {
ctx.diagnostic(jsx_curly_brace_presence_necessary_diagnostic(el.span));
report_missing_curly(ctx, el.span);
}
}
JSXAttributeValue::Fragment(fragment) => {
if self.prop_element_values.is_always() {
ctx.diagnostic(jsx_curly_brace_presence_necessary_diagnostic(fragment.span));
report_missing_curly(ctx, fragment.span);
}
}
JSXAttributeValue::StringLiteral(string) => {
if self.props.is_always() {
ctx.diagnostic(jsx_curly_brace_presence_necessary_diagnostic(string.span));
report_missing_curly(ctx, string.span);
}
}
}
Expand All @@ -438,18 +447,18 @@ impl JsxCurlyBracePresence {
&& self.children.is_never()
&& !has_adjacent_jsx_expression_containers(ctx, container, node.id())
{
report_unnecessary_curly(ctx, container, inner.span());
report_unnecessary_curly(ctx, container, inner.span(), is_prop);
}
}
Expression::JSXElement(el) => {
if is_prop {
if self.prop_element_values.is_never() && el.closing_element.is_none() {
report_unnecessary_curly(ctx, container, inner.span());
report_unnecessary_curly(ctx, container, inner.span(), is_prop);
}
} else if self.children.is_never()
&& !has_adjacent_jsx_expression_containers(ctx, container, node.id())
{
report_unnecessary_curly(ctx, container, inner.span());
report_unnecessary_curly(ctx, container, inner.span(), is_prop);
}
}
Expression::StringLiteral(string) => {
Expand All @@ -458,7 +467,7 @@ impl JsxCurlyBracePresence {
if is_allowed_string_like(ctx, raw, container, node.id(), is_prop) {
return;
}
report_unnecessary_curly(ctx, container, string.span);
report_unnecessary_curly(ctx, container, string.span, is_prop);
}
}
Expression::TemplateLiteral(template) => {
Expand All @@ -475,7 +484,7 @@ impl JsxCurlyBracePresence {
{
return;
}
report_unnecessary_curly(ctx, container, template.span);
report_unnecessary_curly(ctx, container, template.span, is_prop);
}
}
_ => {}
Expand Down Expand Up @@ -538,10 +547,64 @@ fn contains_html_entity(s: &str) -> bool {

fn report_unnecessary_curly<'a>(
ctx: &LintContext<'a>,
_container: &JSXExpressionContainer<'a>,
container: &JSXExpressionContainer<'a>,
inner_span: Span,
is_prop: bool,
) {
ctx.diagnostic(jsx_curly_brace_presence_unnecessary_diagnostic(inner_span));
ctx.diagnostic_with_fix(jsx_curly_brace_presence_unnecessary_diagnostic(inner_span), |fixer| {
if !is_prop {
dbg!(&container.expression);
let str = match &container.expression {
JSXExpression::TemplateLiteral(template_lit) => template_lit.quasi().unwrap(),
JSXExpression::StringLiteral(string_lit) => string_lit.value,
JSXExpression::JSXElement(el) => {
return fixer.replace(container.span, ctx.source_range(el.span));
}
_ => unreachable!(),
};
return fixer.replace(container.span, str);
}

match &container.expression {
JSXExpression::TemplateLiteral(template_lit) => {
let alloc = Allocator::default();
let ast_builder = AstBuilder::new(&alloc);

let mut fix = fixer.codegen();
fix.print_expression(&ast_builder.expression_string_literal(
Span::default(),
template_lit.quasi().unwrap(),
None,
));

fixer.replace(container.span, fix)
}
JSXExpression::StringLiteral(_) => {
let mut fix = fixer.codegen();
fix.print_expression(container.expression.to_expression());

fixer.replace(container.span, fix)
}
_ => {
let mut fix = fixer.new_fix_with_capacity(2);

fix.push(fixer.delete_range(Span::sized(container.span.start, 1)));
fix.push(fixer.delete_range(Span::sized(container.span.end - 1, 1)));

fix.with_message("remove the curly braces")
}
}
});
}

fn report_missing_curly<'a>(ctx: &LintContext<'a>, span: Span) {
ctx.diagnostic_with_fix(jsx_curly_brace_presence_necessary_diagnostic(span), |fixer| {
let mut fix = fixer.new_fix_with_capacity(2);
fix.push(fixer.insert_text_before(&span, "{"));
fix.push(fixer.insert_text_after(&span, "}"));

fix.with_message("add the missing curly braces")
});
}

fn has_adjacent_jsx_expression_containers<'a>(
Expand Down Expand Up @@ -802,7 +865,7 @@ fn test() {
(
r#"
import React from "react";

const Component = () => {
return <span>{"/*"}</span>;
};
Expand Down Expand Up @@ -985,9 +1048,8 @@ fn test() {
//),
];

// TODO: implement fixer
let _fix = vec![
("<App prop={`foo`} />", r#"<App prop="foo" />"#, Some(json!([{ "props": "never" }]))),
let fix = vec![
("<App prop={`foo`} />", r#"<App prop='foo' />"#, Some(json!([{ "props": "never" }]))),
(
"<App>{<myApp></myApp>}</App>",
"<App><myApp></myApp></App>",
Expand All @@ -996,15 +1058,15 @@ fn test() {
("<App>{<myApp></myApp>}</App>", "<App><myApp></myApp></App>", None),
(
"<App prop={`foo`}>foo</App>",
r#"<App prop="foo">foo</App>"#,
r#"<App prop='foo'>foo</App>"#,
Some(json!([{ "props": "never" }])),
),
("<App>{`foo`}</App>", "<App>foo</App>", Some(json!([{ "children": "never" }]))),
("<>{`foo`}</>", "<>foo</>", Some(json!([{ "children": "never" }]))),
("<MyComponent>{'foo'}</MyComponent>", "<MyComponent>foo</MyComponent>", None),
(
"<MyComponent prop={'bar'}>foo</MyComponent>",
r#"<MyComponent prop="bar">foo</MyComponent>"#,
r#"<MyComponent prop='bar'>foo</MyComponent>"#,
None,
),
(
Expand All @@ -1014,7 +1076,7 @@ fn test() {
),
(
"<MyComponent prop={'bar'}>foo</MyComponent>",
r#"<MyComponent prop="bar">foo</MyComponent>"#,
r#"<MyComponent prop='bar'>foo</MyComponent>"#,
Some(json!([{ "props": "never" }])),
),
(
Expand Down Expand Up @@ -1068,27 +1130,22 @@ fn test() {
<div>
bar
</div>
{'baz'}
{'some-complicated-exp'}
baz
some-complicated-exp
</MyComponent>
",
Some(json!([{ "children": "never" }])),
),
(
"<MyComponent prop='bar'>foo</MyComponent>",
r#"<MyComponent prop={"bar"}>foo</MyComponent>"#,
r#"<MyComponent prop={'bar'}>foo</MyComponent>"#,
Some(json!([{ "props": "always" }])),
),
(
r#"<MyComponent prop="foo 'bar'">foo</MyComponent>"#,
r#"<MyComponent prop={"foo 'bar'"}>foo</MyComponent>"#,
Some(json!([{ "props": "always" }])),
),
(
r#"<MyComponent prop='foo "bar"'>foo</MyComponent>"#,
r#"<MyComponent prop={"foo "bar""}>foo</MyComponent>"#,
Some(json!([{ "props": "always" }])),
),
(
"<MyComponent>foo bar </MyComponent>",
r#"<MyComponent>{"foo bar "}</MyComponent>"#,
Expand Down Expand Up @@ -1298,5 +1355,6 @@ fn test() {
),
];
Tester::new(JsxCurlyBracePresence::NAME, JsxCurlyBracePresence::PLUGIN, pass, fail)
.expect_fix(fix)
.test_and_snapshot();
}