Fix publishing docs for scala3 libraries

BarkingBad · romanowski · commit 8339efaf7fd3 · 2021-03-23T15:00:19.000+01:00
diff --git a/build.sbt b/build.sbt
@@ -4,6 +4,7 @@ val `scala3-interfaces` = Build.`scala3-interfaces`
 val `scala3-compiler` = Build.`scala3-compiler`
 val `scala3-compiler-bootstrapped` = Build.`scala3-compiler-bootstrapped`
 val `scala3-library` = Build.`scala3-library`
+val `scala3-library-js` = Build.`scala3-library-js`
 val `scala3-library-bootstrapped` = Build.`scala3-library-bootstrapped`
 val `scala3-library-bootstrappedJS` = Build.`scala3-library-bootstrappedJS`
 val `scala3-sbt-bridge` = Build.`scala3-sbt-bridge`
@@ -22,7 +23,9 @@ val `tasty-core-scala2` = Build.`tasty-core-scala2`
 val scaladoc = Build.scaladoc
 val `scaladoc-nonBootstrapped` = Build.`scaladoc-nonBootstrapped`
 val `scaladoc-testcases` = Build.`scaladoc-testcases`
+val `scaladoc-testcases-nonBootstrapped` = Build.`scaladoc-testcases-nonBootstrapped`
 val `scaladoc-js` = Build.`scaladoc-js`
+val `scaladoc-js-nonBootstrapped` = Build.`scaladoc-js-nonBootstrapped`
 val `scala3-bench-run` = Build.`scala3-bench-run`
 val dist = Build.dist
 val `community-build` = Build.`community-build`
