Extend search by acronym to fuzzy search by tokens

Author: pikinier20

scala3doc-js/src/Globals.scala

@@ -7,4 +7,11 @@ import scala.scalajs.js.annotation.JSGlobalScope
 @JSGlobalScope
 object Globals extends js.Object {
   val pathToRoot: String = js.native
+}
+
+object StringUtils {
+  def createCamelCaseTokens(s: String): List[String] =
+    if s.isEmpty then List.empty
+    else if s.tail.indexWhere(_.isUpper) == -1 then List(s)
+    else List(s.take(s.tail.indexWhere(_.isUpper) + 1)) ++ createCamelCaseTokens(s.drop(s.tail.indexWhere(_.isUpper) + 1))
 }

scala3doc-js/src/searchbar/PageEntry.scala

@@ -15,18 +15,15 @@ case class PageEntry(
   description: String,
   location: String,
   shortName: String,
-  acronym: Option[String]
+  tokens: List[String]
 )
 
 object PageEntry {
-  private def createAcronym(s: String): Option[String] =
-    s.headOption.map(firstLetter => firstLetter.toString ++ s.tail.filter(_.isUpper))
-
   def apply(jsObj: PageEntryJS): PageEntry = PageEntry(
-    jsObj.t,
-    jsObj.d,
-    jsObj.l,
-    jsObj.n.toLowerCase,
-    createAcronym(jsObj.n)
-  )
+      jsObj.t,
+      jsObj.d,
+      jsObj.l,
+      jsObj.n.toLowerCase,
+      StringUtils.createCamelCaseTokens(jsObj.n)
+    )
 }

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

@@ -1,23 +1,24 @@
 package dotty.dokka
 
-enum Matchers extends Function1[PageEntry, Int]:
-  case ByName(query: String)
-  case ByKind(kind: String)
+sealed trait Matchers extends Function1[PageEntry, Int]
 
-  def apply(p: PageEntry): Int = this match {
-    case ByName(query) => {
-      val nameOption = Option(p.shortName)
-      val acronym = p.acronym
-      //Edge case for empty query string
-      if query == "" then 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
-      }
+class ByName(query: String) extends Matchers:
+  val tokens = StringUtils.createCamelCaseTokens(query)
+  def apply(p: PageEntry): Int = {
+    val nameOption = Option(p.shortName)
+    //Edge case for empty query string
+    if query == "" then 1
+    else {
+      val results = List(
+        nameOption.filter(_.contains(query.toLowerCase)).fold(-1)(_.size - query.size),
+        if p.tokens.size >= tokens.size && p.tokens.zip(tokens).forall( (token, query) => token.startsWith(query))
+          then p.tokens.size - tokens.size + 1
+          else -1
+        //acronym.filter(_.contains(query)).fold(-1)(_.size - query.size + 1)
+      )
+      if results.forall(_ == -1) then -1 else results.filter(_ != -1).min
     }
-    case ByKind(kind) => p.fullName.split(" ").headOption.filter(_.equalsIgnoreCase(kind)).fold(-1)(_ => 1)
   }
 
+class ByKind(kind: String) extends Matchers:
+  def apply(p: PageEntry): Int = p.fullName.split(" ").headOption.filter(_.equalsIgnoreCase(kind)).fold(-1)(_ => 1)

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

@@ -21,8 +21,8 @@ class QueryParser:
   val escapedRegex = raw"`(.*)`".r
 
   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))
+    case escapedRegex(rest) => List(ByName(rest))
+    case kindRegex(kind, rest) => List(ByKind(kind)) ++ parse(rest)
+    case restRegex(name) => List(ByName(name))
     case _ => List()
   }