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

DavideD · DavideD · commit 76a6d3fb8f15 · 2025-12-02T16:01: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/build.gradle b/build.gradle
@@ -27,6 +27,10 @@ subprojects {
             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
`@@ -27,6 +27,10 @@ subprojects {`
`27`	`27`	`trimTrailingWhitespace()`
`28`	`28`	`endWithNewline()`
`29`	`29`	`}`
	`30`	`+ format 'javaMisc', {`
	`31`	`+ target 'src//package-info.java', 'src//module-info.java'`
	`32`	`+ licenseHeaderFile rootProject.file( 'spotless.license.java' ), '/\\\\'`
	`33`	`+ }`
`30`	`34`	`}`
`31`	`35`
`32`	`36`	`tasks.compileJava.dependsOn(spotlessApply)`