Skip to content

Remove trailing comments in parsed SBT module version #3477

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Nov 19, 2024
Merged

Remove trailing comments in parsed SBT module version #3477

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
347b586
Remove trailing comments in parsed SBT module ID
aartigao Nov 18, 2024
6989f4e
Format files
aartigao Nov 19, 2024
5408047
Add test for comments like `/* */`
aartigao Nov 19, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion modules/core/src/main/scala/org/scalasteward/core/edit/update/ModulePositionScanner.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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(
Expand Down
48 changes: 48 additions & 0 deletions ...les/core/src/test/scala/org/scalasteward/core/edit/update/ModulePositionScannerTest.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"""")
Expand Down
Loading