Add support for scaladoc pattern for source paths

Author: romanowski

scala3doc/src/dotty/dokka/SourceLinks.scala

@@ -11,6 +11,11 @@ object SourceLink:
   val SubPath = "([^=]+)=(.+)".r
   val KnownProvider = raw"(\w+):\/\/([^\/]+)\/([^\/]+)".r
   val BrokenKnownProvider = raw"(\w+):\/\/.+".r
+  val ScalaDocPatten = raw"€\{(TPL_NAME|TPL_NAME|FILE_PATH|FILE_EXT|FILE_LINE|FILE_PATH_EXT)\}".r
+  val SupportedScalaDocPatternReplacements = Map(
+    "€{FILE_PATH_EXT}" -> "{{ path }}",
+    "€{FILE_LINE}" -> "{{ line }}"
+  )
 
   def githubTemplate(organization: String, repo: String)(revision: String) =
     s"""https://github.com/$organization/$repo/{{ operation | replace: "view", "blob" }}/$revision/{{ path }}#L{{ line }}""".stripMargin
@@ -22,8 +27,8 @@ object SourceLink:
   private def parseLinkDefinition(s: String): Option[SourceLink] = ???
 
   def parse(string: String, revision: Option[String]): Either[String, SourceLink] =
-    def asRawTemplate =
-       try Right(SourceLink(None,Template.parse(string))) catch
+    def asTemplate(template: String) =
+       try Right(SourceLink(None,Template.parse(template))) catch
             case e: RuntimeException =>
               Left(s"Failed to parse template: ${e.getMessage}")
 
@@ -49,7 +54,14 @@ object SourceLink:
             Right(SourceLink(Some(Paths.get(prefix)), template))
       case BrokenKnownProvider("gitlab" | "github") =>
         Left(s"Does not match known provider syntax: `<name>://organization/repository`")
-      case template => asRawTemplate
+      case scaladocSetting if ScalaDocPatten.findFirstIn(scaladocSetting).nonEmpty =>
+        val all = ScalaDocPatten.findAllIn(scaladocSetting)
+        val (supported, unsupported) = all.partition(SupportedScalaDocPatternReplacements.contains)
+        if unsupported.nonEmpty then Left(s"Unsupported patterns from scaladoc format are used: ${unsupported.mkString(" ")}")
+        else asTemplate(supported.foldLeft(string)((template, pattern) =>
+          template.replace(pattern, SupportedScalaDocPatternReplacements(pattern))))
+
+      case template => asTemplate(template)
 
 
 type Operation = "view" | "edit"
@@ -86,8 +98,12 @@ object SourceLinks:
       |where <source-link> is one of following:
       | - `github://<organization>/<repository>` (requires revision to be specified as argument for scala3doc)
       | - `gitlab://<organization>/<repository>` (requires revision to be specified as argument for scala3doc)
+      | - <scaladoc-template>
       | - <template>
       |
+      |<scaladoc-template> is a format for `doc-source-url` parameter scaladoc.
+      |NOTE: We only supports `€{FILE_PATH_EXT}` and €{FILE_LINE} patterns
+      |
       |<template> is a liqid template string that can accepts follwoing arguments:
       | - `operation`: either "view" or "edit"
       | - `path`: relative path of file to provide link to

scala3doc/test/dotty/dokka/SourceLinksTests.scala

@@ -19,6 +19,7 @@ class SourceLinkTest:
     testFailure("ala=ala=ala://ma/kota", "known provider")
     testFailure("ala=ala=ala", "subpath")
     testFailure("""{{ ala "ala"}}""", "parse")
+    testFailure("""€{TPL_NAME}""", "scaladoc")
 
 
   @Test
@@ -32,7 +33,8 @@ class SourceLinkTest:
     Seq(
       """https://github.com/organization/repo/{{ operation | replace: "view", "blob" }}/$revision/{{ path }}{{ line | prepend: "L#"}}""",
       "github://lampepfl/dotty",
-      "gitlab://lampepfl/dotty"
+      "gitlab://lampepfl/dotty",
+      "https://github.com/scala/scala/blob/2.13.x€{FILE_PATH_EXT}#€{FILE_LINE}"
     ).foreach{ template =>
       test(template)
       test(s"docs/dotty=$template")
@@ -100,6 +102,12 @@ class SourceLinksTest:
       ("project/Build.scala", 54, edit) -> "/edit/project/Build.scala#54",
     )
 
+    testLink(Seq("https://github.com/scala/scala/blob/2.13.x/€{FILE_PATH_EXT}#L€{FILE_LINE}"), Some("develop"))(
+      "project/Build.scala" -> "https://github.com/scala/scala/blob/2.13.x/project/Build.scala#L",
+      ("project/Build.scala", 54) -> "https://github.com/scala/scala/blob/2.13.x/project/Build.scala#L54",
+      ("project/Build.scala", edit) -> "https://github.com/scala/scala/blob/2.13.x/project/Build.scala#L",
+      ("project/Build.scala", 54, edit) -> "https://github.com/scala/scala/blob/2.13.x/project/Build.scala#L54",
+    )
 
   @Test
   def testBasicPrefixedPaths =