Spotless Gradle is incompatible with ktfmt 0.57

[ZacSweers]

Seen when updating here.

$ cd samples/
$ ./gradlew spotlessApply

> Task :spotlessKotlinGradleApply FAILED

FAILURE: Build failed with an exception.

* What went wrong:
Execution failed for task ':spotlessKotlinGradleApply'.
> There were 2 lint error(s), they must be fixed or suppressed.
  build.gradle.kts:LINE_UNDEFINED ktfmt(java.lang.NoSuchMethodError) 'boolean com.facebook.ktfmt.format.FormattingOptions.getManageTrailingCommas()' (...)
  settings.gradle.kts:LINE_UNDEFINED ktfmt(java.lang.NoSuchMethodError) 'boolean com.facebook.ktfmt.format.FormattingOptions.getManageTrailingCommas()' (...)
  Resolve these lints or suppress with `suppressLintsFor

https://scans.gradle.com/s/dyeb3xx4stt4y

Change is due to manageTrailingCommas now being a trailingCommaManagementStrategy enum: https://github.com/facebook/ktfmt/releases/tag/v0.57

FormattingOptions.manageTrailingCommas was replaced with FormattingOptions.trailingCommaManagementStrategy, which also added new TrailingCommaManagementStrategy.ONLY_ADD strategy (facebook/ktfmt#461, facebook/ktfmt#512, facebook/ktfmt#514)

[greyhairredbear]

I just might find the time to look into this more deeply in the next couple of days, if help is wanted here (@hick209).

[ZacSweers]

I don't think this is a ktfmt issue, it's an unstable API. Just needs updated handling in spotless to expose the new API and gracefully degrade for older versions

[greyhairredbear]

I'm aware of that (already looked a bit into the code of the plugin), just saw Nivaldo's handle in the commits so I figured he would be the one in charge of the plugin - I just want to avoid doing work that someone else is already doing.

[greyhairredbear]

Started to work on this yesterday in the evening, ran into an issue when upgrading the ktfmtCompileOnly dependency in lib/build.gradle:

> Dependency resolution is looking for a library compatible with JVM runtime version 11, but 'com.facebook:ktfmt:0.57' is only compatible with JVM runtime version 17 or newer.

Also found out that the job for #2400 (from renovate) is failing because of this.

I'm not sure how to handle this.

Haven't looked into this in detail, but I suppose the options are either upgrading spotless to run on at least Java 17 (which doesn't sound very realistic to me) or to make ktfmt compatible with Java 11 again.

I guess for ktfmt, this has changed after migrating to Kotlin 2 and using gradle as a build tool, at least I see java = "17" in ktfmt's libs.versions.toml. From what I've researched here, newer Kotlin versions still should allow targeting a JVM version of 11. Not sure if some other dependencies like google-java-format require targeting a higher JVM version... Maybe @hick209 has some insights here.

EDIT: Just looked into https://github.com/google/google-java-format/blob/master/pom.xml, the target should be Java 1.8. I guess ktfmt's version of Gradle also should allow targeting Java 11. If there are no cons, I could open a PR for ktfmt to change the JVM target.

[hick209]

I've checked and only the idea part of ktfmt requires JDK 17, so it should be fine to downgrade ktfmt to use JDK 11

[nedtwigg]

Spotless main branch has actually already bumped our required JDK to 17.

Dependency resolution is looking for a library compatible with JVM runtime version 11, but 'com.facebook:ktfmt:0.57' is only compatible with JVM runtime version 17 or newer.

Not sure what is causing Gradle to look for 11, but we have other core deps (like JGit) which are now 17-only so this should be possible to fix on the Spotless side.

[greyhairredbear]

Hmmm, please correct me if I'm wrong, but isn't JAVA_VER in gradle.properties set to 11 on the main branch (see here) and then used to configure the Java compiler to use that version here?

Btw: I did change the version to 17 on my machine and it seemed to get me over the hump. (not yet sure if there are repercussions in some other part of the project)

[nedtwigg]

You are correct, and it is a mistake. It should be 17 now. Anyone working on this issue is free to bump it to 17 as part of their PR.

[greyhairredbear]

Thank you for clearing that up! Did the update to Java 17 and I guess most of the work regarding ktfmt itself (https://github.com/greyhairredbear/spotless/tree/fix/ktfmt-0.57%2B).

Currently, there are still two failing tests cases in KtfmtTest. testKtfmtWithManageTrailingCommasOption and testContinuation. I suppose the latter might be expected to fail, since there is no version of ktfmt specified and output might have changed between 0.53 and 0.58, but the former the ktfmt version is set to 0.49 and so I wouldn't expect the output to be changed. I'll certainly look a bit more into this, but maybe you have some insights here @hick209?

Running ./gradlew test doesn't yield any other failures.

I further intend to write two test cases for KtfmtStepTest (one for the ONLY_ADD TrailingCommaManagmentStrategy and another one for ktfmt below 0.57 - I suppose 0.53, the previous version used in the spotless plugin should be fine)

@nedtwigg I could already open a draft PR to see if the CI passes, or would you rather prefer to postpone that until the know issues are fixed?

[nedtwigg]

Draft PRs are always welcome