Better inkuire results display

Author: KacperFKorban

scaladoc-js/resources/scaladoc-searchbar.css

@@ -80,10 +80,13 @@
     background-color: var(--leftbar-bg);
     color: var(--leftbar-fg);
     line-height: 24px;
-    display: flex;
     padding: 4px 10px 4px 10px;
 }
 
+.scaladoc-searchbar-result-row {
+    display: flex;
+}
+
 .scaladoc-searchbar-result .micon {
     height: 16px;
     width: 16px;

scaladoc-js/src/searchbar/PageEntry.scala

@@ -20,6 +20,14 @@ case class PageEntry(
   tokens: List[String]
 )
 
+case class InkuireMatch(
+  prettifiedSignature: String,
+  functionName:        String,
+  packageLocation:     String,
+  pageLocation:        String,
+  entryType:           String
+)
+
 object PageEntry {
   def apply(jsObj: PageEntryJS): PageEntry = PageEntry(
       jsObj.t,

scaladoc-js/src/searchbar/SearchbarComponent.scala

@@ -8,17 +8,18 @@ import scala.concurrent.duration._
 class SearchbarComponent(engine: SearchbarEngine, inkuireEngine: InkuireJSSearchEngine, parser: QueryParser):
   val resultsChunkSize = 100
   extension (p: PageEntry)
-    def toHTML(inkuire: Boolean = false) =
+    def toHTML =
       val wrapper = document.createElement("div").asInstanceOf[html.Div]
       wrapper.classList.add("scaladoc-searchbar-result")
+      wrapper.classList.add("scaladoc-searchbar-result-row")
       wrapper.classList.add("monospace")
 
       val icon = document.createElement("span").asInstanceOf[html.Span]
       icon.classList.add("micon")
       icon.classList.add(p.kind.take(2))
 
       val resultA = document.createElement("a").asInstanceOf[html.Anchor]
-      resultA.href = if inkuire then p.location else Globals.pathToRoot + p.location
+      resultA.href = Globals.pathToRoot + p.location
       resultA.text = s"${p.fullName}"
 
       val location = document.createElement("span")
@@ -34,8 +35,52 @@ class SearchbarComponent(engine: SearchbarEngine, inkuireEngine: InkuireJSSearch
       })
       wrapper
 
+  extension (m: InkuireMatch)
+    def toHTML =
+      val wrapper = document.createElement("div").asInstanceOf[html.Div]
+      wrapper.classList.add("scaladoc-searchbar-result")
+      wrapper.classList.add("monospace")
+
+      val resultDiv = document.createElement("div").asInstanceOf[html.Div]
+      resultDiv.classList.add("scaladoc-searchbar-result-row")
+
+      val icon = document.createElement("span").asInstanceOf[html.Span]
+      icon.classList.add("micon")
+      icon.classList.add(m.entryType.take(2))
+
+      val resultA = document.createElement("a").asInstanceOf[html.Anchor]
+      resultA.href = m.pageLocation
+      resultA.text = m.functionName
+
+      val packageDiv = document.createElement("div").asInstanceOf[html.Div]
+      packageDiv.classList.add("scaladoc-searchbar-inkuire-package")
+
+      val packageIcon = document.createElement("span").asInstanceOf[html.Span]
+      packageIcon.classList.add("micon")
+      packageIcon.classList.add("pa")
+
+      val packageSpan = document.createElement("span").asInstanceOf[html.Span]
+      packageSpan.textContent = m.packageLocation
+
+      val signature = document.createElement("span")
+      signature.classList.add("pull-right")
+      signature.classList.add("scaladoc-searchbar-inkuire-signature")
+      signature.textContent = m.prettifiedSignature
+
+      wrapper.appendChild(resultDiv)
+      resultDiv.appendChild(icon)
+      resultDiv.appendChild(resultA)
+      resultA.appendChild(signature)
+      wrapper.appendChild(packageDiv)
+      packageDiv.appendChild(packageIcon)
+      packageDiv.appendChild(packageSpan)
+      wrapper.addEventListener("mouseover", {
+        case e: MouseEvent => handleHover(wrapper)
+      })
+      wrapper
+
   def handleNewFluffQuery(matchers: List[Matchers]) =
-    val result = engine.query(matchers).map(_.toHTML(inkuire = false))
+    val result = engine.query(matchers).map(_.toHTML)
     resultsDiv.scrollTop = 0
     while (resultsDiv.hasChildNodes()) resultsDiv.removeChild(resultsDiv.lastChild)
     val fragment = document.createDocumentFragment()
@@ -86,8 +131,8 @@ class SearchbarComponent(engine: SearchbarEngine, inkuireEngine: InkuireJSSearch
           animation.classList.add("loading")
           loading.appendChild(animation)
           properResultsDiv.appendChild(loading)
-          inkuireEngine.query(query) { (p: PageEntry) =>
-            properResultsDiv.appendChild(p.toHTML(inkuire = true))
+          inkuireEngine.query(query) { (m: InkuireMatch) =>
+            properResultsDiv.appendChild(m.toHTML)
           } { (s: String) =>
             animation.classList.remove("loading")
             properResultsDiv.appendChild(s.toHTMLError)

scaladoc-js/src/searchbar/engine/InkuireJSSearchEngine.scala

@@ -16,20 +16,18 @@ class InkuireJSSearchEngine {
   val scriptPath     = Globals.pathToRoot + "scripts/"
   val worker: Worker = new Worker(scriptPath + "inkuire-worker.js")
 
-  def dynamicToPageEntry(d: Dynamic): PageEntry = {
-    PageEntry(
-      d.functionName.asInstanceOf[String],
+  def dynamicToMatch(d: Dynamic): InkuireMatch = {
+    InkuireMatch(
       d.prettifiedSignature.asInstanceOf[String],
-      d.pageLocation.asInstanceOf[String],
       d.functionName.asInstanceOf[String],
-      d.entryType.asInstanceOf[String],
-      List.empty
+      d.packageLocation.asInstanceOf[String],
+      d.pageLocation.asInstanceOf[String],
+      d.entryType.asInstanceOf[String]
     )
   }
 
-  def query(s: String)(callback: PageEntry => Unit)(endCallback: String => Unit): List[PageEntry] = {
+  def query(s: String)(callback: InkuireMatch => Unit)(endCallback: String => Unit): Unit = {
     worker.onmessage = _ => ()
-    val res = ListBuffer[PageEntry]()
     val func = (msg: MessageEvent) => {
       msg.data.asInstanceOf[String] match {
         case "engine_ready" =>
@@ -38,13 +36,12 @@ class InkuireJSSearchEngine {
           endCallback(endMsg.drop("query_ended".length))
         case q =>
           val matches = JSON.parse(q).matches
-          val actualMatches = matches.asInstanceOf[js.Array[Dynamic]].map(dynamicToPageEntry)
+          val actualMatches = matches.asInstanceOf[js.Array[Dynamic]].map(dynamicToMatch)
           actualMatches.foreach(callback)
       }
     }
     worker.onmessage = func
     worker.postMessage(s)
-    res.toList
   }
 
 }

scaladoc-js/src/searchbar/engine/QueryParser.scala

@@ -19,7 +19,7 @@ class QueryParser:
   val kindRegex = ("(?i)" + kinds.mkString("(","|",")") + " (.*)").r
   val restRegex = raw"(.*)".r
   val escapedRegex = raw"`(.*)`".r
-  val signatureRegex = raw"([^=>]+=>.*)".r
+  val signatureRegex = raw"(.*=>.*)".r
 
   def parseMatchers(query: String): List[Matchers] = query match {
     case escapedRegex(rest) => List(ByName(rest))

scaladoc/resources/dotty_res/styles/search-bar.css

@@ -112,4 +112,18 @@
   50% {
     background-color: var(--leftbar-bg);
   }
-}
+}
+
+.scaladoc-searchbar-inkuire-package {
+  display: none;
+  color: var(--symbol-fg)
+}
+
+div[selected] > .scaladoc-searchbar-inkuire-package {
+  display: flex;
+}
+
+.scaladoc-searchbar-inkuire-package > .micon {
+  float: right;
+  margin-left: auto !important;
+}