Move script to sbt task

Author: BarkingBad

.github/workflows/ci.yaml

@@ -490,9 +490,6 @@ jobs:
       - name: Add SBT proxy repositories
         run: cp -vf .github/workflows/repositories /root/.sbt/ ; true
 
-      - name: Copy docs
-        run: ./bin/scala project/scripts/processDocs.sc 
-
       - name: Generate Website
         run: |
           ./project/scripts/genDocs -doc-snapshot

.github/workflows/scaladoc.yaml

@@ -52,9 +52,6 @@ jobs:
       - name: Generate testcases documentation
         run: ./project/scripts/sbt scaladoc/generateTestcasesDocumentation
 
-      - name: Copy docs
-        run: ./bin/scala project/scripts/processDocs.sc 
-
       - name: Generate Scala 3 documentation
         run: ./project/scripts/sbt scaladoc/generateScalaDocumentation
 

.gitignore

@@ -102,3 +102,6 @@ cs
 
 # Coursier test product
 compiler/test-coursier/run/*.jar
+
+# Docs
+docs-for-dotty-page/*

docs/README.md

@@ -1,5 +1,4 @@
 This directory is for keeping all the compiler related docs.
 
 For serving this files, one should notice that files under `docs/docs/reference` and `docs/docs/usage/scaladoc` are designed to be compatible with `docs.scala-lang` jekyll page.
-If one wants to generate static site with these files, should firstly run the script from `project/scripts/processDocs.sc`, for example with:
-`bin/scala project/scripts/processDocs.sc` and then using sbt task `sbt scaladoc/generateScalaDocumentation` generate the whole scaladoc for dotty.
+Preprocessing the sources to be compatible with scaladoc static site is done via script at `project/CopyDocs.scala`

project/Build.scala

@@ -1388,7 +1388,7 @@ object Build {
         val dest = file(extraArgs.headOption.getOrElse("scaladoc/output/scala3")).getAbsoluteFile
         val justAPI = extraArgs.drop(1).headOption == Some("--justAPI")
         val majorVersion = (LocalProject("scala3-library-bootstrapped") / scalaBinaryVersion).value
-
+        CopyDocs.copyDocs() // invoke copying function form `project/CopyDocs.scala`
         val dottyJars: Seq[java.io.File] = Seq(
           (`stdlib-bootstrapped`/Compile/products).value,
           (`scala3-interfaces`/Compile/products).value,

project/CopyDocs.scala

@@ -0,0 +1,78 @@
+import scala.io.{ Codec, Source }
+import java.nio.file.{ FileSystems, Files, Path, StandardCopyOption }
+import java.io.PrintStream
+import collection.JavaConverters._
+
+
+/**
+ * Object used for copying docs from docs to docs-for-dotty-page. More explenation can be found and [readme](../docs/README.md)
+ */
+object CopyDocs {
+
+  /**
+   * Input directory from which we will take all the docs.
+   */
+  val inputDir = FileSystems.getDefault.getPath("docs")
+
+  /**
+   * Output directory. Most of the sources will be copied as they are, but some of the files will have headers and links processed.
+   */
+  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 jekyllLinkPattern = """\{\% link _overviews/scala3-scaladoc(.*) %\}"""
+  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)
+
+  /**
+   * Structure for holding which transformations should be applied to which directories.
+   * The outer map is holding morphism `directory prefix` -> `set of transformations`.
+   * The inner set is a collection of pairs `regex pattern` -> `substitution value`.
+   */
+  val transformationMap: Map[String, Set[(String, MyParams => String)]] = Map(
+    "docs/docs/reference/" -> Set(
+      titlePattern -> ((p) => s"---\nlayout: doc-page\ntitle: $$1\nmovedTo: https://docs.scala-lang.org/scala3/reference/${p.newPath}.html\n---"),
+      jekyllLinkPattern -> jekyllLinkSubstitution,
+      jekyllLinkPattern2 -> jekyllLinkSubstitution2,
+      localLinkPattern -> localLinkSubstitution,
+    ),
+
+    "docs/docs/usage/scaladoc/" -> Set(
+      titlePattern -> s"---\ntitle: $$1\n---",
+      jekyllLinkPattern -> jekyllLinkSubstitution,
+      jekyllLinkPattern2 -> jekyllLinkSubstitution2,
+      localLinkPattern -> localLinkSubstitution,
+    ),
+  )
+
+  def copyDocs() = {
+    def copyFile(path: Path): Unit = {
+      val newPath = outputDir.resolve(inputDir.relativize(path))
+      Files.createDirectories(newPath.getParent())
+
+      path.toString match {
+        case s if s.startsWith("docs/docs/") =>
+          val inputStream = Source.fromFile(path.toFile)(Codec.UTF8)
+          val fileContent = inputStream.getLines().mkString("\n")
+
+          new PrintStream(newPath.toFile) {
+            val patterns = transformationMap.find { case (k, v) => path.toString.startsWith(k) }.map(_._2).getOrElse(Set.empty)
+            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)) }
+            write(transformed.getBytes("UTF8"))
+          }
+        case s =>
+          Files.copy(path, newPath, StandardCopyOption.REPLACE_EXISTING);
+      }
+    }
+    Files.walk(inputDir).iterator().asScala.filter(Files.isRegularFile(_)).foreach(copyFile)
+  }
+}