Convert scalafmt integration to use a compile-only sourceset by mdedetrich · Pull Request #1283 · diffplug/spotless

mdedetrich · 2022-08-22T11:24:27Z

Convert scalafmt integration to use a compile-only sourceset (Use custom source sets and compile-only dependencies instead of reflection #524)
- Just like other PRs that convert from reflection to using a compile-only source set, this PR also removes code related to old versions of Scalafmt. This is also necessary due to the fact that scalafmt's API is completely different from major versions so spotless wouldn't even work with scalafmt versions older than 3.
Possible solution to Force scalaVersion when using scala scalafmt extension #1273 (still need to test)

testlib/src/test/java/com/diffplug/spotless/scala/ScalaFmtStepTest.java

mdedetrich · 2022-08-22T11:30:19Z

lib/src/scalafmt/java/com/diffplug/spotless/glue/scalafmt/ScalafmtFormatterFunc.java

+	public String apply(String input) throws Exception {
+		ScalafmtConfig config;
+		if (configSignature.files().isEmpty()) {
+			// Note that reflection is used here only because Scalafmt has a method called


One way around this may be that instead of defining ScalafmtFormatterFunc as a Java source file, instead we can define it as a Scala source file (which with a basic class Java has no issues calling). Not sure if this is possible or even desirable

I'd be okay putting Scala into our codebase if it was really useful for some task, but this is small enough that I'd prefer the reflection. Note the little refactor I did in a75877c.

lib/src/main/java/com/diffplug/spotless/scala/ScalaFmtStep.java

testlib/src/main/resources/scala/scalafmt/scalafmt.conf

lib/src/scalafmt/java/com/diffplug/spotless/glue/scalafmt/ScalafmtFormatterFunc.java

lib/src/main/java/com/diffplug/spotless/scala/ScalaFmtStep.java

nedtwigg · 2022-08-22T22:53:44Z

NBD, but please push new commits instead of force-pushing. Easier to review only what has changed that way :)

nedtwigg · 2022-08-22T22:54:34Z

Also thanks for this very good PR, it will definitely get merged :D

mdedetrich · 2022-08-22T23:12:42Z

So I just added a commit which implements the scalaMajorVersion configuration as well as resolving conflicts from master branch. Let me know if anything else is needed!

plugin-gradle/src/main/java/com/diffplug/gradle/spotless/ScalaExtension.java

mdedetrich · 2022-08-22T23:56:08Z

CI is passing now, forgot about the newly formatted files and accidentally deleted a line which I didn't realize.

mdedetrich · 2022-08-23T09:46:36Z

Just pushed some commits regarding updates/changes in the documentation.

…lved in serialization/equality, so good to eagerly initialize in the constructor.

nedtwigg · 2022-08-23T19:43:22Z

Thanks very much! I'm ready to merge this when you are. My planned commit message:

Add support for setting scala version for scalafmt, and also convert to compile-time (#1283 fixes #1273 helps with #524)

mdedetrich · 2022-08-23T19:44:36Z

Perfect, happy with the commit message so feel free to merge and thanks for being responsive on the PR!

nedtwigg · 2022-08-23T22:10:51Z

Published in plugin-gradle 6.10.0 and plugin-maven 2.25.0.

mdedetrich force-pushed the scalafmt-compile-time-only-sourceset branch from fcb77ca to 848061e Compare August 22, 2022 11:25

mdedetrich mentioned this pull request Aug 22, 2022

Force scalaVersion when using scala scalafmt extension #1273

Closed