Include scaladoc as part of mill inspect (#435)

4 files changed, 66 insertions, 0 deletions

diff --git a/integration/test/resources/docannotations/build.sc b/integration/test/resources/docannotations/build.sc
new file mode 100644
index 00000000..aa3fc113
--- /dev/null
+++ b/integration/test/resources/docannotations/build.sc
@@ -0,0 +1,30 @@
+import mill.Agg
+import mill.scalalib._
+
+trait JUnitTests extends TestModule{
+  def testFrameworks = Seq("com.novocode.junit.JUnitFramework")
+
+  /**
+    * Overriden ivyDeps Docs!!!
+    */
+  def ivyDeps = Agg(ivy"com.novocode:junit-interface:0.11")
+  def task = T{
+    "???"
+  }
+}
+
+/**
+  * The Core Module Docz!
+  */
+object core extends JavaModule{
+  object test extends Tests with JUnitTests
+
+  /**
+    * Core Task Docz!
+    */
+  def task = T{
+    import collection.JavaConverters._
+    println(this.getClass.getClassLoader.getResources("scalac-plugin.xml").asScala.toList)
+    "Hello!"
+  }
+}
diff --git a/integration/test/src/mill/integration/DocAnnotationsTests.scala b/integration/test/src/mill/integration/DocAnnotationsTests.scala
new file mode 100644
index 00000000..75579689
--- /dev/null
+++ b/integration/test/src/mill/integration/DocAnnotationsTests.scala
@@ -0,0 +1,34 @@
+package mill.integration
+
+import ammonite.ops.{Path, pwd}
+import mill.util.ScriptTestSuite
+import utest._
+
+class DocAnnotationsTests(fork: Boolean) extends ScriptTestSuite(fork) {
+  def workspaceSlug: String = "docannotations"
+  def scriptSourcePath: Path = pwd / 'integration / 'test / 'resources / workspaceSlug
+  val tests = Tests{
+    initWorkspace()
+    'test - {
+      assert(eval("inspect", "core.test.ivyDeps"))
+      val inheritedIvyDeps = ujson.read(meta("inspect"))("value").str
+      assert(
+        inheritedIvyDeps.contains("core.test.ivyDeps"),
+        inheritedIvyDeps.contains("Overriden ivyDeps Docs!!!"),
+        inheritedIvyDeps.contains("Any ivy dependencies you want to add to this Module"),
+      )
+
+      assert(eval("inspect", "core.task"))
+      val task = ujson.read(meta("inspect"))("value").str
+      assert(
+        task.contains("Core Task Docz!")
+      )
+
+      assert(eval("inspect", "inspect"))
+      val doc = ujson.read(meta("inspect"))("value").str
+      assert(
+        doc.contains("Displays metadata about the given task without actually running it.")
+      )
+    }
+  }
+}
diff --git a/integration/test/src/mill/integration/forked/Tests.scala b/integration/test/src/mill/integration/forked/Tests.scala
index 38c739ab..41844b58 100644
--- a/integration/test/src/mill/integration/forked/Tests.scala
+++ b/integration/test/src/mill/integration/forked/Tests.scala
@@ -7,3 +7,4 @@ object JawnTests extends mill.integration.JawnTests(fork = true)
 object UpickleTests extends mill.integration.UpickleTests(fork = true)
 object PlayJsonTests extends mill.integration.PlayJsonTests(fork = true)
 object CaffeineTests extends mill.integration.CaffeineTests(fork = true)
+object DocAnnotationsTests extends mill.integration.DocAnnotationsTests(fork = true)
diff --git a/integration/test/src/mill/integration/local/Tests.scala b/integration/test/src/mill/integration/local/Tests.scala
index c1eba757..e95aac54 100644
--- a/integration/test/src/mill/integration/local/Tests.scala
+++ b/integration/test/src/mill/integration/local/Tests.scala
@@ -7,3 +7,4 @@ object JawnTests extends mill.integration.JawnTests(fork = false)
 object UpickleTests extends mill.integration.UpickleTests(fork = false)
 object PlayJsonTests extends mill.integration.PlayJsonTests(fork = false)
 object CaffeineTests extends mill.integration.CaffeineTests(fork = false)
+object DocAnnotationsTests extends mill.integration.DocAnnotationsTests(fork = false)
\ No newline at end of file