Skip to content
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.

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

Inconsistent blank line between license and package statement #1084

Open
sdavids opened this issue Mar 16, 2024 · 1 comment
Open

Inconsistent blank line between license and package statement #1084

sdavids opened this issue Mar 16, 2024 · 1 comment

Comments

@sdavids
Copy link

sdavids commented Mar 16, 2024

Expected Behavior

/* File header */
package ...

/* File header */

package ...

Current Behavior

/* File header */
package ...

/* File header */
package ...

Corresponding Section in Java Style Guide

Source file structure

A source file consists of, in order:

License or copyright information, if present
Package statement
Import statements
Exactly one top-level class
Exactly one blank line separates each section that is present.

https://google.github.io/styleguide/javaguide.html#s3-source-file-structure

Test Cases

/var/tmp $ curl -L -O -s https://github.com/google/google-java-format/releases/download/v1.21.0/google-java-format-1.21.0-all-deps.jar

/var/tmp $ printf '/* File header */\npackage p; class PackageHeader{}\n' > PackageHeader.java
/var/tmp $ java -jar google-java-format-1.21.0-all-deps.jar --replace PackageHeader.java
/var/tmp $ cat PackageHeader.java
/* File header */
package p;

class PackageHeader {}

/var/tmp $ printf '/* File header */\n\npackage p; class PackageHeader{}\n' > PackageHeader.java
/var/tmp $ java -jar google-java-format-1.21.0-all-deps.jar --replace PackageHeader.java
/var/tmp $ cat PackageHeader.java
/* File header */

package p;

class PackageHeader {}

/var/tmp $ printf '/* File header */\n\n\npackage p; class PackageHeader{}\n' > PackageHeader.java
/var/tmp $ java -jar google-java-format-1.21.0-all-deps.jar --replace PackageHeader.java
/var/tmp $ cat PackageHeader.java
/* File header */

package p;

class PackageHeader {}


/var/tmp $ printf '/* File header */\n@NonNullApi package com.baeldung.nullibility; import org.springframework.lang.NonNullApi;\n' > package-info.java
/var/tmp $ java -jar google-java-format-1.21.0-all-deps.jar --replace package-info.java
/var/tmp $ cat package-info.java
/* File header */
@NonNullApi
package com.baeldung.nullibility;

import org.springframework.lang.NonNullApi;

/var/tmp $ printf '/* File header */\n\n@NonNullApi package com.baeldung.nullibility; import org.springframework.lang.NonNullApi;\n' > package-info.java
/var/tmp $ java -jar google-java-format-1.21.0-all-deps.jar --replace package-info.java
/var/tmp $ cat package-info.java
/* File header */

@NonNullApi
package com.baeldung.nullibility;

import org.springframework.lang.NonNullApi;

/var/tmp $ printf '/* File header */\n\n\n@NonNullApi package com.baeldung.nullibility; import org.springframework.lang.NonNullApi;\n' > package-info.java
/var/tmp $ java -jar google-java-format-1.21.0-all-deps.jar --replace package-info.java
/var/tmp $ cat package-info.java
/* File header */

@NonNullApi
package com.baeldung.nullibility;

import org.springframework.lang.NonNullApi;
@sdavids
Copy link
Author

sdavids commented Mar 16, 2024

Maybe related: #235

@sdavids sdavids changed the title Inconsistent space handling between license and package statement Inconsistent blank line between license and package statement Mar 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant