decouple sbt-scalafix from scalafix-interfaces

This will allow for a separate release lifecycle

Author: bjaglin

build.sbt

@@ -101,5 +101,6 @@ scriptedParallelInstances := 2
 scriptedLaunchOpts ++= Seq(
   "-Xmx2048M",
   s"-Dplugin.version=${version.value}",
+  s"-Dinterfaces.version=${Dependencies.scalafixVersion}",
   "-Dsbt-scalafix.uselastmodified=true" // the caching scripted relies on sbt-scalafix only checking file attributes, not content
 )

project/Dependencies.scala

@@ -2,11 +2,13 @@ import sbt._
 
 object Dependencies {
   val x = List(1) // scalafix:ok
-  def scalafixVersion: String = "0.14.2"
+
+  // lowest version of interfaces that for build-time and run-time
+  def scalafixVersion: String = "0.13.0" // https://github.com/scalacenter/scalafix/commit/1498200#diff-8f1370021f0c21599d22a292e6ee5a9446f05c18a05f5c3bb250dea3884c72ee
 
   val all = List(
     "org.eclipse.jgit" % "org.eclipse.jgit" % "5.13.3.202401111512-r",
-    "ch.epfl.scala" % "scalafix-interfaces" % scalafixVersion,
+    "ch.epfl.scala" % "scalafix-interfaces" % scalafixVersion % Provided,
     "io.get-coursier" % "interface" % "1.0.28",
     "org.scala-lang.modules" %% "scala-collection-compat" % "2.13.0"
   )

project/plugins.sbt

@@ -10,3 +10,6 @@ Compile / unmanagedSourceDirectories ++= {
   )
 }
 libraryDependencies ++= Dependencies.all
+
+// latest version of interfaces to test compatibility & get most recent behavior for scalafix invocations
+libraryDependencies += "ch.epfl.scala" % "scalafix-interfaces" % "0.14.2"

src/main/scala/scalafix/sbt/BuildInfo.scala

@@ -29,7 +29,9 @@ object BuildInfo {
         props.load(stream)
       case None =>
         sys.error(
-          s"failed to load the resource file '$propertiesPath'. To fix this problem, make sure to enable the sbt-scalafix in 'project/plugins.sbt' and validate that the scalafix-interfaces jar is available on the classpath of the sbt build."
+          s"failed to load the resource file '$propertiesPath'; " +
+            "to fix this problem, add \"ch.epfl.scala\" % \"scalafix-interfaces\" " +
+            "to libraryDependencies in 'project/plugins.sbt'"
         )
     }
     props
@@ -39,7 +41,7 @@ object BuildInfo {
     Option(props.getProperty(key)).getOrElse {
       sys.error(
         s"sbt-scalafix property '$key' missing in $propertiesPath; " +
-          "to fix this problem, upgrade to the latest version of Scalafix."
+          "to fix this problem, upgrade to a more recent version of scalafix-interfaces"
       )
     }
 }

src/main/scala/scalafix/sbt/ScalafixPlugin.scala

@@ -225,10 +225,23 @@ object ScalafixPlugin extends AutoPlugin {
         )
       )
 
+  // Wrap calls that might result in linking errors because of a missing scalafix-interfaces
+  private def wrapUnsafe[T](value: => T): T = try value catch {
+    case e: LinkageError =>
+      val msg = "failed to load ScalafixPlugin; " +
+            "to fix this problem, add \"ch.epfl.scala\" % \"scalafix-interfaces\" " +
+            "to libraryDependencies in 'project/plugins.sbt' or remove sbt-scalafix"
+      throw new Error(msg, e)
+  }
+
   override lazy val projectConfigurations: Seq[Configuration] =
+    wrapUnsafe(unsafeProjectConfigurations)
+  private lazy val unsafeProjectConfigurations =
     Seq(ScalafixConfig)
 
