Fix - suggest actionable update for toolkit dep (#1785)

Author: lwronski

modules/build/src/main/scala/scala/build/preprocessing/ScalaPreprocessor.scala

@@ -334,7 +334,7 @@ case object ScalaPreprocessor extends Preprocessor {
       val deps = value {
         dependencyTrees
           .map { t => /// skip ivy ($ivy.`) or dep syntax ($dep.`)
-            val pos      = toFilePos(Position.Raw(t.start + "$ivy.`".length, t.end))
+            val pos      = toFilePos(Position.Raw(t.start + "$ivy.`".length, t.end - 1))
             val strDep   = t.prefix.drop(1).mkString(".")
             val maybeDep = parseDependency(strDep, pos)
             maybeDep.map(dep => Positioned(Seq(pos), dep))

modules/build/src/test/scala/scala/build/tests/ActionableDiagnosticTests.scala

@@ -43,7 +43,7 @@ class ActionableDiagnosticTests extends munit.FunSuite {
         expect(osLibDiagnosticOpt.nonEmpty)
         val osLibDiagnostic = osLibDiagnosticOpt.get
 
-        expect(Version(osLibDiagnostic.newVersion) > Version(osLibDiagnostic.oldDependency.version))
+        expect(Version(osLibDiagnostic.newVersion) > Version(osLibDiagnostic.currentVersion))
     }
   }
 
@@ -71,8 +71,7 @@ class ActionableDiagnosticTests extends munit.FunSuite {
         expect(osLibDiagnosticOpt.nonEmpty)
         val osLibDiagnostic = osLibDiagnosticOpt.get
 
-        expect(osLibDiagnostic.oldDependency.render == dependencyOsLib)
-        expect(Version(osLibDiagnostic.newVersion) > Version(osLibDiagnostic.oldDependency.version))
+        expect(Version(osLibDiagnostic.newVersion) > Version(osLibDiagnostic.currentVersion))
     }
   }
 
@@ -100,8 +99,7 @@ class ActionableDiagnosticTests extends munit.FunSuite {
         expect(osLibDiagnosticOpt.nonEmpty)
         val osLibDiagnostic = osLibDiagnosticOpt.get
 
-        expect(osLibDiagnostic.oldDependency.render == dependencyOsLib)
-        expect(Version(osLibDiagnostic.newVersion) > Version(osLibDiagnostic.oldDependency.version))
+        expect(Version(osLibDiagnostic.newVersion) > Version(osLibDiagnostic.currentVersion))
     }
   }
 

modules/cli/src/main/scala/scala/cli/commands/dependencyupdate/DependencyUpdate.scala

@@ -62,7 +62,9 @@ object DependencyUpdate extends ScalaCommand[DependencyUpdateOptions] {
     else {
       println("Updates")
       actionableUpdateDiagnostics.foreach(update =>
-        println(s"   * ${update.oldDependency.render} -> ${update.newVersion}")
+        println(
+          s"   * ${update.dependencyModuleName} ${update.currentVersion} -> ${update.newVersion}"
+        )
       )
       println(s"""|To update all dependencies run:
                   |    $baseRunnerName dependency-update --all""".stripMargin)
@@ -88,7 +90,9 @@ object DependencyUpdate extends ScalaCommand[DependencyUpdateOptions] {
         val appliedDiagnostics = updateDependencies(file, sortedByLine)
         os.write.over(file, appliedDiagnostics)
         diagnostics.foreach(diagnostic =>
-          logger.message(s"Updated dependency to: ${diagnostic._2.suggestion}")
+          logger.message(
+            s"Updated dependency ${diagnostic._2.dependencyModuleName}: ${diagnostic._2.currentVersion} -> ${diagnostic._2.newVersion}"
+          )
         )
       case (Left(file), diagnostics) =>
         diagnostics.foreach {
@@ -109,9 +113,10 @@ object DependencyUpdate extends ScalaCommand[DependencyUpdateOptions] {
 
     diagnostics.foldLeft(fileContent) {
       case (fileContent, (file, diagnostic)) =>
-        val (line, column) = (file.startPos._1, file.startPos._2)
-        val startIndex     = startIndicies(line) + column
-        val endIndex       = startIndex + diagnostic.oldDependency.render.length()
+        val (line, column)       = (file.startPos._1, file.startPos._2)
+        val (lineEnd, columnEnd) = (file.endPos._1, file.endPos._2)
+        val startIndex           = startIndicies(line) + column
+        val endIndex             = startIndicies(lineEnd) + columnEnd
 
         val newDependency = diagnostic.suggestion
         s"${fileContent.slice(0, startIndex)}$newDependency${fileContent.drop(endIndex)}"

modules/directives/src/main/scala/scala/build/preprocessing/directives/Toolkit.scala

@@ -41,7 +41,7 @@ final case class Toolkit(
 object Toolkit {
   def resolveDependency(toolkitVersion: Positioned[String]) = toolkitVersion.map(version =>
     val v = if version == "latest" then "latest.release" else version
-    dep"${Constants.toolkitOrganization}::${Constants.toolkitName}:$v"
+    dep"${Constants.toolkitOrganization}::${Constants.toolkitName}:$v,toolkit"
   )
   val handler: DirectiveHandler[Toolkit] = DirectiveHandler.derive
 }

modules/integration/src/test/scala/scala/cli/integration/BspTestDefinitions.scala

@@ -1283,7 +1283,7 @@ abstract class BspTestDefinitions(val scalaVersionOpt: Option[String])
 
           checkDiagnostic(
             diagnostic = updateActionableDiagnostic,
-            expectedMessage = "com.lihaoyi::os-lib:0.7.8 is outdated",
+            expectedMessage = "os-lib is outdated",
             expectedSeverity = b.DiagnosticSeverity.HINT,
             expectedStartLine = 0,
             expectedStartCharacter = 15,

modules/integration/src/test/scala/scala/cli/integration/DependencyUpdateTests.scala

@@ -1,6 +1,7 @@
 package scala.cli.integration
 
 import com.eed3si9n.expecty.Expecty.expect
+import coursier.core.Version
 
 class DependencyUpdateTests extends ScalaCliSuite {
 
@@ -25,7 +26,7 @@ class DependencyUpdateTests extends ScalaCliSuite {
           stdin = os.Inherit,
           mergeErrIntoOut = true
         )
-      expect(p.out.trim().contains("Updated dependency to"))
+      expect(p.out.trim().contains("Updated dependency"))
       expect( // check if dependency update command modify file
         os.read(root / fileName) != fileContent)
 
@@ -34,4 +35,31 @@ class DependencyUpdateTests extends ScalaCliSuite {
       expect(out == message)
     }
   }
+
+  test("update toolkit dependence") {
+    val toolkitVersion = "0.1.3"
+    val testInputs = TestInputs(
+      os.rel / "Foo.scala" ->
+        s"""//> using toolkit "$toolkitVersion"
+           |
+           |object Hello extends App {
+           |  println("Hello")
+           |}
+           |""".stripMargin
+    )
+    testInputs.fromRoot { root =>
+      // update toolkit
+      os.proc(TestUtil.cli, "dependency-update", "--all", ".")
+        .call(cwd = root)
+
+      val toolkitDirective = "//> using toolkit \"(.*)\"".r
+      val updatedToolkitVersionOpt = {
+        val regexMatch = toolkitDirective.findFirstMatchIn(os.read(root / "Foo.scala"))
+        regexMatch.map(_.group(1))
+      }
+      expect(updatedToolkitVersionOpt.nonEmpty)
+      val updatedToolkitVersion = updatedToolkitVersionOpt.get
+      expect(Version(updatedToolkitVersion) > Version(toolkitVersion))
+    }
+  }
 }

modules/options/src/main/scala/scala/build/actionable/ActionableDependencyHandler.scala

@@ -29,10 +29,23 @@ case object ActionableDependencyHandler
     val currentVersion = dependency.version
     val latestVersion  = value(findLatestVersion(buildOptions, dependency))
 
-    if (latestVersion != currentVersion) {
-      val msg = s"${dependency.render} is outdated, update to $latestVersion"
-      Some(ActionableDependencyUpdateDiagnostic(msg, setting.positions, dependency, latestVersion))
-    }
+    if (latestVersion != currentVersion)
+      if (dependency.userParams.contains("toolkit"))
+        Some(ActionableDependencyUpdateDiagnostic(
+          setting.positions,
+          currentVersion,
+          latestVersion,
+          dependencyModuleName = "toolkit",
+          suggestion = latestVersion
+        ))
+      else
+        Some(ActionableDependencyUpdateDiagnostic(
+          setting.positions,
+          currentVersion,
+          latestVersion,
+          dependencyModuleName = dependency.module.name,
+          suggestion = dependency.copy(version = latestVersion).render
+        ))
     else
       None
   }

modules/options/src/main/scala/scala/build/actionable/ActionableDiagnostic.scala

@@ -20,14 +20,15 @@ abstract class ActionableDiagnostic extends Diagnostic {
 object ActionableDiagnostic {
 
   case class ActionableDependencyUpdateDiagnostic(
-    msg: String,
     positions: Seq[Position],
-    oldDependency: AnyDependency,
-    newVersion: String
+    currentVersion: String,
+    newVersion: String,
+    dependencyModuleName: String,
+    suggestion: String
   ) extends ActionableDiagnostic {
-    override def message: String = s"""|$msg
-                                       |     ${oldDependency.render} -> $suggestion""".stripMargin
-    override def suggestion: String = oldDependency.copy(version = newVersion).render
+    override def message: String =
+      s"""|"$dependencyModuleName is outdated, update to $newVersion"
+          |     $dependencyModuleName $currentVersion -> $suggestion""".stripMargin
   }
 
 }

website/docs/guides/dependencies.md

@@ -97,10 +97,10 @@ scala-cli dependency-update Hello.scala
 
 ```text
 Updates
-   * com.lihaoyi::os-lib:0.7.8 -> 0.8.1
-   * com.lihaoyi::utest:0.7.10 -> 0.8.0
-   * com.lihaoyi::geny:0.6.5 -> 0.7.1
-   * com.lihaoyi::pprint:0.6.6 -> 0.7.3
+   * com.lihaoyi 0.7.8 -> 0.8.1
+   * com.lihaoyi 0.7.10 -> 0.8.0
+   * com.lihaoyi 0.6.5 -> 0.7.1
+   * com.lihaoyi 0.6.6 -> 0.7.3
 To update all dependencies run: 
     scala-cli dependency-update --all
 ```
@@ -116,10 +116,10 @@ scala-cli dependency-update Hello.scala --all
 ```
 
 ```text
-Updated dependency to: com.lihaoyi::os-lib:0.8.1
-Updated dependency to: com.lihaoyi::utest:0.8.0
-Updated dependency to: com.lihaoyi::geny:0.7.1
-Updated dependency to: com.lihaoyi::pprint:0.7.3
+Updated dependency os-lib: 0.7.8 -> 0.9.0
+Updated dependency utest: 0.7.10 -> 0.8.1
+Updated dependency geny: 0.6.5 -> 1.0.0
+Updated dependency pprint: 0.6.6 -> 0.8.1
 ```
 
 </ChainedSnippets>