Use scala-cli to format scala, spotless-gradle to format java

Author: seroperson

.github/workflows/ci.yml

@@ -1,17 +1,5 @@
 name: Continuous Integration
 
-env:
-  # https://github.com/google/google-java-format?tab=readme-ov-file#as-a-library
-  JDK_JAVA_OPTIONS: |
-    --add-opens=java.base/java.util=ALL-UNNAMED
-    --add-opens=java.base/java.lang=ALL-UNNAMED
-    --add-exports=jdk.compiler/com.sun.tools.javac.api=ALL-UNNAMED
-    --add-exports=jdk.compiler/com.sun.tools.javac.code=ALL-UNNAMED
-    --add-exports=jdk.compiler/com.sun.tools.javac.file=ALL-UNNAMED
-    --add-exports=jdk.compiler/com.sun.tools.javac.parser=ALL-UNNAMED
-    --add-exports=jdk.compiler/com.sun.tools.javac.tree=ALL-UNNAMED
-    --add-exports=jdk.compiler/com.sun.tools.javac.util=ALL-UNNAMED
-
 on:
   pull_request:
     branches: ["**"]
@@ -44,11 +32,12 @@ jobs:
       - uses: extractions/setup-just@v3
       - uses: sbt/setup-sbt@v1
         with:
-          sbt-runner-version: 1.11.7
+          sbt-runner-version: 1.12.0
       - uses: zhutmost/setup-mill@main
         with:
           mill-version: 1.1.0-RC2
       - uses: gradle/actions/setup-gradle@v5
+      - uses: VirtusLab/[email protected]
 
       - name: Check code formatting
         run: just code-format-check-all
@@ -85,7 +74,7 @@ jobs:
       - uses: extractions/setup-just@v3
       - uses: sbt/setup-sbt@v1
         with:
-          sbt-runner-version: 1.11.7
+          sbt-runner-version: 1.12.0
       - uses: zhutmost/setup-mill@main
         with:
           mill-version: 1.1.0-RC2

.gitignore

@@ -24,3 +24,6 @@ build/
 metals.sbt
 .bloop/
 *.semanticdb
+
+# scala-cli output
+.scala-build

.jvmopts

@@ -0,0 +1,4 @@
+-Dfile.encoding=UTF-8
+-Dencoding=UTF-8
+--add-opens=java.base/java.util=ALL-UNNAMED
+--add-opens=java.base/java.lang=ALL-UNNAMED

.scalafmt.conf

@@ -1,10 +1,22 @@
 version = "3.9.9"
 runner.dialect = scala3
 
-lineEndings=preserve
+lineEndings = preserve
 
 rewrite.rules = [
   Imports
 ]
 rewrite.imports.expand = true
 rewrite.imports.sort = scalastyle
+
+project {
+  includePaths = [
+    "glob:**.scala",
+    "regex:.*\\.mill"
+  ]
+  excludePaths = [
+    # Ignore mill output
+    "glob:**/out/**.scala",
+    "glob:**/out/**.mill"
+  ]
+}

build.mill

@@ -9,7 +9,6 @@ import mill.*, javalib.*, javalib.publish, scalalib.*, scalalib.publish.*
 import mill.api.BuildCtx
 import mill.api.Task.Simple
 import mill.contrib.buildinfo.BuildInfo
-import mill.scalalib.scalafmt.ScalafmtModule
 import mill.util.BuildInfo.millBinPlatform
 import mill.util.BuildInfo.millVersion
 // @formatter:on
@@ -101,11 +100,7 @@ trait HookScalaModule
   )
 }
 
