Skip to content

Keep XML comments trailing an element on the same line #8353

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
timtebeek merged 2 commits into from
Jul 30, 2026
+93 −0
Merged

Keep XML comments trailing an element on the same line #8353

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1d98594
Keep XML comments trailing an element on the same line
timtebeek Jul 30, 2026
6651e7c
Use neutral package names in trailing comment test fixtures
timtebeek Jul 30, 2026
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
18 changes: 18 additions & 0 deletions rewrite-xml/src/main/java/org/openrewrite/xml/format/LineBreaksVisitor.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,12 @@
import org.jspecify.annotations.Nullable;
import org.openrewrite.Tree;
import org.openrewrite.xml.XmlIsoVisitor;
import org.openrewrite.xml.tree.Content;
import org.openrewrite.xml.tree.Misc;
import org.openrewrite.xml.tree.Xml;

import java.util.List;

public class LineBreaksVisitor<P> extends XmlIsoVisitor<P> {
@Nullable
private final Tree stopAfter;
Expand All @@ -35,10 +38,25 @@ public LineBreaksVisitor(@Nullable Tree stopAfter) {

@Override
public Xml.Comment visitComment(Xml.Comment comment, P p) {
if (isTrailingComment(comment)) {
return super.visitComment(comment, p);
}
return keepMaximumLines(minimumLines(super.visitComment(comment, p),
isFirstMisc(comment) ? 0 : 1), 2);
}

private boolean isTrailingComment(Xml.Comment comment) {
if (comment.getPrefix().contains("\n")) {
return false;
}
Object parent = getCursor().getParentTreeCursor().getValue();
if (!(parent instanceof Xml.Tag)) {
return false;
}
List<? extends Content> content = ((Xml.Tag) parent).getContent();
return content != null && !content.isEmpty() && content.get(0) != comment;
}

@Override
public Xml.DocTypeDecl visitDocTypeDecl(Xml.DocTypeDecl docTypeDecl, P p) {
return keepMaximumLines(minimumLines(super.visitDocTypeDecl(docTypeDecl, p),
Expand Down
59 changes: 59 additions & 0 deletions rewrite-xml/src/test/java/org/openrewrite/xml/format/AutoFormatTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,4 +114,63 @@ void tagContentIndentation() {
)
);
}

@Test
void trailingCommentStaysOnSameLine() {
rewriteRun(
xml(
"""
<?xml version="1.0" encoding="UTF-8"?>
<project>
<excludes>
<exclude>com.example.profit.ProfitFactory.processProfit.1</exclude> <!--tmp logic, tested elsewhere-->
<exclude>com.example.profit.io.ProfitUtils</exclude><!--tmp logic, tested elsewhere-->
</excludes>
</project>
"""
)
);
}

@Test
void trailingCommentAfterTagContentStaysOnSameLine() {
rewriteRun(
xml(
"""
<?xml version="1.0" encoding="UTF-8"?>
<project>
<excludes>
<exclude>a</exclude> <!--why a-->
</excludes> <!--why excludes-->
</project>
"""
)
);
}

@Test
void misindentedTrailingCommentIsStillIndented() {
rewriteRun(
xml(
"""
<?xml version="1.0" encoding="UTF-8"?>
<project>
<excludes>
<exclude>a</exclude>
<!--why a-->
</excludes>
</project>
""",
"""
<?xml version="1.0" encoding="UTF-8"?>
<project>
<excludes>
<exclude>a</exclude>
<!--why a-->
</excludes>
</project>
"""
)
);
}
}
16 changes: 16 additions & 0 deletions rewrite-xml/src/test/java/org/openrewrite/xml/format/LineBreaksTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,22 @@ void comments() {
);
}

@Test
void trailingCommentsStayOnSameLine() {
rewriteRun(
xml(
"""
<project>
<excludes>
<exclude>a</exclude> <!--comment-->
<exclude>b</exclude><!--comment-->
</excludes>
</project>
"""
)
);
}

@SuppressWarnings("CheckTagEmptyBody")
@Test
void docTypeDecl() {
Expand Down