Merge pull request #10 from szymon-rd/search-result-description

Add second line with description to search result

Author: Florian3k

scaladoc-js/main/src/searchbar/PageEntry.scala

@@ -11,11 +11,13 @@ trait PageEntryJS extends js.Object {
   val l: String  = js.native
   val e: Boolean = js.native
   val k: String  = js.native
+  val x: String  = js.native
 }
 
 case class PageEntry(
   fullName: String,
   description: String,
+  extraDescription: String,
   extensionTarget: String,
   location: String,
   isLocationExternal: Boolean,
@@ -37,6 +39,7 @@ object PageEntry {
   def apply(jsObj: PageEntryJS): PageEntry = PageEntry(
       jsObj.t,
       jsObj.d,
+      jsObj.x,
       jsObj.i,
       jsObj.l,
       jsObj.e,

scaladoc-js/main/src/searchbar/SearchbarComponent.scala

@@ -35,7 +35,9 @@ class SearchbarComponent(engine: PageSearchEngine, inkuireEngine: InkuireJSSearc
       a(cls := "scaladoc-searchbar-row mono-small-inline", href := location)(
         p.fullName.zipWithIndex.map((c, i) => if boldChars.contains(i) then b(c.toString) else c.toString),
         span(i(extensionTargetMessage)),
-        span(cls := "pull-right scaladoc-searchbar-location")(p.description)
+        span(cls := "pull-right scaladoc-searchbar-location")(p.description),
+        if p.extraDescription == "" then ""
+        else div(cls := "scaladoc-searchbar-extra-info")(p.extraDescription)
       ).tap { _.onclick = (event: Event) =>
         if (document.body.contains(rootDiv)) {
           document.body.removeChild(rootDiv)

scaladoc-js/main/test/dotty/tools/scaladoc/PageSearchEngineTest.scala

@@ -13,6 +13,7 @@ class PageSearchEngineTest {
       "",
       "",
       "",
+      "",
       false,
       s"$name",
       kind,

scaladoc/resources/dotty_res/styles/theme/layout/searchBar.css

@@ -182,6 +182,7 @@
 
 .scaladoc-searchbar-row {
   display: flex;
+  flex-wrap: wrap;
   color: var(--text-secondary);
   padding: calc(1.5 * var(--base-spacing)) calc(2 * var(--base-spacing));
 }
@@ -228,6 +229,19 @@
   display: block;
 }
 
+.scaladoc-searchbar-extra-info {
+  display: none;
+  width: 100%;
+  padding-top: 1em;
+  white-space: nowrap;
+  overflow-x: hidden;
+  text-overflow: ellipsis;
+}
+
+.scaladoc-searchbar-row:hover .scaladoc-searchbar-extra-info {
+  display: block;
+}
+
 /* searchbar footer */
 #searchbar-footer {
   position: absolute;
@@ -290,6 +304,10 @@
     display: none;
   }
 
+  .scaladoc-searchbar-row:hover .scaladoc-searchbar-extra-info {
+    display: none;
+  }
+
   #scaladoc-searchbar-results {
     border: none;
     margin-left: calc(3 * var(--base-spacing));

scaladoc/src/dotty/tools/scaladoc/renderers/Resources.scala

@@ -154,29 +154,75 @@ trait Resources(using ctx: DocContext) extends Locations, Writer:
     val signatureProvider = ScalaSignatureProvider()
     def flattenToText(signature: Signature): String = signature.getName
 
-    def mkEntry(dri: DRI, name: String, text: String, extensionTarget: String, descr: String, kind: String) = jsonObject(
+    def mkEntry(
+      dri: DRI,
+      name: String,
+      text: String,
+      extensionTarget: String,
+      descr: String,
+      extraDescr: String,
+      kind: String,
+    ) = jsonObject(
         "l" -> jsonString(relativeInternalOrAbsoluteExternalPath(dri)),
         "e" -> (if dri.externalLink.isDefined then rawJSON("true") else rawJSON("false")),
         "i" -> jsonString(extensionTarget),
         "n" -> jsonString(name),
         "t" -> jsonString(text),
         "d" -> jsonString(descr),
-        "k" -> jsonString(kind)
+        "k" -> jsonString(kind),
+        "x" -> jsonString(extraDescr),
       )
 
     def extensionTarget(member: Member): String =
       member.kind match
         case Kind.Extension(on, _) => flattenToText(on.signature)
         case _ => ""
 
+    def docPartRenderPlain(d: DocPart): String =
+      import dotty.tools.scaladoc.tasty.comments.wiki._
+      import com.vladsch.flexmark.util.ast.{Node => MdNode}
+      def renderPlain(wd: WikiDocElement): String =
+        wd match
+          case Paragraph(text) => renderPlain(text)
+          case Chain(items) => items.map(renderPlain).mkString("")
+          case Italic(text) => renderPlain(text)
+          case Bold(text) => renderPlain(text)
+          case Underline(text) => renderPlain(text)
+          case Superscript(text) => renderPlain(text)
+          case Subscript(text) => renderPlain(text)
+          case Link(link, title) => title.map(renderPlain).getOrElse(
+            link match
+              case DocLink.ToURL(url) => url
+              case DocLink.ToDRI(_, name) => name
+              case _ => ""
+          )
+          case Monospace(text) => renderPlain(text)
+          case Text(text) => text
+          case Summary(text) => renderPlain(text)
+          case _ => ""
+      d match
+        case s: Seq[WikiDocElement @unchecked] =>
+          if s.length == 0 then ""
+          else renderPlain(s.head)
+        case _ => ""
+
     def processPage(page: Page, pageFQName: List[String]): Seq[(JSON, Seq[String])] =
       val (res, pageName) =  page.content match
         case m: Member if m.kind != Kind.RootPackage =>
           def processMember(member: Member, fqName: List[String]): Seq[(JSON, Seq[String])] =
             val signature: MemberSignature = signatureProvider.rawSignature(member)()
             val sig = Signature(Plain(member.name)) ++ signature.suffix
             val descr = if member.kind == Kind.Package then "" else fqName.mkString(".")
-            val entry = mkEntry(member.dri, member.name, flattenToText(sig), extensionTarget(member), descr, member.kind.name)
+            val extraDescr = member.docs.map(d => docPartRenderPlain(d.body)).getOrElse("")
+            val entry = mkEntry(
+              member.dri,
+              member.name,
+              flattenToText(sig),
+              extensionTarget(member),
+              descr,
+              extraDescr,
+              member.kind.name,
+            )
             val children = member
                 .membersBy(m => m.kind != Kind.Package && !m.kind.isInstanceOf[Classlike])
                 .filter(m => m.origin == Origin.RegularlyDefined && m.inheritedFrom.fold(true)(_.isSourceSuperclassHidden))
@@ -185,7 +231,7 @@ trait Resources(using ctx: DocContext) extends Locations, Writer:
 
           (processMember(m, pageFQName), m.name)
         case _ =>
-          (Seq((mkEntry(page.link.dri, page.link.name, page.link.name, "", "", "static"), pageFQName)), "")
+          (Seq((mkEntry(page.link.dri, page.link.name, page.link.name, "", "", "", "static"), pageFQName)), "")
 
       val updatedFqName = page.content match
         case m: Member if m.kind == Kind.Package => List(m.name)