-object `mill-live-reload`
-    extends ScalaModule,
-      CorePublishModule,
-      BuildInfo,
-      ScalafmtModule {
+object `mill-live-reload` extends ScalaModule, CorePublishModule, BuildInfo {
 
   override def scalaVersion = "3.7.3"
 
@@ -120,10 +115,6 @@ object `mill-live-reload`
     mvn"org.jline:jline:3.30.6"
   )
 
-  override def scalafmtConfig: T[Seq[PathRef]] = Task.Sources(
-    BuildCtx.workspaceRoot / ".scalafmt.conf"
-  )
-
   object integration extends ScalaTests, TestModule.ScalaTest, BuildInfo {
 
     override def scalaTestVersion = "3.2.19"

build.sbt

@@ -1,15 +1,16 @@
-lazy val scala212 = "2.12.20"
-lazy val scala213 = "2.13.16"
-lazy val scala3 = "3.7.2"
+lazy val scala212 = "2.12.21"
+lazy val scala213 = "2.13.18"
+lazy val scala3 = "3.7.4"
 lazy val supportedScalaVersions = List(scala212, scala213, scala3)
 lazy val supportedScalaSbtVersions = List(scala212, scala3)
 
+javacOptions ++= Seq("-encoding", "UTF-8")
 scalacOptions ++= Seq(
   "-deprecation",
   "-feature",
   "-unchecked",
   "-encoding",
-  "utf8"
+  "UTF-8"
 ) ++
   (CrossVersion.partialVersion(scalaVersion.value) match {
     case Some((2, _)) => Seq("-Xsource:3")
@@ -46,9 +47,6 @@ addCommandAlias(
 )
 addCommandAlias("quickScripted", "quickPublish;scripted")
 
-addCommandAlias("fmtCheckAll", "javafmtCheckAll;scalafmtCheckAll")
-addCommandAlias("fmtAll", "javafmtAll;scalafmtAll")
-
 // if version was pinned already, read from file, otherwise generate new
 version := {
   val versionFile = file("version.txt")
@@ -62,7 +60,8 @@ version := {
 lazy val javaProjectSettings = Seq(
   crossScalaVersions := List(scala212),
   crossPaths := false,
-  autoScalaLibrary := false
+  autoScalaLibrary := false,
+  Compile / unmanagedSourceDirectories := (Compile / javaSource).value :: Nil
 )
 
 LocalRootProject / name := "root"
@@ -71,16 +70,15 @@ LocalRootProject / publishLocal / skip := true
 LocalRootProject / publishM2 / skip := true
 
 lazy val `sbt-live-reload` = (projectMatrix in file("sbt"))
-  .enablePlugins(SbtPlugin)
-  .enablePlugins(BuildInfoPlugin)
+  .enablePlugins(SbtPlugin, BuildInfoPlugin)
   .settings(
     name := "sbt-live-reload",
     description := "Provides an universal Live Reload experience for web applications built with sbt",
     scriptedBufferLog := false,
     scriptedBatchExecution := false,
     (pluginCrossBuild / sbtVersion) := {
       scalaBinaryVersion.value match {
-        case "2.12" => "1.11.7"
+        case "2.12" => "1.12.0"
         case _      => "2.0.0-RC8"
       }
     },
@@ -89,8 +87,7 @@ lazy val `sbt-live-reload` = (projectMatrix in file("sbt"))
     scriptedLaunchOpts += version.apply { v => s"-Dproject.version=$v" }.value
   )
   .jvmPlatform(scalaVersions = supportedScalaSbtVersions)
-  .dependsOn(`build-link`)
-  .dependsOn(`runner`)
+  .dependsOn(`build-link`, `runner`)
 
 lazy val `webserver` = (project in file("core/webserver"))
   .settings(javaProjectSettings)
@@ -124,7 +121,11 @@ lazy val `hook-scala` = (projectMatrix in file("core/hook-scala"))
     libraryDependencies := Seq(
       Dependencies.zio % Provided,
       Dependencies.catsEffect % Provided
-    )
+    ) ++ (scalaBinaryVersion.value match {
+        // https://github.com/sbt/sbt/issues/8328
+        case "3" => Seq("org.scala-lang" %% "scala3-library" % scalaVersion.value)
+        case _   => Seq.empty
+      })
   )
   .jvmPlatform(scalaVersions = supportedScalaVersions)
   .dependsOn(`build-link`)

buildSrc/build.gradle.kts

@@ -4,4 +4,9 @@ plugins {
 
 repositories {
     mavenCentral()
+    gradlePluginPortal()
+}
+
+dependencies {
+    implementation("com.diffplug.spotless:com.diffplug.spotless.gradle.plugin:8.0.0")
 }

buildSrc/src/main/kotlin/core-java-library.gradle.kts

@@ -1,11 +1,18 @@
 plugins {
     `java-library`
     `maven-publish`
+    id("com.diffplug.spotless")
 }
 
 group = "me.seroperson"
 version = readVersion()
 
+spotless {
+    java {
+        googleJavaFormat()
+    }
+}
+
 java {
     toolchain {
         languageVersion = JavaLanguageVersion.of(17)

gradle/build.gradle.kts

@@ -1,7 +1,7 @@
 plugins {
     `kotlin-dsl`
     `java-gradle-plugin`
-    id("com.diffplug.spotless") version "8.0.0"
+    id("com.diffplug.spotless")
     id("com.gradle.plugin-publish") version "2.0.0"
     id("com.github.gmazzo.buildconfig") version "5.7.0"
 }

justfile

@@ -3,6 +3,7 @@ set shell := ["bash", "-c"]
 gradle := "./gradlew"
 mill := "mill"
 sbt := "sbt"
+scala-cli := "scala-cli"
 
 default: publish-local-sbt
 
@@ -57,20 +58,12 @@ publish-mill: calculate-version
   {{ mill }} mill-live-reload.publishSonatypeCentral
 
 [private]
-code-format-check-sbt:
-  {{ sbt }} fmtCheckAll
+code-format-check-scala:
+  {{ scala-cli }} fmt --check
 
 [private]
-code-format-apply-sbt:
-  {{ sbt }} fmtAll
-
-[private]
-code-format-check-mill:
-  {{ mill }} mill-live-reload.checkFormat
-
-[private]
-code-format-apply-mill:
-  {{ mill }} mill-live-reload.reformat
+code-format-apply-scala:
+  {{ scala-cli }} fmt
 
 [private]
 code-format-check-gradle:
@@ -81,11 +74,11 @@ code-format-apply-gradle:
   {{ gradle }} spotlessApply
 
 [doc('Checks formatting. Fails if formatting does not match style.')]
-code-format-check-all: code-format-check-sbt code-format-check-mill code-format-check-gradle
+code-format-check-all: code-format-check-scala code-format-check-gradle
   @echo "SUCCESS"
 
 [doc('Applies formatting.')]
-code-format-apply-all: code-format-apply-sbt code-format-apply-mill code-format-apply-gradle
+code-format-apply-all: code-format-apply-scala code-format-apply-gradle
   @echo "SUCCESS"
 
 [doc('Runs all tests.')]