Refactor scalacOptions of doc tasks

Author: BarkingBad

compiler/src/dotty/tools/dotc/config/ScalaSettings.scala

@@ -40,7 +40,6 @@ 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"))
@@ -116,6 +115,7 @@ 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.")

project/Build.scala

@@ -350,6 +350,25 @@ object Build {
         appConfiguration.value
       )
     },
+    Compile / doc / scalacOptions ++= Seq(
+      "-external-mappings:" +
+        ".*scala.*::scaladoc3::http://dotty.epfl.ch/api/," +
+        ".*java.*::javadoc::https://docs.oracle.com/javase/8/docs/api/",
+      "-skip-by-regex:.+\\.internal($|\\..+)",
+      "-skip-by-regex:.+\\.impl($|\\..+)",
+      "-project-logo", "docs/logo.svg",
+      "-social-links:" +
+        "github::https://github.com/lampepfl/dotty," +
+        "gitter::https://gitter.im/scala/scala," +
+        "twitter::https://twitter.com/scala_lang",
+      // contains special definitions which are "transplanted" elsewhere
+      // and which therefore confuse Scaladoc when accessed from this pkg
+      "-skip-by-id:scala.runtime.stdLibPatches",
+      // MatchCase is a special type that represents match type cases,
+      // Reflect doesn't expect to see it as a standalone definition
+      // and therefore it's easier just not to document it
+      "-skip-by-id:scala.runtime.MatchCase",
+    ),
     // sbt-dotty defines `scalaInstance in doc` so we need to override it manually
     doc / scalaInstance := scalaInstance.value,
   )
@@ -752,7 +771,6 @@ object Build {
     // when compiling a project that depends on scala3-staging (see sbt-dotty/sbt-test/sbt-dotty/quoted-example-project),
     // but we always need it to be present on the JVM classpath at runtime.
     dependsOn(dottyCompiler(Bootstrapped) % "provided; compile->runtime; test->test").
-    settings(commonBootstrappedSettings).
     settings(
       javaOptions := (`scala3-compiler-bootstrapped` / javaOptions).value
     )
@@ -763,7 +781,6 @@ object Build {
     // when compiling a project that depends on scala3-tasty-inspector (see sbt-dotty/sbt-test/sbt-dotty/tasty-inspector-example-project),
     // but we always need it to be present on the JVM classpath at runtime.
     dependsOn(dottyCompiler(Bootstrapped) % "provided; compile->runtime; test->test").
-    settings(commonBootstrappedSettings).
     settings(
       javaOptions := (`scala3-compiler-bootstrapped` / javaOptions).value
     )
@@ -1597,7 +1614,7 @@ object Build {
           val scala3version = stdlibVersion(Bootstrapped)
           // TODO add versions etc.
           val srcManaged = s"out/bootstrap/stdlib-bootstrapped/scala-$baseVersion/src_managed/main/scala-library-src"
-          val sourceLinks = s"-source-links:$srcManaged=github://scala/scala/v$scala3version#src/library"
+          val sourceLinks = s"-source-links:$srcManaged=github://scala/scala/v${stdlibVersion(Bootstrapped)}}#src/library"
           val revision = Seq("-revision", ref, "-project-version", projectVersion)
           val cmd = Seq("-d", outDir, "-project", name, sourceLinks) ++ revision ++ params ++ targets
           import _root_.scala.sys.process._
@@ -1618,14 +1635,6 @@ object Build {
           generateDocumentation(
             (Compile / classDirectory).value.getAbsolutePath :: Nil,
             "scaladoc", "scaladoc/output/self", VersionUtil.gitHash,
-            Seq(
-              "-siteroot", "scaladoc/documentation",
-              "-project-logo", "scaladoc/documentation/logo.svg",
-              "-external-mappings:" +
-                ".*scala.*::scaladoc3::http://dotty.epfl.ch/api/," +
-                ".*java.*::javadoc::https://docs.oracle.com/javase/8/docs/api/"
-            )
-
           )
         }.value,
         generateScalaDocumentation := Def.inputTaskDyn {
@@ -1661,29 +1670,10 @@ object Build {
           }.dependsOn(generateDocumentation(
             roots, "Scala 3", dest.getAbsolutePath, "master",
             Seq(
-              // contains special definitions which are "transplanted" elsewhere
-              // and which therefore confuse Scaladoc when accessed from this pkg
-              "-skip-by-id:scala.runtime.stdLibPatches",
-              // MatchCase is a special type that represents match type cases,
-              // Reflect doesn't expect to see it as a standalone definition
-              // and therefore it's easier just not to document it
-              "-skip-by-id:scala.runtime.MatchCase",
-              "-skip-by-regex:.+\\.internal($|\\..+)",
-              "-skip-by-regex:.+\\.impl($|\\..+)",
               "-comment-syntax", "wiki",
               "-siteroot", "docs",
-              "-project-logo", "docs/logo.svg",
-              "-external-mappings:.*java.*::javadoc::https://docs.oracle.com/javase/8/docs/api/",
-              "-social-links:" +
-                "github::https://github.com/lampepfl/dotty," +
-                "gitter::https://gitter.im/scala/scala," +
-                "twitter::https://twitter.com/scala_lang",
-              s"-source-links:" +
-                s"$dottyLibRoot=github://lampepfl/dotty/master#library/src," +
-                s"$stdLibRoot=github://scala/scala/v${stdlibVersion(Bootstrapped)}#src/library," +
-                s"docs=github://lampepfl/dotty/master#docs",
-              "-doc-root-content", docRootFile.toString,
-              "-Ydocument-synthetic-types"
+              s"-source-links:docs=github://lampepfl/dotty/master#docs",
+              "-doc-root-content", docRootFile.toString
             )
           ))
         }.evaluated,

sbt-bridge/src/xsbt/DottydocRunner.java

@@ -43,37 +43,14 @@ public void run() {
       return msg.toString();
     });
 
-    // When running with `-from-tasty`, remove the source files from arg list.
     String[] args;
-    boolean fromTasty = false;
+
+    ArrayList<String> retained = new ArrayList<>(args0.length);
     for (String arg : args0) {
-      if ("-from-tasty".equals(arg)) {
-        fromTasty = true;
-        break;
-      }
-    }
-    if (fromTasty) {
-      ArrayList<String> excluded = new ArrayList<>(args0.length);
-      ArrayList<String> retained = new ArrayList<>(args0.length);
-      for (String arg : args0) {
-        if ((arg.endsWith(".scala") || arg.endsWith(".java")) && Files.exists(Paths.get(arg)))
-          excluded.add(arg);
-        else
-          retained.add(arg);
-      }
-      log.debug(() -> {
-        StringBuilder msg =
-          new StringBuilder("Running `-from-tasty`, excluding source files:");
-        for (String arg : excluded) {
-          msg.append("\n\t");
-          msg.append(arg);
-        }
-        return msg.toString();
-      });
-      args = retained.toArray(new String[retained.size()]);
-    } else {
-      args = args0;
+      if (!((arg.endsWith(".scala") || arg.endsWith(".java")) && Files.exists(Paths.get(arg))))
+        retained.add(arg);
     }
+    args = retained.toArray(new String[retained.size()]);
 
     Context ctx = new ContextBase().initialCtx().fresh()
       .setReporter(new DelegatingReporter(delegate));

sbt-dotty/src/dotty/tools/sbtplugin/DottyPlugin.scala

@@ -474,8 +474,7 @@ object DottyPlugin extends AutoPlugin {
           else
             s"${name.value}-${configuration.value}"
         Seq(
-          "-project", projectName,
-          "-from-tasty"
+          "-project", projectName
         )
       }
       else