Upgrading gradle plugin from 6.0.25 to 8.0.0 (and 7.0.0) yields strange lint errors

[recfut-erikr]

We have been running 6.0.25 for a long time and were going to upgrade to 8.0.0 but it fails with some strange lint errors. Went back to 7.0.0 and it has the same issue. So my problem came between 6.25.0 and 7.0.0.

Since the lines are undefined, Im having some problems understanding what provokes this behaviour.
Could anyone share some insight on how to debug this?

Best regards
//Erik

gw build
> Task :api:spotlessScalaCheck FAILED

FAILURE: Build failed with an exception.

* What went wrong:
Execution failed for task ':api:spotlessScalaCheck'.
> There were 2 lint error(s), they must be fixed or suppressed.
  src/main/scala/MyApi.scala:LINE_UNDEFINED scalafmt(java.lang.reflect.InvocationTargetException) java.lang.reflect.InvocationTargetException (...)
  src/test/scala/MyApiTest.scala:LINE_UNDEFINED scalafmt(java.lang.reflect.InvocationTargetException) java.lang.reflect.InvocationTargetException (...)
  Resolve these lints or suppress with `suppressLintsFor`

gradle version

> ./gradlew -v

------------------------------------------------------------
Gradle 8.11.1
------------------------------------------------------------

Build time:    2024-11-20 16:56:46 UTC
Revision:      481cb05a490e0ef9f8620f7873b83bd8a72e7c39

Kotlin:        2.0.20
Groovy:        3.0.22
Ant:           Apache Ant(TM) version 1.10.14 compiled on August 16 2023
Launcher JVM:  21.0.9 (Eclipse Adoptium 21.0.9+10-LTS)
Daemon JVM:    /Library/Java/JavaVirtualMachines/temurin-21.jdk/Contents/Home (no JDK specified, using current Java home)
OS:            Mac OS X 15.7.1 aarch64

scala format

version = "3.9.4"
runner.dialect = scala213

project {
  includeFilters = [
    ".*.\\.scala$"
  ]
}

maxColumn = 120
assumeStandardLibraryStripMargin=true

align {
  openParenCallSite = false,
  openParenDefnSite = false,
  tokens = [],
}

indent {
  callSite = 2
  defnSite = 2
  extendSite = 2
}

# https://docs.scala-lang.org/style/declarations.html#ordering-of-class-elements
newlines {
  source = keep
  topLevelStatementBlankLines = [
    {
      blanks { before = 1 }
    }
  ]

}

# Force that import statements are always on one line
importSelectors = singleLine

rewrite.trailingCommas.style = keep

docstrings {
  style = Asterisk
}

[nedtwigg]

It is a bit confusing. There are two kinds of lints:

• the formatter intended to lint (might have a line #, might not, but it should have a nice message)
• the formatter blew up and threw an exception

This is the latter case. The formatter is just failing to run on these two files, and we are passing the exception as a lint. The reason we do this is that it lets the other files get formatted, and it lets you use the lint suppression API to decide if you care about these two problems or not.

But it's quite bad that we hide the stacktrace. The fix would be to implement this:

• Give option for detailed linting errors #2455

[recfut-erikr]

Thanks, that makes totally sense and sorry for not finding that issue, I thought I had searched the issues as well. So the next step is for me to find out why scalafmt blews up.

Thanks for response and your work in this plugin

[recfut-erikr]

@nedtwigg Is the spotless plugin limited to one scalafmt version only? Because if I change our scalafmt version to 3.8.1 it works as intended. Increasing the version to 3.8.2 breaks the linting again.

I did find the ScalaFmtStep.java but it doesnt look like it should be limited to one version only?

Got the following stack trace (using copilot so it is mangled)

java.lang.reflect.InvocationTargetException
     	at java.base/jdk.internal.reflect.DirectConstructorHandleAccessor.newInstance(DirectConstructorHandleAccessor.java:74)
     	at java.base/java.lang.reflect.Constructor.newInstanceWithCaller(Constructor.java:502)
     	at java.base/java.lang.reflect.Constructor.newInstance(Constructor.java:486)
     	at com.diffplug.spotless.scala.ScalaFmtStep$State.createFormat(ScalaFmtStep.java:97)

   The real cause (at the bottom):
     Caused by: java.util.NoSuchElementException: version [expected 3.8.1 or 3.8.1]: 3.8.2
     	at metaconfig.Configured.get(Configured.scala:15)
     	at com.diffplug.spotless.glue.scalafmt.ScalafmtFormatterFunc.<init>(ScalafmtFormatterFunc.java:47)
     	at java.base/jdk.internal.reflect.DirectConstructorHandleAccessor.newInstance(DirectConstructorHandleAccessor.java:62)

Best regards
//Erik

[nedtwigg]

scala is a mystery box to me, but your error is coming from here:

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

Lines 36 to 47 in 88c83de

	if (configSignature.files().isEmpty()) {
	// Note that reflection is used here only because Scalafmt has a method called
	// default which happens to be a reserved Java keyword. The only way to call
	// such methods is by reflection, see
	// https://vlkan.com/blog/post/2015/11/20/scala-method-with-java-reserved-keyword/
	Method method = ScalafmtConfig$.MODULE$.getClass().getDeclaredMethod("default");
	config = (ScalafmtConfig) method.invoke(ScalafmtConfig$.MODULE$);
	} else {
	File file = configSignature.getOnlyFile();
	String configStr = Files.readString(file.toPath());
	config = Scalafmt.parseHoconConfig(configStr).get();
	}

My guess is that maybe your config file needs to have a matching version string?