ci: set up Spotless linting in CI (#351)

Signed-off-by: Kaleab Argaw <kaleruha16@gmail.com>

Author: KaleabArgaw

.github/workflows/build.yml

@@ -18,6 +18,38 @@ defaults:
     shell: bash
 
 jobs:
+  lint:
+    runs-on: ubuntu-latest
+    name: lint-java
+    steps:
+      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
+        with:
+          fetch-depth: 0
+
+      - name: Reclaim disk space
+        working-directory: .github/scripts
+        shell: bash
+        run: ./ci-reclaim-disk-space.sh
+
+      - name: Set up Java 17
+        uses: actions/setup-java@be666c2fcd27ec809703dec50e508c2fdc7f6654 # v5.2.0
+        with:
+          java-version: 17
+          distribution: temurin
+
+      - name: Setup Gradle
+        uses: gradle/actions/setup-gradle@0723195856401067f7a2779048b490ace7a47d7c # v5.0.2
+
+      - name: spotless-apply
+        run: ./gradlew --no-daemon -Pjava.version=17 spotlessApply
+
+      - name: Verify formatting is clean
+        run: |
+          git diff --exit-code || {
+            echo "Formatting issues were fixed by Spotless. Run './gradlew --no-daemon spotlessApply' locally and commit the result."
+            exit 1
+          }
+
   save-pr-info:
     runs-on: ubuntu-latest
     if: always() && (github.event_name == 'pull_request')

CONTRIBUTING.md

@@ -101,6 +101,26 @@ If you have not done so on this machine, you need to:
 
 The project has a `.editorconfig` file checked into the root. Please make sure the rules in there are adhered to by your IDE.
 
+## Build
+
+To run a full build locally:
+
+```bash
+./gradlew --no-daemon build
+```
+
+To run code linting locally:
+
+```bash
+./gradlew --no-daemon spotlessCheck
+```
+
+To automatically apply formatting fixes:
+
+```bash
+./gradlew --no-daemon spotlessApply
+```
+
 ## The small print
 
 This project is an open source project, please act responsibly, be nice, polite and enjoy!

buildSrc/build.gradle.kts

@@ -10,6 +10,7 @@ repositories {
 dependencies {
   implementation("org.yaml:snakeyaml:2.5")
   implementation(libs.lombok.gradle)
+  implementation(libs.spotless.gradle)
 }
 
 // Read root gradle.properties

buildSrc/src/main/kotlin/docling-java-shared.gradle.kts

@@ -2,6 +2,7 @@ plugins {
   id("docling-shared")
   `java-library`
   `jacoco`
+  id("com.diffplug.spotless")
 }
 
 repositories {
@@ -41,6 +42,19 @@ jacoco {
   toolVersion = libs.findVersion("jacoco").get().toString()
 }
 
+spotless {
+  // Roll out linting incrementally by checking only files changed from main.
+  ratchetFrom("origin/main")
+
+  java {
+    target("src/*/java/**/*.java")
+    removeUnusedImports()
+    formatAnnotations()
+    trimTrailingWhitespace()
+    endWithNewline()
+  }
+}
+
 tasks.withType<Test>().configureEach {
   // Use JUnit Platform for unit tests.
   useJUnitPlatform()

gradle/libs.versions.toml

@@ -9,6 +9,7 @@ junit = "6.0.3"
 lombok = "1.18.42"
 lombok-gradle = "9.2.0"
 module-info = "1.14"
+spotless = "7.2.1"
 semver4j = "6.0.0"
 slf4j = "2.0.17"
 testcontainers = "2.0.3"
@@ -26,6 +27,7 @@ awaitility = { group = "org.awaitility", name = "awaitility", version.ref = "awa
 
 # lombok-gradle
 lombok-gradle = { group = "io.freefair.lombok", name = "io.freefair.lombok.gradle.plugin", version.ref = "lombok-gradle" }
+spotless-gradle = { group = "com.diffplug.spotless", name = "spotless-plugin-gradle", version.ref = "spotless" }
 
 # Jackson
 jackson-annotations = { group = "com.fasterxml.jackson.core", name = "jackson-annotations" }