Add search by acronym

Author: pikinier20

scala3doc-js/src/searchbar/PageEntry.scala

@@ -11,17 +11,19 @@ trait PageEntryJS extends js.Object {
 }
 
 case class PageEntry(
-  name: String,
+  fullName: String,
   description: String,
   location: String,
-  searchKeys: Array[String]
+  shortName: String,
+  acronym: Option[String],
 )
 
 object PageEntry {
   def apply(jsObj: PageEntryJS): PageEntry = PageEntry(
     jsObj.name,
     jsObj.description,
     jsObj.location,
-    jsObj.searchKeys.toArray
+    jsObj.searchKeys.head.toLowerCase,
+    Option.when(jsObj.searchKeys.size > 1)(jsObj.searchKeys.last)
   )
 }

scala3doc-js/src/searchbar/SearchbarComponent.scala

@@ -12,7 +12,7 @@ class SearchbarComponent(val callback: (String) => List[PageEntry]):
 
       val resultA = document.createElement("a").asInstanceOf[html.Anchor]
       resultA.href = Globals.pathToRoot + p.location
-      resultA.text = s"${p.name}"
+      resultA.text = s"${p.fullName}"
 
       val location = document.createElement("span")
       location.classList.add("pull-right")

scala3doc-js/src/searchbar/engine/Matchers.scala

@@ -3,10 +3,17 @@ package dotty.dokka
 enum Matchers(func: (PageEntry) => Int) extends Function1[PageEntry, Int]:
   export func.apply
   case ByName(query: String) extends Matchers( (p) => {
-    val name = p.searchKeys.headOption.map(_.toLowerCase)
+    val nameOption = Option(p.shortName)
+    val acronym = p.acronym
     //Edge case for empty query string
     if query == "" then 1
-    else name.filter(_.contains(query)).map(_ => p.name.size - query.size).getOrElse(-1)
+    else {
+      val results = List(
+        nameOption.filter(_.contains(query.toLowerCase)).fold(-1)(_.size - query.size),
+        acronym.filter(_.contains(query)).fold(-1)(_.size - query.size + 1)
+      )
+      if results.forall(_ == -1) then -1 else results.filter(_ != -1).min
+    }
   })
-  case ByKind(kind: String) extends Matchers((p) => p.name.split(" ").headOption.filter(_ == kind).fold(-1)(_ => 1))
+  case ByKind(kind: String) extends Matchers((p) => p.fullName.split(" ").headOption.filter(_.equalsIgnoreCase(kind)).fold(-1)(_ => 1))
 

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

@@ -14,12 +14,13 @@ class QueryParser:
     "var",
     "package",
     "given",
+    "type"
   )
-  val kindRegex = (kinds.mkString("(","|",")") + " (.*)").r
+  val kindRegex = ("(?i)" + kinds.mkString("(","|",")") + " (.*)").r
   val restRegex = raw"(.*)".r
   val escapedRegex = raw"`(.*)`".r
 
-  def parse(query: String): List[Matchers] = query.toLowerCase match {
+  def parse(query: String): List[Matchers] = query match {
     case escapedRegex(rest) => List(Matchers.ByName(rest))
     case kindRegex(kind, rest) => List(Matchers.ByKind(kind)) ++ parse(rest)
     case restRegex(name) => List(Matchers.ByName(name))

scala3doc/src/dotty/renderers/ScalaSearchbarDataInstaller.scala

@@ -60,8 +60,11 @@ class ScalaSearchbarDataInstaller(val ctx: DokkaContext) extends SearchbarDataIn
     pages.addOne(p.getName + link, PageEntry(p.getName, p.getName, link, ""))
   }
 
+  private def createAcronym(s: String): Option[String] =
+    if s.head.isUpper then Some(s.filter(_.isUpper)) else None
+
   override def generatePagesList(): String = {
     val mapper = jacksonObjectMapper()
-    val pagesList = pages.values.map(p => createSearchRecord(p.signature, p.pkg, p.link, List(p.name).asJava)).toList.asJava
+    val pagesList = pages.values.map(p => createSearchRecord(p.signature, p.pkg, p.link, (List(p.name) ++ createAcronym(p.name)).asJava)).toList.asJava
     mapper.writeValueAsString(pagesList)
   }