Include scaladoc as part of mill inspect (#435)

1 files changed, 34 insertions, 0 deletions

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.")
+      )
+    }
+  }
+}