Merge pull request #3477 from aartigao/remove-trailing-comments-val-v…

…ersions Remove trailing comments in parsed SBT module version
scala-steward-org · Nov 19, 2024 · 251f21e · 251f21e
2 parents c1e6eac + 5408047
commit 251f21e
Show file tree

Hide file tree

Showing 2 changed files with 49 additions and 1 deletion.
diff --git a/modules/core/src/main/scala/org/scalasteward/core/edit/update/ModulePositionScanner.scala b/modules/core/src/main/scala/org/scalasteward/core/edit/update/ModulePositionScanner.scala
@@ -45,7 +45,7 @@ object ModulePositionScanner {
   private def sbtModuleIdRegex(dependency: Dependency): Regex = {
     val g = Regex.quote(dependency.groupId.value)
     val a = Regex.quote(dependency.artifactId.name)
-    raw""""($g)"\s*%+\s*"($a)"\s*%+\s*(.*)""".r
+    raw""""($g)"\s*%+\s*"($a)"\s*%+\s*([^\s/]*)""".r
   }
 
   private def findMillDependency(

diff --git a/...les/core/src/test/scala/org/scalasteward/core/edit/update/ModulePositionScannerTest.scala b/...les/core/src/test/scala/org/scalasteward/core/edit/update/ModulePositionScannerTest.scala
@@ -34,6 +34,54 @@ class ModulePositionScannerTest extends FunSuite {
     assertEquals(obtained, expected)
   }
 
+  test("sbt module with version val and comment") {
+    val d = "org.typelevel".g % "cats-core".a % "2.9.0"
+    val fd = FileData(
+      "build.sbt",
+      s""""${d.groupId}" %% "${d.artifactId.name}" % catsVersion // this is a comment"""
+    )
+    val obtained = ModulePositionScanner.findPositions(d, fd)
+    val expected = List(
+      ModulePosition(
+        Substring.Position(fd.path, 1, d.groupId.value),
+        Substring.Position(fd.path, 20, d.artifactId.name),
+        Substring.Position(fd.path, 33, "catsVersion")
+      )
+    )
+    assertEquals(obtained, expected)
+  }
+
+  test("sbt module with version val and comment with /* */") {
+    val d = "org.typelevel".g % "cats-core".a % "2.9.0"
+    val fd = FileData(
+      "build.sbt",
+      s""""${d.groupId}" %% "${d.artifactId.name}" % catsVersion /* this is a comment */"""
+    )
+    val obtained = ModulePositionScanner.findPositions(d, fd)
+    val expected = List(
+      ModulePosition(
+        Substring.Position(fd.path, 1, d.groupId.value),
+        Substring.Position(fd.path, 20, d.artifactId.name),
+        Substring.Position(fd.path, 33, "catsVersion")
+      )
+    )
+    assertEquals(obtained, expected)
+  }
+
+  test("sbt module with version val and end space") {
+    val d = "org.typelevel".g % "cats-core".a % "2.9.0"
+    val fd = FileData("build.sbt", s""""${d.groupId}" %% "${d.artifactId.name}" % catsVersion """)
+    val obtained = ModulePositionScanner.findPositions(d, fd)
+    val expected = List(
+      ModulePosition(
+        Substring.Position(fd.path, 1, d.groupId.value),
+        Substring.Position(fd.path, 20, d.artifactId.name),
+        Substring.Position(fd.path, 33, "catsVersion")
+      )
+    )
+    assertEquals(obtained, expected)
+  }
+
   test("sbt module where the artifactId is also part of the groupId") {
     val d = "com.typesafe.play".g % "play".a % "2.9.0"
     val fd = FileData("build.sbt", s""""com.typesafe.play" %% "play" % "2.9.0"""")