Merge pull request #272 from mkurz/formatter-all-deps-runtime

Select formatter runtimes explicitly and add Java compatibility coverage

Author: mkurz

.github/workflows/ci.yml

@@ -19,6 +19,18 @@ jobs:
             java: 17
             distribution: zulu
             jobtype: 2
+          - os: ubuntu-latest
+            java: 21
+            distribution: zulu
+            jobtype: 3
+          - os: ubuntu-latest
+            java: 25
+            distribution: zulu
+            jobtype: 4
+          - os: ubuntu-latest
+            java: 11
+            distribution: zulu
+            jobtype: 5
     runs-on: ${{ matrix.os }}
     env:
       # define Java options for both official sbt and sbt-extras
@@ -35,12 +47,35 @@ jobs:
         distribution: "${{ matrix.distribution }}"
         java-version: "${{ matrix.java }}"
         cache: sbt
+    - name: Setup formatter JDK
+      if: ${{ matrix.jobtype == 5 }}
+      uses: actions/setup-java@v5
+      with:
+        distribution: zulu
+        java-version: "25"
     - uses: sbt/setup-sbt@v1
     - name: Build and test (sbt 1.x)
       if: ${{ matrix.jobtype == 1 }}
       shell: bash
-      run: sbt -v '++ 2.12.x' clean scalafmtSbtCheck scalafmtCheckAll test scripted
+      run: sbt -v '++ 2.12.x' clean scalafmtSbtCheck scalafmtCheckAll test 'scripted sbt-java-formatter/*' 'scripted java-runtime/compatible-11'
     - name: Build and test (sbt 2.x)
       if: ${{ matrix.jobtype == 2 }}
       shell: bash
-      run: sbt -v '++ 3.x' clean scalafmtSbtCheck scalafmtCheckAll test scripted
+      run: sbt -v '++ 3.x' clean scalafmtSbtCheck scalafmtCheckAll test 'scripted sbt-java-formatter/*' 'scripted java-runtime/compatible-17' 'scripted java-runtime/incompatible-21-on-java-17'
+    - name: Build and test (sbt 2.x, Java 21)
+      if: ${{ matrix.jobtype == 3 }}
+      shell: bash
+      run: sbt -v '++ 3.x' clean scalafmtSbtCheck scalafmtCheckAll test 'scripted sbt-java-formatter/*' 'scripted java-runtime/compatible-21'
+    - name: Build and test (sbt 2.x, Java 25)
+      if: ${{ matrix.jobtype == 4 }}
+      shell: bash
+      run: sbt -v '++ 3.x' clean scalafmtSbtCheck scalafmtCheckAll test 'scripted java-runtime/compatible-21'
+    - name: Build and test (sbt 1.x, Java 11 with formatter on Java 25)
+      if: ${{ matrix.jobtype == 5 }}
+      shell: bash
+      env:
+        JAVA_HOME: ${{ env.JAVA_HOME_11_X64 }}
+        SBT_JAVAFMT_JAVA_HOME: ${{ env.JAVA_HOME_25_X64 }}
+      run: |
+        export PATH="${JAVA_HOME}/bin:$PATH"
+        sbt -v '++ 2.12.x' clean scalafmtSbtCheck scalafmtCheckAll test 'scripted java-runtime/compatible-21'

README.md

