Add support for multiple redirects

Author: BarkingBad

.github/workflows/scaladoc.yaml

@@ -36,7 +36,7 @@ jobs:
           java-version: 11
 
       - name: Compile and test scala3doc-js
-        run: ./project/scripts/sbt scaladoc-js/test
+        run: ./project/scripts/sbt scaladoc-js-main/test
 
       - name: Compile and test
         run: |

project/Build.scala

@@ -1258,20 +1258,23 @@ object Build {
    lazy val `scaladoc-js-common` = project.in(file("scaladoc-js/common")).
     enablePlugins(DottyJSPlugin).
     dependsOn(`scala3-library-bootstrappedJS`).
-    settings(
-      Test / fork := false,
-      libraryDependencies += ("org.scala-js" %%% "scalajs-dom" % "1.1.0").cross(CrossVersion.for3Use2_13)
-    )
+    settings(libraryDependencies += ("org.scala-js" %%% "scalajs-dom" % "1.1.0").cross(CrossVersion.for3Use2_13))
 
   lazy val `scaladoc-js-main` = project.in(file("scaladoc-js/main")).
     enablePlugins(DottyJSPlugin).
     dependsOn(`scaladoc-js-common`).
-    settings(scalaJSUseMainModuleInitializer := true)
+    settings(
+      scalaJSUseMainModuleInitializer := true,
+      Test / fork := false
+    )
 
    lazy val `scaladoc-js-markdown` = project.in(file("scaladoc-js/markdown")).
     enablePlugins(DottyJSPlugin).
     dependsOn(`scaladoc-js-common`).
-    settings(scalaJSUseMainModuleInitializer := true)
+    settings(
+      scalaJSUseMainModuleInitializer := true,
+      Test / fork := false
+    )
 
   lazy val `scaladoc-js-contributors` = project.in(file("scaladoc-js/contributors")).
     enablePlugins(DottyJSPlugin).

project/CopyDocs.scala

@@ -19,21 +19,14 @@ object CopyDocs {
    */
   val outputDir = FileSystems.getDefault.getPath("docs-for-dotty-page")
 
-  implicit def stringToFun(s: String): MyParams => String = _ => s
-
-  // Patterns, for convenience
-  val titlePattern = """(?s)^(---\n.*?title: ([^\n]*).*?---)"""
-  val redirectFromPattern = """(?s)^---.*?((redirectFrom: ([^\n]*)).*?---|---)"""
   val jekyllLinkPattern = """\{\% link _overviews/scala3-reference(.*) %\}"""
   val jekyllLinkSubstitution = "..$1"
   val jekyllLinkPattern2 = """\{\% link _overviews/scala3-scaladoc(.*) %\}"""
   val jekyllLinkSubstitution2 = ".$1"
   val localLinkPattern = """\((?!http|www)(.*).html\)"""
   val localLinkSubstitution = "($1.md)"
 
-  case class MyParams(newPath: String)
-
-  val commonTransformations: List[(String, MyParams => String)] = List(
+  val commonTransformations: Map[String, String] = Map(
     jekyllLinkPattern -> jekyllLinkSubstitution,
     jekyllLinkPattern2 -> jekyllLinkSubstitution2,
     localLinkPattern -> localLinkSubstitution,
@@ -44,32 +37,26 @@ object CopyDocs {
    * The outer map is holding morphism `directory prefix` -> `List of transformations`.
    * The inner list is a collection of pairs `regex pattern` -> `substitution value`.
    */
-  val transformationMap: Map[String, List[(String, MyParams => String)]] = Map(
-    "docs/docs/usage/scaladoc/index.md" -> List(
+  val transformationMap: Map[String, Map[String, String]] = Map(
+    "docs/docs/usage/scaladoc/index.md" -> Map(
       ("""\{\{ site\.baseurl \}\}/resources/images/scala3/scaladoc/logo\.svg""" -> "images/scaladoc_logo.svg"),
     ),
 
-    "docs/docs/usage/scaladoc/site-versioning.md" -> List(
+    "docs/docs/usage/scaladoc/site-versioning.md" -> Map(
       ("""/resources/images/scala3/scaladoc/nightly\.gif""" -> "images/scaladoc/nightly.gif"),
     ),
 
-    "docs/docs/usage/scaladoc/search-engine.md" -> List(
+    "docs/docs/usage/scaladoc/search-engine.md" -> Map(
       ("""/resources/images/scala3/scaladoc/inkuire-1\.0\.0-M2_js_flatMap\.gif""" -> "images/scaladoc/inkuire-1.0.0-M2_js_flatMap.gif"),
     ),
 
-    "docs/docs/reference/other-new-features/explicit-nulls.md" -> List(
+    "docs/docs/reference/other-new-features/explicit-nulls.md" -> Map(
       ("""/resources/images/scala3/explicit-nulls/explicit-nulls-type-hierarchy\.png""" -> "images/explicit-nulls/explicit-nulls-type-hierarchy.png"),
     ),
 
-    "docs/docs/reference/" -> (commonTransformations ++ List[(String, MyParams => String)](
-      (titlePattern -> ((p) => s"$$1\nlayout: doc-page\ntitle: $$2\nmovedTo: https://docs.scala-lang.org/scala3/reference/${p.newPath}.html\n---")),
-      (redirectFromPattern -> "---\n$2")
-    )),
+    "docs/docs/reference/" -> commonTransformations,
 
-    "docs/docs/usage/scaladoc/" -> (commonTransformations ++ List[(String, MyParams => String)](
-      (titlePattern -> s"$$1\nlayout: doc-page\ntitle: $$2\n---"),
-      (redirectFromPattern -> "---\n$2")
-    )),
+    "docs/docs/usage/scaladoc/" -> commonTransformations
   )
 
   def copyDocs() = {
@@ -78,14 +65,24 @@ object CopyDocs {
       Files.createDirectories(newPath.getParent())
 
       path.toString match {
-        case s if s.startsWith("docs/docs/") =>
+        case s if s.startsWith("docs/docs/") && s.endsWith(".md") =>
           val inputStream = Source.fromFile(path.toFile)(Codec.UTF8)
           val fileContent = inputStream.getLines().mkString("\n")
 
           new PrintStream(newPath.toFile) {
             val patterns = transformationMap.filter { case (k, v) => path.toString.startsWith(k) }.flatMap(_._2)
-            val params = MyParams(newPath = s.stripPrefix("docs/docs/reference/").stripSuffix(".md"))
-            val transformed = patterns.foldLeft(fileContent) { case (res, (pattern, substitution)) => res.replaceAll(pattern, substitution(params)) }
+            val _ :: frontMatter :: actualContent :: Nil = fileContent.split("---", 3).toList
+            write("---".getBytes("UTF8"))
+            val frontMatterSplitted = frontMatter.split("\n(?=[^\\s])")
+            val frontMatterUpdated = List(
+              Some("layout: doc-page"),
+              frontMatterSplitted.find(_.startsWith("title")),
+              frontMatterSplitted.find(_.startsWith("redirectFrom")),
+              if (s.startsWith("docs/docs/reference/")) Some(s"movedTo: https://docs.scala-lang.org/scala3/reference/${s.stripPrefix("docs/docs/reference/").stripSuffix(".md")}.html") else None
+            ).flatten.mkString("\n", "\n", "\n")
+            write(frontMatterUpdated.getBytes("UTF8"))
+            write("---\n".getBytes("UTF8"))
+            val transformed = patterns.foldLeft(actualContent) { case (res, (pattern, substitution)) => res.replaceAll(pattern, substitution) }
             write(transformed.getBytes("UTF8"))
           }
         case s =>

scaladoc-js/main/test/dotty/dokka/MatchersTest.scala renamed to scaladoc-js/main/test/dotty/tools/scaladoc/MatchersTest.scala

@@ -32,4 +32,4 @@ class QueryParserTest:
     testCase("trait", EngineMatchersQuery(List(ByName("trait"))))
     testCase("trait A", EngineMatchersQuery(List(ByKind("trait"), ByName("A"))))
     testCase("`trait A`", EngineMatchersQuery(List(ByName("trait A"))))
-  }
+  }

scaladoc-js/main/test/dotty/dokka/QueryParserTest.scala renamed to scaladoc-js/main/test/dotty/tools/scaladoc/QueryParserTest.scala

@@ -111,7 +111,11 @@ abstract class Renderer(rootPackage: Member, val members: Map[DRI, Member], prot
 
           (siteContext.orphanedTemplates ++ actualIndexTemplate).map(templateToPage(_, siteContext))
 
-  val redirectPages: Seq[Page] = staticSite.fold(Seq.empty)(siteContext => siteContext.redirectTemplates.map(templateToPage(_, siteContext)))
+  val redirectPages: Seq[Page] = staticSite.fold(Seq.empty)(siteContext => siteContext.redirectTemplates.map {
+    case (template, driFrom, driTo) =>
+      val redirectTo = pathToPage(driFrom, driTo)
+      templateToPage(template.copy(templateFile = template.templateFile.copy(settings = template.templateFile.settings ++ Map("redirectTo" -> redirectTo))), siteContext)
+  })
 
   /**
    * Here we have to retrive index pages from hidden pages and replace fake index pages in navigable page tree.

scaladoc/src/dotty/tools/scaladoc/renderers/Renderer.scala

@@ -71,16 +71,21 @@ class StaticSiteContext(
     orphanedFiles.flatMap(p => loadTemplate(p.toFile, isBlog = false))
   }
 
-  lazy val redirectTemplates: Seq[LoadedTemplate] = {
+  lazy val redirectTemplates: Seq[(LoadedTemplate, DRI, DRI)] = {
     def doFlatten(t: LoadedTemplate): Seq[LoadedTemplate] =
       t +: t.children.flatMap(doFlatten)
     val mainFiles = templates.flatMap(doFlatten)
     mainFiles.flatMap { loadedTemplate =>
-      loadedTemplate.templateFile.settings.getOrElse("page", Map.empty).asInstanceOf[Map[String, Object]].get("redirectFrom").map { case redirectFrom: String =>
+      val redirectFrom = loadedTemplate.templateFile.settings.getOrElse("page", Map.empty).asInstanceOf[Map[String, Object]].get("redirectFrom")
+      def redirectToTemplate(redirectFrom: String) =
         val fakeFile = new File(docsPath.toFile, redirectFrom)
-        val redirectTo = fakeFile.toPath.getParent.relativize(loadedTemplate.file.toPath).toString.stripSuffix(".md") + ".html"
-        LoadedTemplate(layouts("redirect").copy(settings = layouts("redirect").settings ++ Map("redirectTo" -> redirectTo)), List.empty, fakeFile)
-      }
+        val driFrom = driFor(fakeFile.toPath)
+        val driTo = driFor(loadedTemplate.file.toPath)
+        (LoadedTemplate(layouts("redirect"), List.empty, fakeFile), driFrom, driTo)
+      redirectFrom.map {
+        case redirectFrom: String => Seq(redirectToTemplate(redirectFrom))
+        case redirects: List[?] => redirects.asInstanceOf[List[String]].map(redirectToTemplate)
+      }.getOrElse(Nil)
     }
   }