Skip to content

Fix column numbers in diagnostics #1167

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
copybara-service merged 1 commit into from
Oct 2, 2024
Merged

Fix column numbers in diagnostics #1167

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
6 changes: 3 additions & 3 deletions core/src/main/java/com/google/googlejavaformat/FormatterDiagnostic.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ public int line() {
}

/**
* Returns the 0-indexed column number on which the error occurred, or {@code -1} if the error
* Returns the 1-indexed column number on which the error occurred, or {@code -1} if the error
* does not have a column.
*/
public int column() {
Expand All @@ -61,14 +61,14 @@ public String message() {
return message;
}

@Override
public String toString() {
StringBuilder sb = new StringBuilder();
if (lineNumber >= 0) {
sb.append(lineNumber).append(':');
}
if (column >= 0) {
// internal column numbers are 0-based, but diagnostics use 1-based indexing by convention
sb.append(column + 1).append(':');
sb.append(column).append(':');
}
if (lineNumber >= 0 || column >= 0) {
sb.append(' ');
Expand Down
2 changes: 1 addition & 1 deletion core/src/main/java/com/google/googlejavaformat/java/FormatterException.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ public String formatDiagnostics(String path, String input) {
if (line != -1 && column != -1) {
sb.append(CharMatcher.breakingWhitespace().trimTrailingFrom(lines.get(line - 1)))
.append(System.lineSeparator());
sb.append(" ".repeat(column)).append('^').append(System.lineSeparator());
sb.append(" ".repeat(column - 1)).append('^').append(System.lineSeparator());
}
}
return sb.toString();
Expand Down
14 changes: 7 additions & 7 deletions core/src/test/java/com/google/googlejavaformat/java/DiagnosticTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ public void parseError() throws Exception {

int result = main.format(path.toString());
assertThat(stdout.toString()).isEmpty();
assertThat(stderr.toString()).contains("InvalidSyntax.java:2:29: error: <identifier> expected");
assertThat(stderr.toString()).contains("InvalidSyntax.java:2:28: error: <identifier> expected");
assertThat(result).isEqualTo(1);
}

Expand Down Expand Up @@ -119,7 +119,7 @@ public void oneFileParseError() throws Exception {

int result = main.format(pathOne.toString(), pathTwo.toString());
assertThat(stdout.toString()).isEqualTo(two);
assertThat(stderr.toString()).contains("One.java:1:13: error: reached end of file");
assertThat(stderr.toString()).contains("One.java:1:12: error: reached end of file");
assertThat(result).isEqualTo(1);
}

Expand All @@ -141,7 +141,7 @@ public void oneFileParseErrorReplace() throws Exception {

int result = main.format("-i", pathOne.toString(), pathTwo.toString());
assertThat(stdout.toString()).isEmpty();
assertThat(stderr.toString()).contains("One.java:1:14: error: class, interface");
assertThat(stderr.toString()).contains("One.java:1:13: error: class, interface");
assertThat(result).isEqualTo(1);
// don't edit files with parse errors
assertThat(Files.readAllLines(pathOne, UTF_8)).containsExactly("class One {}}");
Expand All @@ -164,7 +164,7 @@ public void parseError2() throws FormatterException, IOException, UsageException
int exitCode = main.format(args);

assertThat(exitCode).isEqualTo(1);
assertThat(err.toString()).contains("A.java:2:6: error: ';' expected");
assertThat(err.toString()).contains("A.java:2:5: error: ';' expected");
}

@Test
Expand All @@ -179,7 +179,7 @@ public void parseErrorStdin() throws FormatterException, IOException, UsageExcep
int exitCode = main.format(args);

assertThat(exitCode).isEqualTo(1);
assertThat(err.toString()).contains("<stdin>:2:6: error: ';' expected");
assertThat(err.toString()).contains("<stdin>:2:5: error: ';' expected");
}

@Test
Expand All @@ -198,7 +198,7 @@ public void lexError2() throws FormatterException, IOException, UsageException {
int exitCode = main.format(args);

assertThat(exitCode).isEqualTo(1);
assertThat(err.toString()).contains("A.java:2:5: error: unclosed character literal");
assertThat(err.toString()).contains("A.java:2:4: error: unclosed character literal");
}

@Test
Expand All @@ -212,6 +212,6 @@ public void lexErrorStdin() throws FormatterException, IOException, UsageExcepti
int exitCode = main.format(args);

assertThat(exitCode).isEqualTo(1);
assertThat(err.toString()).contains("<stdin>:2:5: error: unclosed character literal");
assertThat(err.toString()).contains("<stdin>:2:4: error: unclosed character literal");
}
}
44 changes: 37 additions & 7 deletions core/src/test/java/com/google/googlejavaformat/java/MainTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -307,7 +307,7 @@ public void importRemoveErrorParseError() throws Exception {
new PrintWriter(err, true),
new ByteArrayInputStream(joiner.join(input).getBytes(UTF_8)));
assertThat(main.format("-")).isEqualTo(1);
assertThat(err.toString()).contains("<stdin>:4:3: error: class, interface");
assertThat(err.toString()).contains("<stdin>:4:2: error: class, interface");

} finally {
Locale.setDefault(backupLocale);
Expand Down Expand Up @@ -508,7 +508,7 @@ public void assumeFilename_error() throws Exception {
new PrintWriter(err, true),
new ByteArrayInputStream(joiner.join(input).getBytes(UTF_8)));
assertThat(main.format("--assume-filename=Foo.java", "-")).isEqualTo(1);
assertThat(err.toString()).contains("Foo.java:1:15: error: class, interface");
assertThat(err.toString()).contains("Foo.java:1:14: error: class, interface");
}

@Test
Expand Down Expand Up @@ -637,11 +637,13 @@ public void reorderModifiersOptionTest() throws Exception {
}

@Test
public void badIdentifier() throws Exception {
public void syntaxError() throws Exception {
Path path = testFolder.newFile("Test.java").toPath();
String[] input = {
"class Test {", //
" void f(int package) {}",
" void f(int package) {",
" int",
" }",
"}",
"",
};
Expand All @@ -653,9 +655,37 @@ public void badIdentifier() throws Exception {
int errorCode = main.format(path.toAbsolutePath().toString());
assertWithMessage("Error Code").that(errorCode).isEqualTo(1);
String[] expected = {
path + ":2:14: error: <identifier> expected", //
" void f(int package) {}",
" ^",
path + ":2:13: error: <identifier> expected",
" void f(int package) {",
" ^",
path + ":3:5: error: not a statement",
" int",
" ^",
path + ":3:8: error: ';' expected",
" int",
" ^",
"",
};
assertThat(err.toString()).isEqualTo(joiner.join(expected));
}

@Test
public void syntaxErrorBeginning() throws Exception {
Path path = testFolder.newFile("Test.java").toPath();
String[] input = {
"error", //
};
String source = joiner.join(input);
Files.writeString(path, source, UTF_8);
StringWriter out = new StringWriter();
StringWriter err = new StringWriter();
Main main = new Main(new PrintWriter(out, true), new PrintWriter(err, true), System.in);
int errorCode = main.format(path.toAbsolutePath().toString());
assertWithMessage("Error Code").that(errorCode).isEqualTo(1);
String[] expected = {
path + ":1:1: error: reached end of file while parsing", //
"error",
"^",
"",
};
assertThat(err.toString()).isEqualTo(joiner.join(expected));
Expand Down