[#2855] Create spotless rule for package-info.java

DavideD · DavideD · commit 9b6a8d7867a9 · 2025-12-02T16:00:23.000+01:00
And `module-info.java` Spotless ingores package-info.java files (see diffplug/spotless#532), but we can create a rule that applies it if the file contains a javadoc. Note that if the package-info.java doesn't have a javadoc, it will cause an exception at compile time.
diff --git a/local-build-plugins/src/main/groovy/hr-java-library.gradle b/local-build-plugins/src/main/groovy/hr-java-library.gradle
@@ -15,6 +15,10 @@ spotless {
 		trimTrailingWhitespace()
 		endWithNewline()
 	}
+	format 'javaMisc', {
+		target 'src/**/package-info.java', 'src/**/module-info.java'
+		licenseHeaderFile rootProject.file('spotless.license.java'), '/\\*\\*'
+	}
 }
 
 tasks.compileJava.dependsOn(spotlessApply)

Original file line number	Diff line number	Diff line change
`@@ -15,6 +15,10 @@ spotless {`
`15`	`15`	`trimTrailingWhitespace()`
`16`	`16`	`endWithNewline()`
`17`	`17`	`}`
	`18`	`+ format 'javaMisc', {`
	`19`	`+ target 'src//package-info.java', 'src//module-info.java'`
	`20`	`+ licenseHeaderFile rootProject.file('spotless.license.java'), '/\\\\'`
	`21`	`+ }`
`18`	`22`	`}`
`19`	`23`
`20`	`24`	`tasks.compileJava.dependsOn(spotlessApply)`