@@ -37,6 +37,7 @@ For available versions see [releases](https://github.com/sbt/sbt-java-formatter/
 * The `javafmtRemoveUnusedImports` setting controls whether unused imports are removed (`true` by default).
 * The `javafmtReflowLongStrings` setting controls whether long string literals are reflowed (`true` by default).
 * The `javafmtFormatJavadoc` setting controls whether Javadoc comments are reformatted (`true` by default).
+* The `javafmtFormatterCompatibleJavaVersion` setting selects which `google-java-format` runtime line to use (`21` by default).
 * The `javafmtJavaMaxHeap` setting controls the maximum heap passed to the forked `google-java-format` JVM (`Some("256m")` by default).
 
 This plugin requires sbt 1.3.0+.
@@ -66,6 +67,20 @@ To make the plugin launch the formatter with a different Java installation, set
 
 If both are set, `sbt-javafmt.java.home` takes precedence.
 
+The selected Java home must still be compatible with the `google-java-format` runtime line chosen by `javafmtFormatterCompatibleJavaVersion`.
+
+This is useful if your build runs sbt on one JDK but needs to launch the formatter on another one. For example, you can keep sbt on Java 11 and still run the formatter on a newer JDK by setting `SBT_JAVAFMT_JAVA_HOME` or `-Dsbt-javafmt.java.home=...`.
+
+For example:
+
+```scala
+ThisBuild / javafmtFormatterCompatibleJavaVersion := 21
+```
+
+```bash
+SBT_JAVAFMT_JAVA_HOME=/path/to/jdk-21 sbt javafmt
+```
+
 Use `javafmtJavaMaxHeap` to control the maximum heap size passed to that JVM:
 
 ```scala
@@ -83,6 +98,7 @@ ThisBuild / javafmtJavaMaxHeap := None
 The plugin also exposes a few `google-java-format` CLI options directly:
 
 ```scala
+ThisBuild / javafmtFormatterCompatibleJavaVersion := 21
 ThisBuild / javafmtSortImports := true
 ThisBuild / javafmtRemoveUnusedImports := true
 ThisBuild / javafmtReflowLongStrings := true
@@ -91,6 +107,17 @@ ThisBuild / javafmtFormatJavadoc := true
 
 Set any of them to `false` to pass the corresponding `--skip-...` flag to `google-java-format`.
 
+`javafmtFormatterCompatibleJavaVersion` maps to these formatter versions:
+
+- `11` -> `google-java-format 1.24.0`
+- `17` -> `google-java-format 1.28.0`
+- `21` -> `google-java-format 1.35.0`
+
+If the selected formatter runtime is newer than the Java used to launch the formatter JVM, either:
+
+- lower `ThisBuild / javafmtFormatterCompatibleJavaVersion`
+- or point the formatter to a newer JDK via `SBT_JAVAFMT_JAVA_HOME` or `-Dsbt-javafmt.java.home=...`
+
 `javafmtOptions` is still available for compatibility, but the preferred sbt-facing configuration is through the dedicated `javafmt...` settings above.
 
 `JavaFormatterOptions.reorderModifiers()` currently has no effect in this plugin.

build.sbt

@@ -16,6 +16,7 @@ lazy val plugin = project
       ScmInfo(url("https://github.com/sbt/sbt-java-formatter"), "scm:git:git@github.com:sbt/sbt-java-formatter.git")),
     developers := List(
       Developer("ktoso", "Konrad 'ktoso' Malawski", "<ktoso@project13.pl>", url("https://github.com/ktoso"))),
+    // Compile the plugin against the Java 11-compatible google-java-format API line; actual formatter execution uses a separately selected forked runtime.
     libraryDependencies ++= Seq("com.google.googlejavaformat" % "google-java-format" % "1.24.0"),
     startYear := Some(2015),
     description := "Formats Java code in your project.",

plugin/src/main/scala/com/github/sbt/JavaFormatterPlugin.scala

