Consistently add license header to all java source files

marcphilipp · marcphilipp · commit 6ce1265bb41f · 2026-01-06T15:39:59.000+01:00
* Add line break after license header to all files, including Kotlin * Add license header to `package-info.java` files (cherry picked from commit e373917)
diff --git a/gradle/config/spotless/eclipse-public-license-2.0.java b/gradle/config/spotless/eclipse-public-license-2.0.java
@@ -7,3 +7,4 @@
  *
  * https://www.eclipse.org/legal/epl-v20.html
  */
+
diff --git a/gradle/plugins/code-generator/src/main/kotlin/junitbuild/generator/GenerateJreRelatedSourceCode.kt b/gradle/plugins/code-generator/src/main/kotlin/junitbuild/generator/GenerateJreRelatedSourceCode.kt
@@ -64,7 +64,7 @@ abstract class GenerateJreRelatedSourceCode : DefaultTask() {
                 "allJres" to jres,
                 "supportedJres" to supportedJres,
                 "supportedJresSortedByStringValue" to supportedJres.sortedBy { it.version.toString() },
-                "licenseHeader" to licenseHeaderFile.asFile.get().readText()
+                "licenseHeader" to licenseHeaderFile.asFile.get().readText().trimEnd() + "\n",
             )
             templates.forEach {
                 val targetFile = mainTargetDir.toPath().resolve(it.resolveSibling(it.nameWithoutExtension).path)
diff --git a/gradle/plugins/common/src/main/kotlin/junitbuild.spotless-conventions.gradle.kts b/gradle/plugins/common/src/main/kotlin/junitbuild.spotless-conventions.gradle.kts
@@ -29,7 +29,7 @@ spotless {
 		val javaFormatterConfigFile = configDir.file("junit-eclipse-formatter-settings.xml")
 
 		java {
-			targetExclude("**/module-info.java")
+			targetExclude("**/module-info.java", "**/package-info.java")
 			licenseHeaderFile(license.headerFile, "(package|import) ")
 			importOrderFile(importOrderConfigFile)
 			val fullVersion = requiredVersionFromLibs("eclipse")
@@ -40,13 +40,14 @@ spotless {
 			removeUnusedImports()
 		}
 
-		format("moduleDescriptor") {
+		format("moduleAndPackageInfo") {
 			target(fileTree(layout.projectDirectory.dir("src/main/java")) {
-				include("module-info.java")
+				include("module-info.java", "**/package-info.java")
 			})
-			licenseHeaderFile(license.headerFile, "^$")
+			licenseHeaderFile(license.headerFile, "((/(//|\\*\\*))|((open )?module )|package|@.+)")
 			trimTrailingWhitespace()
 			endWithNewline()
+			leadingSpacesToTabs()
 		}
 	}
 
diff --git a/platform-tooling-support-tests/platform-tooling-support-tests.gradle.kts b/platform-tooling-support-tests/platform-tooling-support-tests.gradle.kts
@@ -22,6 +22,9 @@ spotless {
 	java {
 		target(files(project.java.sourceSets.map { it.allJava }), "projects/**/*.java")
 	}
+	format("moduleAndPackageInfo") {
+		target("projects/**/module-info.java", "projects/**/package-info.java")
+	}
 	kotlin {
 		target("projects/**/*.kt")
 	}

Original file line number	Diff line number	Diff line change
`@@ -7,3 +7,4 @@`
`7`	`7`	`*`
`8`	`8`	`* https://www.eclipse.org/legal/epl-v20.html`
`9`	`9`	`*/`
	`10`	`+`
Original file line number	Diff line number	Diff line change
`@@ -64,7 +64,7 @@ abstract class GenerateJreRelatedSourceCode : DefaultTask() {`
`64`	`64`	`"allJres" to jres,`
`65`	`65`	`"supportedJres" to supportedJres,`
`66`	`66`	`"supportedJresSortedByStringValue" to supportedJres.sortedBy { it.version.toString() },`
`67`		`- "licenseHeader" to licenseHeaderFile.asFile.get().readText()`
	`67`	`+ "licenseHeader" to licenseHeaderFile.asFile.get().readText().trimEnd() + "\n",`
`68`	`68`	`)`
`69`	`69`	`templates.forEach {`
`70`	`70`	`val targetFile = mainTargetDir.toPath().resolve(it.resolveSibling(it.nameWithoutExtension).path)`
Original file line number	Diff line number	Diff line change
`@@ -22,6 +22,9 @@ spotless {`
`22`	`22`	`java {`
`23`	`23`	`target(files(project.java.sourceSets.map { it.allJava }), "projects/*/.java")`
`24`	`24`	`}`
	`25`	`+ format("moduleAndPackageInfo") {`
	`26`	`+ target("projects//module-info.java", "projects//package-info.java")`
	`27`	`+ }`
`25`	`28`	`kotlin {`
`26`	`29`	`target("projects/*/.kt")`
`27`	`30`	`}`