Skip to content

Drop trailing tabs from comments instead of writing them out #73

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
abashev merged 1 commit into from
Sep 25, 2026
Merged

Drop trailing tabs from comments instead of writing them out #73

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
23 changes: 14 additions & 9 deletions open-java-format/src/main/java/com/palantir/javaformat/java/JavaOutput.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,9 +50,11 @@ public final class JavaOutput extends Output {
private final InputMetadata inputMetadata;
private int iLine = 0; // Closest corresponding line number on input.
private int lastK = -1; // Last {@link Tok} index output.
private int spacesPending = 0;
private int newlinesPending = 0;
private StringBuilder lineBuilder = new StringBuilder();
// Spaces and tabs seen since the last non-blank character. Written out in front of the next one, so that a line
// never ends in whitespace: trailing tabs inside a comment were kept before, and only a second run removed them.
private StringBuilder spacesPending = new StringBuilder();

/**
* {@code JavaOutput} constructor.
Expand Down Expand Up @@ -99,23 +101,26 @@ public void append(State state, String text, Range<Integer> range) {
if (newlinesPending == 0) {
++newlinesPending;
}
spacesPending = 0;
spacesPending = new StringBuilder();
} else {
boolean rangesSet = false;
int textN = text.length();
for (int i = 0; i < textN; i++) {
char c = text.charAt(i);
switch (c) {
case ' ':
++spacesPending;
spacesPending.append(' ');
break;
case '\t':
spacesPending.append('\t');
break;
case '\r':
if (i + 1 < text.length() && text.charAt(i + 1) == '\n') {
i++;
}
// falls through
case '\n':
spacesPending = 0;
spacesPending = new StringBuilder();
++newlinesPending;
break;
default:
Expand All @@ -128,9 +133,9 @@ public void append(State state, String text, Range<Integer> range) {
rangesSet = false;
--newlinesPending;
}
while (spacesPending > 0) {
lineBuilder.append(' ');
--spacesPending;
if (spacesPending.length() > 0) {
lineBuilder.append(spacesPending);
spacesPending = new StringBuilder();
}
lineBuilder.append(c);
if (!range.isEmpty()) {
Expand All @@ -152,7 +157,7 @@ public void append(State state, String text, Range<Integer> range) {

@Override
public void indent(int indent) {
spacesPending = indent;
spacesPending.append(" ".repeat(indent));
}

/** Flush any incomplete last line, then add the EOF token into our data structures. */
Expand Down Expand Up @@ -354,7 +359,7 @@ public String toString() {
return MoreObjects.toStringHelper(this)
.add("iLine", iLine)
.add("lastK", lastK)
.add("spacesPending", spacesPending)
.add("spacesPending", spacesPending.toString().replace("\t", "\\t"))
.add("newlinesPending", newlinesPending)
.add("inputMetadata", inputMetadata)
.add("super", super.toString())
Expand Down
10 changes: 10 additions & 0 deletions open-java-format/src/test/java/com/palantir/javaformat/java/FormatterTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -508,4 +508,14 @@ void indentsCommentsThatShareALineLinearly() throws FormatterException {

assertThat(formatter.formatSource(input.toString()).length()).isLessThan(10_000);
}

@Test
public void removeTrailingTabsInComments() throws FormatterException {
String input = "class Foo {\n void f() {\n int x = 0; // comment\t\t\t\n return;\n }\n}\n";
String expected = "class Foo {\n void f() {\n int x = 0; // comment\n return;\n }\n}\n";
Formatter formatter = Formatter.createFormatter(
JavaFormatterOptions.builder().style(Style.OJF).build());

assertThat(formatter.formatSource(input)).isEqualTo(expected);
}
}
Loading