Setup scalafmt.

Signed-off-by: Pascal Spörri <[email protected]>

Author: pspoerri

.github/workflows/ci.yml

@@ -10,7 +10,7 @@ on:
     - main
     tags:
     - v*
-            
+
 jobs:
   Build:
     strategy:
@@ -66,6 +66,12 @@ jobs:
         distribution: temurin
         java-version: 11
         cache: sbt
+    - name: Check formatting
+      shell: bash
+      run: |
+        echo "If either of these checks fail run: 'sbt scalafmtAll && sbt scalafmtSbt'"
+        sbt scalafmtSbtCheck
+        sbt scalafmtCheckAll
     - name: Test Default Shuffle Fetch
       shell: bash
       if: startsWith(matrix.scala, '2.12.')

.scalafmt.conf

@@ -0,0 +1,3 @@
+version = 3.7.13
+runner.dialect = scala212
+maxColumn = 120

README.md

@@ -16,7 +16,17 @@ Examples are available [here](./examples).
 ```bash
 sbt package  # Creates a minimal jar.
 sbt assembly # Creates the full assembly with all dependencies, notably hadoop cloud.
- ```
+```
+
+## Formatting Code
+
+Formatting is done with `scalafmt`. This can be triggered with the following configuration.
+
+```bash
+sbt scalafmtAll  # Format the source code
+sbt scalafmtSbt  # Format the SBT.
+```
+
 
 ## Required configuration
 
@@ -86,14 +96,14 @@ to Java > 11:
   --add-opens=java.base/java.io=ALL-UNNAMED
   --add-opens=java.base/java.net=ALL-UNNAMED
   --add-opens=java.base/java.nio=ALL-UNNAMED
-  --add-opens=java.base/java.util=ALL-UNNAMED 
-  --add-opens=java.base/java.util.concurrent=ALL-UNNAMED 
-  --add-opens=java.base/java.util.concurrent.atomic=ALL-UNNAMED 
-  --add-opens=java.base/sun.nio.ch=ALL-UNNAMED 
-  --add-opens=java.base/sun.nio.cs=ALL-UNNAMED 
+  --add-opens=java.base/java.util=ALL-UNNAMED
+  --add-opens=java.base/java.util.concurrent=ALL-UNNAMED
+  --add-opens=java.base/java.util.concurrent.atomic=ALL-UNNAMED
+  --add-opens=java.base/sun.nio.ch=ALL-UNNAMED
+  --add-opens=java.base/sun.nio.cs=ALL-UNNAMED
   --add-opens=java.base/sun.security.action=ALL-UNNAMED -
-  -add-opens=java.base/sun.util.calendar=ALL-UNNAMED 
-  --add-opens=java.security.jgss/sun.security.krb5=ALL-UNNAMED 
+  -add-opens=java.base/sun.util.calendar=ALL-UNNAMED
+  --add-opens=java.security.jgss/sun.security.krb5=ALL-UNNAMED
 ```
 
 ## Usage
@@ -119,7 +129,7 @@ Add the following lines to your Spark configuration:
     --conf spark.hadoop.fs.s3a.endpoint=S3A_ENDPOINT
     --conf spark.hadoop.fs.s3a.path.style.access=true
     --conf spark.hadoop.fs.s3a.fast.upload=true
-    
+
     --conf spark.shuffle.manager="org.apache.spark.shuffle.sort.S3ShuffleManager"
     --conf spark.shuffle.sort.io.plugin.class="org.apache.spark.shuffle.S3ShuffleDataIO"
     --conf spark.hadoop.fs.s3a.impl="org.apache.hadoop.fs.s3a.S3AFileSystem"

project/plugins.sbt

@@ -5,3 +5,4 @@
 addSbtPlugin("com.eed3si9n" % "sbt-assembly" % "1.2.0") // https://github.com/sbt/sbt-assembly (MIT)
 addSbtPlugin("com.eed3si9n" % "sbt-buildinfo" % "0.11.0") // https://github.com/sbt/sbt-buildinfo (MIT)
 addSbtPlugin("com.github.sbt" % "sbt-git" % "2.0.1") // https://github.com/sbt/sbt-git (BSD-2-Clause)
+addSbtPlugin("org.scalameta" % "sbt-scalafmt" % "2.5.2")