-  override lazy val projectSettings: Seq[Def.Setting[?]] = Def.settings(
+  override lazy val projectSettings: Seq[Def.Setting[?]] =
+    wrapUnsafe(unsafeProjectSettings)
+  private lazy val unsafeProjectSettings = Def.settings(
     Seq(Compile, Test).flatMap(c => inConfig(c)(scalafixConfigSettings(c))),
     inConfig(ScalafixConfig)(
       Def.settings(
@@ -261,7 +274,7 @@ object ScalafixPlugin extends AutoPlugin {
                       "via `semanticdbVersion` does follow the version recommended " +
                       "for Scalafix, but is not supported for the given Scala " +
                       s"version ${scalaV}. Please consider upgrading to a more recent version " +
-                      "of sbt-scalafix and/or Scala, or uninstalling sbt-scalafix plugin."
+                      "of scalafix-interfaces and/or Scala, or uninstalling sbt-scalafix plugin."
                   throw inc.copy(message = Some(msg))
                 case _ =>
               }
@@ -278,7 +291,9 @@ object ScalafixPlugin extends AutoPlugin {
       .mkString(".")): @nowarn
   )
 
-  override lazy val globalSettings: Seq[Def.Setting[?]] = Seq(
+  override def globalSettings: Seq[Def.Setting[?]] =
+    wrapUnsafe(unsafeGlobalSettings)
+  private lazy val unsafeGlobalSettings = Seq(
     scalafixCallback := new ScalafixLogger(ScalafixInterface.defaultLogger),
     scalafixConfig := None, // let scalafix-cli try to infer $CWD/.scalafix.conf
     scalafixOnCompile := false,
@@ -294,6 +309,8 @@ object ScalafixPlugin extends AutoPlugin {
   )
 
   override def buildSettings: Seq[Def.Setting[?]] =
+    wrapUnsafe(unsafeBuildSettings)
+  private lazy val unsafeBuildSettings =
     Seq(
       scalafixSbtResolversAsCoursierRepositories := {
         val logger = streams.value.log

src/sbt-test/sbt-scalafix/basic/project/plugins.sbt

@@ -1,3 +1,4 @@
 resolvers += Resolver.sonatypeRepo("public")
 libraryDependencies += "com.googlecode.java-diff-utils" % "diffutils" % "1.3.0"
 addSbtPlugin("ch.epfl.scala" % "sbt-scalafix" % sys.props("plugin.version"))
+libraryDependencies += "ch.epfl.scala" % "scalafix-interfaces" % sys.props("interfaces.version")

src/sbt-test/sbt-scalafix/build-lint/project/plugins.sbt

@@ -1,2 +1,3 @@
 resolvers += Resolver.sonatypeRepo("public")
 addSbtPlugin("ch.epfl.scala" % "sbt-scalafix" % sys.props("plugin.version"))
+libraryDependencies += "ch.epfl.scala" % "scalafix-interfaces" % sys.props("interfaces.version")

src/sbt-test/sbt-scalafix/concurrency/project/plugins.sbt

@@ -1,2 +1,3 @@
 resolvers += Resolver.sonatypeRepo("public")
 addSbtPlugin("ch.epfl.scala" % "sbt-scalafix" % sys.props("plugin.version"))
+libraryDependencies += "ch.epfl.scala" % "scalafix-interfaces" % sys.props("interfaces.version")

src/sbt-test/sbt-scalafix/cross-build/project/plugins.sbt

@@ -1,3 +1,4 @@
 resolvers += Resolver.sonatypeRepo("public")
 libraryDependencies += "com.googlecode.java-diff-utils" % "diffutils" % "1.3.0"
 addSbtPlugin("ch.epfl.scala" % "sbt-scalafix" % sys.props("plugin.version"))
+libraryDependencies += "ch.epfl.scala" % "scalafix-interfaces" % sys.props("interfaces.version")

src/sbt-test/sbt-scalafix/custom-config/project/plugins.sbt

@@ -1,2 +1,3 @@
 resolvers += Resolver.sonatypeRepo("public")
 addSbtPlugin("ch.epfl.scala" % "sbt-scalafix" % sys.props("plugin.version"))
+libraryDependencies += "ch.epfl.scala" % "scalafix-interfaces" % sys.props("interfaces.version")

src/sbt-test/sbt-scalafix/custom-src-directory/project/plugins.sbt

@@ -1,2 +1,3 @@
 resolvers += Resolver.sonatypeRepo("public")
 addSbtPlugin("ch.epfl.scala" % "sbt-scalafix" % sys.props("plugin.version"))
+libraryDependencies += "ch.epfl.scala" % "scalafix-interfaces" % sys.props("interfaces.version")

src/sbt-test/sbt-scalafix/dependency/project/plugins.sbt

@@ -1,3 +1,4 @@
 resolvers += Resolver.sonatypeRepo("public")
 libraryDependencies += "com.googlecode.java-diff-utils" % "diffutils" % "1.3.0"
 addSbtPlugin("ch.epfl.scala" % "sbt-scalafix" % sys.props("plugin.version"))
+libraryDependencies += "ch.epfl.scala" % "scalafix-interfaces" % sys.props("interfaces.version")

src/sbt-test/sbt-scalafix/explicit-files/project/plugins.sbt

@@ -1,2 +1,3 @@
 resolvers += Resolver.sonatypeRepo("public")
 addSbtPlugin("ch.epfl.scala" % "sbt-scalafix" % sys.props("plugin.version"))
+libraryDependencies += "ch.epfl.scala" % "scalafix-interfaces" % sys.props("interfaces.version")

src/sbt-test/sbt-scalafix/inconfig/project/plugins.sbt

@@ -1,3 +1,4 @@
 resolvers += Resolver.sonatypeRepo("public")
 libraryDependencies += "com.googlecode.java-diff-utils" % "diffutils" % "1.3.0"
 addSbtPlugin("ch.epfl.scala" % "sbt-scalafix" % sys.props("plugin.version"))
+libraryDependencies += "ch.epfl.scala" % "scalafix-interfaces" % sys.props("interfaces.version")

src/sbt-test/sbt-scalafix/interfaces-missing/project/plugins.sbt

@@ -0,0 +1 @@
+resolvers += Resolver.sonatypeRepo("public")

src/sbt-test/sbt-scalafix/interfaces-missing/test

@@ -0,0 +1,6 @@
+> reload plugins
+> set addSbtPlugin("ch.epfl.scala" % "sbt-scalafix" % sys.props("plugin.version"))
+> session save
+-> reload return
+$ delete project/plugins.sbt
+> reload

src/sbt-test/sbt-scalafix/resolvers/project/plugins.sbt

@@ -1,2 +1,3 @@
 resolvers += Resolver.sonatypeRepo("public")
 addSbtPlugin("ch.epfl.scala" % "sbt-scalafix" % sys.props("plugin.version"))
+libraryDependencies += "ch.epfl.scala" % "scalafix-interfaces" % sys.props("interfaces.version")

src/sbt-test/sbt-scalafix/root-validation/project/plugins.sbt

@@ -1,2 +1,3 @@
 resolvers += Resolver.sonatypeRepo("public")
 addSbtPlugin("ch.epfl.scala" % "sbt-scalafix" % sys.props("plugin.version"))
+libraryDependencies += "ch.epfl.scala" % "scalafix-interfaces" % sys.props("interfaces.version")

src/sbt-test/sbt-scalafix/scalafixEnable/project/plugins.sbt

@@ -1,5 +1,4 @@
 resolvers += Resolver.sonatypeRepo("public")
 addSbtPlugin("ch.epfl.scala" % "sbt-scalafix" % sys.props("plugin.version"))
-
 // https://github.com/scalameta/scalameta/blob/v4.4.10/project/Versions.scala
-dependencyOverrides += "ch.epfl.scala" % "scalafix-interfaces" % "0.9.27" // scala-steward:off
+libraryDependencies += "ch.epfl.scala" % "scalafix-interfaces" % "0.9.27" // scala-steward:off

src/sbt-test/sbt-scalafix/scalafixOnCompile/project/plugins.sbt

@@ -1,2 +1,3 @@
 resolvers += Resolver.sonatypeRepo("public")
 addSbtPlugin("ch.epfl.scala" % "sbt-scalafix" % sys.props("plugin.version"))
+libraryDependencies += "ch.epfl.scala" % "scalafix-interfaces" % sys.props("interfaces.version")

src/sbt-test/sbt-scalafix/semanticdb-enabled/project/plugins.sbt

@@ -1,2 +1,3 @@
 resolvers += Resolver.sonatypeRepo("public")
 addSbtPlugin("ch.epfl.scala" % "sbt-scalafix" % sys.props("plugin.version"))
+libraryDependencies += "ch.epfl.scala" % "scalafix-interfaces" % sys.props("interfaces.version")

src/sbt-test/sbt-scalafix/suppress/project/plugins.sbt

@@ -1,3 +1,4 @@
 resolvers += Resolver.sonatypeRepo("public")
 addSbtPlugin("ch.epfl.scala" % "sbt-scalafix" % sys.props("plugin.version"))
+libraryDependencies += "ch.epfl.scala" % "scalafix-interfaces" % sys.props("interfaces.version")
 libraryDependencies += "com.googlecode.java-diff-utils" % "diffutils" % "1.3.0"

src/sbt-test/sbt-scalafix/unavailable-semanticdb-scalac/build.sbt

@@ -19,7 +19,7 @@ checkLogs := {
   assert(
     logLines.exists(
       _.contains(
-        "Please consider upgrading to a more recent version of sbt-scalafix and/or Scala, or uninstalling sbt-scalafix plugin"
+        "Please consider upgrading to a more recent version of scalafix-interfaces and/or Scala, or uninstalling sbt-scalafix plugin"
       )
     )
   )

src/sbt-test/sbt-scalafix/unavailable-semanticdb-scalac/project/plugins.sbt

@@ -1,2 +1,3 @@
 resolvers += Resolver.sonatypeRepo("public")
 addSbtPlugin("ch.epfl.scala" % "sbt-scalafix" % sys.props("plugin.version"))
+libraryDependencies += "ch.epfl.scala" % "scalafix-interfaces" % sys.props("interfaces.version")

src/sbt-test/sbt-scalafix/wrapper/project/plugins.sbt

@@ -1,2 +1,3 @@
 resolvers += Resolver.sonatypeRepo("public")
 addSbtPlugin("ch.epfl.scala" % "sbt-scalafix" % sys.props("plugin.version"))
+libraryDependencies += "ch.epfl.scala" % "scalafix-interfaces" % sys.props("interfaces.version")

src/sbt-test/skip-java17+/scalafixResolvers/project/plugins.sbt

@@ -1,3 +1,4 @@
 resolvers += Resolver.sonatypeRepo("public")
 addSbtPlugin("ch.epfl.scala" % "sbt-scalafix" % sys.props("plugin.version"))
+libraryDependencies += "ch.epfl.scala" % "scalafix-interfaces" % sys.props("interfaces.version")
 addSbtPlugin("nl.gn0s1s" %% "sbt-dotenv" % "3.1.1")

src/sbt-test/skip-sbt1.4/cross-build-scala3/project/plugins.sbt

@@ -1,2 +1,3 @@
 resolvers += Resolver.sonatypeRepo("public")
 addSbtPlugin("ch.epfl.scala" % "sbt-scalafix" % sys.props("plugin.version"))
+libraryDependencies += "ch.epfl.scala" % "scalafix-interfaces" % sys.props("interfaces.version")

src/sbt-test/skip-sbt1.4/local-rules/project/plugins.sbt

@@ -1,2 +1,3 @@
 resolvers += Resolver.sonatypeRepo("public")
 addSbtPlugin("ch.epfl.scala" % "sbt-scalafix" % sys.props("plugin.version"))
+libraryDependencies += "ch.epfl.scala" % "scalafix-interfaces" % sys.props("interfaces.version")

src/sbt-test/skip-sbt1.4/scala-3/project/plugins.sbt

@@ -1,2 +1,3 @@
 resolvers += Resolver.sonatypeRepo("public")
 addSbtPlugin("ch.epfl.scala" % "sbt-scalafix" % sys.props("plugin.version"))
+libraryDependencies += "ch.epfl.scala" % "scalafix-interfaces" % sys.props("interfaces.version")

src/sbt-test/skip-sbt1.4/scalafixEnable/project/plugins.sbt

@@ -1,2 +1,3 @@
 resolvers += Resolver.sonatypeRepo("public")
 addSbtPlugin("ch.epfl.scala" % "sbt-scalafix" % sys.props("plugin.version"))
+libraryDependencies += "ch.epfl.scala" % "scalafix-interfaces" % sys.props("interfaces.version")

src/sbt-test/skip-sbt1.4/testkit/project/plugins.sbt

@@ -1,5 +1,6 @@
 resolvers += Resolver.sonatypeRepo("public")
 addSbtPlugin("ch.epfl.scala" % "sbt-scalafix" % sys.props("plugin.version"))
+libraryDependencies += "ch.epfl.scala" % "scalafix-interfaces" % sys.props("interfaces.version")
 
 libraryDependencies ++= {
   val sbtV = sbtBinaryVersion.value

src/sbt-test/skip-windows/caching/project/plugins.sbt

@@ -1,2 +1,3 @@
 resolvers += Resolver.sonatypeRepo("public")
 addSbtPlugin("ch.epfl.scala" % "sbt-scalafix" % sys.props("plugin.version"))
+libraryDependencies += "ch.epfl.scala" % "scalafix-interfaces" % sys.props("interfaces.version")

src/sbt-test/skip-windows/relax-scalacOptions/project/plugins.sbt

@@ -1,2 +1,3 @@
 resolvers += Resolver.sonatypeRepo("public")
 addSbtPlugin("ch.epfl.scala" % "sbt-scalafix" % sys.props("plugin.version"))
+libraryDependencies += "ch.epfl.scala" % "scalafix-interfaces" % sys.props("interfaces.version")

src/test/scala/scalafix/internal/sbt/ScalafixAPISuite.scala

@@ -39,7 +39,7 @@ class ScalafixAPISuite extends AnyFunSuite {
       "2.12",
       Arg.ToolClasspath(
         Nil,
-        List("ch.epfl.scala" %% "example-scalafix-rule" % "6.0.0"),
+        List("ch.epfl.scala" %% "example-scalafix-rule" % "5.0.0"),
         Seq(
           Repository.central,
           MavenRepository.of(