Change scala3doc parameter names

Clean up Build.scala and scala3doc.yaml

Author: romanowski

.github/workflows/scala3doc.yaml

@@ -9,11 +9,10 @@ jobs:
   build:
     runs-on: ubuntu-latest
     container: lampepfl/dotty:2020-04-24
-    
-    steps:
 
+    steps:
+      - name: Git Checkout
       - uses: actions/checkout@v2
-      - run: git fetch --prune --unshallow --tags
 
       - name: Cache Coursier
         uses: actions/cache@v1

project/Build.scala

@@ -213,6 +213,13 @@ object Build {
     }
   )
 
+  lazy val disableDocSetting =
+    // Disable scaladoc generation, it's way too slow and we'll replace it
+    // by dottydoc anyway. We still publish an empty -javadoc.jar to make
+    // sonatype happy.
+      sources in (Compile, doc) := Seq()
+
+
   lazy val commonSettings = publishSettings ++ Seq(
     scalaSource       in Compile    := baseDirectory.value / "src",
     scalaSource       in Test       := baseDirectory.value / "test",
@@ -221,11 +228,6 @@ object Build {
     resourceDirectory in Compile    := baseDirectory.value / "resources",
     resourceDirectory in Test       := baseDirectory.value / "test-resources",
 
-    // Disable scaladoc generation, it's way too slow and we'll replace it
-    // by dottydoc anyway. We still publish an empty -javadoc.jar to make
-    // sonatype happy.
-    sources in (Compile, doc) := Seq(),
-
     // Prevent sbt from rewriting our dependencies
     scalaModuleInfo ~= (_.map(_.withOverrideScalaVersion(false))),
 
@@ -244,7 +246,8 @@ object Build {
     crossPaths := false,
     // Do not depend on the Scala library
     autoScalaLibrary := false,
-    excludeFromIDE := true
+    excludeFromIDE := true,
+    disableDocSetting
   )
 
   // Settings used when compiling dotty (both non-bootstrapped and bootstrapped)
@@ -258,6 +261,8 @@ object Build {
     moduleName ~= { _.stripSuffix("-scala2") },
     version := dottyVersion,
     target := baseDirectory.value / ".." / "out" / "scala-2" / name.value,
+
+    disableDocSetting
   )
 
   // Settings used when compiling dotty with the reference compiler
@@ -267,13 +272,12 @@ object Build {
     version := dottyNonBootstrappedVersion,
     scalaVersion := referenceVersion,
     excludeFromIDE := true,
+
+    disableDocSetting
   )
 
   // Settings used when compiling dotty with a non-bootstrapped dotty
-  lazy val commonBootstrappedSettings = commonBootstrappedSettings0 ++ Seq(
-    disableDocSetting,
-  )
-  lazy val commonBootstrappedSettings0 = commonDottySettings ++ Seq(
+  lazy val commonBootstrappedSettings = commonDottySettings ++ Seq(
     unmanagedSourceDirectories in Compile += baseDirectory.value / "src-bootstrapped",
 
     version := dottyVersion,
@@ -331,6 +335,8 @@ object Build {
     },
     // sbt-dotty defines `scalaInstance in doc` so we need to override it manually
     scalaInstance in doc := scalaInstance.value,
+
+    disableDocSetting,
   )
 
   lazy val commonBenchmarkSettings = Seq(
@@ -1158,7 +1164,7 @@ object Build {
 
   val testcasesOutputDir = taskKey[String]("Root directory where tests classses are generated")
   val testcasesSourceRoot = taskKey[String]("Root directory where tests sources are generated")
-  val generateSelfDocumentation = inputKey[Unit]("Generate example documentation")
+  val generateSelfDocumentation = taskKey[Unit]("Generate example documentation")
   val generateScala3Documentation = taskKey[Unit]("Generate documentation for dotty lib")
   val generateTestcasesDocumentation  = taskKey[Unit]("Generate documentation for testcases, usefull for debugging tests")
   lazy val `scala3doc` = project.in(file("scala3doc")).asScala3doc
@@ -1203,6 +1209,7 @@ object Build {
         publishLocal in `scala3-staging`,
         publishLocal in `scala3-tasty-inspector`,
         publishLocal in `scala3-doc-bootstrapped`,
+        publishLocal in `scala3doc`,
         publishLocal in `scala3-bootstrapped` // Needed because sbt currently hardcodes the dotty artifact
       ).evaluated
     )
@@ -1404,7 +1411,7 @@ object Build {
     def asDottyRoot(implicit mode: Mode): Project = project.withCommonSettings.
       aggregate(`scala3-interfaces`, dottyLibrary, dottyCompiler, tastyCore, dottyDoc, `scala3-sbt-bridge`).
       bootstrappedAggregate(`scala3-language-server`, `scala3-staging`, `scala3-tasty-inspector`,
-        `scala3-library-bootstrappedJS`).
+        `scala3-library-bootstrappedJS`, scala3doc).
       dependsOn(tastyCore).
       dependsOn(dottyCompiler).
       dependsOn(dottyLibrary).
@@ -1454,19 +1461,18 @@ object Build {
     def asScala3doc: Project = {
       def generateDocumentation(targets: String, name: String, outDir: String, params: String = "") = Def.taskDyn {
           val sourceMapping = "=https://github.com/lampepfl/dotty/tree/master#L"
-          run.in(Compile).toTask(s""" -o output/$outDir -t $targets -n "$name" -s $sourceMapping $params""")
+          run.in(Compile).toTask(s""" -d output/$outDir -t $targets -n "$name" -s $sourceMapping $params""")
       }
 
       project.settings(commonBootstrappedSettings).
         dependsOn(`scala3-compiler-bootstrapped`).
         dependsOn(`scala3-tasty-inspector`).
         settings(
+          // Needed to download dokka and its dependencies
           resolvers += Resolver.jcenterRepo,
-          resolvers += Resolver.bintrayRepo("kotlin", "kotlin-dev"),
+          // Needed to download dokka-site
           resolvers += Resolver.bintrayRepo("virtuslab", "dokka"),
           libraryDependencies ++= Seq(
-            "org.scala-lang" %% "scala3-tasty-inspector" % scalaVersion.value,
-
             "com.virtuslab.dokka" % "dokka-site" % "0.1.9",
             "com.vladsch.flexmark" % "flexmark-all" % "0.42.12",
             "nl.big-o" % "liqp" % "0.6.7",
@@ -1475,17 +1481,15 @@ object Build {
             "org.jetbrains.dokka" % "dokka-test-api" % "1.4.10.2" % "test",
             "com.novocode" % "junit-interface" % "0.11" % "test",
           ),
-          test.in(Test) := test.in(Test).dependsOn(compile.in(Compile).in(`scala3doc-testcases`)).value,
+          Test / test := (Test / test).dependsOn(compile.in(Compile).in(`scala3doc-testcases`)).value,
           testcasesOutputDir.in(Test) := classDirectory.in(Compile).in(`scala3doc-testcases`).value.getAbsolutePath.toString,
           testcasesSourceRoot.in(Test) := (baseDirectory.in(`scala3doc-testcases`).value / "src").getAbsolutePath.toString,
-          fork.in(run) := true,
           Compile / mainClass := Some("dotty.dokka.Main"),
           // There is a bug in dokka that prevents parallel tests withing the same jvm
           fork.in(test) := true,
-          Test / parallelExecution := false,
-          generateSelfDocumentation := Def.inputTaskDyn {
-            generateDocumentation(classDirectory.in(Compile).value.getAbsolutePath, "scala3doc", "self", "-d documentation")
-          }.evaluated,
+          generateSelfDocumentation := Def.taskDyn {
+            generateDocumentation(classDirectory.in(Compile).value.getAbsolutePath, "scala3doc", "self", "-p documentation")
+          }.value,
           generateScala3Documentation := Def.taskDyn {
             val dottyJars = Seq(
               // All projects below will be used to generated documentation for Scala 3
@@ -1497,8 +1501,8 @@ object Build {
             )
             val roots = dottyJars.map(_.toString).mkString(java.io.File.pathSeparator)
 
-            if (dottyJars.isEmpty) Def.task { streams.value.log.error("Dotty lib wasn't found") } 
-            else generateDocumentation(roots, "Scala 3", "stdLib", "-d dotty-docs/docs")
+            if (dottyJars.isEmpty) Def.task { streams.value.log.error("Dotty lib wasn't found") }
+            else generateDocumentation(roots, "Scala 3", "stdLib", "-p dotty-docs/docs")
           }.value,
           generateTestcasesDocumentation := Def.taskDyn {
             generateDocumentation(Build.testcasesOutputDir.in(Test).value, "Scala3doc testcases", "testcases")

scala3doc/src/dotty/dokka/Main.scala

@@ -21,7 +21,7 @@ class RawArgs:
     @COption(name="--tastyRoots", required = true, aliases = Array("-t"), usage="Roots where tools should look for tasty files")
     protected var tastyRoots: String = null
 
-    @COption(name="--output",required = true, aliases = Array("-o"), usage="Output to generate documentation to")
+    @COption(name="--dest",required = true, aliases = Array("-d"), usage="Output to generate documentation to")
     protected var output: String = "output"
 
     @COption(name="--classpath", aliases = Array("--cp", "-c"), usage="Classpath to load dependencies from")
@@ -30,7 +30,7 @@ class RawArgs:
     @COption(name="--name", required = true, aliases = Array("-n"), usage="Name of module in generated documentation")
     protected var name: String = "main"
 
-    @COption(name="--docs", aliases = Array("-d"), usage="Root of project docs")
+    @COption(name="--docs", aliases = Array("-p"), usage="Root of project docs")
     private var docsRoot: String =  null
 
     @COption(name="--sources", handler = classOf[StringArrayOptionHandler], aliases = Array("-s"), usage = "Links to source files provided in convention: local_directory=remote_directory#line_suffix")

scala3doc/src/dotty/tools/dottydoc/Main.scala

@@ -57,7 +57,7 @@ object Main extends Driver {
         // we extract some settings from Dotty options since that's how SBT passes them
         "--name", ctx.settings.projectName.value,
         "--projectTitle", ctx.settings.projectName.value,
-        "--output", ctx.settings.outputDir.value.toString,
+        "--dest", ctx.settings.outputDir.value.toString,
       )
 
       val allArgs = requiredArgs ++ dokkaStrArgs