Decouple Scala.js jses. Move contributors to be independent asset/

Author: BarkingBad

build.sbt

@@ -20,7 +20,10 @@ val `tasty-core-bootstrapped` = Build.`tasty-core-bootstrapped`
 val `tasty-core-scala2` = Build.`tasty-core-scala2`
 val scaladoc = Build.scaladoc
 val `scaladoc-testcases` = Build.`scaladoc-testcases`
-val `scaladoc-js` = Build.`scaladoc-js`
+val `scaladoc-js-common` = Build.`scaladoc-js-common`
+val `scaladoc-js-main` = Build.`scaladoc-js-main`
+val `scaladoc-js-markdown` = Build.`scaladoc-js-markdown`
+val `scaladoc-js-contributors` = Build.`scaladoc-js-contributors`
 val `scala3-bench-run` = Build.`scala3-bench-run`
 val dist = Build.dist
 val `community-build` = Build.`community-build`

docs/_layouts/main.html

@@ -1,12 +1,11 @@
 ---
 layout: base
+extraJS:
+  - js/contributors.js
+extraCSS:
+  - css/content-contributors.css
 ---
 <div id="content-wrapper">
-  {% if page.movedTo %}
-  <aside class="warning">
-    The content of this page is outdated. Click <a href="{{ page.movedTo }}">here</a> to find the up to date version of this page.
-  </aside>
-  {% endif %}
   {{ content }}
 </div>
 <script>

docs/_layouts/static-site-main.html

@@ -7,7 +7,7 @@
       <nav class="navigation" role="menu">
         <ul class="navigation-menu">
           <li class="navigation-menu-item">
-            <a href="/" class="active">Documentation</a>
+            <a href="https://docs.scala-lang.org/" class="active">Documentation</a>
           </li>
           <li class="navigation-menu-item">
             <a href="https://www.scala-lang.org/download/">Download</a>
@@ -28,6 +28,11 @@
       </nav>
     </div>
   </div>
+  {% if page.movedTo %}
+  <aside class="warning">
+    The content of this page is outdated. Click <a href="{{ page.movedTo }}">here</a> to find the up to date version of this page.
+  </aside>
+  {% endif %}
   {{ content }}
   <nav class="arrows-wrapper" aria-label="Page navigation">
     {% if page.previous %}

project/Build.scala

