Rename Unidoc to Apidoc to avoid conflict with sbt-unidoc

Author: richardimaoka

README.md

@@ -1,4 +1,4 @@
-# sbt-paradox-unidoc
+# sbt-paradox-apidoc
 
 # Maintanance notes
 

build.sbt

@@ -5,7 +5,7 @@ lazy val root = project
   .settings(
     sbtPlugin := true,
     organization := "com.lightbend.paradox",
-    name := "sbt-paradox-unidoc",
+    name := "sbt-paradox-apidoc",
     addSbtPlugin(Library.sbtParadox),
     libraryDependencies ++= Seq(
       Library.fastClassPathScanner,

src/main/scala/com/lightbend/paradox/unidoc/UnidocDirective.scala renamed to src/main/scala/com/lightbend/paradox/apidoc/ApidocDirective.scala

@@ -2,13 +2,13 @@
  * Copyright (C) 2009-2018 Lightbend Inc. <https://www.lightbend.com>
  */
 
-package com.lightbend.paradox.unidoc
+package com.lightbend.paradox.apidoc
 
 import com.lightbend.paradox.markdown.InlineDirective
 import org.pegdown.Printer
 import org.pegdown.ast.{DirectiveNode, TextNode, Visitor}
 
-class UnidocDirective(allClasses: IndexedSeq[String]) extends InlineDirective("unidoc") {
+class ApidocDirective(allClasses: IndexedSeq[String]) extends InlineDirective("apidoc") {
   def render(node: DirectiveNode, visitor: Visitor, printer: Printer): Unit = {
     if (node.label.split('[')(0).contains('.')) {
       val fqcn = node.label
@@ -17,7 +17,7 @@ class UnidocDirective(allClasses: IndexedSeq[String]) extends InlineDirective("u
         syntheticNode("scala", scalaLabel(label), fqcn, node).accept(visitor)
         syntheticNode("java", javaLabel(label), fqcn, node).accept(visitor)
       } else {
-        throw new java.lang.IllegalStateException(s"fqcn not found by @unidoc[$fqcn]")
+        throw new java.lang.IllegalStateException(s"fqcn not found by @apidoc[$fqcn]")
       }
     }
     else {
@@ -71,7 +71,7 @@ class UnidocDirective(allClasses: IndexedSeq[String]) extends InlineDirective("u
       case n =>
         throw new java.lang.IllegalStateException(
           s"$n matches found for $query, but not javadsl/scaladsl: ${matches.mkString(", ")}. " +
-            s"You may want to use the fully qualified class name as @unidoc[fqcn] instead of @unidoc[${label}]."
+            s"You may want to use the fully qualified class name as @apidoc[fqcn] instead of @apidoc[${label}]."
         )
     }
   }

src/main/scala/com/lightbend/paradox/apidoc/ApidocKeys.scala

@@ -0,0 +1,11 @@
+/**
+ * Copyright (C) 2009-2018 Lightbend Inc. <https://www.lightbend.com>
+ */
+
+package com.lightbend.paradox.apidoc
+
+import sbt._
+
+object ApidocKeys {
+  val apidocRootPackage = settingKey[String]("")
+}

src/main/scala/com/lightbend/paradox/unidoc/UnidocPlugin.scala renamed to src/main/scala/com/lightbend/paradox/apidoc/ApidocPlugin.scala

@@ -2,7 +2,7 @@
  * Copyright (C) 2009-2018 Lightbend Inc. <https://www.lightbend.com>
  */
 
-package com.lightbend.paradox.unidoc
+package com.lightbend.paradox.apidoc
 
 import _root_.io.github.lukehutch.fastclasspathscanner.FastClasspathScanner
 import com.lightbend.paradox.markdown.Writer
@@ -13,31 +13,31 @@ import sbt._
 
 import scala.collection.JavaConverters._
 
-object UnidocPlugin extends AutoPlugin {
-  import UnidocKeys._
+object ApidocPlugin extends AutoPlugin {
+  import ApidocKeys._
 
   val version = ParadoxPlugin.readProperty("akka-paradox.properties", "akka.paradox.version")
 
   override def requires: Plugins = ParadoxPlugin
 
   override def trigger: PluginTrigger = noTrigger
 
-  override def projectSettings: Seq[Setting[_]] = unidocSettings(Compile)
+  override def projectSettings: Seq[Setting[_]] = apidocSettings(Compile)
 
-  def unidocParadoxGlobalSettings: Seq[Setting[_]] = Seq(
-    unidocRootPackage := "scala",
+  def apidocParadoxGlobalSettings: Seq[Setting[_]] = Seq(
+    apidocRootPackage := "scala",
     paradoxDirectives ++= Def.taskDyn {
       val classpath = (fullClasspath in Compile).value.files.map(_.toURI.toURL).toArray
       val classLoader = new java.net.URLClassLoader(classpath, this.getClass.getClassLoader)
-      val scanner = new FastClasspathScanner(unidocRootPackage.value).addClassLoader(classLoader).scan()
+      val scanner = new FastClasspathScanner(apidocRootPackage.value).addClassLoader(classLoader).scan()
       val allClasses = scanner.getNamesOfAllClasses.asScala.toVector
       Def.task { Seq(
-        { _: Writer.Context ⇒ new UnidocDirective(allClasses) }
+        { _: Writer.Context ⇒ new ApidocDirective(allClasses) }
       )}
     }.value
   )
 
-  def unidocSettings(config: Configuration): Seq[Setting[_]] = unidocParadoxGlobalSettings ++ inConfig(config)(Seq(
+  def apidocSettings(config: Configuration): Seq[Setting[_]] = apidocParadoxGlobalSettings ++ inConfig(config)(Seq(
     // scoped settings here
   ))
 }

src/main/scala/com/lightbend/paradox/unidoc/UnidocKeys.scala

@@ -2,11 +2,11 @@
  * Copyright (C) 2009-2018 Lightbend Inc. <https://www.lightbend.com>
  */
 
-package com.lightbend.paradox.unidoc
+package com.lightbend.paradox.apidoc
 
 import com.lightbend.paradox.markdown.Writer
 
-class UnidocPluginSpec extends MarkdownBaseSpec {
+class ApidocPluginSpec extends MarkdownBaseSpec {
   val rootPackage = "akka"
 
   val allClasses = Array(
@@ -35,7 +35,7 @@ class UnidocPluginSpec extends MarkdownBaseSpec {
     verbatimSerializers = Writer.defaultVerbatims,
     serializerPlugins = Writer.defaultPlugins(
       Writer.defaultDirectives ++ Seq(
-        (_: Writer.Context) => new UnidocDirective(allClasses)
+        (_: Writer.Context) => new ApidocDirective(allClasses)
       )
     )
   )
@@ -47,8 +47,8 @@ class UnidocPluginSpec extends MarkdownBaseSpec {
     "javadoc.akka.http.base_url" -> "https://doc.akka.io/japi/akka-http/current",
   )
 
-  "Unidoc directive" should "generate markdown correctly when there is only one match" in {
-    markdown("@unidoc[Envelope]") shouldEqual
+  "Apidoc directive" should "generate markdown correctly when there is only one match" in {
+    markdown("@apidoc[Envelope]") shouldEqual
       html(
         """<p><span class="group-scala">
           |<a href="https://doc.akka.io/api/akka/2.5/akka/dispatch/Envelope.html">Envelope</a></span><span class="group-java">
@@ -58,14 +58,14 @@ class UnidocPluginSpec extends MarkdownBaseSpec {
   }
 
   it should "throw an exception when there is no match" in {
-    val thrown = the[IllegalStateException] thrownBy markdown("@unidoc[ThereIsNoSuchClass]")
+    val thrown = the[IllegalStateException] thrownBy markdown("@apidoc[ThereIsNoSuchClass]")
     thrown.getMessage shouldEqual
       "No matches found for ThereIsNoSuchClass"
   }
 
 
   it should "generate markdown correctly when 2 matches found and their package names include javadsl/scaladsl" in {
-    markdown("@unidoc[Flow]") shouldEqual
+    markdown("@apidoc[Flow]") shouldEqual
       html(
         """<p><span class="group-java">
           |<a href="https://doc.akka.io/japi/akka/2.5/?akka/stream/javadsl/Flow.html">Flow</a></span><span class="group-scala">
@@ -75,13 +75,13 @@ class UnidocPluginSpec extends MarkdownBaseSpec {
   }
 
   it should "throw an exception when two matches found but javadsl/scaladsl is not in their packages" in {
-    val thrown = the[IllegalStateException] thrownBy markdown("@unidoc[ActorRef]")
+    val thrown = the[IllegalStateException] thrownBy markdown("@apidoc[ActorRef]")
     thrown.getMessage shouldEqual
-      "2 matches found for ActorRef, but not javadsl/scaladsl: akka.actor.ActorRef, akka.actor.typed.ActorRef. You may want to use the fully qualified class name as @unidoc[fqcn] instead of @unidoc[ActorRef]."
+      "2 matches found for ActorRef, but not javadsl/scaladsl: akka.actor.ActorRef, akka.actor.typed.ActorRef. You may want to use the fully qualified class name as @apidoc[fqcn] instead of @apidoc[ActorRef]."
   }
 
-  it should "generate markdown correctly when fully qualified class name (fqcn) is specified as @unidoc[fqcn]" in {
-    markdown("@unidoc[akka.actor.ActorRef]") shouldEqual
+  it should "generate markdown correctly when fully qualified class name (fqcn) is specified as @apidoc[fqcn]" in {
+    markdown("@apidoc[akka.actor.ActorRef]") shouldEqual
       html(
         """<p><span class="group-scala">
           |<a href="https://doc.akka.io/api/akka/2.5/akka/actor/ActorRef.html">ActorRef</a></span><span class="group-java">
@@ -91,13 +91,13 @@ class UnidocPluginSpec extends MarkdownBaseSpec {
   }
 
   it should "throw an exception when `.` is in the [label], but the label is not fqcn" in {
-    val thrown = the[IllegalStateException] thrownBy markdown("@unidoc[actor.typed.ActorRef]")
+    val thrown = the[IllegalStateException] thrownBy markdown("@apidoc[actor.typed.ActorRef]")
     thrown.getMessage shouldEqual
-      "fqcn not found by @unidoc[actor.typed.ActorRef]"
+      "fqcn not found by @apidoc[actor.typed.ActorRef]"
   }
 
   it should "generate markdown correctly for a companion object" in {
-    markdown("@unidoc[ClusterClient$]") shouldEqual
+    markdown("@apidoc[ClusterClient$]") shouldEqual
       html(
         """<p><span class="group-scala">
           |<a href="https://doc.akka.io/api/akka/2.5/akka/cluster/client/ClusterClient$.html">ClusterClient</a></span><span class="group-java">
@@ -107,7 +107,7 @@ class UnidocPluginSpec extends MarkdownBaseSpec {
   }
 
   it should "generate markdown correctly for type parameter and wildcard" in {
-    markdown("@unidoc[Source[ServerSentEvent, \\_]]") shouldEqual
+    markdown("@apidoc[Source[ServerSentEvent, \\_]]") shouldEqual
       html(
         """<p><span class="group-java">
           |<a href="https://doc.akka.io/japi/akka/2.5/?akka/stream/javadsl/Source.html">Source&lt;ServerSentEvent, ?&gt;</a></span><span class="group-scala">
@@ -117,7 +117,7 @@ class UnidocPluginSpec extends MarkdownBaseSpec {
   }
 
   it should "generate markdown correctly for type parameters with concrete names" in {
-    markdown("@unidoc[Flow[Message, Message, Mat]]") shouldEqual
+    markdown("@apidoc[Flow[Message, Message, Mat]]") shouldEqual
       html(
         """<p><span class="group-java">
           |<a href="https://doc.akka.io/japi/akka/2.5/?akka/stream/javadsl/Flow.html">Flow&lt;Message, Message, Mat&gt;</a></span><span class="group-scala">
@@ -127,7 +127,7 @@ class UnidocPluginSpec extends MarkdownBaseSpec {
   }
 
   it should "generate markdown correctly for nested type parameters" in {
-    markdown("@unidoc[Marshaller[Try[A], B]]") shouldEqual
+    markdown("@apidoc[Marshaller[Try[A], B]]") shouldEqual
       html(
         """<p><span class="group-java">
           |<a href="https://doc.akka.io/japi/akka-http/current/?akka/http/javadsl/marshalling/Marshaller.html">Marshaller&lt;Try&lt;A&gt;, B&gt;</a></span><span class="group-scala">

src/test/scala/com.lightbend.paradox/unidoc/UnidocPluginSpec.scala renamed to src/test/scala/com.lightbend.paradox/apidoc/ApidocPluginSpec.scala

@@ -3,7 +3,7 @@
  */
 
 
-package com.lightbend.paradox.unidoc
+package com.lightbend.paradox.apidoc
 
 import com.lightbend.paradox.tree.Tree.{Forest, Location}
 import java.io.{File, PrintWriter}