#383: Added formatter/linter

Author: Manuel Stöger

.github/workflows/backend-fast.yml

@@ -17,9 +17,38 @@ env:
   WD: binocular-backend-new
 
 jobs:
+  lint: 
+    strategy:
+      fail-fast: true
+      matrix:
+        os: [ ubuntu-latest ]
+        java_version: [ '23' ]
+        distribution: [ 'temurin' ]
+    runs-on: ${{ matrix.os }}
+    defaults:
+      run:
+        working-directory: ${{ env.WD }}
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup (cache/java/go-offline)
+        uses: ./.github/actions/java-maven-setup
+        with:
+          java-version: ${{ matrix.java_version }}
+          distribution: ${{ matrix.distribution }}
+          working-directory: ${{ env.WD }}
+          checkout-depth: 1
+
+      - name: Validate
+        run: mvn $MAVEN_CLI_OPTS ktlint:check
+
   # Merged: validate + compile-sources + compile-tests
   preflight:
     name: Preflight (validate + compile + test-compile)
+    needs:
+      - lint
     strategy:
       fail-fast: true
       matrix:

binocular-backend-new/.editorconfig

@@ -12,5 +12,5 @@ ij_kotlin_name_count_to_use_star_import = 2147483647
 ij_kotlin_name_count_to_use_star_import_for_members = 2147483647
 ij_kotlin_packages_to_use_import_on_demand = unset
 
-[ffi/src/main/kotlin/com/inso_world/binocular/internal/binocular_ffi.kt]
-ktlint = disabled
+[ffi/src/main/kotlin/com/inso_world/binocular/ffi/internal/gix_binocular.kt]
+ktlint = disabled

binocular-backend-new/README.md

@@ -1,6 +1,10 @@
 # Binocular Backend
 
 ## Requirements
+- Install `ktlint`: https://pinterest.github.io/ktlint/latest/quick-start/. 
+  - Maven plugin reference: https://gantsign.com/ktlint-maven-plugin/plugin-info.html 
+  - Use `mvn ktlint:check` to check for errors
+  - Use `mvn ktlint:format` to automatically fixes violations of the code style (when possible)
 - Docker running in the background, otherwise tests will fail (tests in `infrastructure-sql/arangodb/tests` use TestContainers internally)
 
 © INSO/BUSY 09/2025

binocular-backend-new/pom.xml

@@ -71,6 +71,7 @@
         <module>jgit</module>
         <module>integration-test/vcs-indexer</module>
     </modules>
+
     <dependencyManagement>
         <!--
             Dependency management is a mechanism for centralizing the dependency information
@@ -221,8 +222,22 @@
                         </avoidCallsTo>
                     </configuration>
                 </plugin>
+                <plugin>
+                    <groupId>com.github.gantsign.maven</groupId>
+                    <artifactId>ktlint-maven-plugin</artifactId>
+                    <version>3.5.0</version>
+                </plugin>
             </plugins>
         </pluginManagement>
+
+        <!-- To use the plugin goals in your POM or parent POM -->
+        <plugins>
+            <plugin>
+                <groupId>com.github.gantsign.maven</groupId>
+                <artifactId>ktlint-maven-plugin</artifactId>
+                <version>3.5.0</version>
+            </plugin>
+        </plugins>
     </build>
 
     <reporting>
@@ -235,6 +250,11 @@
                     <aggregate>true</aggregate>
                 </configuration>
             </plugin>
+            <plugin>
+                <groupId>com.github.gantsign.maven</groupId>
+                <artifactId>ktlint-maven-plugin</artifactId>
+                <version>3.5.0</version>
+            </plugin>
         </plugins>
     </reporting>