@@ -1254,16 +1254,31 @@ object Build {
   lazy val `scaladoc-testcases` = project.in(file("scaladoc-testcases")).
     dependsOn(`scala3-compiler-bootstrapped`).
     settings(commonBootstrappedSettings)
-  lazy val `scaladoc-js` = project.in(file("scaladoc-js")).
+
+   lazy val `scaladoc-js-common` = project.in(file("scaladoc-js/common")).
     enablePlugins(DottyJSPlugin).
     dependsOn(`scala3-library-bootstrappedJS`).
     settings(
-      Compile / scalaJSMainModuleInitializer := (sys.env.get("scaladoc.projectFormat") match {
-        case Some("md") => Some(ModuleInitializer.mainMethod("dotty.tools.scaladoc.Main", "markdownMain"))
-        case _ => Some(ModuleInitializer.mainMethod("dotty.tools.scaladoc.Main", "main"))
-      }),
       Test / fork := false,
-      Compile / scalaJSUseMainModuleInitializer := true,
+      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)
+
+   lazy val `scaladoc-js-markdown` = project.in(file("scaladoc-js/markdown")).
+    enablePlugins(DottyJSPlugin).
+    dependsOn(`scaladoc-js-common`).
+    settings(scalaJSUseMainModuleInitializer := true)
+
+  lazy val `scaladoc-js-contributors` = project.in(file("scaladoc-js/contributors")).
+    enablePlugins(DottyJSPlugin).
+    dependsOn(`scala3-library-bootstrappedJS`).
+    settings(
+      Test / fork := false,
+      scalaJSUseMainModuleInitializer := true,
       libraryDependencies += ("org.scala-js" %%% "scalajs-dom" % "1.1.0").cross(CrossVersion.for3Use2_13)
     )
 
@@ -1318,14 +1333,30 @@ object Build {
     ).
     settings(
       Compile / resourceGenerators += Def.task {
-        val jsDestinationFile = (Compile / resourceManaged).value / "dotty_res" / "scripts" / "scaladoc-scalajs.js"
-        sbt.IO.copyFile((`scaladoc-js` / Compile / fullOptJS).value.data, jsDestinationFile)
-        Seq(jsDestinationFile)
+        val contributorsFile = (`scaladoc-js-contributors` / Compile / fullOptJS).value.data
+        val contributorsDestinationFile = Paths.get("docs-for-dotty-page", "js", "contributors.js").toFile
+        sbt.IO.copyFile(contributorsFile, contributorsDestinationFile)
+
+        val mainFile = (`scaladoc-js-main` / Compile / fullOptJS).value.data
+        val mainDestinationFile = (Compile / resourceManaged).value / "dotty_res" / "scripts" / "scaladoc-scalajs.js"
+        sbt.IO.copyFile(mainFile, mainDestinationFile)
+
+        Seq(mainDestinationFile, contributorsDestinationFile)
       }.taskValue,
       Compile / resourceGenerators += Def.task {
-        Seq("code-snippets.css", "searchbar.css", "content-contributors.css", "social-links.css", "ux.css", "versions-dropdown.css").map { file =>
+        {
+          val cssDesitnationFile = (Compile / resourceManaged).value / "dotty_res" / "styles" / "code-snippets.css"
+          val cssSourceFile = (`scaladoc-js-common` / Compile / resourceDirectory).value / "code-snippets.css"
+          sbt.IO.copyFile(cssSourceFile, cssDesitnationFile)
+          Seq(cssDesitnationFile)
+        } ++ {
+          val cssDesitnationFile = Paths.get("docs-for-dotty-page", "css", "content-contributors.css").toFile
+          val cssSourceFile = (`scaladoc-js-contributors` / Compile / resourceDirectory).value / "content-contributors.css"
+          sbt.IO.copyFile(cssSourceFile, cssDesitnationFile)
+          Seq(cssDesitnationFile)
+        } ++ Seq("searchbar.css", "social-links.css", "ux.css", "versions-dropdown.css").map { file =>
           val cssDesitnationFile = (Compile / resourceManaged).value / "dotty_res" / "styles" / file
-          val cssSourceFile = (`scaladoc-js` / Compile / resourceDirectory).value / file
+          val cssSourceFile = (`scaladoc-js-main` / Compile / resourceDirectory).value / file
           sbt.IO.copyFile(cssSourceFile, cssDesitnationFile)
           cssDesitnationFile
         }
@@ -1341,27 +1372,27 @@ object Build {
         sbt.IO.touch(inkuireDestinationFile)
 
         def tryFetch(retries: Int, timeout: Duration): Unit = {
-          // val downloadProcess = (new java.net.URL(inkuireLink) #> inkuireDestinationFile).run()
-          // val result: Future[Int] = Future(blocking(downloadProcess.exitValue()))
-          // try {
-          //   Await.result(result, timeout) match {
-          //     case 0 =>
-          //     case res if retries > 0 =>
-          //       println(s"Failed to fetch inkuire.js from $inkuireLink: Error code $res. $retries retries left")
-          //       tryFetch(retries - 1, timeout)
-          //     case res => throw new MessageOnlyException(s"Failed to fetch inkuire.js from $inkuireLink: Error code $res")
-          //   }
-          // } catch {
-          //   case e: TimeoutException =>
-          //     downloadProcess.destroy()
-          //     if (retries > 0) {
-          //       println(s"Failed to fetch inkuire.js from $inkuireLink: Download timeout. $retries retries left")
-          //       tryFetch(retries - 1, timeout)
-          //     }
-          //     else {
-          //       throw new MessageOnlyException(s"Failed to fetch inkuire.js from $inkuireLink: Download timeout")
-          //     }
-          // }
+          val downloadProcess = (new java.net.URL(inkuireLink) #> inkuireDestinationFile).run()
+          val result: Future[Int] = Future(blocking(downloadProcess.exitValue()))
+          try {
+            Await.result(result, timeout) match {
+              case 0 =>
+              case res if retries > 0 =>
+                println(s"Failed to fetch inkuire.js from $inkuireLink: Error code $res. $retries retries left")
+                tryFetch(retries - 1, timeout)
+              case res => throw new MessageOnlyException(s"Failed to fetch inkuire.js from $inkuireLink: Error code $res")
+            }
+          } catch {
+            case e: TimeoutException =>
+              downloadProcess.destroy()
+              if (retries > 0) {
+                println(s"Failed to fetch inkuire.js from $inkuireLink: Download timeout. $retries retries left")
+                tryFetch(retries - 1, timeout)
+              }
+              else {
+                throw new MessageOnlyException(s"Failed to fetch inkuire.js from $inkuireLink: Download timeout")
+              }
+          }
         }
 
         tryFetch(5, Duration(60, "s"))
@@ -1456,10 +1487,10 @@ object Build {
           case _ => throw new IllegalArgumentException("No js destination provided")
         }
         val jsDestinationFile: File = Paths.get(destJS).toFile
-        sbt.IO.copyFile((`scaladoc-js` / Compile / fullOptJS).value.data, jsDestinationFile)
+        sbt.IO.copyFile((`scaladoc-js-markdown` / Compile / fullOptJS).value.data, jsDestinationFile)
         csses.map { file =>
           val cssDesitnationFile = Paths.get(destCSS).toFile / file
-          val cssSourceFile = (`scaladoc-js` / Compile / resourceDirectory).value / file
+          val cssSourceFile = (`scaladoc-js-markdown` / Compile / resourceDirectory).value / file
           sbt.IO.copyFile(cssSourceFile, cssDesitnationFile)
           cssDesitnationFile
         }

scaladoc-js/resources/code-snippets.css renamed to scaladoc-js/common/resources/code-snippets.css

@@ -0,0 +1,11 @@
+package dotty.tools.scaladoc
+
+import scala.scalajs.js
+import scala.scalajs.js.annotation.JSGlobalScope
+
+@js.native
+@JSGlobalScope
+object Globals extends js.Object {
+  val githubContributorsUrl: String = js.native
+}
+

scaladoc-js/src/code-snippets/CodeSnippets.scala renamed to scaladoc-js/common/src/code-snippets/CodeSnippets.scala

@@ -0,0 +1,5 @@
+package dotty.tools.scaladoc
+import scala.scalajs.js.annotation._
+
+object Main extends App:
+  ContentContributors()

scaladoc-js/src/code-snippets/CodeSnippetsGlobals.scala renamed to scaladoc-js/common/src/code-snippets/CodeSnippetsGlobals.scala

@@ -8,7 +8,6 @@ import scala.scalajs.js.annotation.JSGlobalScope
 object Globals extends js.Object {
   val pathToRoot: String = js.native
   val versionsDictionaryUrl: String = js.native
-  val githubContributorsUrl: String = js.native
 }
 
 object StringUtils {

scaladoc-js/src/code-snippets/Scastie.scala renamed to scaladoc-js/common/src/code-snippets/Scastie.scala

@@ -0,0 +1,10 @@
+package dotty.tools.scaladoc
+import scala.scalajs.js.annotation._
+
+object Main extends App:
+  Searchbar()
+  SocialLinks()
+  DropdownHandler()
+  Ux()
+  TooltipNormalizer()
+  CodeSnippets()

scaladoc-js/resources/content-contributors.css renamed to scaladoc-js/contributors/resources/content-contributors.css

@@ -0,0 +1,5 @@
+package dotty.tools.scaladoc
+import scala.scalajs.js.annotation._
+
+object Main extends App:
+  CodeSnippets()

scaladoc-js/contributors/src/Globals.scala

@@ -90,7 +90,6 @@ trait Resources(using ctx: DocContext) extends Locations, Writer:
       "styles/filter-bar.css",
       "styles/code-snippets.css",
       "styles/searchbar.css",
-      "styles/content-contributors.css",
       "styles/social-links.css",
       "styles/ux.css",
       "styles/versions-dropdown.css",