diff --git a/compiler/src/dotty/tools/dotc/config/ScalaSettings.scala b/compiler/src/dotty/tools/dotc/config/ScalaSettings.scala
@@ -40,6 +40,7 @@ trait CommonScalaSettings { self: Settings.SettingGroup =>
   val help: Setting[Boolean] = BooleanSetting("-help", "Print a synopsis of standard options.", aliases = List("--help"))
   val pageWidth: Setting[Int] = IntSetting("-pagewidth", "Set page width", defaultPageWidth, aliases = List("--page-width"))
   val silentWarnings: Setting[Boolean] = BooleanSetting("-nowarn", "Silence all warnings.", aliases = List("--no-warnings"))
+  val fromTasty: Setting[Boolean] = BooleanSetting("-from-tasty", "Accept only sources from tasty files. The arguments are .tasty or .jar files.", aliases = List("--from-tasty"))
 
   /** Other settings */
   val encoding: Setting[String] = StringSetting("-encoding", "encoding", "Specify character encoding used by source files.", Properties.sourceEncoding, aliases = List("--encoding"))
@@ -115,7 +116,6 @@ class ScalaSettings extends Settings.SettingGroup with CommonScalaSettings {
   val uniqid: Setting[Boolean] = BooleanSetting("-uniqid", "Uniquely tag all identifiers in debugging output.", aliases = List("--unique-id"))
   val language: Setting[List[String]] = MultiStringSetting("-language", "feature", "Enable one or more language features.", aliases = List("--language"))
   val rewrite: Setting[Option[Rewrites]] = OptionSetting[Rewrites]("-rewrite", "When used in conjunction with a `...-migration` source version, rewrites sources to migrate to new version.", aliases = List("--rewrite"))
-  val fromTasty: Setting[Boolean] = BooleanSetting("-from-tasty", "Compile classes from tasty files. The arguments are .tasty or .jar files.", aliases = List("--from-tasty"))
 
   val newSyntax: Setting[Boolean] = BooleanSetting("-new-syntax", "Require `then` and `do` in control expressions.")
   val oldSyntax: Setting[Boolean] = BooleanSetting("-old-syntax", "Require `(...)` around conditions.")
diff --git a/project/Build.scala b/project/Build.scala
@@ -30,13 +30,13 @@ import scala.util.Properties.isJavaAtLeast
 
 import org.portablescala.sbtplatformdeps.PlatformDepsPlugin.autoImport._
 
-object MyScalaJSPlugin extends AutoPlugin {
+abstract class DottyJSPlugin(settings: Seq[Setting[_]]) extends AutoPlugin {
   import Build._
 
   override def requires: Plugins = ScalaJSPlugin
 
   override def projectSettings: Seq[Setting[_]] = Def.settings(
-    commonBootstrappedSettings,
+    settings,
 
     /* #11709 Remove the dependency on scala3-library that ScalaJSPlugin adds.
      * Instead, in this build, we use `.dependsOn` relationships to depend on
@@ -61,6 +61,8 @@ object MyScalaJSPlugin extends AutoPlugin {
     excludeFromIDE := true
   )
 }
+object BootstrappedDottyJSPlugin extends DottyJSPlugin(Build.commonBootstrappedSettings)
+object NonBootstrappedDottyJSPlugin extends DottyJSPlugin(Build.commonNonBootstrappedSettings)
 
 object Build {
   val referenceVersion = "3.0.0-RC2-bin-20210318-e60ef35-NIGHTLY"
@@ -350,8 +352,6 @@ object Build {
     },
     // sbt-dotty defines `scalaInstance in doc` so we need to override it manually
     doc / scalaInstance := scalaInstance.value,
-
-    disableDocSetting,
   )
 
   lazy val commonBenchmarkSettings = Seq(
@@ -689,6 +689,16 @@ object Build {
     case Bootstrapped => `scala3-library-bootstrapped`
   }
 
+  lazy val `scala3-library-js`: Project = project.in(file("library-js")).
+    asDottyLibrary(NonBootstrapped).
+    enablePlugins(NonBootstrappedDottyJSPlugin).
+    settings(
+      libraryDependencies +=
+        ("org.scala-js" %% "scalajs-library" % scalaJSVersion).withDottyCompat(scalaVersion.value),
+      unmanagedSourceDirectories in Compile :=
+        (unmanagedSourceDirectories in (`scala3-library`, Compile)).value
+    )
+
   /** The dotty standard library compiled with the Scala.js back-end, to produce
    *  the corresponding .sjsir files.
    *
@@ -700,7 +710,7 @@ object Build {
    */
   lazy val `scala3-library-bootstrappedJS`: Project = project.in(file("library-js")).
     asDottyLibrary(Bootstrapped).
-    enablePlugins(MyScalaJSPlugin).
+    enablePlugins(BootstrappedDottyJSPlugin).
     settings(
       libraryDependencies +=
         ("org.scala-js" %% "scalajs-library" % scalaJSVersion).withDottyCompat(scalaVersion.value),
@@ -981,7 +991,7 @@ object Build {
    *  useful, as that would not provide the linker and JS runners.
    */
   lazy val sjsSandbox = project.in(file("sandbox/scalajs")).
-    enablePlugins(MyScalaJSPlugin).
+    enablePlugins(BootstrappedDottyJSPlugin).
     dependsOn(`scala3-library-bootstrappedJS`).
     settings(
       // Required to run Scala.js tests.
@@ -998,7 +1008,7 @@ object Build {
    *  It will grow in the future, as more stuff is confirmed to be supported.
    */
   lazy val sjsJUnitTests = project.in(file("tests/sjs-junit")).
-    enablePlugins(MyScalaJSPlugin).
+    enablePlugins(BootstrappedDottyJSPlugin).
     dependsOn(`scala3-library-bootstrappedJS`).
     settings(
       scalacOptions --= Seq("-Xfatal-warnings", "-deprecation"),
@@ -1056,7 +1066,7 @@ object Build {
             (Compile / sourceManaged).value,
             "org.scalajs.testsuite.utils.BuildInfo",
             "scalaVersion" -> scalaVersion.value,
-            "hasSourceMaps" -> false, //MyScalaJSPlugin.wantSourceMaps.value,
+            "hasSourceMaps" -> false, //BootstrappedDottyJSPlugin.wantSourceMaps.value,
             "isNoModule" -> (moduleKind == ModuleKind.NoModule),
             "isESModule" -> (moduleKind == ModuleKind.ESModule),
             "isCommonJSModule" -> (moduleKind == ModuleKind.CommonJSModule),
@@ -1180,9 +1190,21 @@ object Build {
     case Bootstrapped => scaladoc
   }
 
-  lazy val `scaladoc-testcases` = project.in(file("scaladoc-testcases")).asScaladocTestcases
+  lazy val `scaladoc-testcases` = project.in(file("scaladoc-testcases")).asScaladocTestcases(Bootstrapped)
+  lazy val `scaladoc-testcases-nonBootstrapped` = project.in(file("scaladoc-testcases")).asScaladocTestcases(NonBootstrapped)
+
+  def scalaDocTestcases(implicit mode: Mode): Project = mode match {
+    case NonBootstrapped => `scaladoc-testcases-nonBootstrapped`
+    case Bootstrapped => `scaladoc-testcases`
+  }
+
+  lazy val `scaladoc-js` = project.in(file("scaladoc-js")).asScaladocJs(Bootstrapped)
+  lazy val `scaladoc-js-nonBootstrapped` = project.in(file("scaladoc-js")).asScaladocJs(NonBootstrapped)
 
-  lazy val `scaladoc-js` = project.in(file("scaladoc-js")).asScaladocJs
+  def scalaDocJs(implicit mode: Mode): Project = mode match {
+    case NonBootstrapped => `scaladoc-js-nonBootstrapped`
+    case Bootstrapped => `scaladoc-js`
+  }
 
   // sbt plugin to use Dotty in your own build, see
   // https://github.com/lampepfl/scala3-example-project for usage.
@@ -1517,42 +1539,53 @@ object Build {
       settings(commonBenchmarkSettings).
       enablePlugins(JmhPlugin)
 
-    def scaladocBasic(mode: Mode): Project = {
+    def scaladocBasic(implicit mode: Mode): Project = {
       val flexmarkVersion = "0.42.12"
 
-      val base = if(mode == Bootstrapped)
-        project.settings(commonBootstrappedSettings).
-          dependsOn(`scala3-compiler-bootstrapped`).
-          dependsOn(`scala3-tasty-inspector`)
-        else
-          project.settings(commonNonBootstrappedSettings).
-          dependsOn(`scala3-compiler`).
-          dependsOn(`scala3-tasty-inspector-nonbootstrapped`)
-
-        base.settings(
-          libraryDependencies ++= Seq(
-            "com.vladsch.flexmark" % "flexmark" % flexmarkVersion,
-            "com.vladsch.flexmark" % "flexmark-html-parser" % flexmarkVersion,
-            "com.vladsch.flexmark" % "flexmark-ext-anchorlink" % flexmarkVersion,
-            "com.vladsch.flexmark" % "flexmark-ext-autolink" % flexmarkVersion,
-            "com.vladsch.flexmark" % "flexmark-ext-emoji" % flexmarkVersion,
-            "com.vladsch.flexmark" % "flexmark-ext-gfm-strikethrough" % flexmarkVersion,
-            "com.vladsch.flexmark" % "flexmark-ext-gfm-tables" % flexmarkVersion,
-            "com.vladsch.flexmark" % "flexmark-ext-gfm-tasklist" % flexmarkVersion,
-            "com.vladsch.flexmark" % "flexmark-ext-wikilink" % flexmarkVersion,
-            "com.vladsch.flexmark" % "flexmark-ext-yaml-front-matter" % flexmarkVersion,
-            "nl.big-o" % "liqp" % "0.6.7",
-            "org.jsoup" % "jsoup" % "1.13.1", // Needed to process .html files for static site
-            Dependencies.`jackson-dataformat-yaml`,
-
-            "com.novocode" % "junit-interface" % "0.11" % "test",
-          ),
-          Compile / mainClass := Some("dotty.tools.scaladoc.Main"),
-          Compile / buildInfoKeys := Seq[BuildInfoKey](version),
-          Compile / buildInfoPackage := "dotty.tools.scaladoc",
-          BuildInfoPlugin.buildInfoScopedSettings(Compile),
-          BuildInfoPlugin.buildInfoDefaultSettings,
-        )
+      val base = if (mode == Bootstrapped)
+        project.settings(commonBootstrappedSettings)
+          .dependsOn(`scala3-compiler-bootstrapped`)
+          .dependsOn(`scala3-tasty-inspector`)
+      else
+        project.settings(commonNonBootstrappedSettings)
+          .dependsOn(`scala3-compiler`)
+          .dependsOn(`scala3-tasty-inspector-nonbootstrapped`)
+
+      base.settings(
+        Compile / resourceGenerators += Def.task {
+          val jsDestinationFile = (Compile / resourceManaged).value / "dotty_res" / "scripts" / "searchbar.js"
+          sbt.IO.copyFile((scalaDocJs / Compile / fullOptJS).value.data, jsDestinationFile)
+          Seq(jsDestinationFile)
+        }.taskValue,
+        Compile / resourceGenerators += Def.task {
+          val cssDesitnationFile = (Compile / resourceManaged).value / "dotty_res" / "styles" / "scaladoc-searchbar.css"
+          val cssSourceFile = (scalaDocJs / Compile / resourceDirectory).value / "scaladoc-searchbar.css"
+          sbt.IO.copyFile(cssSourceFile, cssDesitnationFile)
+          Seq(cssDesitnationFile)
+        }.taskValue,
+        libraryDependencies ++= Seq(
+          "com.vladsch.flexmark" % "flexmark" % flexmarkVersion,
+          "com.vladsch.flexmark" % "flexmark-html-parser" % flexmarkVersion,
+          "com.vladsch.flexmark" % "flexmark-ext-anchorlink" % flexmarkVersion,
+          "com.vladsch.flexmark" % "flexmark-ext-autolink" % flexmarkVersion,
+          "com.vladsch.flexmark" % "flexmark-ext-emoji" % flexmarkVersion,
+          "com.vladsch.flexmark" % "flexmark-ext-gfm-strikethrough" % flexmarkVersion,
+          "com.vladsch.flexmark" % "flexmark-ext-gfm-tables" % flexmarkVersion,
+          "com.vladsch.flexmark" % "flexmark-ext-gfm-tasklist" % flexmarkVersion,
+          "com.vladsch.flexmark" % "flexmark-ext-wikilink" % flexmarkVersion,
+          "com.vladsch.flexmark" % "flexmark-ext-yaml-front-matter" % flexmarkVersion,
+          "nl.big-o" % "liqp" % "0.6.7",
+          "org.jsoup" % "jsoup" % "1.13.1", // Needed to process .html files for static site
+          Dependencies.`jackson-dataformat-yaml`,
+
+          "com.novocode" % "junit-interface" % "0.11" % "test",
+        ),
+        Compile / mainClass := Some("dotty.tools.scaladoc.Main"),
+        Compile / buildInfoKeys := Seq[BuildInfoKey](version),
+        Compile / buildInfoPackage := "dotty.tools.scaladoc",
+        BuildInfoPlugin.buildInfoScopedSettings(Compile),
+        BuildInfoPlugin.buildInfoDefaultSettings,
+      )
     }
 
     def asScaladoc: Project = {
@@ -1668,36 +1701,29 @@ object Build {
           (Test / Build.testcasesSourceRoot),
           Build.testDocumentationRoot,
         ),
-        Compile / resourceGenerators += Def.task {
-          val jsDestinationFile = (Compile / resourceManaged).value / "dotty_res" / "scripts" / "searchbar.js"
-          sbt.IO.copyFile((`scaladoc-js` / Compile / fullOptJS).value.data, jsDestinationFile)
-          Seq(jsDestinationFile)
-        }.taskValue,
-        Compile / resourceGenerators += Def.task {
-          val cssDesitnationFile = (Compile / resourceManaged).value / "dotty_res" / "styles" / "scaladoc-searchbar.css"
-          val cssSourceFile = (`scaladoc-js` / Compile / resourceDirectory).value / "scaladoc-searchbar.css"
-          sbt.IO.copyFile(cssSourceFile, cssDesitnationFile)
-          Seq(cssDesitnationFile)
-        }.taskValue,
         testDocumentationRoot := (baseDirectory.value / "test-documentations").getAbsolutePath,
         Test / buildInfoPackage := "dotty.tools.scaladoc.test",
         BuildInfoPlugin.buildInfoScopedSettings(Test),
       )
     }
 
-    def asScaladocTestcases: Project =
-      project.dependsOn(`scala3-compiler-bootstrapped`).settings(commonBootstrappedSettings)
-
-    def asScaladocJs: Project =
-      project.
-        enablePlugins(MyScalaJSPlugin).
-        dependsOn(`scala3-library-bootstrappedJS`).
-        settings(
-          Test / fork := false,
-          scalaJSUseMainModuleInitializer := true,
-          libraryDependencies += ("org.scala-js" %%% "scalajs-dom" % "1.1.0").withDottyCompat(scalaVersion.value)
-        )
-
+    def asScaladocTestcases(implicit mode: Mode): Project =
+      if (mode == Bootstrapped)
+        project.dependsOn(`scala3-compiler-bootstrapped`).settings(commonBootstrappedSettings)
+      else
+        project.dependsOn(`scala3-compiler`).settings(commonNonBootstrappedSettings)
+
+    def asScaladocJs(implicit mode: Mode): Project = {
+      val pr = if (mode == Bootstrapped)
+        project.enablePlugins(BootstrappedDottyJSPlugin).dependsOn(`scala3-library-bootstrappedJS`)
+      else
+        project.enablePlugins(NonBootstrappedDottyJSPlugin).dependsOn(`scala3-library-js`)
+      pr.settings(
+        Test / fork := false,
+        scalaJSUseMainModuleInitializer := true,
+        libraryDependencies += ("org.scala-js" %%% "scalajs-dom" % "1.1.0").withDottyCompat(scalaVersion.value)
+      )
+    }
 
     def asDist(implicit mode: Mode): Project = project.
       enablePlugins(PackPlugin).
diff --git a/scaladoc/src/dotty/tools/scaladoc/Scaladoc.scala b/scaladoc/src/dotty/tools/scaladoc/Scaladoc.scala
@@ -96,9 +96,6 @@ object Scaladoc:
 
     allSettings.filterNot(scaladocSpecificSettings.contains).foreach(setInGlobal)
 
-    summary.warnings.foreach(report.warning(_))
-    summary.errors.foreach(report.error(_))
-
     def parseTastyRoots(roots: String) =
       roots.split(File.pathSeparatorChar).toList.map(new File(_))
 