@@ -32,6 +32,12 @@ object AutomateJavaFormatterPlugin extends AutoPlugin {
 
 object JavaFormatterPlugin extends AutoPlugin {
 
+  private val JavafmtRuntime = config("javafmtRuntime").hide.extend(Runtime)
+
+  @transient
+  private val javafmtFormatterClasspath =
+    taskKey[Seq[File]]("Resolved classpath for the forked google-java-format CLI.")
+
   object autoImport {
     @transient
     val javafmt: TaskKey[Unit] = taskKey("Format Java sources")
@@ -58,6 +64,9 @@ object JavaFormatterPlugin extends AutoPlugin {
       "Execute the javafmtFixImportsCheck task for all configurations in which it is enabled. " +
       "(By default this means the Compile and Test configurations.)")
     val javafmtOnCompile = settingKey[Boolean]("Format Java source files on compile, off by default.")
+    val javafmtFormatterCompatibleJavaVersion =
+      settingKey[Int](
+        "Selects the google-java-format runtime line by compatible Java version. Supported values: 11, 17, 21.")
     val javafmtStyle =
       settingKey[JavaFormatterOptions.Style]("Define formatting style, Google Java Style (default) or AOSP")
     val javafmtJavaMaxHeap =
@@ -103,6 +112,7 @@ object JavaFormatterPlugin extends AutoPlugin {
   override def globalSettings: Seq[Def.Setting[?]] =
     Seq(
       javafmtOnCompile := false,
+      javafmtFormatterCompatibleJavaVersion := 21,
       javafmtStyle := JavaFormatterOptions.Style.GOOGLE,
       javafmtJavaMaxHeap := Some("256m"),
       javafmtSortImports := true,
@@ -125,6 +135,7 @@ object JavaFormatterPlugin extends AutoPlugin {
         val eF = (javafmt / excludeFilter).value
         val cache = streamz.cacheStoreFactory
         val options = javafmtOptions.value
+        val formatterClasspath = javafmtFormatterClasspath.value.toVector
         val javaMaxHeap = javafmtJavaMaxHeap.value
         val sortImports = javafmtSortImports.value
         val removeUnusedImports = javafmtRemoveUnusedImports.value
@@ -136,6 +147,7 @@ object JavaFormatterPlugin extends AutoPlugin {
           streamz,
           cache,
           options,
+          formatterClasspath,
           javaMaxHeap,
           sortImports,
           removeUnusedImports,
@@ -149,6 +161,7 @@ object JavaFormatterPlugin extends AutoPlugin {
         val eF = (javafmt / excludeFilter).value
         val cache = (javafmt / streams).value.cacheStoreFactory
         val options = javafmtOptions.value
+        val formatterClasspath = javafmtFormatterClasspath.value.toVector
         val javaMaxHeap = javafmtJavaMaxHeap.value
         val sortImports = javafmtSortImports.value
         val removeUnusedImports = javafmtRemoveUnusedImports.value
@@ -161,6 +174,7 @@ object JavaFormatterPlugin extends AutoPlugin {
           streamz,
           cache,
           options,
+          formatterClasspath,
           javaMaxHeap,
           sortImports,
           removeUnusedImports,
@@ -173,6 +187,7 @@ object JavaFormatterPlugin extends AutoPlugin {
         val eF = (javafmt / excludeFilter).value
         val cache = streamz.cacheStoreFactory
         val options = javafmtOptions.value
+        val formatterClasspath = javafmtFormatterClasspath.value.toVector
         val javaMaxHeap = javafmtJavaMaxHeap.value
         val sortImports = javafmtSortImports.value
         val removeUnusedImports = javafmtRemoveUnusedImports.value
@@ -184,6 +199,7 @@ object JavaFormatterPlugin extends AutoPlugin {
           streamz,
           cache,
           options,
+          formatterClasspath,
           javaMaxHeap,
           sortImports,
           removeUnusedImports,
@@ -197,6 +213,7 @@ object JavaFormatterPlugin extends AutoPlugin {
         val eF = (javafmt / excludeFilter).value
         val cache = (javafmt / streams).value.cacheStoreFactory
         val options = javafmtOptions.value
+        val formatterClasspath = javafmtFormatterClasspath.value.toVector
         val javaMaxHeap = javafmtJavaMaxHeap.value
         val sortImports = javafmtSortImports.value
         val removeUnusedImports = javafmtRemoveUnusedImports.value
@@ -209,6 +226,7 @@ object JavaFormatterPlugin extends AutoPlugin {
           streamz,
           cache,
           options,
+          formatterClasspath,
           javaMaxHeap,
           sortImports,
           removeUnusedImports,
@@ -224,7 +242,28 @@ object JavaFormatterPlugin extends AutoPlugin {
       compile / compileInputs := (compile / compileInputs).dependsOn(javafmtDoFormatOnCompile).value)
 
   def notToBeScopedSettings: Seq[Setting[?]] =
-    List(javafmt / includeFilter := "*.java")
+    List(
+      ivyConfigurations += JavafmtRuntime,
+      libraryDependencies +=
+        ("com.google.googlejavaformat" % "google-java-format" % formatterVersionForCompatibleJavaVersion(
+          javafmtFormatterCompatibleJavaVersion.value) % JavafmtRuntime.name).classifier("all-deps").intransitive(),
+      javafmtFormatterClasspath := update.value
+        .matching(
+          configurationFilter(JavafmtRuntime.name) && moduleFilter(
+            organization = "com.google.googlejavaformat",
+            name = "google-java-format"))
+        .distinct,
+      javafmt / includeFilter := "*.java")
+
+  private def formatterVersionForCompatibleJavaVersion(compatibleJavaVersion: Int): String =
+    compatibleJavaVersion match {
+      case 11    => "1.24.0"
+      case 17    => "1.28.0"
+      case 21    => "1.35.0"
+      case other =>
+        throw new MessageOnlyException(
+          s"Unsupported javafmtFormatterCompatibleJavaVersion: $other. Expected one of: 11, 17, 21.")
+    }
 
   @transient
   private val javafmtDoFormatOnCompile =