google / google/google-java-format

unused import removal leaves extra blank line between package declaration and class Javadoc / declaration

Đang mở
#1,436 2 bình luận 0 reaction 0 người được giao Xem trên GitHub
Ngôn ngữ chính
Java
Star
6.2k
Fork
937
Merge trung bình
6 phút
Pull request đã merge (30 ngày)
3

Mô tả

When `google-java-format` removes an unused import statement located between a `package` declaration and class Javadoc or class declaration, it does not collapse the vertical whitespace in the same formatting pass. As a result, the formatted output contains extra blank lines (two consecutive blank lines instead of one).

Running `google-java-format` a second time on the output collapses the extra blank line as expected. We observed this in generated code, more context here: https://github.com/googleapis/librarian/issues/7146

## Environment
* **`google-java-format` Version:** Tested on `1.25.2` through `1.35.0` (including recent builds).
* **Operating System:** Linux / macOS / Cross-platform

## Minimal Reproducible Example

### Input Code (`TestBug.java`)

```java
package com.example;

import static io.grpc.MethodDescriptor.generateFullMethodName;

/**
* Javadoc for class.
*/
public class TestBug {
}

### Command Executed

google-java-format TestBug.java

## Actual Output (First Pass)

package com.example;

/** Javadoc for class. */
public class TestBug {}

(Notice the two consecutive empty lines between package com.example; and /** Javadoc for class. */.)

## Expected Output

package com.example;

/** Javadoc for class. */
public class TestBug {}

## Additional Context & Workaround

• Second Pass Result: Executing google-java-format a second time on the first pass output (google-java-format TestBug.java | google-java-format -) produces the correct output with a single blank line.

Hướng dẫn đóng góp

Mở hướng dẫn đóng góp

Hướng nghiên cứu

Start by reproducing the issue with the TestBug.java example and the google-java-format command. Trace the formatting pass that removes the unused import and handles vertical whitespace between the package declaration and class Javadoc. Done means the first formatting pass produces one blank line, matching the expected output, without needing a second pass.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Đánh giá

Công nghệ
java
Lĩnh vực
tooling
Loại issue
Lỗi
Độ khó
3/5
Thời gian dự kiến
1-2 ngày
Mức độ hoạt động
Ít trao đổi
Độ rõ ràng
Khá rõ ràng
Mức phù hợp với người mới
62/100

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.