Add integration tests for scala3doc

Author: romanowski

.github/workflows/scala3doc.yaml

@@ -33,13 +33,24 @@ jobs:
           java-version: 11
 
       - name: Compile and test
-        run: sbt scala3doc/test
+        run: ./project/scripts/sbt scala3doc/test
 
       - name: Locally publish self
-        run: sbt scala3doc/publishLocal
+        run: ./project/scripts/sbt scala3doc/publishLocal
 
       - name: Generate test documentation
-        run: sbt scala3doc/generateSelfDocumentation
+        run: ./project/scripts/sbt scala3doc/generateSelfDocumentation
 
       - name: Generate Scala 3 documentation
-        run: sbt scala3doc/generateScala3Documentation
+        run: |
+          ./project/scripts/sbt sbt-dotty/publishLocal scala3-bootstrapped/publishLocal
+          VERSION=$(./project/scripts/sbt "show sbt-dotty/version" | tail -1 | sed 's/\[info\] //')
+          echo Using sbt-dotty version: $VERSION
+          echo 'addSbtPlugin("ch.epfl.lamp" % "sbt-dotty" % "'$VERSION'")' > scala3doc/example-project/project/dotty.sbt
+
+          SCALA_VERSION=$(./project/scripts/sbt "show scala3-bootstrapped/version" | tail -1 | sed 's/\[info\] //')
+          echo Using scala version: $SCALA_VERSION
+          echo 'scalaVersion := "'$SCALA_VERSION'"' > scala3doc/example-project/dotty.sbt
+
+          cd scala3doc/example-project
+          sbt doc

sbt-dotty/sbt-test/sbt-dotty/example-project/test

@@ -1,8 +1,6 @@
 > run
 > doc
 > clean
-> 'set useScala3doc := true'
-> doc
 > 'set initialCommands := "1 + 1" '
 # FIXME: does not work on the CI
 #> console

sbt-dotty/sbt-test/sbt-dotty/scala3doc/build.sbt

@@ -0,0 +1,3 @@
+scalaVersion := sys.props("plugin.scalaVersion")
+
+useScala3doc := true

sbt-dotty/sbt-test/sbt-dotty/scala3doc/project/plugins.sbt

@@ -0,0 +1 @@
+addSbtPlugin("ch.epfl.lamp" % "sbt-dotty" % sys.props("plugin.version"))

sbt-dotty/sbt-test/sbt-dotty/scala3doc/src/main/scala/hello/Hello.scala

@@ -0,0 +1,8 @@
+package hello
+/** Hello, world! */
+object Hello {
+  def main(args: Array[String]): Unit = {
+    val dotty: Int | String = "dotty"
+    println(s"Hello $dotty!")
+  }
+}

sbt-dotty/sbt-test/sbt-dotty/scala3doc/test

@@ -0,0 +1,2 @@
+> doc
+

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

@@ -363,7 +363,7 @@ object DottyPlugin extends AutoPlugin {
         Resolver.bintrayRepo("virtuslab", "dokka"),
       ),
       useScala3doc := false,
-      scala3docOptions := Seq.empty,
+      scala3docOptions := Seq("-n", name.value),
       Compile / doc / scalacOptions := {
         val s3dOpts = scala3docOptions.value.map("--+DOC+" + _)
         val s3cOpts = (Compile / doc / scalacOptions).value

scala3doc/.gitignore

@@ -1,4 +1,2 @@
 # root where we generate documentation
-output
-
-
+output

scala3doc/build.sbt

@@ -52,3 +52,9 @@ generateScala3Documentation := Def.taskDyn {
   generateDottyDocsFromClasspath(dotttyJars) 
 }.value
 
+val prepareExampleProject = taskKey[Unit]("Prepare example projet for interaction test")
+prepareExampleProject := {
+  
+
+
+}

scala3doc/example-project/.gitignore

@@ -1,27 +1,2 @@
-.DS_Store
-*.class
-*.log
-*~
-
-# sbt specific
-dist/*
-target/
-lib_managed/
-src_managed/
-project/boot/
-project/plugins/project/
-project/local-plugins.sbt
-.history
-
-# Scala-IDE specific
-.scala_dependencies
-.cache
-.classpath
-.project
-.settings
-classes/
-
-# idea
-.idea
-.idea_modules
-/.worksheet/
+dotty.sbt
+project/dotty.sbt

scala3doc/example-project/.travis.yml

@@ -0,0 +1,3 @@
+scalaVersion := "Do fail!"
+
+useScala3doc := true

scala3doc/example-project/default.sbt

@@ -57,9 +57,11 @@ object Main extends Driver {
         "--output", ctx.settings.outputDir.value.toString,
       )
 
+      val allArgs = requiredArgs ++ dokkaStrArgs
+      println(s"Running scala3doc with arguments: $allArgs")
       val parser = org.kohsuke.args4j.CmdLineParser(dokkaRawArgs)
       try {
-        parser.parseArgument(requiredArgs ++ dokkaStrArgs : _*)
+        parser.parseArgument(allArgs : _*)
       } catch {
         case ex: org.kohsuke.args4j.CmdLineException =>
           // compiler errors are reported in SBT